@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/esm/api.js CHANGED
@@ -57,6 +57,9 @@ export const ClearRepOpTypeEnum = {
57
57
  export const ClearTransformOpTypeEnum = {
58
58
  ClearTransform: 'clear-transform',
59
59
  };
60
+ export const CreateFileCollectionRequestDataTypeEnum = {
61
+ FileCollection: 'file-collection',
62
+ };
60
63
  export const DeselectOperationTypeEnum = {
61
64
  Deselect: 'deselect',
62
65
  };
@@ -66,6 +69,9 @@ export const ExportRelationshipDataTypeEnum = {
66
69
  export const ExportStateRelationshipDataTypeEnum = {
67
70
  SceneViewState: 'scene-view-state',
68
71
  };
72
+ export const FileCollectionMetadataDataTypeEnum = {
73
+ FileCollection: 'file-collection',
74
+ };
69
75
  export const FileRelationshipDataTypeEnum = {
70
76
  File: 'file',
71
77
  };
@@ -121,6 +127,9 @@ export const QueryByIdDataAttributesTypeEnum = {
121
127
  Id: 'id',
122
128
  SuppliedId: 'suppliedId',
123
129
  };
130
+ export const QueryByMetadataDataTypeEnum = {
131
+ QueryByMetadata: 'query-by-metadata',
132
+ };
124
133
  export const SceneItemRelationshipDataTypeEnum = {
125
134
  SceneItem: 'scene-item',
126
135
  };
@@ -140,6 +149,9 @@ export const UpdateAccountRequestDataAttributesStatusEnum = {
140
149
  Active: 'active',
141
150
  Disabled: 'disabled',
142
151
  };
152
+ export const UpdateFileCollectionRequestDataTypeEnum = {
153
+ FileCollection: 'file-collection',
154
+ };
143
155
  export const UpdateItemToDefaultRenditionOperationTypeEnum = {
144
156
  UpdateToDefaultRendition: 'update-to-default-rendition',
145
157
  };
@@ -1411,12 +1423,585 @@ export class ExportsApi extends BaseAPI {
1411
1423
  .then((request) => request(this.axios, this.basePath));
1412
1424
  }
1413
1425
  }
1426
+ /**
1427
+ * FileCollectionsApi - axios parameter creator
1428
+ * @export
1429
+ */
1430
+ export const FileCollectionsApiAxiosParamCreator = function (configuration) {
1431
+ return {
1432
+ /**
1433
+ * Add files to a `file-collection`.
1434
+ * @param {string} id The `file-collection` ID.
1435
+ * @param {FileIdList} fileIdList
1436
+ * @param {*} [options] Override http request option.
1437
+ * @throws {RequiredError}
1438
+ */
1439
+ addFileCollectionFiles: (id, fileIdList, options = {}) => __awaiter(this, void 0, void 0, function* () {
1440
+ var _a;
1441
+ // verify required parameter 'id' is not null or undefined
1442
+ assertParamExists('addFileCollectionFiles', 'id', id);
1443
+ // verify required parameter 'fileIdList' is not null or undefined
1444
+ assertParamExists('addFileCollectionFiles', 'fileIdList', fileIdList);
1445
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1446
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1447
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1448
+ let baseOptions;
1449
+ if (configuration) {
1450
+ baseOptions = configuration.baseOptions;
1451
+ }
1452
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1453
+ const localVarHeaderParameter = {};
1454
+ const localVarQueryParameter = {};
1455
+ // authentication OAuth2 required
1456
+ // oauth required
1457
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1458
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1459
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1460
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
1461
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1462
+ localVarRequestOptions.data = serializeDataIfNeeded(fileIdList, localVarRequestOptions, configuration);
1463
+ return {
1464
+ url: toPathString(localVarUrlObj),
1465
+ options: localVarRequestOptions,
1466
+ };
1467
+ }),
1468
+ /**
1469
+ * Create a `file-collection`.
1470
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ */
1474
+ createFileCollection: (createFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1475
+ var _b;
1476
+ // verify required parameter 'createFileCollectionRequest' is not null or undefined
1477
+ assertParamExists('createFileCollection', 'createFileCollectionRequest', createFileCollectionRequest);
1478
+ const localVarPath = `/file-collections`;
1479
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1480
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1481
+ let baseOptions;
1482
+ if (configuration) {
1483
+ baseOptions = configuration.baseOptions;
1484
+ }
1485
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1486
+ const localVarHeaderParameter = {};
1487
+ const localVarQueryParameter = {};
1488
+ // authentication OAuth2 required
1489
+ // oauth required
1490
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1491
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1492
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1493
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
1494
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1495
+ localVarRequestOptions.data = serializeDataIfNeeded(createFileCollectionRequest, localVarRequestOptions, configuration);
1496
+ return {
1497
+ url: toPathString(localVarUrlObj),
1498
+ options: localVarRequestOptions,
1499
+ };
1500
+ }),
1501
+ /**
1502
+ * Delete a `file-collection`.
1503
+ * @param {string} id The `file-collection` ID.
1504
+ * @param {*} [options] Override http request option.
1505
+ * @throws {RequiredError}
1506
+ */
1507
+ deleteFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1508
+ var _c;
1509
+ // verify required parameter 'id' is not null or undefined
1510
+ assertParamExists('deleteFileCollection', 'id', id);
1511
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1512
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1513
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1514
+ let baseOptions;
1515
+ if (configuration) {
1516
+ baseOptions = configuration.baseOptions;
1517
+ }
1518
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1519
+ const localVarHeaderParameter = {};
1520
+ const localVarQueryParameter = {};
1521
+ // authentication OAuth2 required
1522
+ // oauth required
1523
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1524
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1525
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
1526
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1527
+ return {
1528
+ url: toPathString(localVarUrlObj),
1529
+ options: localVarRequestOptions,
1530
+ };
1531
+ }),
1532
+ /**
1533
+ * Get a `file-collection` by ID.
1534
+ * @param {string} id The `file-collection` ID.
1535
+ * @param {*} [options] Override http request option.
1536
+ * @throws {RequiredError}
1537
+ */
1538
+ getFileCollection: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1539
+ var _d;
1540
+ // verify required parameter 'id' is not null or undefined
1541
+ assertParamExists('getFileCollection', 'id', id);
1542
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1543
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1544
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1545
+ let baseOptions;
1546
+ if (configuration) {
1547
+ baseOptions = configuration.baseOptions;
1548
+ }
1549
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1550
+ const localVarHeaderParameter = {};
1551
+ const localVarQueryParameter = {};
1552
+ // authentication OAuth2 required
1553
+ // oauth required
1554
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1555
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1556
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
1557
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1558
+ return {
1559
+ url: toPathString(localVarUrlObj),
1560
+ options: localVarRequestOptions,
1561
+ };
1562
+ }),
1563
+ /**
1564
+ * List the files in a `file-collection`.
1565
+ * @param {string} id The `file-collection` ID.
1566
+ * @param {string} [pageCursor] The cursor for the next page of items.
1567
+ * @param {number} [pageSize] The number of items to return.
1568
+ * @param {*} [options] Override http request option.
1569
+ * @throws {RequiredError}
1570
+ */
1571
+ listFileCollectionFiles: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
1572
+ var _e;
1573
+ // verify required parameter 'id' is not null or undefined
1574
+ assertParamExists('listFileCollectionFiles', 'id', id);
1575
+ const localVarPath = `/file-collections/{id}/files`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1576
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1577
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1578
+ let baseOptions;
1579
+ if (configuration) {
1580
+ baseOptions = configuration.baseOptions;
1581
+ }
1582
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1583
+ const localVarHeaderParameter = {};
1584
+ const localVarQueryParameter = {};
1585
+ // authentication OAuth2 required
1586
+ // oauth required
1587
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1588
+ if (pageCursor !== undefined) {
1589
+ localVarQueryParameter['page[cursor]'] = pageCursor;
1590
+ }
1591
+ if (pageSize !== undefined) {
1592
+ localVarQueryParameter['page[size]'] = pageSize;
1593
+ }
1594
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1595
+ let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
1596
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1597
+ return {
1598
+ url: toPathString(localVarUrlObj),
1599
+ options: localVarRequestOptions,
1600
+ };
1601
+ }),
1602
+ /**
1603
+ * List `file-collection`s by supplied ID.
1604
+ * @param {string} [pageCursor] The cursor for the next page of items.
1605
+ * @param {number} [pageSize] The number of items to return.
1606
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1607
+ * @param {*} [options] Override http request option.
1608
+ * @throws {RequiredError}
1609
+ */
1610
+ listFileCollections: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1611
+ var _f;
1612
+ const localVarPath = `/file-collections`;
1613
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1614
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1615
+ let baseOptions;
1616
+ if (configuration) {
1617
+ baseOptions = configuration.baseOptions;
1618
+ }
1619
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1620
+ const localVarHeaderParameter = {};
1621
+ const localVarQueryParameter = {};
1622
+ // authentication OAuth2 required
1623
+ // oauth required
1624
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1625
+ if (pageCursor !== undefined) {
1626
+ localVarQueryParameter['page[cursor]'] = pageCursor;
1627
+ }
1628
+ if (pageSize !== undefined) {
1629
+ localVarQueryParameter['page[size]'] = pageSize;
1630
+ }
1631
+ if (filterSuppliedId !== undefined) {
1632
+ localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
1633
+ }
1634
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1635
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
1636
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1637
+ return {
1638
+ url: toPathString(localVarUrlObj),
1639
+ options: localVarRequestOptions,
1640
+ };
1641
+ }),
1642
+ /**
1643
+ * Update a `file-collection`.
1644
+ * @param {string} id The `file-collection` ID.
1645
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1646
+ * @param {*} [options] Override http request option.
1647
+ * @throws {RequiredError}
1648
+ */
1649
+ updateFileCollection: (id, updateFileCollectionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1650
+ var _g;
1651
+ // verify required parameter 'id' is not null or undefined
1652
+ assertParamExists('updateFileCollection', 'id', id);
1653
+ // verify required parameter 'updateFileCollectionRequest' is not null or undefined
1654
+ assertParamExists('updateFileCollection', 'updateFileCollectionRequest', updateFileCollectionRequest);
1655
+ const localVarPath = `/file-collections/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1656
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1657
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1658
+ let baseOptions;
1659
+ if (configuration) {
1660
+ baseOptions = configuration.baseOptions;
1661
+ }
1662
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
1663
+ const localVarHeaderParameter = {};
1664
+ const localVarQueryParameter = {};
1665
+ // authentication OAuth2 required
1666
+ // oauth required
1667
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1668
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1669
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1670
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1671
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1672
+ localVarRequestOptions.data = serializeDataIfNeeded(updateFileCollectionRequest, localVarRequestOptions, configuration);
1673
+ return {
1674
+ url: toPathString(localVarUrlObj),
1675
+ options: localVarRequestOptions,
1676
+ };
1677
+ }),
1678
+ };
1679
+ };
1680
+ /**
1681
+ * FileCollectionsApi - functional programming interface
1682
+ * @export
1683
+ */
1684
+ export const FileCollectionsApiFp = function (configuration) {
1685
+ const localVarAxiosParamCreator = FileCollectionsApiAxiosParamCreator(configuration);
1686
+ return {
1687
+ /**
1688
+ * Add files to a `file-collection`.
1689
+ * @param {string} id The `file-collection` ID.
1690
+ * @param {FileIdList} fileIdList
1691
+ * @param {*} [options] Override http request option.
1692
+ * @throws {RequiredError}
1693
+ */
1694
+ addFileCollectionFiles(id, fileIdList, options) {
1695
+ return __awaiter(this, void 0, void 0, function* () {
1696
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.addFileCollectionFiles(id, fileIdList, options);
1697
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1698
+ });
1699
+ },
1700
+ /**
1701
+ * Create a `file-collection`.
1702
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1703
+ * @param {*} [options] Override http request option.
1704
+ * @throws {RequiredError}
1705
+ */
1706
+ createFileCollection(createFileCollectionRequest, options) {
1707
+ return __awaiter(this, void 0, void 0, function* () {
1708
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createFileCollection(createFileCollectionRequest, options);
1709
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1710
+ });
1711
+ },
1712
+ /**
1713
+ * Delete a `file-collection`.
1714
+ * @param {string} id The `file-collection` ID.
1715
+ * @param {*} [options] Override http request option.
1716
+ * @throws {RequiredError}
1717
+ */
1718
+ deleteFileCollection(id, options) {
1719
+ return __awaiter(this, void 0, void 0, function* () {
1720
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFileCollection(id, options);
1721
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1722
+ });
1723
+ },
1724
+ /**
1725
+ * Get a `file-collection` by ID.
1726
+ * @param {string} id The `file-collection` ID.
1727
+ * @param {*} [options] Override http request option.
1728
+ * @throws {RequiredError}
1729
+ */
1730
+ getFileCollection(id, options) {
1731
+ return __awaiter(this, void 0, void 0, function* () {
1732
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFileCollection(id, options);
1733
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1734
+ });
1735
+ },
1736
+ /**
1737
+ * List the files in a `file-collection`.
1738
+ * @param {string} id The `file-collection` ID.
1739
+ * @param {string} [pageCursor] The cursor for the next page of items.
1740
+ * @param {number} [pageSize] The number of items to return.
1741
+ * @param {*} [options] Override http request option.
1742
+ * @throws {RequiredError}
1743
+ */
1744
+ listFileCollectionFiles(id, pageCursor, pageSize, options) {
1745
+ return __awaiter(this, void 0, void 0, function* () {
1746
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollectionFiles(id, pageCursor, pageSize, options);
1747
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1748
+ });
1749
+ },
1750
+ /**
1751
+ * List `file-collection`s by supplied ID.
1752
+ * @param {string} [pageCursor] The cursor for the next page of items.
1753
+ * @param {number} [pageSize] The number of items to return.
1754
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1755
+ * @param {*} [options] Override http request option.
1756
+ * @throws {RequiredError}
1757
+ */
1758
+ listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
1759
+ return __awaiter(this, void 0, void 0, function* () {
1760
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listFileCollections(pageCursor, pageSize, filterSuppliedId, options);
1761
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1762
+ });
1763
+ },
1764
+ /**
1765
+ * Update a `file-collection`.
1766
+ * @param {string} id The `file-collection` ID.
1767
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1768
+ * @param {*} [options] Override http request option.
1769
+ * @throws {RequiredError}
1770
+ */
1771
+ updateFileCollection(id, updateFileCollectionRequest, options) {
1772
+ return __awaiter(this, void 0, void 0, function* () {
1773
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFileCollection(id, updateFileCollectionRequest, options);
1774
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1775
+ });
1776
+ },
1777
+ };
1778
+ };
1779
+ /**
1780
+ * FileCollectionsApi - factory interface
1781
+ * @export
1782
+ */
1783
+ export const FileCollectionsApiFactory = function (configuration, basePath, axios) {
1784
+ const localVarFp = FileCollectionsApiFp(configuration);
1785
+ return {
1786
+ /**
1787
+ * Add files to a `file-collection`.
1788
+ * @param {string} id The `file-collection` ID.
1789
+ * @param {FileIdList} fileIdList
1790
+ * @param {*} [options] Override http request option.
1791
+ * @throws {RequiredError}
1792
+ */
1793
+ addFileCollectionFiles(id, fileIdList, options) {
1794
+ return localVarFp
1795
+ .addFileCollectionFiles(id, fileIdList, options)
1796
+ .then((request) => request(axios, basePath));
1797
+ },
1798
+ /**
1799
+ * Create a `file-collection`.
1800
+ * @param {CreateFileCollectionRequest} createFileCollectionRequest
1801
+ * @param {*} [options] Override http request option.
1802
+ * @throws {RequiredError}
1803
+ */
1804
+ createFileCollection(createFileCollectionRequest, options) {
1805
+ return localVarFp
1806
+ .createFileCollection(createFileCollectionRequest, options)
1807
+ .then((request) => request(axios, basePath));
1808
+ },
1809
+ /**
1810
+ * Delete a `file-collection`.
1811
+ * @param {string} id The `file-collection` ID.
1812
+ * @param {*} [options] Override http request option.
1813
+ * @throws {RequiredError}
1814
+ */
1815
+ deleteFileCollection(id, options) {
1816
+ return localVarFp
1817
+ .deleteFileCollection(id, options)
1818
+ .then((request) => request(axios, basePath));
1819
+ },
1820
+ /**
1821
+ * Get a `file-collection` by ID.
1822
+ * @param {string} id The `file-collection` ID.
1823
+ * @param {*} [options] Override http request option.
1824
+ * @throws {RequiredError}
1825
+ */
1826
+ getFileCollection(id, options) {
1827
+ return localVarFp
1828
+ .getFileCollection(id, options)
1829
+ .then((request) => request(axios, basePath));
1830
+ },
1831
+ /**
1832
+ * List the files in a `file-collection`.
1833
+ * @param {string} id The `file-collection` ID.
1834
+ * @param {string} [pageCursor] The cursor for the next page of items.
1835
+ * @param {number} [pageSize] The number of items to return.
1836
+ * @param {*} [options] Override http request option.
1837
+ * @throws {RequiredError}
1838
+ */
1839
+ listFileCollectionFiles(id, pageCursor, pageSize, options) {
1840
+ return localVarFp
1841
+ .listFileCollectionFiles(id, pageCursor, pageSize, options)
1842
+ .then((request) => request(axios, basePath));
1843
+ },
1844
+ /**
1845
+ * List `file-collection`s by supplied ID.
1846
+ * @param {string} [pageCursor] The cursor for the next page of items.
1847
+ * @param {number} [pageSize] The number of items to return.
1848
+ * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
1849
+ * @param {*} [options] Override http request option.
1850
+ * @throws {RequiredError}
1851
+ */
1852
+ listFileCollections(pageCursor, pageSize, filterSuppliedId, options) {
1853
+ return localVarFp
1854
+ .listFileCollections(pageCursor, pageSize, filterSuppliedId, options)
1855
+ .then((request) => request(axios, basePath));
1856
+ },
1857
+ /**
1858
+ * Update a `file-collection`.
1859
+ * @param {string} id The `file-collection` ID.
1860
+ * @param {UpdateFileCollectionRequest} updateFileCollectionRequest
1861
+ * @param {*} [options] Override http request option.
1862
+ * @throws {RequiredError}
1863
+ */
1864
+ updateFileCollection(id, updateFileCollectionRequest, options) {
1865
+ return localVarFp
1866
+ .updateFileCollection(id, updateFileCollectionRequest, options)
1867
+ .then((request) => request(axios, basePath));
1868
+ },
1869
+ };
1870
+ };
1871
+ /**
1872
+ * FileCollectionsApi - object-oriented interface
1873
+ * @export
1874
+ * @class FileCollectionsApi
1875
+ * @extends {BaseAPI}
1876
+ */
1877
+ export class FileCollectionsApi extends BaseAPI {
1878
+ /**
1879
+ * Add files to a `file-collection`.
1880
+ * @param {FileCollectionsApiAddFileCollectionFilesRequest} requestParameters Request parameters.
1881
+ * @param {*} [options] Override http request option.
1882
+ * @throws {RequiredError}
1883
+ * @memberof FileCollectionsApi
1884
+ */
1885
+ addFileCollectionFiles(requestParameters, options) {
1886
+ return FileCollectionsApiFp(this.configuration)
1887
+ .addFileCollectionFiles(requestParameters.id, requestParameters.fileIdList, options)
1888
+ .then((request) => request(this.axios, this.basePath));
1889
+ }
1890
+ /**
1891
+ * Create a `file-collection`.
1892
+ * @param {FileCollectionsApiCreateFileCollectionRequest} requestParameters Request parameters.
1893
+ * @param {*} [options] Override http request option.
1894
+ * @throws {RequiredError}
1895
+ * @memberof FileCollectionsApi
1896
+ */
1897
+ createFileCollection(requestParameters, options) {
1898
+ return FileCollectionsApiFp(this.configuration)
1899
+ .createFileCollection(requestParameters.createFileCollectionRequest, options)
1900
+ .then((request) => request(this.axios, this.basePath));
1901
+ }
1902
+ /**
1903
+ * Delete a `file-collection`.
1904
+ * @param {FileCollectionsApiDeleteFileCollectionRequest} requestParameters Request parameters.
1905
+ * @param {*} [options] Override http request option.
1906
+ * @throws {RequiredError}
1907
+ * @memberof FileCollectionsApi
1908
+ */
1909
+ deleteFileCollection(requestParameters, options) {
1910
+ return FileCollectionsApiFp(this.configuration)
1911
+ .deleteFileCollection(requestParameters.id, options)
1912
+ .then((request) => request(this.axios, this.basePath));
1913
+ }
1914
+ /**
1915
+ * Get a `file-collection` by ID.
1916
+ * @param {FileCollectionsApiGetFileCollectionRequest} requestParameters Request parameters.
1917
+ * @param {*} [options] Override http request option.
1918
+ * @throws {RequiredError}
1919
+ * @memberof FileCollectionsApi
1920
+ */
1921
+ getFileCollection(requestParameters, options) {
1922
+ return FileCollectionsApiFp(this.configuration)
1923
+ .getFileCollection(requestParameters.id, options)
1924
+ .then((request) => request(this.axios, this.basePath));
1925
+ }
1926
+ /**
1927
+ * List the files in a `file-collection`.
1928
+ * @param {FileCollectionsApiListFileCollectionFilesRequest} requestParameters Request parameters.
1929
+ * @param {*} [options] Override http request option.
1930
+ * @throws {RequiredError}
1931
+ * @memberof FileCollectionsApi
1932
+ */
1933
+ listFileCollectionFiles(requestParameters, options) {
1934
+ return FileCollectionsApiFp(this.configuration)
1935
+ .listFileCollectionFiles(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
1936
+ .then((request) => request(this.axios, this.basePath));
1937
+ }
1938
+ /**
1939
+ * List `file-collection`s by supplied ID.
1940
+ * @param {FileCollectionsApiListFileCollectionsRequest} requestParameters Request parameters.
1941
+ * @param {*} [options] Override http request option.
1942
+ * @throws {RequiredError}
1943
+ * @memberof FileCollectionsApi
1944
+ */
1945
+ listFileCollections(requestParameters = {}, options) {
1946
+ return FileCollectionsApiFp(this.configuration)
1947
+ .listFileCollections(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
1948
+ .then((request) => request(this.axios, this.basePath));
1949
+ }
1950
+ /**
1951
+ * Update a `file-collection`.
1952
+ * @param {FileCollectionsApiUpdateFileCollectionRequest} requestParameters Request parameters.
1953
+ * @param {*} [options] Override http request option.
1954
+ * @throws {RequiredError}
1955
+ * @memberof FileCollectionsApi
1956
+ */
1957
+ updateFileCollection(requestParameters, options) {
1958
+ return FileCollectionsApiFp(this.configuration)
1959
+ .updateFileCollection(requestParameters.id, requestParameters.updateFileCollectionRequest, options)
1960
+ .then((request) => request(this.axios, this.basePath));
1961
+ }
1962
+ }
1414
1963
  /**
1415
1964
  * FilesApi - axios parameter creator
1416
1965
  * @export
1417
1966
  */
1418
1967
  export const FilesApiAxiosParamCreator = function (configuration) {
1419
1968
  return {
1969
+ /**
1970
+ * Create a download uri for a `file` by ID.
1971
+ * @param {string} id The `file` ID.
1972
+ * @param {CreateDownloadRequest} createDownloadRequest
1973
+ * @param {*} [options] Override http request option.
1974
+ * @throws {RequiredError}
1975
+ */
1976
+ createDownloadUrl: (id, createDownloadRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1977
+ var _a;
1978
+ // verify required parameter 'id' is not null or undefined
1979
+ assertParamExists('createDownloadUrl', 'id', id);
1980
+ // verify required parameter 'createDownloadRequest' is not null or undefined
1981
+ assertParamExists('createDownloadUrl', 'createDownloadRequest', createDownloadRequest);
1982
+ const localVarPath = `/files/{id}/download-url`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1983
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1984
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1985
+ let baseOptions;
1986
+ if (configuration) {
1987
+ baseOptions = configuration.baseOptions;
1988
+ }
1989
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1990
+ const localVarHeaderParameter = {};
1991
+ const localVarQueryParameter = {};
1992
+ // authentication OAuth2 required
1993
+ // oauth required
1994
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1995
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1996
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1997
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
1998
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1999
+ localVarRequestOptions.data = serializeDataIfNeeded(createDownloadRequest, localVarRequestOptions, configuration);
2000
+ return {
2001
+ url: toPathString(localVarUrlObj),
2002
+ options: localVarRequestOptions,
2003
+ };
2004
+ }),
1420
2005
  /**
1421
2006
  * 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.
1422
2007
  * @param {CreateFileRequest} createFileRequest
@@ -1424,7 +2009,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1424
2009
  * @throws {RequiredError}
1425
2010
  */
1426
2011
  createFile: (createFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1427
- var _a;
2012
+ var _b;
1428
2013
  // verify required parameter 'createFileRequest' is not null or undefined
1429
2014
  assertParamExists('createFile', 'createFileRequest', createFileRequest);
1430
2015
  const localVarPath = `/files`;
@@ -1442,7 +2027,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1442
2027
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1443
2028
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1444
2029
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1445
- let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
2030
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
1446
2031
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1447
2032
  localVarRequestOptions.data = serializeDataIfNeeded(createFileRequest, localVarRequestOptions, configuration);
1448
2033
  return {
@@ -1457,7 +2042,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1457
2042
  * @throws {RequiredError}
1458
2043
  */
1459
2044
  deleteFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1460
- var _b;
2045
+ var _c;
1461
2046
  // verify required parameter 'id' is not null or undefined
1462
2047
  assertParamExists('deleteFile', 'id', id);
1463
2048
  const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -1474,7 +2059,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1474
2059
  // oauth required
1475
2060
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1476
2061
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1477
- let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
2062
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
1478
2063
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1479
2064
  return {
1480
2065
  url: toPathString(localVarUrlObj),
@@ -1488,7 +2073,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1488
2073
  * @throws {RequiredError}
1489
2074
  */
1490
2075
  getFile: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1491
- var _c;
2076
+ var _d;
1492
2077
  // verify required parameter 'id' is not null or undefined
1493
2078
  assertParamExists('getFile', 'id', id);
1494
2079
  const localVarPath = `/files/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
@@ -1505,7 +2090,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1505
2090
  // oauth required
1506
2091
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1507
2092
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1508
- let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
2093
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
1509
2094
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1510
2095
  return {
1511
2096
  url: toPathString(localVarUrlObj),
@@ -1521,7 +2106,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1521
2106
  * @throws {RequiredError}
1522
2107
  */
1523
2108
  getFiles: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1524
- var _d;
2109
+ var _e;
1525
2110
  const localVarPath = `/files`;
1526
2111
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1527
2112
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1545,7 +2130,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1545
2130
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
1546
2131
  }
1547
2132
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1548
- let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
2133
+ let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
1549
2134
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1550
2135
  return {
1551
2136
  url: toPathString(localVarUrlObj),
@@ -1560,7 +2145,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1560
2145
  * @throws {RequiredError}
1561
2146
  */
1562
2147
  updateFile: (id, updateFileRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1563
- var _e;
2148
+ var _f;
1564
2149
  // verify required parameter 'id' is not null or undefined
1565
2150
  assertParamExists('updateFile', 'id', id);
1566
2151
  // verify required parameter 'updateFileRequest' is not null or undefined
@@ -1580,7 +2165,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1580
2165
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1581
2166
  localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1582
2167
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1583
- let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
2168
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
1584
2169
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1585
2170
  localVarRequestOptions.data = serializeDataIfNeeded(updateFileRequest, localVarRequestOptions, configuration);
1586
2171
  return {
@@ -1596,7 +2181,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1596
2181
  * @throws {RequiredError}
1597
2182
  */
1598
2183
  uploadFile: (id, body, options = {}) => __awaiter(this, void 0, void 0, function* () {
1599
- var _f;
2184
+ var _g;
1600
2185
  // verify required parameter 'id' is not null or undefined
1601
2186
  assertParamExists('uploadFile', 'id', id);
1602
2187
  // verify required parameter 'body' is not null or undefined
@@ -1616,7 +2201,7 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1616
2201
  yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
1617
2202
  localVarHeaderParameter['Content-Type'] = 'application/octet-stream';
1618
2203
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1619
- let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
2204
+ let headersFromBaseOptions = (_g = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _g !== void 0 ? _g : {};
1620
2205
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1621
2206
  localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
1622
2207
  return {
@@ -1633,6 +2218,19 @@ export const FilesApiAxiosParamCreator = function (configuration) {
1633
2218
  export const FilesApiFp = function (configuration) {
1634
2219
  const localVarAxiosParamCreator = FilesApiAxiosParamCreator(configuration);
1635
2220
  return {
2221
+ /**
2222
+ * Create a download uri for a `file` by ID.
2223
+ * @param {string} id The `file` ID.
2224
+ * @param {CreateDownloadRequest} createDownloadRequest
2225
+ * @param {*} [options] Override http request option.
2226
+ * @throws {RequiredError}
2227
+ */
2228
+ createDownloadUrl(id, createDownloadRequest, options) {
2229
+ return __awaiter(this, void 0, void 0, function* () {
2230
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createDownloadUrl(id, createDownloadRequest, options);
2231
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2232
+ });
2233
+ },
1636
2234
  /**
1637
2235
  * 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.
1638
2236
  * @param {CreateFileRequest} createFileRequest
@@ -1718,6 +2316,18 @@ export const FilesApiFp = function (configuration) {
1718
2316
  export const FilesApiFactory = function (configuration, basePath, axios) {
1719
2317
  const localVarFp = FilesApiFp(configuration);
1720
2318
  return {
2319
+ /**
2320
+ * Create a download uri for a `file` by ID.
2321
+ * @param {string} id The `file` ID.
2322
+ * @param {CreateDownloadRequest} createDownloadRequest
2323
+ * @param {*} [options] Override http request option.
2324
+ * @throws {RequiredError}
2325
+ */
2326
+ createDownloadUrl(id, createDownloadRequest, options) {
2327
+ return localVarFp
2328
+ .createDownloadUrl(id, createDownloadRequest, options)
2329
+ .then((request) => request(axios, basePath));
2330
+ },
1721
2331
  /**
1722
2332
  * 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.
1723
2333
  * @param {CreateFileRequest} createFileRequest
@@ -1797,6 +2407,18 @@ export const FilesApiFactory = function (configuration, basePath, axios) {
1797
2407
  * @extends {BaseAPI}
1798
2408
  */
1799
2409
  export class FilesApi extends BaseAPI {
2410
+ /**
2411
+ * Create a download uri for a `file` by ID.
2412
+ * @param {FilesApiCreateDownloadUrlRequest} requestParameters Request parameters.
2413
+ * @param {*} [options] Override http request option.
2414
+ * @throws {RequiredError}
2415
+ * @memberof FilesApi
2416
+ */
2417
+ createDownloadUrl(requestParameters, options) {
2418
+ return FilesApiFp(this.configuration)
2419
+ .createDownloadUrl(requestParameters.id, requestParameters.createDownloadRequest, options)
2420
+ .then((request) => request(this.axios, this.basePath));
2421
+ }
1800
2422
  /**
1801
2423
  * Create a `file`. Once created, upload file content via the uploadFile API. For details including supported file formats, see our [Import data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guide.
1802
2424
  * @param {FilesApiCreateFileRequest} requestParameters Request parameters.