@vertexvis/api-client-node 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api.d.ts CHANGED
@@ -511,6 +511,13 @@ export interface BoundingBox {
511
511
  */
512
512
  max: Vector3;
513
513
  }
514
+ /**
515
+ * Describes the options for configuring a CAD file export.
516
+ * @export
517
+ * @interface CADExportConfig
518
+ */
519
+ export interface CADExportConfig extends ExportConfig {
520
+ }
514
521
  /**
515
522
  * Fit camera in 3D space based on items in scene.
516
523
  * @export
@@ -814,6 +821,70 @@ export interface CreateBatchRequest {
814
821
  */
815
822
  'vertexvis/batch:operations': Array<BatchOperation>;
816
823
  }
824
+ /**
825
+ *
826
+ * @export
827
+ * @interface CreateExportRequest
828
+ */
829
+ export interface CreateExportRequest {
830
+ /**
831
+ *
832
+ * @type {CreateExportRequestData}
833
+ * @memberof CreateExportRequest
834
+ */
835
+ data: CreateExportRequestData;
836
+ }
837
+ /**
838
+ *
839
+ * @export
840
+ * @interface CreateExportRequestData
841
+ */
842
+ export interface CreateExportRequestData {
843
+ /**
844
+ * Resource object type.
845
+ * @type {string}
846
+ * @memberof CreateExportRequestData
847
+ */
848
+ type: string;
849
+ /**
850
+ *
851
+ * @type {CreateExportRequestDataAttributes}
852
+ * @memberof CreateExportRequestData
853
+ */
854
+ attributes: CreateExportRequestDataAttributes;
855
+ /**
856
+ *
857
+ * @type {CreateExportRequestDataRelationships}
858
+ * @memberof CreateExportRequestData
859
+ */
860
+ relationships: CreateExportRequestDataRelationships;
861
+ }
862
+ /**
863
+ *
864
+ * @export
865
+ * @interface CreateExportRequestDataAttributes
866
+ */
867
+ export interface CreateExportRequestDataAttributes {
868
+ /**
869
+ * Specifies the export format and options to configure the export.
870
+ * @type {CADExportConfig}
871
+ * @memberof CreateExportRequestDataAttributes
872
+ */
873
+ config: CADExportConfig;
874
+ }
875
+ /**
876
+ *
877
+ * @export
878
+ * @interface CreateExportRequestDataRelationships
879
+ */
880
+ export interface CreateExportRequestDataRelationships {
881
+ /**
882
+ *
883
+ * @type {ExportRelationship}
884
+ * @memberof CreateExportRequestDataRelationships
885
+ */
886
+ source: ExportRelationship;
887
+ }
817
888
  /**
818
889
  *
819
890
  * @export
@@ -1779,6 +1850,128 @@ export interface Dimensions {
1779
1850
  */
1780
1851
  width: number;
1781
1852
  }
