@vertexvis/api-client-node 0.24.0 → 0.26.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.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.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = 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.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
- 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 = 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.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = void 0;
30
- 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 = 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 = void 0;
28
+ exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateFileCollectionRequestDataTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = 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.FileCollectionMetadataDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = 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.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRevisionInstancesApi = exports.PartRevisionInstancesApiFactory = exports.PartRevisionInstancesApiFp = exports.PartRevisionInstancesApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = 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.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 = void 0;
30
+ exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = 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 = void 0;
31
+ exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = 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,9 @@ exports.ClearRepOpTypeEnum = {
65
66
  exports.ClearTransformOpTypeEnum = {
66
67
  ClearTransform: 'clear-transform',
67
68
  };
69
+ exports.CreateFileCollectionRequestDataTypeEnum = {
70
+ FileCollection: 'file-collection',
71
+ };
68
72
  exports.DeselectOperationTypeEnum = {
69
73
  Deselect: 'deselect',
70
74
  };
@@ -74,6 +78,9 @@ exports.ExportRelationshipDataTypeEnum = {
74
78
  exports.ExportStateRelationshipDataTypeEnum = {
75
79
  SceneViewState: 'scene-view-state',
76
80
  };
81
+ exports.FileCollectionMetadataDataTypeEnum = {
82
+ FileCollection: 'file-collection',
83
+ };
77
84
  exports.FileRelationshipDataTypeEnum = {
78
85
  File: 'file',
79
86
  };
@@ -129,6 +136,9 @@ exports.QueryByIdDataAttributesTypeEnum = {
129
136
  Id: 'id',
130
137
  SuppliedId: 'suppliedId',
131
138
  };
139
+ exports.QueryByMetadataDataTypeEnum = {
140
+ QueryByMetadata: 'query-by-metadata',
141
+ };
132
142
  exports.SceneItemRelationshipDataTypeEnum = {
133
143
  SceneItem: 'scene-item',
134
144
  };
@@ -148,6 +158,9 @@ exports.UpdateAccountRequestDataAttributesStatusEnum = {
148
158
  Active: 'active',
149
159
  Disabled: 'disabled',
150
160
  };
161
+ exports.UpdateFileCollectionRequestDataTypeEnum = {
162
+ FileCollection: 'file-collection',
163
+ };
151
164
  exports.UpdateItemToDefaultRenditionOperationTypeEnum = {
152
165
  UpdateToDefaultRendition: 'update-to-default-rendition',
153
166
  };
@@ -1435,12 +1448,589 @@ class ExportsApi extends base_1.BaseAPI {
1435
1448
  }
1436
1449
  }
1437
1450
  exports.ExportsApi = ExportsApi;
1451
+ /**
1452
+ * FileCollectionsApi - axios parameter creator
1453
+ * @export
1454
+ */
1455
+ const FileCollectionsApiAxiosParamCreator = function (configuration) {
1456
+ return {
1457
+ /**
1458
+ * Add files to a `file-collection`.
1459
+ * @param {string} id The `file-collection` ID.
1460
+ * @param {FileIdList} fileIdList
1461
+ * @param {*} [options] Override http request option.
1462
+ * @throws {RequiredError}
1463
+ */
1464
+ addFileCollectionFiles: (id, fileIdList, options = {}) => __awaiter(this, void 0, void 0, function* () {
1465
+ var _a;
1466
+ // verify required parameter 'id' is not null or undefined
1467
+ (0, common_1.assertParamExists)('addFileCollectionFiles', 'id', id);
1468
+ // verify required parameter 'fileIdList' is not null or undefined
1469
+ (0, common_1.assertParamExists)('addFileCollectionFiles', 'fileIdList', fileIdList);
1470
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1471
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1472
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1473
+ let baseOptions;
1474
+ if (configuration) {
1475
+ baseOptions = configuration.baseOptions;
1476
+ }
1477
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1478
+ const localVarHeaderParameter = {};
1479
+ const localVarQueryParameter = {};
1480
+ // authentication OAuth2 required
1481
+ // oauth required
1482
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1483
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1484
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1485
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
1486
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1487
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(fileIdList, localVarRequestOptions, configuration);
1488
+ return {
1489
+ url: (0, common_1.toPathString)(localVarUrlObj),
1490
+ options: localVarRequestOptions,
1491
+ };
1492
+ }),
1493
+ /**
1494
+ * Create a `file-collection`.
1495
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1496
+ * @param {*} [options] Override http request option.
1497
+ * @throws {RequiredError}
1498
+ */
1499
+ createFileCollection: (createFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1500
+ var _b;
1501
+ // verify required parameter 'createFileCollectionRequest' is not null or undefined
1502
+ (0, common_1.assertParamExists)('createFileCollection', 'createFileCollectionRequest', createFileCollectionRequest);
1503
+ const localVarPath = `/file-collections`;
1504
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1505
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1506
+ let baseOptions;
1507
+ if (configuration) {
1508
+ baseOptions = configuration.baseOptions;
1509
+ }
1510
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1511
+ const localVarHeaderParameter = {};
1512
+ const localVarQueryParameter = {};
1513
+ // authentication OAuth2 required
1514
+ // oauth required
1515
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1516
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1517
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1518
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
1519
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1520
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileCollectionRequest, localVarRequestOptions, configuration);
1521
+ return {
1522
+ url: (0, common_1.toPathString)(localVarUrlObj),
1523
+ options: localVarRequestOptions,
1524
+ };
1525
+ }),
1526
+ /**
1527
+ * Delete a `file-collection`.
1528
+ * @param {string} id The `file-collection` ID.
1529
+ * @param {*} [options] Override http request option.
1530
+ * @throws {RequiredError}
1531
+ */
1532
+ deleteFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1533
+ var _c;
1534
+ // verify required parameter 'id' is not null or undefined
1535
+ (0, common_1.assertParamExists)('deleteFileCollection', 'id', id);
1536
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1537
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1538
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1539
+ let baseOptions;
1540
+ if (configuration) {
1541
+ baseOptions = configuration.baseOptions;
1542
+ }
1543
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1544
+ const localVarHeaderParameter = {};
1545
+ const localVarQueryParameter = {};
1546
+ // authentication OAuth2 required
1547
+ // oauth required
1548
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1549
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1550
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
1551
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1552
+ return {
1553
+ url: (0, common_1.toPathString)(localVarUrlObj),
1554
+ options: localVarRequestOptions,
1555
+ };
1556
+ }),
1557
+ /**
1558
+ * Get a `file-collection` by ID.
1559
+ * @param {string} id The `file-collection` ID.
1560
+ * @param {*} [options] Override http request option.
1561
+ * @throws {RequiredError}
1562
+ */
1563
+ getFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1564
+ var _d;
1565
+ // verify required parameter 'id' is not null or undefined
1566
+ (0, common_1.assertParamExists)('getFileCollection', 'id', id);
1567
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1568
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1569
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1570
+ let baseOptions;
1571
+ if (configuration) {
1572
+ baseOptions = configuration.baseOptions;
1573
+ }
1574
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1575
+ const localVarHeaderParameter = {};
1576
+ const localVarQueryParameter = {};
1577
+ // authentication OAuth2 required
1578
+ // oauth required
1579
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1580
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1581
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
1582
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1583
+ return {
1584
+ url: (0, common_1.toPathString)(localVarUrlObj),
1585
+ options: localVarRequestOptions,
1586
+ };
1587
+ }),
1588
+ /**
1589
+ * List the files in a `file-collection`.
1590
+ * @param {string} id The `file-collection` ID.
1591
+ * @param {string} [pageCursor] The cursor for the next page of items.
1592
+ * @param {number} [pageSize] The number of items to return.
1593
+ * @param {*} [options] Override http request option.
1594
+ * @throws {RequiredError}
1595
+ */
1596
+ listFileCollectionFiles: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
1597
+ var _e;
1598
+ // verify required parameter 'id' is not null or undefined
1599
+ (0, common_1.assertParamExists)('listFileCollectionFiles', 'id', id);
1600
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1601
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1602
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1603
+ let baseOptions;
1604
+ if (configuration) {
1605
+ baseOptions = configuration.baseOptions;
1606
+ }
1607
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1608
+ const localVarHeaderParameter = {};
1609
+ const localVarQueryParameter = {};
1610
+ // authentication OAuth2 required
1611
+ // oauth required
1612
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1613
+ if (pageCursor !== undefined) {
1614
+ localVarQueryParameter['page[cursor]'] = pageCursor;
1615
+ }
1616
+ if (pageSize !== undefined) {
1617
+ localVarQueryParameter['page[size]'] = pageSize;
1618
+ }
1619
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1620
+ let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
1621
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1622
+ return {
1623
+ url: (0, common_1.toPathString)(localVarUrlObj),
1624
+ options: localVarRequestOptions,
1625
+ };
1626
+ }),
1627
+ /**
1628
+ * List `file-collection`s by supplied ID.
1629
+ * @param {string} [pageCursor] The cursor for the next page of items.
1630
+ * @param {number} [pageSize] The number of items to return.
1631
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1632
+ * @param {*} [options] Override http request option.
1633
+ * @throws {RequiredError}
1634
+ */
1635
+ listFileCollections: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1636
+ var _f;
1637
+ const localVarPath = `/file-collections`;
1638
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1639
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1640
+ let baseOptions;
1641
+ if (configuration) {
1642
+ baseOptions = configuration.baseOptions;
1643
+ }
1644
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1645
+ const localVarHeaderParameter = {};
1646
+ const localVarQueryParameter = {};
1647
+ // authentication OAuth2 required
1648
+ // oauth required
1649
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1650
+ if (pageCursor !== undefined) {
1651
+ localVarQueryParameter['page[cursor]'] = pageCursor;
1652
+ }
1653
+ if (pageSize !== undefined) {
1654
+ localVarQueryParameter['page[size]'] = pageSize;
1655
+ }
1656
+ if (filterSuppliedId !== undefined) {
1657
+ localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
1658
+ }
1659
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1660
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
1661
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1662
+ return {
1663
+ url: (0, common_1.toPathString)(localVarUrlObj),
1664
+ options: localVarRequestOptions,
1665
+ };
1666
+ }),
1667
+ /**
1668
+ * Update a `file-collection`.
1669
+ * @param {string} id The `file-collection` ID.
1670
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1671
+ * @param {*} [options] Override http request option.
1672
+ * @throws {RequiredError}
1673
+ */
1674
+ updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1675
+ var _g;
1676
+ // verify required parameter 'id' is not null or undefined
1677
+ (0, common_1.assertParamExists)('updateFileCollection', 'id', id);
1678
+ // verify required parameter 'updateFileCollectionRequest' is not null or undefined
1679
+ (0, common_1.assertParamExists)('updateFileCollection', 'updateFileCollectionRequest', updateFileCollectionRequest);
1680
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1681
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1682
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1683
+ let baseOptions;
1684
+ if (configuration) {
1685
+ baseOptions = configuration.baseOptions;
1686
+ }
1687
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
1688
+ const localVarHeaderParameter = {};
1689
+ const localVarQueryParameter = {};
1690
+ // authentication OAuth2 required
1691
+ // oauth required
1692
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1693
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1694
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1695
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1696
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1697
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileCollectionRequest, localVarRequestOptions, configuration);
1698
+ return {
1699
+ url: (0, common_1.toPathString)(localVarUrlObj),
1700
+ options: localVarRequestOptions,
1701
+ };
1702
+ }),
1703
+ };
1704
+ };
1705
+ exports.FileCollectionsApiAxiosParamCreator = FileCollectionsApiAxiosParamCreator;
1706
+ /**
1707
+ * FileCollectionsApi - functional programming interface
1708
+ * @export
1709
+ */
1710
+ const FileCollectionsApiFp = function (configuration) {
1711
+ const localVarAxiosParamCreator = (0, exports.FileCollectionsApiAxiosParamCreator)(configuration);
1712
+ return {
1713
+ /**
1714
+ * Add files to a `file-collection`.
1715
+ * @param {string} id The `file-collection` ID.
1716
+ * @param {FileIdList} fileIdList
1717
+ * @param {*} [options] Override http request option.
1718
+ * @throws {RequiredError}
1719
+ */
1720
+ addFileCollectionFiles(id, fileIdList, options) {
1721
+ return __awaiter(this, void 0, void 0, function* () {
1722
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.addFileCollectionFiles(id, fileIdList, options);
1723
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1724
+ });
1725
+ },
1726
+ /**
1727
+ * Create a `file-collection`.
1728
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1729
+ * @param {*} [options] Override http request option.
1730
+ * @throws {RequiredError}
1731
+ */
1732
+ createFileCollection(createFileCollectionRequest, options) {
1733
+ return __awaiter(this, void 0, void 0, function* () {
1734
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileCollection(createFileCollectionRequest, options);
1735
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1736
+ });
1737
+ },
1738
+ /**
1739
+ * Delete a `file-collection`.
1740
+ * @param {string} id The `file-collection` ID.
1741
+ * @param {*} [options] Override http request option.
1742
+ * @throws {RequiredError}
1743
+ */
1744
+ deleteFileCollection(id, options) {
1745
+ return __awaiter(this, void 0, void 0, function* () {
1746
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFileCollection(id, options);
1747
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1748
+ });
1749
+ },
1750
+ /**
1751
+ * Get a `file-collection` by ID.
1752
+ * @param {string} id The `file-collection` ID.
1753
+ * @param {*} [options] Override http request option.
1754
+ * @throws {RequiredError}
1755
+ */
1756
+ getFileCollection(id, options) {
1757
+ return __awaiter(this, void 0, void 0, function* () {
1758
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileCollection(id, options);
1759
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1760
+ });
1761
+ },
1762
+ /**
1763
+ * List the files in a `file-collection`.
1764
+ * @param {string} id The `file-collection` ID.
1765
+ * @param {string} [pageCursor] The cursor for the next page of items.
1766
+ * @param {number} [pageSize] The number of items to return.
1767
+ * @param {*} [options] Override http request option.
1768
+ * @throws {RequiredError}
1769
+ */
1770
+ listFileCollectionFiles(id, pageCursor, pageSize, options) {
1771
+ return __awaiter(this, void 0, void 0, function* () {
1772
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollectionFiles(id, pageCursor, pageSize, options);
1773
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1774
+ });
1775
+ },
1776
+ /**
1777
+ * List `file-collection`s by supplied ID.
1778
+ * @param {string} [pageCursor] The cursor for the next page of items.
1779
+ * @param {number} [pageSize] The number of items to return.
1780
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1781
+ * @param {*} [options] Override http request option.
1782
+ * @throws {RequiredError}
1783
+ */
1784
+ listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
1785
+ return __awaiter(this, void 0, void 0, function* () {
1786
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollections(pageCursor, pageSize, filterSuppliedId, options);
1787
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1788
+ });
1789
+ },
1790
+ /**
1791
+ * Update a `file-collection`.
1792
+ * @param {string} id The `file-collection` ID.
1793
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1794
+ * @param {*} [options] Override http request option.
1795
+ * @throws {RequiredError}
1796
+ */
1797
+ updateFileCollection(id, updateFileCollectionRequest, options) {
1798
+ return __awaiter(this, void 0, void 0, function* () {
1799
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFileCollection(id, updateFileCollectionRequest, options);
1800
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1801
+ });
1802
+ },
1803
+ };
1804
+ };
1805
+ exports.FileCollectionsApiFp = FileCollectionsApiFp;
1806
+ /**
1807
+ * FileCollectionsApi - factory interface
1808
+ * @export
1809
+ */
1810
+ const FileCollectionsApiFactory = function (configuration, basePath, axios) {
1811
+ const localVarFp = (0, exports.FileCollectionsApiFp)(configuration);
1812
+ return {
1813
+ /**
1814
+ * Add files to a `file-collection`.
1815
+ * @param {string} id The `file-collection` ID.
1816
+ * @param {FileIdList} fileIdList
1817
+ * @param {*} [options] Override http request option.
1818
+ * @throws {RequiredError}
1819
+ */
1820
+ addFileCollectionFiles(id, fileIdList, options) {
1821
+ return localVarFp
1822
+ .addFileCollectionFiles(id, fileIdList, options)
1823
+ .then((request) => request(axios, basePath));
1824
+ },
1825
+ /**
1826
+ * Create a `file-collection`.
1827
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1828
+ * @param {*} [options] Override http request option.
1829
+ * @throws {RequiredError}
1830
+ */
1831
+ createFileCollection(createFileCollectionRequest, options) {
1832
+ return localVarFp
1833
+ .createFileCollection(createFileCollectionRequest, options)
1834
+ .then((request) => request(axios, basePath));
1835
+ },
1836
+ /**
1837
+ * Delete a `file-collection`.
1838
+ * @param {string} id The `file-collection` ID.
1839
+ * @param {*} [options] Override http request option.
1840
+ * @throws {RequiredError}
1841
+ */
1842
+ deleteFileCollection(id, options) {
1843
+ return localVarFp
1844
+ .deleteFileCollection(id, options)
1845
+ .then((request) => request(axios, basePath));
1846
+ },
1847
+ /**
1848
+ * Get a `file-collection` by ID.
1849
+ * @param {string} id The `file-collection` ID.
1850
+ * @param {*} [options] Override http request option.
1851
+ * @throws {RequiredError}
1852
+ */
1853
+ getFileCollection(id, options) {
1854
+ return localVarFp
1855
+ .getFileCollection(id, options)
1856
+ .then((request) => request(axios, basePath));
1857
+ },
1858
+ /**
1859
+ * List the files in a `file-collection`.
1860
+ * @param {string} id The `file-collection` ID.
1861
+ * @param {string} [pageCursor] The cursor for the next page of items.
1862
+ * @param {number} [pageSize] The number of items to return.
1863
+ * @param {*} [options] Override http request option.
1864
+ * @throws {RequiredError}
1865
+ */
1866
+ listFileCollectionFiles(id, pageCursor, pageSize, options) {
1867
+ return localVarFp
1868
+ .listFileCollectionFiles(id, pageCursor, pageSize, options)
1869
+ .then((request) => request(axios, basePath));
1870
+ },
1871
+ /**
1872
+ * List `file-collection`s by supplied ID.
1873
+ * @param {string} [pageCursor] The cursor for the next page of items.
1874
+ * @param {number} [pageSize] The number of items to return.
1875
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1876
+ * @param {*} [options] Override http request option.
1877
+ * @throws {RequiredError}
1878
+ */
1879
+ listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
1880
+ return localVarFp
1881
+ .listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
1882
+ .then((request) => request(axios, basePath));
1883
+ },
1884
+ /**
1885
+ * Update a `file-collection`.
1886
+ * @param {string} id The `file-collection` ID.
1887
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1888
+ * @param {*} [options] Override http request option.
1889
+ * @throws {RequiredError}
1890
+ */
1891
+ updateFileCollection(id, updateFileCollectionRequest, options) {
1892
+ return localVarFp
1893
+ .updateFileCollection(id, updateFileCollectionRequest, options)
1894
+ .then((request) => request(axios, basePath));
1895
+ },
1896
+ };
1897
+ };
1898
+ exports.FileCollectionsApiFactory = FileCollectionsApiFactory;
1899
+ /**
1900
+ * FileCollectionsApi - object-oriented interface
1901
+ * @export
1902
+ * @class FileCollectionsApi
1903
+ * @extends {BaseAPI}
1904
+ */
1905
+ class FileCollectionsApi extends base_1.BaseAPI {
1906
+ /**
1907
+ * Add files to a `file-collection`.
1908
+ * @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
1909
+ * @param {*} [options] Override http request option.
1910
+ * @throws {RequiredError}
1911
+ * @memberof FileCollectionsApi
1912
+ */
1913
+ addFileCollectionFiles(requestParameters, options) {
1914
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1915
+ .addFileCollectionFiles(requestParameters.id, requestParameters.fileIdList, options)
1916
+ .then((request) => request(this.axios, this.basePath));
1917
+ }
1918
+ /**
1919
+ * Create a `file-collection`.
1920
+ * @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
1921
+ * @param {*} [options] Override http request option.
1922
+ * @throws {RequiredError}
1923
+ * @memberof FileCollectionsApi
1924
+ */
1925
+ createFileCollection(requestParameters, options) {
1926
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1927
+ .createFileCollection(requestParameters.createFileCollectionRequest, options)
1928
+ .then((request) => request(this.axios, this.basePath));
1929
+ }
1930
+ /**
1931
+ * Delete a `file-collection`.
1932
+ * @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
1933
+ * @param {*} [options] Override http request option.
1934
+ * @throws {RequiredError}
1935
+ * @memberof FileCollectionsApi
1936
+ */
1937
+ deleteFileCollection(requestParameters, options) {
1938
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1939
+ .deleteFileCollection(requestParameters.id, options)
1940
+ .then((request) => request(this.axios, this.basePath));
1941
+ }
1942
+ /**
1943
+ * Get a `file-collection` by ID.
1944
+ * @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
1945
+ * @param {*} [options] Override http request option.
1946
+ * @throws {RequiredError}
1947
+ * @memberof FileCollectionsApi
1948
+ */
1949
+ getFileCollection(requestParameters, options) {
1950
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1951
+ .getFileCollection(requestParameters.id, options)
1952
+ .then((request) => request(this.axios, this.basePath));
1953
+ }
1954
+ /**
1955
+ * List the files in a `file-collection`.
1956
+ * @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
1957
+ * @param {*} [options] Override http request option.
1958
+ * @throws {RequiredError}
1959
+ * @memberof FileCollectionsApi
1960
+ */
1961
+ listFileCollectionFiles(requestParameters, options) {
1962
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1963
+ .listFileCollectionFiles(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
1964
+ .then((request) => request(this.axios, this.basePath));
1965
+ }
1966
+ /**
1967
+ * List `file-collection`s by supplied ID.
1968
+ * @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
1969
+ * @param {*} [options] Override http request option.
1970
+ * @throws {RequiredError}
1971
+ * @memberof FileCollectionsApi
1972
+ */
1973
+ listFileCollections(requestParameters = {}, options) {
1974
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1975
+ .listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
1976
+ .then((request) => request(this.axios, this.basePath));
1977
+ }
1978
+ /**
1979
+ * Update a `file-collection`.
1980
+ * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
1981
+ * @param {*} [options] Override http request option.
1982
+ * @throws {RequiredError}
1983
+ * @memberof FileCollectionsApi
1984
+ */
1985
+ updateFileCollection(requestParameters, options) {
1986
+ return (0, exports.FileCollectionsApiFp)(this.configuration)
1987
+ .updateFileCollection(requestParameters.id, requestParameters.updateFileCollectionRequest, options)
1988
+ .then((request) => request(this.axios, this.basePath));
1989
+ }
1990
+ }
1991
+ exports.FileCollectionsApi = FileCollectionsApi;
1438
1992
  /**
1439
1993
  * FilesApi - axios parameter creator
1440
1994
  * @export
1441
1995
  */
1442
1996
  const FilesApiAxiosParamCreator = function (configuration) {
1443
1997
  return {
1998
+ /**
1999
+ * Create a download uri for a `file` by ID.
2000
+ * @param {string} id The `file` ID.
2001
+ * @param {CreateDownloadRequest} createDownloadRequest
2002
+ * @param {*} [options] Override http request option.
2003
+ * @throws {RequiredError}
2004
+ */
2005
+ createDownloadUrl: (id, createDownloadRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
2006
+ var _a;
2007
+ // verify required parameter 'id' is not null or undefined
2008
+ (0, common_1.assertParamExists)('createDownloadUrl', 'id', id);
2009
+ // verify required parameter 'createDownloadRequest' is not null or undefined
2010
+ (0, common_1.assertParamExists)('createDownloadUrl', 'createDownloadRequest', createDownloadRequest);
2011
+ const localVarPath = `/files/{id}/download-url`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
2012
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2013
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2014
+ let baseOptions;
2015
+ if (configuration) {
2016
+ baseOptions = configuration.baseOptions;
2017
+ }
2018
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
2019
+ const localVarHeaderParameter = {};
2020
+ const localVarQueryParameter = {};
2021
+ // authentication OAuth2 required
2022
+ // oauth required
2023
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
2024
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
2025
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2026
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
2027
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2028
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDownloadRequest, localVarRequestOptions, configuration);
2029
+ return {
2030
+ url: (0, common_1.toPathString)(localVarUrlObj),
2031
+ options: localVarRequestOptions,
2032
+ };
2033
+ }),
1444
2034
  /**
1445
2035
  * 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.
1446
2036
  * @param {CreateFileRequest} createFileRequest
@@ -1448,7 +2038,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1448
2038
  * @throws {RequiredError}
1449
2039
  */
1450
2040
  createFile: (createFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1451
- var _a;
2041
+ var _b;
1452
2042
  // verify required parameter 'createFileRequest' is not null or undefined
1453
2043
  (0, common_1.assertParamExists)('createFile', 'createFileRequest', createFileRequest);
1454
2044
  const localVarPath = `/files`;
@@ -1466,7 +2056,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1466
2056
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1467
2057
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1468
2058
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1469
- let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
2059
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
1470
2060
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1471
2061
  localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createFileRequest, localVarRequestOptions, configuration);
1472
2062
  return {
@@ -1481,7 +2071,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1481
2071
  * @throws {RequiredError}
1482
2072
  */
1483
2073
  deleteFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1484
- var _b;
2074
+ var _c;
1485
2075
  // verify required parameter 'id' is not null or undefined
1486
2076
  (0, common_1.assertParamExists)('deleteFile', 'id', id);
1487
2077
  const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -1498,7 +2088,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1498
2088
  // oauth required
1499
2089
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1500
2090
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1501
- let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
2091
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
1502
2092
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1503
2093
  return {
1504
2094
  url: (0, common_1.toPathString)(localVarUrlObj),
@@ -1512,7 +2102,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1512
2102
  * @throws {RequiredError}
1513
2103
  */
1514
2104
  getFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1515
- var _c;
2105
+ var _d;
1516
2106
  // verify required parameter 'id' is not null or undefined
1517
2107
  (0, common_1.assertParamExists)('getFile', 'id', id);
1518
2108
  const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -1529,7 +2119,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1529
2119
  // oauth required
1530
2120
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1531
2121
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1532
- let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
2122
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
1533
2123
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1534
2124
  return {
1535
2125
  url: (0, common_1.toPathString)(localVarUrlObj),
@@ -1545,7 +2135,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1545
2135
  * @throws {RequiredError}
1546
2136
  */
1547
2137
  getFiles: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1548
- var _d;
2138
+ var _e;
1549
2139
  const localVarPath = `/files`;
1550
2140
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1551
2141
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1569,7 +2159,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1569
2159
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
1570
2160
  }
1571
2161
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1572
- let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
2162
+ let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
1573
2163
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1574
2164
  return {
1575
2165
  url: (0, common_1.toPathString)(localVarUrlObj),
@@ -1584,7 +2174,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1584
2174
  * @throws {RequiredError}
1585
2175
  */
1586
2176
  updateFile: (id, updateFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1587
- var _e;
2177
+ var _f;
1588
2178
  // verify required parameter 'id' is not null or undefined
1589
2179
  (0, common_1.assertParamExists)('updateFile', 'id', id);
1590
2180
  // verify required parameter 'updateFileRequest' is not null or undefined
@@ -1604,7 +2194,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1604
2194
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1605
2195
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1606
2196
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1607
- let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
2197
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
1608
2198
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1609
2199
  localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateFileRequest, localVarRequestOptions, configuration);
1610
2200
  return {
@@ -1620,7 +2210,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1620
2210
  * @throws {RequiredError}
1621
2211
  */
1622
2212
  uploadFile: (id, body, options = {}) => __awaiter(this, void 0, void 0, function* () {
1623
- var _f;
2213
+ var _g;
1624
2214
  // verify required parameter 'id' is not null or undefined
1625
2215
  (0, common_1.assertParamExists)('uploadFile', 'id', id);
1626
2216
  // verify required parameter 'body' is not null or undefined
@@ -1640,7 +2230,7 @@ const FilesApiAxiosParamCreator = function (configuration) {
1640
2230
  yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1641
2231
  localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
1642
2232
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1643
- let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
2233
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1644
2234
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1645
2235
  localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
1646
2236
  return {
@@ -1658,6 +2248,19 @@ exports.FilesApiAxiosParamCreator = FilesApiAxiosParamCreator;
1658
2248
  const FilesApiFp = function (configuration) {
1659
2249
  const localVarAxiosParamCreator = (0, exports.FilesApiAxiosParamCreator)(configuration);
1660
2250
  return {
2251
+ /**
2252
+ * Create a download uri for a `file` by ID.
2253
+ * @param {string} id The `file` ID.
2254
+ * @param {CreateDownloadRequest} createDownloadRequest
2255
+ * @param {*} [options] Override http request option.
2256
+ * @throws {RequiredError}
2257
+ */
2258
+ createDownloadUrl(id, createDownloadRequest, options) {
2259
+ return __awaiter(this, void 0, void 0, function* () {
2260
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createDownloadUrl(id, createDownloadRequest, options);
2261
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2262
+ });
2263
+ },
1661
2264
  /**
1662
2265
  * 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.
1663
2266
  * @param {CreateFileRequest} createFileRequest
@@ -1744,6 +2347,18 @@ exports.FilesApiFp = FilesApiFp;
1744
2347
  const FilesApiFactory = function (configuration, basePath, axios) {
1745
2348
  const localVarFp = (0, exports.FilesApiFp)(configuration);
1746
2349
  return {
2350
+ /**
2351
+ * Create a download uri for a `file` by ID.
2352
+ * @param {string} id The `file` ID.
2353
+ * @param {CreateDownloadRequest} createDownloadRequest
2354
+ * @param {*} [options] Override http request option.
2355
+ * @throws {RequiredError}
2356
+ */
2357
+ createDownloadUrl(id, createDownloadRequest, options) {
2358
+ return localVarFp
2359
+ .createDownloadUrl(id, createDownloadRequest, options)
2360
+ .then((request) => request(axios, basePath));
2361
+ },
1747
2362
  /**
1748
2363
  * 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.
1749
2364
  * @param {CreateFileRequest} createFileRequest
@@ -1824,6 +2439,18 @@ exports.FilesApiFactory = FilesApiFactory;
1824
2439
  * @extends {BaseAPI}
1825
2440
  */
1826
2441
  class FilesApi extends base_1.BaseAPI {
2442
+ /**
2443
+ * Create a download uri for a `file` by ID.
2444
+ * @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
2445
+ * @param {*} [options] Override http request option.
2446
+ * @throws {RequiredError}
2447
+ * @memberof FilesApi
2448
+ */
2449
+ createDownloadUrl(requestParameters, options) {
2450
+ return (0, exports.FilesApiFp)(this.configuration)
2451
+ .createDownloadUrl(requestParameters.id, requestParameters.createDownloadRequest, options)
2452
+ .then((request) => request(this.axios, this.basePath));
2453
+ }
1827
2454
  /**
1828
2455
  * 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
2456
  * @param {FilesApiCreateFileRequest} requestParameters Request parameters.