1853
+ /**
1854
+ *
1855
+ * @export
1856
+ * @interface Export
1857
+ */
1858
+ export interface Export {
1859
+ /**
1860
+ *
1861
+ * @type {ExportData}
1862
+ * @memberof Export
1863
+ */
1864
+ data: ExportData;
1865
+ /**
1866
+ *
1867
+ * @type {{ [key: string]: Link; }}
1868
+ * @memberof Export
1869
+ */
1870
+ links?: {
1871
+ [key: string]: Link;
1872
+ };
1873
+ }
1874
+ /**
1875
+ * Describes the options for configuring a file export.
1876
+ * @export
1877
+ * @interface ExportConfig
1878
+ */
1879
+ export interface ExportConfig {
1880
+ /**
1881
+ *
1882
+ * @type {string}
1883
+ * @memberof ExportConfig
1884
+ */
1885
+ format: string;
1886
+ }
1887
+ /**
1888
+ *
1889
+ * @export
1890
+ * @interface ExportData
1891
+ */
1892
+ export interface ExportData {
1893
+ /**
1894
+ *
1895
+ * @type {string}
1896
+ * @memberof ExportData
1897
+ */
1898
+ type: string;
1899
+ /**
1900
+ * ID of the resource.
1901
+ * @type {string}
1902
+ * @memberof ExportData
1903
+ */
1904
+ id: string;
1905
+ /**
1906
+ *
1907
+ * @type {ExportDataAttributes}
1908
+ * @memberof ExportData
1909
+ */
1910
+ attributes: ExportDataAttributes;
1911
+ /**
1912
+ *
1913
+ * @type {{ [key: string]: Link; }}
1914
+ * @memberof ExportData
1915
+ */
1916
+ links?: {
1917
+ [key: string]: Link;
1918
+ };
1919
+ }
1920
+ /**
1921
+ *
1922
+ * @export
1923
+ * @interface ExportDataAttributes
1924
+ */
1925
+ export interface ExportDataAttributes {
1926
+ /**
1927
+ *
1928
+ * @type {string}
1929
+ * @memberof ExportDataAttributes
1930
+ */
1931
+ created: string;
1932
+ /**
1933
+ *
1934
+ * @type {string}
1935
+ * @memberof ExportDataAttributes
1936
+ */
1937
+ downloadUrl: string;
1938
+ }
1939
+ /**
1940
+ * Relationship to an `export`.
1941
+ * @export
1942
+ * @interface ExportRelationship
1943
+ */
1944
+ export interface ExportRelationship {
1945
+ /**
1946
+ *
1947
+ * @type {ExportRelationshipData}
1948
+ * @memberof ExportRelationship
1949
+ */
1950
+ data: ExportRelationshipData;
1951
+ }
1952
+ /**
1953
+ *
1954
+ * @export
1955
+ * @interface ExportRelationshipData
1956
+ */
1957
+ export interface ExportRelationshipData {
1958
+ /**
1959
+ * Resource object type.
1960
+ * @type {string}
1961
+ * @memberof ExportRelationshipData
1962
+ */
1963
+ type: ExportRelationshipDataTypeEnum;
1964
+ /**
1965
+ * ID of the resource.
1966
+ * @type {string}
1967
+ * @memberof ExportRelationshipData
1968
+ */
1969
+ id: string;
1970
+ }
1971
+ export declare const ExportRelationshipDataTypeEnum: {
1972
+ readonly Scene: "scene";
1973
+ };
1974
+ export declare type ExportRelationshipDataTypeEnum = typeof ExportRelationshipDataTypeEnum[keyof typeof ExportRelationshipDataTypeEnum];
1782
1975
  /**
1783
1976
  *
1784
1977
  * @export
@@ -5860,6 +6053,158 @@ export declare class BatchesApi extends BaseAPI {
5860
6053
  */
5861
6054
  getQueuedBatch(requestParameters: BatchesApiGetQueuedBatchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
5862
6055
  }
6056
+ /**
6057
+ * ExportsApi - axios parameter creator
6058
+ * @export
6059
+ */
6060
+ export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
6061
+ /**
6062
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
6063
+ * @param {CreateExportRequest} createExportRequest
6064
+ * @param {*} [options] Override http request option.
6065
+ * @throws {RequiredError}
6066
+ */
6067
+ createExport: (createExportRequest: CreateExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6068
+ /**
6069
+ * Get an `export` by ID.
6070
+ * @param {string} id The &#x60;export&#x60; ID.
6071
+ * @param {*} [options] Override http request option.
6072
+ * @throws {RequiredError}
6073
+ */
6074
+ getExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6075
+ /**
6076
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
6077
+ * @param {string} id The &#x60;queued-export&#x60; ID.
6078
+ * @param {*} [options] Override http request option.
6079
+ * @throws {RequiredError}
6080
+ */
6081
+ getQueuedExport: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6082
+ };
6083
+ /**
6084
+ * ExportsApi - functional programming interface
6085
+ * @export
6086
+ */
6087
+ export declare const ExportsApiFp: (configuration?: Configuration | undefined) => {
6088
+ /**
6089
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
6090
+ * @param {CreateExportRequest} createExportRequest
6091
+ * @param {*} [options] Override http request option.
6092
+ * @throws {RequiredError}
6093
+ */
6094
+ createExport(createExportRequest: CreateExportRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
6095
+ /**
6096
+ * Get an `export` by ID.
6097
+ * @param {string} id The &#x60;export&#x60; ID.
6098
+ * @param {*} [options] Override http request option.
6099
+ * @throws {RequiredError}
6100
+ */
6101
+ getExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Export>>;
6102
+ /**
6103
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
6104
+ * @param {string} id The &#x60;queued-export&#x60; ID.
6105
+ * @param {*} [options] Override http request option.
6106
+ * @throws {RequiredError}
6107
+ */
6108
+ getQueuedExport(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
6109
+ };
6110
+ /**
6111
+ * ExportsApi - factory interface
6112
+ * @export
6113
+ */
6114
+ export declare const ExportsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
6115
+ /**
6116
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
6117
+ * @param {CreateExportRequest} createExportRequest
6118
+ * @param {*} [options] Override http request option.
6119
+ * @throws {RequiredError}
6120
+ */
6121
+ createExport(createExportRequest: CreateExportRequest, options?: any): AxiosPromise<QueuedJob>;
6122
+ /**
6123
+ * Get an `export` by ID.
6124
+ * @param {string} id The &#x60;export&#x60; ID.
6125
+ * @param {*} [options] Override http request option.
6126
+ * @throws {RequiredError}
6127
+ */
6128
+ getExport(id: string, options?: any): AxiosPromise<Export>;
6129
+ /**
6130
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
6131
+ * @param {string} id The &#x60;queued-export&#x60; ID.
6132
+ * @param {*} [options] Override http request option.
6133
+ * @throws {RequiredError}
6134
+ */
6135
+ getQueuedExport(id: string, options?: any): AxiosPromise<QueuedJob>;
6136
+ };
6137
+ /**
6138
+ * Request parameters for createExport operation in ExportsApi.
6139
+ * @export
6140
+ * @interface ExportsApiCreateExportRequest
6141
+ */
6142
+ export interface ExportsApiCreateExportRequest {
6143
+ /**
6144
+ *
6145
+ * @type {CreateExportRequest}
6146
+ * @memberof ExportsApiCreateExport
6147
+ */
6148
+ readonly createExportRequest: CreateExportRequest;
6149
+ }
6150
+ /**
6151
+ * Request parameters for getExport operation in ExportsApi.
6152
+ * @export
6153
+ * @interface ExportsApiGetExportRequest
6154
+ */
6155
+ export interface ExportsApiGetExportRequest {
6156
+ /**
6157
+ * The &#x60;export&#x60; ID.
6158
+ * @type {string}
6159
+ * @memberof ExportsApiGetExport
6160
+ */
6161
+ readonly id: string;
6162
+ }
6163
+ /**
6164
+ * Request parameters for getQueuedExport operation in ExportsApi.
6165
+ * @export
6166
+ * @interface ExportsApiGetQueuedExportRequest
6167
+ */
6168
+ export interface ExportsApiGetQueuedExportRequest {
6169
+ /**
6170
+ * The &#x60;queued-export&#x60; ID.
6171
+ * @type {string}
6172
+ * @memberof ExportsApiGetQueuedExport
6173
+ */
6174
+ readonly id: string;
6175
+ }
6176
+ /**
6177
+ * ExportsApi - object-oriented interface
6178
+ * @export
6179
+ * @class ExportsApi
6180
+ * @extends {BaseAPI}
6181
+ */
6182
+ export declare class ExportsApi extends BaseAPI {
6183
+ /**
6184
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
6185
+ * @param {ExportsApiCreateExportRequest} requestParameters Request parameters.
6186
+ * @param {*} [options] Override http request option.
6187
+ * @throws {RequiredError}
6188
+ * @memberof ExportsApi
6189
+ */
6190
+ createExport(requestParameters: ExportsApiCreateExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
6191
+ /**
6192
+ * Get an `export` by ID.
6193
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
6194
+ * @param {*} [options] Override http request option.
6195
+ * @throws {RequiredError}
6196
+ * @memberof ExportsApi
6197
+ */
6198
+ getExport(requestParameters: ExportsApiGetExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Export, any>>;
6199
+ /**
6200
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
6201
+ * @param {ExportsApiGetQueuedExportRequest} requestParameters Request parameters.
6202
+ * @param {*} [options] Override http request option.
6203
+ * @throws {RequiredError}
6204
+ * @memberof ExportsApi
6205
+ */
6206
+ getQueuedExport(requestParameters: ExportsApiGetQueuedExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
6207
+ }
5863
6208
  /**
5864
6209
  * FilesApi - axios parameter creator
5865
6210
  * @export
package/dist/cjs/api.js CHANGED
@@ -25,9 +25,9 @@ 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.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOperationTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.MetadataValueTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOperationTypeEnum = exports.ClearMaterialOperationTypeEnum = exports.ChangeVisibilityOperationTypeEnum = exports.ChangeTransformOperationTypeEnum = exports.ChangeMaterialOperationTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
- 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.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = void 0;
30
- exports.WebhookSubscriptionsApi = void 0;
28
+ 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 = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOperationTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.MetadataValueTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOperationTypeEnum = exports.ClearMaterialOperationTypeEnum = exports.ChangeVisibilityOperationTypeEnum = exports.ChangeTransformOperationTypeEnum = exports.ChangeMaterialOperationTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
+ 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.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = void 0;
30
+ exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = void 0;
31
31
  const axios_1 = __importDefault(require("axios"));
32
32
  // Some imports not used depending on template conditions
33
33
  // @ts-ignore
@@ -62,6 +62,9 @@ exports.ClearTransformOperationTypeEnum = {
62
62
  exports.DeselectOperationTypeEnum = {
63
63
  Deselect: 'deselect',
64
64
  };
65
+ exports.ExportRelationshipDataTypeEnum = {
66
+ Scene: 'scene',
67
+ };
65
68
  exports.FileRelationshipDataTypeEnum = {
66
69
  File: 'file',
67
70
  };
@@ -1130,6 +1133,241 @@ class BatchesApi extends base_1.BaseAPI {
1130
1133
  }
1131
1134
  }
1132
1135
  exports.BatchesApi = BatchesApi;
1136
+ /**
1137
+ * ExportsApi - axios parameter creator
1138
+ * @export
1139
+ */
1140
+ const ExportsApiAxiosParamCreator = function (configuration) {
1141
+ return {
1142
+ /**
1143
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
1144
+ * @param {CreateExportRequest} createExportRequest
1145
+ * @param {*} [options] Override http request option.
1146
+ * @throws {RequiredError}
1147
+ */
1148
+ createExport: (createExportRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
1149
+ // verify required parameter 'createExportRequest' is not null or undefined
1150
+ (0, common_1.assertParamExists)('createExport', 'createExportRequest', createExportRequest);
1151
+ const localVarPath = `/exports`;
1152
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1153
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1154
+ let baseOptions;
1155
+ if (configuration) {
1156
+ baseOptions = configuration.baseOptions;
1157
+ }
1158
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1159
+ const localVarHeaderParameter = {};
1160
+ const localVarQueryParameter = {};
1161
+ // authentication OAuth2 required
1162
+ // oauth required
1163
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1164
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
1165
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1166
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1167
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1168
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createExportRequest, localVarRequestOptions, configuration);
1169
+ return {
1170
+ url: (0, common_1.toPathString)(localVarUrlObj),
1171
+ options: localVarRequestOptions,
1172
+ };
1173
+ }),
1174
+ /**
1175
+ * Get an `export` by ID.
1176
+ * @param {string} id The &#x60;export&#x60; ID.
1177
+ * @param {*} [options] Override http request option.
1178
+ * @throws {RequiredError}
1179
+ */
1180
+ getExport: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1181
+ // verify required parameter 'id' is not null or undefined
1182
+ (0, common_1.assertParamExists)('getExport', 'id', id);
1183
+ const localVarPath = `/exports/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1184
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1185
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1186
+ let baseOptions;
1187
+ if (configuration) {
1188
+ baseOptions = configuration.baseOptions;
1189
+ }
1190
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1191
+ const localVarHeaderParameter = {};
1192
+ const localVarQueryParameter = {};
1193
+ // authentication OAuth2 required
1194
+ // oauth required
1195
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1196
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1197
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1198
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1199
+ return {
1200
+ url: (0, common_1.toPathString)(localVarUrlObj),
1201
+ options: localVarRequestOptions,
1202
+ };
1203
+ }),
1204
+ /**
1205
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
1206
+ * @param {string} id The &#x60;queued-export&#x60; ID.
1207
+ * @param {*} [options] Override http request option.
1208
+ * @throws {RequiredError}
1209
+ */
1210
+ getQueuedExport: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1211
+ // verify required parameter 'id' is not null or undefined
1212
+ (0, common_1.assertParamExists)('getQueuedExport', 'id', id);
1213
+ const localVarPath = `/queued-exports/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
1214
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1215
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1216
+ let baseOptions;
1217
+ if (configuration) {
1218
+ baseOptions = configuration.baseOptions;
1219
+ }
1220
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1221
+ const localVarHeaderParameter = {};
1222
+ const localVarQueryParameter = {};
1223
+ // authentication OAuth2 required
1224
+ // oauth required
1225
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
1226
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1227
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1228
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1229
+ return {
1230
+ url: (0, common_1.toPathString)(localVarUrlObj),
1231
+ options: localVarRequestOptions,
1232
+ };
1233
+ }),
1234
+ };
1235
+ };
1236
+ exports.ExportsApiAxiosParamCreator = ExportsApiAxiosParamCreator;
1237
+ /**
1238
+ * ExportsApi - functional programming interface
1239
+ * @export
1240
+ */
1241
+ const ExportsApiFp = function (configuration) {
1242
+ const localVarAxiosParamCreator = (0, exports.ExportsApiAxiosParamCreator)(configuration);
1243
+ return {
1244
+ /**
1245
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
1246
+ * @param {CreateExportRequest} createExportRequest
1247
+ * @param {*} [options] Override http request option.
1248
+ * @throws {RequiredError}
1249
+ */
1250
+ createExport(createExportRequest, options) {
1251
+ return __awaiter(this, void 0, void 0, function* () {
1252
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createExport(createExportRequest, options);
1253
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1254
+ });
1255
+ },
1256
+ /**
1257
+ * Get an `export` by ID.
1258
+ * @param {string} id The &#x60;export&#x60; ID.
1259
+ * @param {*} [options] Override http request option.
1260
+ * @throws {RequiredError}
1261
+ */
1262
+ getExport(id, options) {
1263
+ return __awaiter(this, void 0, void 0, function* () {
1264
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getExport(id, options);
1265
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1266
+ });
1267
+ },
1268
+ /**
1269
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
1270
+ * @param {string} id The &#x60;queued-export&#x60; ID.
1271
+ * @param {*} [options] Override http request option.
1272
+ * @throws {RequiredError}
1273
+ */
1274
+ getQueuedExport(id, options) {
1275
+ return __awaiter(this, void 0, void 0, function* () {
1276
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedExport(id, options);
1277
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1278
+ });
1279
+ },
1280
+ };
1281
+ };
1282
+ exports.ExportsApiFp = ExportsApiFp;
1283
+ /**
1284
+ * ExportsApi - factory interface
1285
+ * @export
1286
+ */
1287
+ const ExportsApiFactory = function (configuration, basePath, axios) {
1288
+ const localVarFp = (0, exports.ExportsApiFp)(configuration);
1289
+ return {
1290
+ /**
1291
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
1292
+ * @param {CreateExportRequest} createExportRequest
1293
+ * @param {*} [options] Override http request option.
1294
+ * @throws {RequiredError}
1295
+ */
1296
+ createExport(createExportRequest, options) {
1297
+ return localVarFp
1298
+ .createExport(createExportRequest, options)
1299
+ .then((request) => request(axios, basePath));
1300
+ },
1301
+ /**
1302
+ * Get an `export` by ID.
1303
+ * @param {string} id The &#x60;export&#x60; ID.
1304
+ * @param {*} [options] Override http request option.
1305
+ * @throws {RequiredError}
1306
+ */
1307
+ getExport(id, options) {
1308
+ return localVarFp
1309
+ .getExport(id, options)
1310
+ .then((request) => request(axios, basePath));
1311
+ },
1312
+ /**
1313
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
1314
+ * @param {string} id The &#x60;queued-export&#x60; ID.
1315
+ * @param {*} [options] Override http request option.
1316
+ * @throws {RequiredError}
1317
+ */
1318
+ getQueuedExport(id, options) {
1319
+ return localVarFp
1320
+ .getQueuedExport(id, options)
1321
+ .then((request) => request(axios, basePath));
1322
+ },
1323
+ };
1324
+ };
1325
+ exports.ExportsApiFactory = ExportsApiFactory;
1326
+ /**
1327
+ * ExportsApi - object-oriented interface
1328
+ * @export
1329
+ * @class ExportsApi
1330
+ * @extends {BaseAPI}
1331
+ */
1332
+ class ExportsApi extends base_1.BaseAPI {
1333
+ /**
1334
+ * Create an `export`. This API is asynchronous, returning the location of a `queued-export`. Check the status via the getQueuedExport API.
1335
+ * @param {ExportsApiCreateExportRequest} requestParameters Request parameters.
1336
+ * @param {*} [options] Override http request option.
1337
+ * @throws {RequiredError}
1338
+ * @memberof ExportsApi
1339
+ */
1340
+ createExport(requestParameters, options) {
1341
+ return (0, exports.ExportsApiFp)(this.configuration)
1342
+ .createExport(requestParameters.createExportRequest, options)
1343
+ .then((request) => request(this.axios, this.basePath));
1344
+ }
1345
+ /**
1346
+ * Get an `export` by ID.
1347
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
1348
+ * @param {*} [options] Override http request option.
1349
+ * @throws {RequiredError}
1350
+ * @memberof ExportsApi
1351
+ */
1352
+ getExport(requestParameters, options) {
1353
+ return (0, exports.ExportsApiFp)(this.configuration)
1354
+ .getExport(requestParameters.id, options)
1355
+ .then((request) => request(this.axios, this.basePath));
1356
+ }
1357
+ /**
1358
+ * Get a `queued-export`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `export`.
1359
+ * @param {ExportsApiGetQueuedExportRequest} requestParameters Request parameters.
1360
+ * @param {*} [options] Override http request option.
1361
+ * @throws {RequiredError}
1362
+ * @memberof ExportsApi
1363
+ */
1364
+ getQueuedExport(requestParameters, options) {
1365
+ return (0, exports.ExportsApiFp)(this.configuration)
1366
+ .getQueuedExport(requestParameters.id, options)
1367
+ .then((request) => request(this.axios, this.basePath));
1368
+ }
1369
+ }
1370
+ exports.ExportsApi = ExportsApi;
1133
1371
  /**
1134
1372
  * FilesApi - axios parameter creator
1135
1373
  * @export
@@ -0,0 +1,15 @@
1
+ import { CreateExportRequest, Export } from '../../index';
2
+ import { BaseReq } from '../index';
3
+ /**
4
+ * Create export arguments.
5
+ */
6
+ export interface CreateExportReq extends BaseReq {
7
+ /** Function returning a {@link CreateExportRequest}. */
8
+ readonly createExportReq: () => CreateExportRequest;
9
+ }
10
+ /**
11
+ * Create an export.
12
+ *
13
+ * @param args - The {@link CreateExportReq}.
14
+ */
15
+ export declare function createExport({ client, createExportReq, onMsg, verbose, }: CreateExportReq): Promise<Export>;