@cosmotech/api-ts 5.0.0-rc4 → 5.0.0-rc6
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/README.md +2 -2
- package/api.ts +171 -171
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +171 -171
- package/dist/api.js +161 -161
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ContainerResourceSizeInfo.md +3 -3
- package/docs/DatasetApi.md +10 -4
- package/docs/MetaApi.md +1 -0
- package/docs/OrganizationApi.md +7 -2
- package/docs/ResourceSizeInfo.md +3 -3
- package/docs/RunApi.md +4 -0
- package/docs/RunResourceRequested.md +2 -2
- package/docs/RunTemplateResourceSizing.md +1 -1
- package/docs/RunnerApi.md +7 -0
- package/docs/RunnerResourceSizing.md +1 -1
- package/docs/SolutionApi.md +4 -0
- package/docs/WorkspaceApi.md +8 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.0-
|
|
5
|
+
* The version of the OpenAPI document: 5.0.0-rc6
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,15 +62,15 @@ export interface ComponentRolePermissions {
|
|
|
62
62
|
};
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
*
|
|
65
|
+
* Define cpus and memory needs
|
|
66
66
|
*/
|
|
67
67
|
export interface ContainerResourceSizeInfo {
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Define cpu needs
|
|
70
70
|
*/
|
|
71
71
|
'cpu': string;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Define memory needs
|
|
74
74
|
*/
|
|
75
75
|
'memory': string;
|
|
76
76
|
}
|
|
@@ -394,15 +394,15 @@ export interface OrganizationUpdateRequest {
|
|
|
394
394
|
'name'?: string;
|
|
395
395
|
}
|
|
396
396
|
/**
|
|
397
|
-
*
|
|
397
|
+
* Define CPUs and memory needs. Values must follow the Kubernetes resource requirements/limits syntax: See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes
|
|
398
398
|
*/
|
|
399
399
|
export interface ResourceSizeInfo {
|
|
400
400
|
/**
|
|
401
|
-
*
|
|
401
|
+
* Define cpu needs
|
|
402
402
|
*/
|
|
403
403
|
'cpu': string;
|
|
404
404
|
/**
|
|
405
|
-
*
|
|
405
|
+
* Define memory needs
|
|
406
406
|
*/
|
|
407
407
|
'memory': string;
|
|
408
408
|
}
|
|
@@ -545,11 +545,11 @@ export interface RunEditInfo {
|
|
|
545
545
|
*/
|
|
546
546
|
export interface RunResourceRequested {
|
|
547
547
|
/**
|
|
548
|
-
*
|
|
548
|
+
* Define cpu needs
|
|
549
549
|
*/
|
|
550
550
|
'cpu'?: number;
|
|
551
551
|
/**
|
|
552
|
-
*
|
|
552
|
+
* Define memory needs
|
|
553
553
|
*/
|
|
554
554
|
'memory'?: number;
|
|
555
555
|
}
|
|
@@ -976,7 +976,7 @@ export interface RunTemplateParameterValue {
|
|
|
976
976
|
'value': string;
|
|
977
977
|
}
|
|
978
978
|
/**
|
|
979
|
-
* A description object for resource requests and limits
|
|
979
|
+
* A description object for resource requests and limits Values must follow the Kubernetes resource requirements/limits syntax: See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes
|
|
980
980
|
*/
|
|
981
981
|
export interface RunTemplateResourceSizing {
|
|
982
982
|
'requests': ResourceSizeInfo;
|
|
@@ -1197,7 +1197,7 @@ export interface RunnerEditInfo {
|
|
|
1197
1197
|
'userId': string;
|
|
1198
1198
|
}
|
|
1199
1199
|
/**
|
|
1200
|
-
*
|
|
1200
|
+
* A description object for resource requests and limits. Values must follow the Kubernetes resource requirements/limits syntax: See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes Default configuration is basic sizing
|
|
1201
1201
|
*/
|
|
1202
1202
|
export interface RunnerResourceSizing {
|
|
1203
1203
|
'requests': ResourceSizeInfo;
|
|
@@ -1717,7 +1717,7 @@ export interface WorkspaceUpdateRequest {
|
|
|
1717
1717
|
*/
|
|
1718
1718
|
export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1719
1719
|
/**
|
|
1720
|
-
*
|
|
1720
|
+
* Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
|
|
1721
1721
|
* @summary Create a Dataset
|
|
1722
1722
|
* @param {string} organizationId the Organization identifier
|
|
1723
1723
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1739,7 +1739,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1739
1739
|
*/
|
|
1740
1740
|
createDatasetAccessControl: (organizationId: string, workspaceId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1741
1741
|
/**
|
|
1742
|
-
*
|
|
1742
|
+
* Create a new data part within a dataset. Specify type as \'File\' for file storage or \'DB\' for database storage. Returns the created part.
|
|
1743
1743
|
* @summary Create a data part of a Dataset
|
|
1744
1744
|
* @param {string} organizationId the Organization identifier
|
|
1745
1745
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1751,7 +1751,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1751
1751
|
*/
|
|
1752
1752
|
createDatasetPart: (organizationId: string, workspaceId: string, datasetId: string, file: File, datasetPartCreateRequest: DatasetPartCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1753
1753
|
/**
|
|
1754
|
-
*
|
|
1754
|
+
* Permanently delete a dataset and all its data parts. This operation cannot be undone.
|
|
1755
1755
|
* @summary Delete a Dataset
|
|
1756
1756
|
* @param {string} organizationId the Organization identifier
|
|
1757
1757
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1761,7 +1761,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1761
1761
|
*/
|
|
1762
1762
|
deleteDataset: (organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1763
1763
|
/**
|
|
1764
|
-
*
|
|
1764
|
+
* Remove a user or group\'s access to a dataset. Cannot remove the last administrator - at least one admin must remain.
|
|
1765
1765
|
* @summary Remove the specified access from the given Dataset
|
|
1766
1766
|
* @param {string} organizationId the Organization identifier
|
|
1767
1767
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1783,7 +1783,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
deleteDatasetPart: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1785
1785
|
/**
|
|
1786
|
-
*
|
|
1786
|
+
* Download the file content from a dataset part. Returns the file as an application/octet-stream.
|
|
1787
1787
|
* @summary Download data from a dataset part
|
|
1788
1788
|
* @param {string} organizationId the Organization identifier
|
|
1789
1789
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1794,7 +1794,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1794
1794
|
*/
|
|
1795
1795
|
downloadDatasetPart: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1796
1796
|
/**
|
|
1797
|
-
* Retrieve a dataset
|
|
1797
|
+
* Retrieve complete information about a specific dataset including dataset parts.
|
|
1798
1798
|
* @summary Retrieve a Dataset
|
|
1799
1799
|
* @param {string} organizationId the Organization identifier
|
|
1800
1800
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1826,7 +1826,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1826
1826
|
*/
|
|
1827
1827
|
getDatasetPart: (organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1828
1828
|
/**
|
|
1829
|
-
*
|
|
1829
|
+
* Retrieve all data parts associated with a dataset.
|
|
1830
1830
|
* @summary Retrieve all dataset parts of a Dataset
|
|
1831
1831
|
* @param {string} organizationId the Organization identifier
|
|
1832
1832
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1848,7 +1848,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1848
1848
|
*/
|
|
1849
1849
|
listDatasetSecurityUsers: (organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1850
1850
|
/**
|
|
1851
|
-
*
|
|
1851
|
+
* Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via \'page\' and \'size\' query parameters. Returns datasets based on user permissions.
|
|
1852
1852
|
* @summary Retrieve a list of defined Dataset
|
|
1853
1853
|
* @param {string} organizationId the Organization identifier
|
|
1854
1854
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1859,7 +1859,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1859
1859
|
*/
|
|
1860
1860
|
listDatasets: (organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1861
1861
|
/**
|
|
1862
|
-
*
|
|
1862
|
+
* Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
|
|
1863
1863
|
* @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
1864
1864
|
* @param {string} organizationId the Organization identifier
|
|
1865
1865
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1918,7 +1918,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1918
1918
|
*/
|
|
1919
1919
|
searchDatasets: (organizationId: string, workspaceId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1920
1920
|
/**
|
|
1921
|
-
* Update
|
|
1921
|
+
* Update dataset information and return the updated dataset.
|
|
1922
1922
|
* @summary Update a Dataset
|
|
1923
1923
|
* @param {string} organizationId the Organization identifier
|
|
1924
1924
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1970,7 +1970,7 @@ export declare const DatasetApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1970
1970
|
*/
|
|
1971
1971
|
export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
1972
1972
|
/**
|
|
1973
|
-
*
|
|
1973
|
+
* Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
|
|
1974
1974
|
* @summary Create a Dataset
|
|
1975
1975
|
* @param {string} organizationId the Organization identifier
|
|
1976
1976
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -1992,7 +1992,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
1992
1992
|
*/
|
|
1993
1993
|
createDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetAccessControl>>;
|
|
1994
1994
|
/**
|
|
1995
|
-
*
|
|
1995
|
+
* Create a new data part within a dataset. Specify type as \'File\' for file storage or \'DB\' for database storage. Returns the created part.
|
|
1996
1996
|
* @summary Create a data part of a Dataset
|
|
1997
1997
|
* @param {string} organizationId the Organization identifier
|
|
1998
1998
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2004,7 +2004,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2004
2004
|
*/
|
|
2005
2005
|
createDatasetPart(organizationId: string, workspaceId: string, datasetId: string, file: File, datasetPartCreateRequest: DatasetPartCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetPart>>;
|
|
2006
2006
|
/**
|
|
2007
|
-
*
|
|
2007
|
+
* Permanently delete a dataset and all its data parts. This operation cannot be undone.
|
|
2008
2008
|
* @summary Delete a Dataset
|
|
2009
2009
|
* @param {string} organizationId the Organization identifier
|
|
2010
2010
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2014,7 +2014,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2014
2014
|
*/
|
|
2015
2015
|
deleteDataset(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2016
2016
|
/**
|
|
2017
|
-
*
|
|
2017
|
+
* Remove a user or group\'s access to a dataset. Cannot remove the last administrator - at least one admin must remain.
|
|
2018
2018
|
* @summary Remove the specified access from the given Dataset
|
|
2019
2019
|
* @param {string} organizationId the Organization identifier
|
|
2020
2020
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2036,7 +2036,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2036
2036
|
*/
|
|
2037
2037
|
deleteDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2038
2038
|
/**
|
|
2039
|
-
*
|
|
2039
|
+
* Download the file content from a dataset part. Returns the file as an application/octet-stream.
|
|
2040
2040
|
* @summary Download data from a dataset part
|
|
2041
2041
|
* @param {string} organizationId the Organization identifier
|
|
2042
2042
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2047,7 +2047,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2047
2047
|
*/
|
|
2048
2048
|
downloadDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2049
2049
|
/**
|
|
2050
|
-
* Retrieve a dataset
|
|
2050
|
+
* Retrieve complete information about a specific dataset including dataset parts.
|
|
2051
2051
|
* @summary Retrieve a Dataset
|
|
2052
2052
|
* @param {string} organizationId the Organization identifier
|
|
2053
2053
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2079,7 +2079,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2079
2079
|
*/
|
|
2080
2080
|
getDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatasetPart>>;
|
|
2081
2081
|
/**
|
|
2082
|
-
*
|
|
2082
|
+
* Retrieve all data parts associated with a dataset.
|
|
2083
2083
|
* @summary Retrieve all dataset parts of a Dataset
|
|
2084
2084
|
* @param {string} organizationId the Organization identifier
|
|
2085
2085
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2101,7 +2101,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2101
2101
|
*/
|
|
2102
2102
|
listDatasetSecurityUsers(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
2103
2103
|
/**
|
|
2104
|
-
*
|
|
2104
|
+
* Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via \'page\' and \'size\' query parameters. Returns datasets based on user permissions.
|
|
2105
2105
|
* @summary Retrieve a list of defined Dataset
|
|
2106
2106
|
* @param {string} organizationId the Organization identifier
|
|
2107
2107
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2112,7 +2112,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2112
2112
|
*/
|
|
2113
2113
|
listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
2114
2114
|
/**
|
|
2115
|
-
*
|
|
2115
|
+
* Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
|
|
2116
2116
|
* @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
2117
2117
|
* @param {string} organizationId the Organization identifier
|
|
2118
2118
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2171,7 +2171,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2171
2171
|
*/
|
|
2172
2172
|
searchDatasets(organizationId: string, workspaceId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Dataset>>>;
|
|
2173
2173
|
/**
|
|
2174
|
-
* Update
|
|
2174
|
+
* Update dataset information and return the updated dataset.
|
|
2175
2175
|
* @summary Update a Dataset
|
|
2176
2176
|
* @param {string} organizationId the Organization identifier
|
|
2177
2177
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2223,7 +2223,7 @@ export declare const DatasetApiFp: (configuration?: Configuration) => {
|
|
|
2223
2223
|
*/
|
|
2224
2224
|
export declare const DatasetApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2225
2225
|
/**
|
|
2226
|
-
*
|
|
2226
|
+
* Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
|
|
2227
2227
|
* @summary Create a Dataset
|
|
2228
2228
|
* @param {string} organizationId the Organization identifier
|
|
2229
2229
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2245,7 +2245,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2245
2245
|
*/
|
|
2246
2246
|
createDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: RawAxiosRequestConfig): AxiosPromise<DatasetAccessControl>;
|
|
2247
2247
|
/**
|
|
2248
|
-
*
|
|
2248
|
+
* Create a new data part within a dataset. Specify type as \'File\' for file storage or \'DB\' for database storage. Returns the created part.
|
|
2249
2249
|
* @summary Create a data part of a Dataset
|
|
2250
2250
|
* @param {string} organizationId the Organization identifier
|
|
2251
2251
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2257,7 +2257,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2257
2257
|
*/
|
|
2258
2258
|
createDatasetPart(organizationId: string, workspaceId: string, datasetId: string, file: File, datasetPartCreateRequest: DatasetPartCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<DatasetPart>;
|
|
2259
2259
|
/**
|
|
2260
|
-
*
|
|
2260
|
+
* Permanently delete a dataset and all its data parts. This operation cannot be undone.
|
|
2261
2261
|
* @summary Delete a Dataset
|
|
2262
2262
|
* @param {string} organizationId the Organization identifier
|
|
2263
2263
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2267,7 +2267,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2267
2267
|
*/
|
|
2268
2268
|
deleteDataset(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2269
2269
|
/**
|
|
2270
|
-
*
|
|
2270
|
+
* Remove a user or group\'s access to a dataset. Cannot remove the last administrator - at least one admin must remain.
|
|
2271
2271
|
* @summary Remove the specified access from the given Dataset
|
|
2272
2272
|
* @param {string} organizationId the Organization identifier
|
|
2273
2273
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2289,7 +2289,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2289
2289
|
*/
|
|
2290
2290
|
deleteDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2291
2291
|
/**
|
|
2292
|
-
*
|
|
2292
|
+
* Download the file content from a dataset part. Returns the file as an application/octet-stream.
|
|
2293
2293
|
* @summary Download data from a dataset part
|
|
2294
2294
|
* @param {string} organizationId the Organization identifier
|
|
2295
2295
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2300,7 +2300,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2300
2300
|
*/
|
|
2301
2301
|
downloadDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2302
2302
|
/**
|
|
2303
|
-
* Retrieve a dataset
|
|
2303
|
+
* Retrieve complete information about a specific dataset including dataset parts.
|
|
2304
2304
|
* @summary Retrieve a Dataset
|
|
2305
2305
|
* @param {string} organizationId the Organization identifier
|
|
2306
2306
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2332,7 +2332,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2332
2332
|
*/
|
|
2333
2333
|
getDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): AxiosPromise<DatasetPart>;
|
|
2334
2334
|
/**
|
|
2335
|
-
*
|
|
2335
|
+
* Retrieve all data parts associated with a dataset.
|
|
2336
2336
|
* @summary Retrieve all dataset parts of a Dataset
|
|
2337
2337
|
* @param {string} organizationId the Organization identifier
|
|
2338
2338
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2354,7 +2354,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2354
2354
|
*/
|
|
2355
2355
|
listDatasetSecurityUsers(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
2356
2356
|
/**
|
|
2357
|
-
*
|
|
2357
|
+
* Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via \'page\' and \'size\' query parameters. Returns datasets based on user permissions.
|
|
2358
2358
|
* @summary Retrieve a list of defined Dataset
|
|
2359
2359
|
* @param {string} organizationId the Organization identifier
|
|
2360
2360
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2365,7 +2365,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2365
2365
|
*/
|
|
2366
2366
|
listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Dataset>>;
|
|
2367
2367
|
/**
|
|
2368
|
-
*
|
|
2368
|
+
* Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
|
|
2369
2369
|
* @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
2370
2370
|
* @param {string} organizationId the Organization identifier
|
|
2371
2371
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2424,7 +2424,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2424
2424
|
*/
|
|
2425
2425
|
searchDatasets(organizationId: string, workspaceId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Dataset>>;
|
|
2426
2426
|
/**
|
|
2427
|
-
* Update
|
|
2427
|
+
* Update dataset information and return the updated dataset.
|
|
2428
2428
|
* @summary Update a Dataset
|
|
2429
2429
|
* @param {string} organizationId the Organization identifier
|
|
2430
2430
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2476,7 +2476,7 @@ export declare const DatasetApiFactory: (configuration?: Configuration, basePath
|
|
|
2476
2476
|
*/
|
|
2477
2477
|
export declare class DatasetApi extends BaseAPI {
|
|
2478
2478
|
/**
|
|
2479
|
-
*
|
|
2479
|
+
* Create a new dataset in the workspace. The dataset is initialized with specified parts (can be empty). The dataset can also be populated through dataset parts.
|
|
2480
2480
|
* @summary Create a Dataset
|
|
2481
2481
|
* @param {string} organizationId the Organization identifier
|
|
2482
2482
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2498,7 +2498,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2498
2498
|
*/
|
|
2499
2499
|
createDatasetAccessControl(organizationId: string, workspaceId: string, datasetId: string, datasetAccessControl: DatasetAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetAccessControl, any, {}>>;
|
|
2500
2500
|
/**
|
|
2501
|
-
*
|
|
2501
|
+
* Create a new data part within a dataset. Specify type as \'File\' for file storage or \'DB\' for database storage. Returns the created part.
|
|
2502
2502
|
* @summary Create a data part of a Dataset
|
|
2503
2503
|
* @param {string} organizationId the Organization identifier
|
|
2504
2504
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2510,7 +2510,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2510
2510
|
*/
|
|
2511
2511
|
createDatasetPart(organizationId: string, workspaceId: string, datasetId: string, file: File, datasetPartCreateRequest: DatasetPartCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
|
|
2512
2512
|
/**
|
|
2513
|
-
*
|
|
2513
|
+
* Permanently delete a dataset and all its data parts. This operation cannot be undone.
|
|
2514
2514
|
* @summary Delete a Dataset
|
|
2515
2515
|
* @param {string} organizationId the Organization identifier
|
|
2516
2516
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2520,7 +2520,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2520
2520
|
*/
|
|
2521
2521
|
deleteDataset(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2522
2522
|
/**
|
|
2523
|
-
*
|
|
2523
|
+
* Remove a user or group\'s access to a dataset. Cannot remove the last administrator - at least one admin must remain.
|
|
2524
2524
|
* @summary Remove the specified access from the given Dataset
|
|
2525
2525
|
* @param {string} organizationId the Organization identifier
|
|
2526
2526
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2542,7 +2542,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2542
2542
|
*/
|
|
2543
2543
|
deleteDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2544
2544
|
/**
|
|
2545
|
-
*
|
|
2545
|
+
* Download the file content from a dataset part. Returns the file as an application/octet-stream.
|
|
2546
2546
|
* @summary Download data from a dataset part
|
|
2547
2547
|
* @param {string} organizationId the Organization identifier
|
|
2548
2548
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2553,7 +2553,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2553
2553
|
*/
|
|
2554
2554
|
downloadDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2555
2555
|
/**
|
|
2556
|
-
* Retrieve a dataset
|
|
2556
|
+
* Retrieve complete information about a specific dataset including dataset parts.
|
|
2557
2557
|
* @summary Retrieve a Dataset
|
|
2558
2558
|
* @param {string} organizationId the Organization identifier
|
|
2559
2559
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2585,7 +2585,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2585
2585
|
*/
|
|
2586
2586
|
getDatasetPart(organizationId: string, workspaceId: string, datasetId: string, datasetPartId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DatasetPart, any, {}>>;
|
|
2587
2587
|
/**
|
|
2588
|
-
*
|
|
2588
|
+
* Retrieve all data parts associated with a dataset.
|
|
2589
2589
|
* @summary Retrieve all dataset parts of a Dataset
|
|
2590
2590
|
* @param {string} organizationId the Organization identifier
|
|
2591
2591
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2607,7 +2607,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2607
2607
|
*/
|
|
2608
2608
|
listDatasetSecurityUsers(organizationId: string, workspaceId: string, datasetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
2609
2609
|
/**
|
|
2610
|
-
*
|
|
2610
|
+
* Retrieve a paginated list of all datasets in the specified workspace. Supports pagination via \'page\' and \'size\' query parameters. Returns datasets based on user permissions.
|
|
2611
2611
|
* @summary Retrieve a list of defined Dataset
|
|
2612
2612
|
* @param {string} organizationId the Organization identifier
|
|
2613
2613
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2618,7 +2618,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2618
2618
|
*/
|
|
2619
2619
|
listDatasets(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
|
|
2620
2620
|
/**
|
|
2621
|
-
*
|
|
2621
|
+
* Execute a query against a dataset part. Results are returned as plain-text CSV. Only available for parts with type=DB.
|
|
2622
2622
|
* @summary Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
2623
2623
|
* @param {string} organizationId the Organization identifier
|
|
2624
2624
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2677,7 +2677,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2677
2677
|
*/
|
|
2678
2678
|
searchDatasets(organizationId: string, workspaceId: string, requestBody: Array<string>, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Dataset[], any, {}>>;
|
|
2679
2679
|
/**
|
|
2680
|
-
* Update
|
|
2680
|
+
* Update dataset information and return the updated dataset.
|
|
2681
2681
|
* @summary Update a Dataset
|
|
2682
2682
|
* @param {string} organizationId the Organization identifier
|
|
2683
2683
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -2729,7 +2729,7 @@ export declare class DatasetApi extends BaseAPI {
|
|
|
2729
2729
|
*/
|
|
2730
2730
|
export declare const MetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2731
2731
|
/**
|
|
2732
|
-
*
|
|
2732
|
+
* Retrieve API version information and build details.
|
|
2733
2733
|
* @summary Get various information about the API
|
|
2734
2734
|
* @param {*} [options] Override http request option.
|
|
2735
2735
|
* @throws {RequiredError}
|
|
@@ -2741,7 +2741,7 @@ export declare const MetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
2741
2741
|
*/
|
|
2742
2742
|
export declare const MetaApiFp: (configuration?: Configuration) => {
|
|
2743
2743
|
/**
|
|
2744
|
-
*
|
|
2744
|
+
* Retrieve API version information and build details.
|
|
2745
2745
|
* @summary Get various information about the API
|
|
2746
2746
|
* @param {*} [options] Override http request option.
|
|
2747
2747
|
* @throws {RequiredError}
|
|
@@ -2753,7 +2753,7 @@ export declare const MetaApiFp: (configuration?: Configuration) => {
|
|
|
2753
2753
|
*/
|
|
2754
2754
|
export declare const MetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2755
2755
|
/**
|
|
2756
|
-
*
|
|
2756
|
+
* Retrieve API version information and build details.
|
|
2757
2757
|
* @summary Get various information about the API
|
|
2758
2758
|
* @param {*} [options] Override http request option.
|
|
2759
2759
|
* @throws {RequiredError}
|
|
@@ -2765,7 +2765,7 @@ export declare const MetaApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2765
2765
|
*/
|
|
2766
2766
|
export declare class MetaApi extends BaseAPI {
|
|
2767
2767
|
/**
|
|
2768
|
-
*
|
|
2768
|
+
* Retrieve API version information and build details.
|
|
2769
2769
|
* @summary Get various information about the API
|
|
2770
2770
|
* @param {*} [options] Override http request option.
|
|
2771
2771
|
* @throws {RequiredError}
|
|
@@ -2777,15 +2777,15 @@ export declare class MetaApi extends BaseAPI {
|
|
|
2777
2777
|
*/
|
|
2778
2778
|
export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2779
2779
|
/**
|
|
2780
|
-
*
|
|
2780
|
+
* Create a new organization.
|
|
2781
2781
|
* @summary Create a new organization
|
|
2782
|
-
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
2782
|
+
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
2783
2783
|
* @param {*} [options] Override http request option.
|
|
2784
2784
|
* @throws {RequiredError}
|
|
2785
2785
|
*/
|
|
2786
2786
|
createOrganization: (organizationCreateRequest: OrganizationCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2787
2787
|
/**
|
|
2788
|
-
*
|
|
2788
|
+
* Grant access to an organization for a user or group.
|
|
2789
2789
|
* @summary Add a control access to the Organization
|
|
2790
2790
|
* @param {string} organizationId The Organization identifier
|
|
2791
2791
|
* @param {OrganizationAccessControl} organizationAccessControl The new Organization security access to add.
|
|
@@ -2794,7 +2794,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
2794
2794
|
*/
|
|
2795
2795
|
createOrganizationAccessControl: (organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2796
2796
|
/**
|
|
2797
|
-
*
|
|
2797
|
+
* Permanently delete an organization. This operation cannot be undone.
|
|
2798
2798
|
* @summary Delete an organization
|
|
2799
2799
|
* @param {string} organizationId The Organization identifier
|
|
2800
2800
|
* @param {*} [options] Override http request option.
|
|
@@ -2811,7 +2811,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
2811
2811
|
*/
|
|
2812
2812
|
deleteOrganizationAccessControl: (organizationId: string, identityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2813
2813
|
/**
|
|
2814
|
-
*
|
|
2814
|
+
* Retrieve detailed information about an organization.
|
|
2815
2815
|
* @summary Get the details of an Organization
|
|
2816
2816
|
* @param {string} organizationId The Organization identifier
|
|
2817
2817
|
* @param {*} [options] Override http request option.
|
|
@@ -2853,7 +2853,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
2853
2853
|
*/
|
|
2854
2854
|
listOrganizationSecurityUsers: (organizationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2855
2855
|
/**
|
|
2856
|
-
*
|
|
2856
|
+
* Retrieve a paginated list of all organizations the authenticated user has permission to view. Use \'page\' and \'size\' query parameters for pagination.
|
|
2857
2857
|
* @summary List all Organizations
|
|
2858
2858
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
2859
2859
|
* @param {number} [size] Amount of result by page
|
|
@@ -2902,15 +2902,15 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
2902
2902
|
*/
|
|
2903
2903
|
export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
2904
2904
|
/**
|
|
2905
|
-
*
|
|
2905
|
+
* Create a new organization.
|
|
2906
2906
|
* @summary Create a new organization
|
|
2907
|
-
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
2907
|
+
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
2908
2908
|
* @param {*} [options] Override http request option.
|
|
2909
2909
|
* @throws {RequiredError}
|
|
2910
2910
|
*/
|
|
2911
2911
|
createOrganization(organizationCreateRequest: OrganizationCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Organization>>;
|
|
2912
2912
|
/**
|
|
2913
|
-
*
|
|
2913
|
+
* Grant access to an organization for a user or group.
|
|
2914
2914
|
* @summary Add a control access to the Organization
|
|
2915
2915
|
* @param {string} organizationId The Organization identifier
|
|
2916
2916
|
* @param {OrganizationAccessControl} organizationAccessControl The new Organization security access to add.
|
|
@@ -2919,7 +2919,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
2919
2919
|
*/
|
|
2920
2920
|
createOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationAccessControl>>;
|
|
2921
2921
|
/**
|
|
2922
|
-
*
|
|
2922
|
+
* Permanently delete an organization. This operation cannot be undone.
|
|
2923
2923
|
* @summary Delete an organization
|
|
2924
2924
|
* @param {string} organizationId The Organization identifier
|
|
2925
2925
|
* @param {*} [options] Override http request option.
|
|
@@ -2936,7 +2936,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
2936
2936
|
*/
|
|
2937
2937
|
deleteOrganizationAccessControl(organizationId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2938
2938
|
/**
|
|
2939
|
-
*
|
|
2939
|
+
* Retrieve detailed information about an organization.
|
|
2940
2940
|
* @summary Get the details of an Organization
|
|
2941
2941
|
* @param {string} organizationId The Organization identifier
|
|
2942
2942
|
* @param {*} [options] Override http request option.
|
|
@@ -2978,7 +2978,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
2978
2978
|
*/
|
|
2979
2979
|
listOrganizationSecurityUsers(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
2980
2980
|
/**
|
|
2981
|
-
*
|
|
2981
|
+
* Retrieve a paginated list of all organizations the authenticated user has permission to view. Use \'page\' and \'size\' query parameters for pagination.
|
|
2982
2982
|
* @summary List all Organizations
|
|
2983
2983
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
2984
2984
|
* @param {number} [size] Amount of result by page
|
|
@@ -3027,15 +3027,15 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
3027
3027
|
*/
|
|
3028
3028
|
export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3029
3029
|
/**
|
|
3030
|
-
*
|
|
3030
|
+
* Create a new organization.
|
|
3031
3031
|
* @summary Create a new organization
|
|
3032
|
-
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
3032
|
+
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
3033
3033
|
* @param {*} [options] Override http request option.
|
|
3034
3034
|
* @throws {RequiredError}
|
|
3035
3035
|
*/
|
|
3036
3036
|
createOrganization(organizationCreateRequest: OrganizationCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Organization>;
|
|
3037
3037
|
/**
|
|
3038
|
-
*
|
|
3038
|
+
* Grant access to an organization for a user or group.
|
|
3039
3039
|
* @summary Add a control access to the Organization
|
|
3040
3040
|
* @param {string} organizationId The Organization identifier
|
|
3041
3041
|
* @param {OrganizationAccessControl} organizationAccessControl The new Organization security access to add.
|
|
@@ -3044,7 +3044,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3044
3044
|
*/
|
|
3045
3045
|
createOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: RawAxiosRequestConfig): AxiosPromise<OrganizationAccessControl>;
|
|
3046
3046
|
/**
|
|
3047
|
-
*
|
|
3047
|
+
* Permanently delete an organization. This operation cannot be undone.
|
|
3048
3048
|
* @summary Delete an organization
|
|
3049
3049
|
* @param {string} organizationId The Organization identifier
|
|
3050
3050
|
* @param {*} [options] Override http request option.
|
|
@@ -3061,7 +3061,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3061
3061
|
*/
|
|
3062
3062
|
deleteOrganizationAccessControl(organizationId: string, identityId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3063
3063
|
/**
|
|
3064
|
-
*
|
|
3064
|
+
* Retrieve detailed information about an organization.
|
|
3065
3065
|
* @summary Get the details of an Organization
|
|
3066
3066
|
* @param {string} organizationId The Organization identifier
|
|
3067
3067
|
* @param {*} [options] Override http request option.
|
|
@@ -3103,7 +3103,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3103
3103
|
*/
|
|
3104
3104
|
listOrganizationSecurityUsers(organizationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
3105
3105
|
/**
|
|
3106
|
-
*
|
|
3106
|
+
* Retrieve a paginated list of all organizations the authenticated user has permission to view. Use \'page\' and \'size\' query parameters for pagination.
|
|
3107
3107
|
* @summary List all Organizations
|
|
3108
3108
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
3109
3109
|
* @param {number} [size] Amount of result by page
|
|
@@ -3152,15 +3152,15 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
3152
3152
|
*/
|
|
3153
3153
|
export declare class OrganizationApi extends BaseAPI {
|
|
3154
3154
|
/**
|
|
3155
|
-
*
|
|
3155
|
+
* Create a new organization.
|
|
3156
3156
|
* @summary Create a new organization
|
|
3157
|
-
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
3157
|
+
* @param {OrganizationCreateRequest} organizationCreateRequest
|
|
3158
3158
|
* @param {*} [options] Override http request option.
|
|
3159
3159
|
* @throws {RequiredError}
|
|
3160
3160
|
*/
|
|
3161
3161
|
createOrganization(organizationCreateRequest: OrganizationCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Organization, any, {}>>;
|
|
3162
3162
|
/**
|
|
3163
|
-
*
|
|
3163
|
+
* Grant access to an organization for a user or group.
|
|
3164
3164
|
* @summary Add a control access to the Organization
|
|
3165
3165
|
* @param {string} organizationId The Organization identifier
|
|
3166
3166
|
* @param {OrganizationAccessControl} organizationAccessControl The new Organization security access to add.
|
|
@@ -3169,7 +3169,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3169
3169
|
*/
|
|
3170
3170
|
createOrganizationAccessControl(organizationId: string, organizationAccessControl: OrganizationAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationAccessControl, any, {}>>;
|
|
3171
3171
|
/**
|
|
3172
|
-
*
|
|
3172
|
+
* Permanently delete an organization. This operation cannot be undone.
|
|
3173
3173
|
* @summary Delete an organization
|
|
3174
3174
|
* @param {string} organizationId The Organization identifier
|
|
3175
3175
|
* @param {*} [options] Override http request option.
|
|
@@ -3186,7 +3186,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3186
3186
|
*/
|
|
3187
3187
|
deleteOrganizationAccessControl(organizationId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
3188
3188
|
/**
|
|
3189
|
-
*
|
|
3189
|
+
* Retrieve detailed information about an organization.
|
|
3190
3190
|
* @summary Get the details of an Organization
|
|
3191
3191
|
* @param {string} organizationId The Organization identifier
|
|
3192
3192
|
* @param {*} [options] Override http request option.
|
|
@@ -3228,7 +3228,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
3228
3228
|
*/
|
|
3229
3229
|
listOrganizationSecurityUsers(organizationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
3230
3230
|
/**
|
|
3231
|
-
*
|
|
3231
|
+
* Retrieve a paginated list of all organizations the authenticated user has permission to view. Use \'page\' and \'size\' query parameters for pagination.
|
|
3232
3232
|
* @summary List all Organizations
|
|
3233
3233
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
3234
3234
|
* @param {number} [size] Amount of result by page
|
|
@@ -3288,7 +3288,7 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
3288
3288
|
*/
|
|
3289
3289
|
deleteRun: (organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3290
3290
|
/**
|
|
3291
|
-
*
|
|
3291
|
+
* Retrieve detailed information about a specific run.
|
|
3292
3292
|
* @summary Get the details of a run
|
|
3293
3293
|
* @param {string} organizationId The Organization identifier
|
|
3294
3294
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3299,7 +3299,7 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
3299
3299
|
*/
|
|
3300
3300
|
getRun: (organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3301
3301
|
/**
|
|
3302
|
-
*
|
|
3302
|
+
* Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.
|
|
3303
3303
|
* @summary get the logs for the Run
|
|
3304
3304
|
* @param {string} organizationId The Organization identifier
|
|
3305
3305
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3310,7 +3310,7 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
3310
3310
|
*/
|
|
3311
3311
|
getRunLogs: (organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3312
3312
|
/**
|
|
3313
|
-
*
|
|
3313
|
+
* Retrieve detailed execution status of a run.
|
|
3314
3314
|
* @summary get the status for the Run
|
|
3315
3315
|
* @param {string} organizationId The Organization identifier
|
|
3316
3316
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3321,7 +3321,7 @@ export declare const RunApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
3321
3321
|
*/
|
|
3322
3322
|
getRunStatus: (organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3323
3323
|
/**
|
|
3324
|
-
*
|
|
3324
|
+
* Retrieve a paginated list of all runs for a specific runner.
|
|
3325
3325
|
* @summary get the list of Runs for the Runner
|
|
3326
3326
|
* @param {string} organizationId The Organization identifier
|
|
3327
3327
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3349,7 +3349,7 @@ export declare const RunApiFp: (configuration?: Configuration) => {
|
|
|
3349
3349
|
*/
|
|
3350
3350
|
deleteRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3351
3351
|
/**
|
|
3352
|
-
*
|
|
3352
|
+
* Retrieve detailed information about a specific run.
|
|
3353
3353
|
* @summary Get the details of a run
|
|
3354
3354
|
* @param {string} organizationId The Organization identifier
|
|
3355
3355
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3360,7 +3360,7 @@ export declare const RunApiFp: (configuration?: Configuration) => {
|
|
|
3360
3360
|
*/
|
|
3361
3361
|
getRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Run>>;
|
|
3362
3362
|
/**
|
|
3363
|
-
*
|
|
3363
|
+
* Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.
|
|
3364
3364
|
* @summary get the logs for the Run
|
|
3365
3365
|
* @param {string} organizationId The Organization identifier
|
|
3366
3366
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3371,7 +3371,7 @@ export declare const RunApiFp: (configuration?: Configuration) => {
|
|
|
3371
3371
|
*/
|
|
3372
3372
|
getRunLogs(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3373
3373
|
/**
|
|
3374
|
-
*
|
|
3374
|
+
* Retrieve detailed execution status of a run.
|
|
3375
3375
|
* @summary get the status for the Run
|
|
3376
3376
|
* @param {string} organizationId The Organization identifier
|
|
3377
3377
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3382,7 +3382,7 @@ export declare const RunApiFp: (configuration?: Configuration) => {
|
|
|
3382
3382
|
*/
|
|
3383
3383
|
getRunStatus(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunStatus>>;
|
|
3384
3384
|
/**
|
|
3385
|
-
*
|
|
3385
|
+
* Retrieve a paginated list of all runs for a specific runner.
|
|
3386
3386
|
* @summary get the list of Runs for the Runner
|
|
3387
3387
|
* @param {string} organizationId The Organization identifier
|
|
3388
3388
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3410,7 +3410,7 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
3410
3410
|
*/
|
|
3411
3411
|
deleteRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3412
3412
|
/**
|
|
3413
|
-
*
|
|
3413
|
+
* Retrieve detailed information about a specific run.
|
|
3414
3414
|
* @summary Get the details of a run
|
|
3415
3415
|
* @param {string} organizationId The Organization identifier
|
|
3416
3416
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3421,7 +3421,7 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
3421
3421
|
*/
|
|
3422
3422
|
getRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): AxiosPromise<Run>;
|
|
3423
3423
|
/**
|
|
3424
|
-
*
|
|
3424
|
+
* Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.
|
|
3425
3425
|
* @summary get the logs for the Run
|
|
3426
3426
|
* @param {string} organizationId The Organization identifier
|
|
3427
3427
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3432,7 +3432,7 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
3432
3432
|
*/
|
|
3433
3433
|
getRunLogs(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
3434
3434
|
/**
|
|
3435
|
-
*
|
|
3435
|
+
* Retrieve detailed execution status of a run.
|
|
3436
3436
|
* @summary get the status for the Run
|
|
3437
3437
|
* @param {string} organizationId The Organization identifier
|
|
3438
3438
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3443,7 +3443,7 @@ export declare const RunApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
3443
3443
|
*/
|
|
3444
3444
|
getRunStatus(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): AxiosPromise<RunStatus>;
|
|
3445
3445
|
/**
|
|
3446
|
-
*
|
|
3446
|
+
* Retrieve a paginated list of all runs for a specific runner.
|
|
3447
3447
|
* @summary get the list of Runs for the Runner
|
|
3448
3448
|
* @param {string} organizationId The Organization identifier
|
|
3449
3449
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3471,7 +3471,7 @@ export declare class RunApi extends BaseAPI {
|
|
|
3471
3471
|
*/
|
|
3472
3472
|
deleteRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
3473
3473
|
/**
|
|
3474
|
-
*
|
|
3474
|
+
* Retrieve detailed information about a specific run.
|
|
3475
3475
|
* @summary Get the details of a run
|
|
3476
3476
|
* @param {string} organizationId The Organization identifier
|
|
3477
3477
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3482,7 +3482,7 @@ export declare class RunApi extends BaseAPI {
|
|
|
3482
3482
|
*/
|
|
3483
3483
|
getRun(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Run, any, {}>>;
|
|
3484
3484
|
/**
|
|
3485
|
-
*
|
|
3485
|
+
* Retrieve execution logs for a run as plain text. Logs are aggregated from all containers. May be truncated for long-running simulations.
|
|
3486
3486
|
* @summary get the logs for the Run
|
|
3487
3487
|
* @param {string} organizationId The Organization identifier
|
|
3488
3488
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3493,7 +3493,7 @@ export declare class RunApi extends BaseAPI {
|
|
|
3493
3493
|
*/
|
|
3494
3494
|
getRunLogs(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
3495
3495
|
/**
|
|
3496
|
-
*
|
|
3496
|
+
* Retrieve detailed execution status of a run.
|
|
3497
3497
|
* @summary get the status for the Run
|
|
3498
3498
|
* @param {string} organizationId The Organization identifier
|
|
3499
3499
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3504,7 +3504,7 @@ export declare class RunApi extends BaseAPI {
|
|
|
3504
3504
|
*/
|
|
3505
3505
|
getRunStatus(organizationId: string, workspaceId: string, runnerId: string, runId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunStatus, any, {}>>;
|
|
3506
3506
|
/**
|
|
3507
|
-
*
|
|
3507
|
+
* Retrieve a paginated list of all runs for a specific runner.
|
|
3508
3508
|
* @summary get the list of Runs for the Runner
|
|
3509
3509
|
* @param {string} organizationId The Organization identifier
|
|
3510
3510
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -3521,7 +3521,7 @@ export declare class RunApi extends BaseAPI {
|
|
|
3521
3521
|
*/
|
|
3522
3522
|
export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3523
3523
|
/**
|
|
3524
|
-
*
|
|
3524
|
+
* Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.
|
|
3525
3525
|
* @summary Create a new Runner
|
|
3526
3526
|
* @param {string} organizationId the Organization identifier
|
|
3527
3527
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3531,7 +3531,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3531
3531
|
*/
|
|
3532
3532
|
createRunner: (organizationId: string, workspaceId: string, runnerCreateRequest: RunnerCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3533
3533
|
/**
|
|
3534
|
-
*
|
|
3534
|
+
* Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.
|
|
3535
3535
|
* @summary Add a control access to the Runner
|
|
3536
3536
|
* @param {string} organizationId the Organization identifier
|
|
3537
3537
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3542,7 +3542,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3542
3542
|
*/
|
|
3543
3543
|
createRunnerAccessControl: (organizationId: string, workspaceId: string, runnerId: string, runnerAccessControl: RunnerAccessControl, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3544
3544
|
/**
|
|
3545
|
-
*
|
|
3545
|
+
* Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.
|
|
3546
3546
|
* @summary Delete a runner
|
|
3547
3547
|
* @param {string} organizationId the Organization identifier
|
|
3548
3548
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3563,7 +3563,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3563
3563
|
*/
|
|
3564
3564
|
deleteRunnerAccessControl: (organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3565
3565
|
/**
|
|
3566
|
-
*
|
|
3566
|
+
* Retrieve detailed information about a runner.
|
|
3567
3567
|
* @summary Get the details of a runner
|
|
3568
3568
|
* @param {string} organizationId the Organization identifier
|
|
3569
3569
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3615,7 +3615,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3615
3615
|
*/
|
|
3616
3616
|
listRunnerSecurityUsers: (organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3617
3617
|
/**
|
|
3618
|
-
*
|
|
3618
|
+
* Retrieve a paginated list of all runners in a workspace.
|
|
3619
3619
|
* @summary List all Runners
|
|
3620
3620
|
* @param {string} organizationId the Organization identifier
|
|
3621
3621
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3626,7 +3626,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3626
3626
|
*/
|
|
3627
3627
|
listRunners: (organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3628
3628
|
/**
|
|
3629
|
-
*
|
|
3629
|
+
* Start a new simulation run using the runner\'s current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress
|
|
3630
3630
|
* @summary Start a run with runner parameters
|
|
3631
3631
|
* @param {string} organizationId the Organization identifier
|
|
3632
3632
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3636,7 +3636,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3636
3636
|
*/
|
|
3637
3637
|
startRun: (organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3638
3638
|
/**
|
|
3639
|
-
*
|
|
3639
|
+
* Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.
|
|
3640
3640
|
* @summary Stop the last run
|
|
3641
3641
|
* @param {string} organizationId the Organization identifier
|
|
3642
3642
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3685,7 +3685,7 @@ export declare const RunnerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
3685
3685
|
*/
|
|
3686
3686
|
export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
3687
3687
|
/**
|
|
3688
|
-
*
|
|
3688
|
+
* Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.
|
|
3689
3689
|
* @summary Create a new Runner
|
|
3690
3690
|
* @param {string} organizationId the Organization identifier
|
|
3691
3691
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3695,7 +3695,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3695
3695
|
*/
|
|
3696
3696
|
createRunner(organizationId: string, workspaceId: string, runnerCreateRequest: RunnerCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Runner>>;
|
|
3697
3697
|
/**
|
|
3698
|
-
*
|
|
3698
|
+
* Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.
|
|
3699
3699
|
* @summary Add a control access to the Runner
|
|
3700
3700
|
* @param {string} organizationId the Organization identifier
|
|
3701
3701
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3706,7 +3706,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3706
3706
|
*/
|
|
3707
3707
|
createRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, runnerAccessControl: RunnerAccessControl, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunnerAccessControl>>;
|
|
3708
3708
|
/**
|
|
3709
|
-
*
|
|
3709
|
+
* Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.
|
|
3710
3710
|
* @summary Delete a runner
|
|
3711
3711
|
* @param {string} organizationId the Organization identifier
|
|
3712
3712
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3727,7 +3727,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3727
3727
|
*/
|
|
3728
3728
|
deleteRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3729
3729
|
/**
|
|
3730
|
-
*
|
|
3730
|
+
* Retrieve detailed information about a runner.
|
|
3731
3731
|
* @summary Get the details of a runner
|
|
3732
3732
|
* @param {string} organizationId the Organization identifier
|
|
3733
3733
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3779,7 +3779,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3779
3779
|
*/
|
|
3780
3780
|
listRunnerSecurityUsers(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
3781
3781
|
/**
|
|
3782
|
-
*
|
|
3782
|
+
* Retrieve a paginated list of all runners in a workspace.
|
|
3783
3783
|
* @summary List all Runners
|
|
3784
3784
|
* @param {string} organizationId the Organization identifier
|
|
3785
3785
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3790,7 +3790,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3790
3790
|
*/
|
|
3791
3791
|
listRunners(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Runner>>>;
|
|
3792
3792
|
/**
|
|
3793
|
-
*
|
|
3793
|
+
* Start a new simulation run using the runner\'s current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress
|
|
3794
3794
|
* @summary Start a run with runner parameters
|
|
3795
3795
|
* @param {string} organizationId the Organization identifier
|
|
3796
3796
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3800,7 +3800,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3800
3800
|
*/
|
|
3801
3801
|
startRun(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatedRun>>;
|
|
3802
3802
|
/**
|
|
3803
|
-
*
|
|
3803
|
+
* Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.
|
|
3804
3804
|
* @summary Stop the last run
|
|
3805
3805
|
* @param {string} organizationId the Organization identifier
|
|
3806
3806
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3849,7 +3849,7 @@ export declare const RunnerApiFp: (configuration?: Configuration) => {
|
|
|
3849
3849
|
*/
|
|
3850
3850
|
export declare const RunnerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3851
3851
|
/**
|
|
3852
|
-
*
|
|
3852
|
+
* Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.
|
|
3853
3853
|
* @summary Create a new Runner
|
|
3854
3854
|
* @param {string} organizationId the Organization identifier
|
|
3855
3855
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3859,7 +3859,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3859
3859
|
*/
|
|
3860
3860
|
createRunner(organizationId: string, workspaceId: string, runnerCreateRequest: RunnerCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Runner>;
|
|
3861
3861
|
/**
|
|
3862
|
-
*
|
|
3862
|
+
* Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.
|
|
3863
3863
|
* @summary Add a control access to the Runner
|
|
3864
3864
|
* @param {string} organizationId the Organization identifier
|
|
3865
3865
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3870,7 +3870,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3870
3870
|
*/
|
|
3871
3871
|
createRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, runnerAccessControl: RunnerAccessControl, options?: RawAxiosRequestConfig): AxiosPromise<RunnerAccessControl>;
|
|
3872
3872
|
/**
|
|
3873
|
-
*
|
|
3873
|
+
* Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.
|
|
3874
3874
|
* @summary Delete a runner
|
|
3875
3875
|
* @param {string} organizationId the Organization identifier
|
|
3876
3876
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3891,7 +3891,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3891
3891
|
*/
|
|
3892
3892
|
deleteRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3893
3893
|
/**
|
|
3894
|
-
*
|
|
3894
|
+
* Retrieve detailed information about a runner.
|
|
3895
3895
|
* @summary Get the details of a runner
|
|
3896
3896
|
* @param {string} organizationId the Organization identifier
|
|
3897
3897
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3943,7 +3943,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3943
3943
|
*/
|
|
3944
3944
|
listRunnerSecurityUsers(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
3945
3945
|
/**
|
|
3946
|
-
*
|
|
3946
|
+
* Retrieve a paginated list of all runners in a workspace.
|
|
3947
3947
|
* @summary List all Runners
|
|
3948
3948
|
* @param {string} organizationId the Organization identifier
|
|
3949
3949
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3954,7 +3954,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3954
3954
|
*/
|
|
3955
3955
|
listRunners(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Runner>>;
|
|
3956
3956
|
/**
|
|
3957
|
-
*
|
|
3957
|
+
* Start a new simulation run using the runner\'s current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress
|
|
3958
3958
|
* @summary Start a run with runner parameters
|
|
3959
3959
|
* @param {string} organizationId the Organization identifier
|
|
3960
3960
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -3964,7 +3964,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
3964
3964
|
*/
|
|
3965
3965
|
startRun(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): AxiosPromise<CreatedRun>;
|
|
3966
3966
|
/**
|
|
3967
|
-
*
|
|
3967
|
+
* Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.
|
|
3968
3968
|
* @summary Stop the last run
|
|
3969
3969
|
* @param {string} organizationId the Organization identifier
|
|
3970
3970
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4013,7 +4013,7 @@ export declare const RunnerApiFactory: (configuration?: Configuration, basePath?
|
|
|
4013
4013
|
*/
|
|
4014
4014
|
export declare class RunnerApi extends BaseAPI {
|
|
4015
4015
|
/**
|
|
4016
|
-
*
|
|
4016
|
+
* Create a new runner for executing simulations. Use parentId to create a child runner that inherits configuration from a parent.
|
|
4017
4017
|
* @summary Create a new Runner
|
|
4018
4018
|
* @param {string} organizationId the Organization identifier
|
|
4019
4019
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4023,7 +4023,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4023
4023
|
*/
|
|
4024
4024
|
createRunner(organizationId: string, workspaceId: string, runnerCreateRequest: RunnerCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner, any, {}>>;
|
|
4025
4025
|
/**
|
|
4026
|
-
*
|
|
4026
|
+
* Grant access to a runner for a user or group. Valid roles: viewer, editor, validator (can validate runs), admin.
|
|
4027
4027
|
* @summary Add a control access to the Runner
|
|
4028
4028
|
* @param {string} organizationId the Organization identifier
|
|
4029
4029
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4034,7 +4034,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4034
4034
|
*/
|
|
4035
4035
|
createRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, runnerAccessControl: RunnerAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunnerAccessControl, any, {}>>;
|
|
4036
4036
|
/**
|
|
4037
|
-
*
|
|
4037
|
+
* Delete a runner. Cannot delete while runs are in progress. Note: Child runners that reference this runner are not deleted automatically.
|
|
4038
4038
|
* @summary Delete a runner
|
|
4039
4039
|
* @param {string} organizationId the Organization identifier
|
|
4040
4040
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4055,7 +4055,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4055
4055
|
*/
|
|
4056
4056
|
deleteRunnerAccessControl(organizationId: string, workspaceId: string, runnerId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
4057
4057
|
/**
|
|
4058
|
-
*
|
|
4058
|
+
* Retrieve detailed information about a runner.
|
|
4059
4059
|
* @summary Get the details of a runner
|
|
4060
4060
|
* @param {string} organizationId the Organization identifier
|
|
4061
4061
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4107,7 +4107,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4107
4107
|
*/
|
|
4108
4108
|
listRunnerSecurityUsers(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
4109
4109
|
/**
|
|
4110
|
-
*
|
|
4110
|
+
* Retrieve a paginated list of all runners in a workspace.
|
|
4111
4111
|
* @summary List all Runners
|
|
4112
4112
|
* @param {string} organizationId the Organization identifier
|
|
4113
4113
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4118,7 +4118,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4118
4118
|
*/
|
|
4119
4119
|
listRunners(organizationId: string, workspaceId: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Runner[], any, {}>>;
|
|
4120
4120
|
/**
|
|
4121
|
-
*
|
|
4121
|
+
* Start a new simulation run using the runner\'s current configuration. Returns the run Id. The run executes asynchronously - use the run status endpoint to monitor progress
|
|
4122
4122
|
* @summary Start a run with runner parameters
|
|
4123
4123
|
* @param {string} organizationId the Organization identifier
|
|
4124
4124
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4128,7 +4128,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4128
4128
|
*/
|
|
4129
4129
|
startRun(organizationId: string, workspaceId: string, runnerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatedRun, any, {}>>;
|
|
4130
4130
|
/**
|
|
4131
|
-
*
|
|
4131
|
+
* Stop the currently executing run for this runner. The stop operation is asynchronous - the run may continue briefly before stopping.
|
|
4132
4132
|
* @summary Stop the last run
|
|
4133
4133
|
* @param {string} organizationId the Organization identifier
|
|
4134
4134
|
* @param {string} workspaceId the Workspace identifier
|
|
@@ -4177,7 +4177,7 @@ export declare class RunnerApi extends BaseAPI {
|
|
|
4177
4177
|
*/
|
|
4178
4178
|
export declare const SolutionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4179
4179
|
/**
|
|
4180
|
-
*
|
|
4180
|
+
* Create a new solution with optional run templates and parameter definitions.
|
|
4181
4181
|
* @summary Create a new solution
|
|
4182
4182
|
* @param {string} organizationId the Organization identifier
|
|
4183
4183
|
* @param {SolutionCreateRequest} solutionCreateRequest The Solution to create
|
|
@@ -4186,7 +4186,7 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4186
4186
|
*/
|
|
4187
4187
|
createSolution: (organizationId: string, solutionCreateRequest: SolutionCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4188
4188
|
/**
|
|
4189
|
-
*
|
|
4189
|
+
* Grant access to a solution for a user or group.
|
|
4190
4190
|
* @summary Create solution access control
|
|
4191
4191
|
* @param {string} organizationId the Organization identifier
|
|
4192
4192
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4285,7 +4285,7 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4285
4285
|
*/
|
|
4286
4286
|
getRunTemplate: (organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4287
4287
|
/**
|
|
4288
|
-
*
|
|
4288
|
+
* Retrieve detailed information about a solution.
|
|
4289
4289
|
* @summary Get the details of a solution
|
|
4290
4290
|
* @param {string} organizationId the Organization identifier
|
|
4291
4291
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4369,7 +4369,7 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4369
4369
|
*/
|
|
4370
4370
|
listSolutionSecurityUsers: (organizationId: string, solutionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4371
4371
|
/**
|
|
4372
|
-
*
|
|
4372
|
+
* Retrieve a paginated list of all solutions in an organization that the user has permission to view.
|
|
4373
4373
|
* @summary List all Solutions
|
|
4374
4374
|
* @param {string} organizationId the Organization identifier
|
|
4375
4375
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -4448,7 +4448,7 @@ export declare const SolutionApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
4448
4448
|
*/
|
|
4449
4449
|
export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
4450
4450
|
/**
|
|
4451
|
-
*
|
|
4451
|
+
* Create a new solution with optional run templates and parameter definitions.
|
|
4452
4452
|
* @summary Create a new solution
|
|
4453
4453
|
* @param {string} organizationId the Organization identifier
|
|
4454
4454
|
* @param {SolutionCreateRequest} solutionCreateRequest The Solution to create
|
|
@@ -4457,7 +4457,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
4457
4457
|
*/
|
|
4458
4458
|
createSolution(organizationId: string, solutionCreateRequest: SolutionCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Solution>>;
|
|
4459
4459
|
/**
|
|
4460
|
-
*
|
|
4460
|
+
* Grant access to a solution for a user or group.
|
|
4461
4461
|
* @summary Create solution access control
|
|
4462
4462
|
* @param {string} organizationId the Organization identifier
|
|
4463
4463
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4556,7 +4556,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
4556
4556
|
*/
|
|
4557
4557
|
getRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunTemplate>>;
|
|
4558
4558
|
/**
|
|
4559
|
-
*
|
|
4559
|
+
* Retrieve detailed information about a solution.
|
|
4560
4560
|
* @summary Get the details of a solution
|
|
4561
4561
|
* @param {string} organizationId the Organization identifier
|
|
4562
4562
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4640,7 +4640,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
4640
4640
|
*/
|
|
4641
4641
|
listSolutionSecurityUsers(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
4642
4642
|
/**
|
|
4643
|
-
*
|
|
4643
|
+
* Retrieve a paginated list of all solutions in an organization that the user has permission to view.
|
|
4644
4644
|
* @summary List all Solutions
|
|
4645
4645
|
* @param {string} organizationId the Organization identifier
|
|
4646
4646
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -4719,7 +4719,7 @@ export declare const SolutionApiFp: (configuration?: Configuration) => {
|
|
|
4719
4719
|
*/
|
|
4720
4720
|
export declare const SolutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4721
4721
|
/**
|
|
4722
|
-
*
|
|
4722
|
+
* Create a new solution with optional run templates and parameter definitions.
|
|
4723
4723
|
* @summary Create a new solution
|
|
4724
4724
|
* @param {string} organizationId the Organization identifier
|
|
4725
4725
|
* @param {SolutionCreateRequest} solutionCreateRequest The Solution to create
|
|
@@ -4728,7 +4728,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
4728
4728
|
*/
|
|
4729
4729
|
createSolution(organizationId: string, solutionCreateRequest: SolutionCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Solution>;
|
|
4730
4730
|
/**
|
|
4731
|
-
*
|
|
4731
|
+
* Grant access to a solution for a user or group.
|
|
4732
4732
|
* @summary Create solution access control
|
|
4733
4733
|
* @param {string} organizationId the Organization identifier
|
|
4734
4734
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4827,7 +4827,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
4827
4827
|
*/
|
|
4828
4828
|
getRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig): AxiosPromise<RunTemplate>;
|
|
4829
4829
|
/**
|
|
4830
|
-
*
|
|
4830
|
+
* Retrieve detailed information about a solution.
|
|
4831
4831
|
* @summary Get the details of a solution
|
|
4832
4832
|
* @param {string} organizationId the Organization identifier
|
|
4833
4833
|
* @param {string} solutionId the Solution identifier
|
|
@@ -4911,7 +4911,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
4911
4911
|
*/
|
|
4912
4912
|
listSolutionSecurityUsers(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
4913
4913
|
/**
|
|
4914
|
-
*
|
|
4914
|
+
* Retrieve a paginated list of all solutions in an organization that the user has permission to view.
|
|
4915
4915
|
* @summary List all Solutions
|
|
4916
4916
|
* @param {string} organizationId the Organization identifier
|
|
4917
4917
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -4990,7 +4990,7 @@ export declare const SolutionApiFactory: (configuration?: Configuration, basePat
|
|
|
4990
4990
|
*/
|
|
4991
4991
|
export declare class SolutionApi extends BaseAPI {
|
|
4992
4992
|
/**
|
|
4993
|
-
*
|
|
4993
|
+
* Create a new solution with optional run templates and parameter definitions.
|
|
4994
4994
|
* @summary Create a new solution
|
|
4995
4995
|
* @param {string} organizationId the Organization identifier
|
|
4996
4996
|
* @param {SolutionCreateRequest} solutionCreateRequest The Solution to create
|
|
@@ -4999,7 +4999,7 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
4999
4999
|
*/
|
|
5000
5000
|
createSolution(organizationId: string, solutionCreateRequest: SolutionCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Solution, any, {}>>;
|
|
5001
5001
|
/**
|
|
5002
|
-
*
|
|
5002
|
+
* Grant access to a solution for a user or group.
|
|
5003
5003
|
* @summary Create solution access control
|
|
5004
5004
|
* @param {string} organizationId the Organization identifier
|
|
5005
5005
|
* @param {string} solutionId the Solution identifier
|
|
@@ -5098,7 +5098,7 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
5098
5098
|
*/
|
|
5099
5099
|
getRunTemplate(organizationId: string, solutionId: string, runTemplateId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RunTemplate, any, {}>>;
|
|
5100
5100
|
/**
|
|
5101
|
-
*
|
|
5101
|
+
* Retrieve detailed information about a solution.
|
|
5102
5102
|
* @summary Get the details of a solution
|
|
5103
5103
|
* @param {string} organizationId the Organization identifier
|
|
5104
5104
|
* @param {string} solutionId the Solution identifier
|
|
@@ -5182,7 +5182,7 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
5182
5182
|
*/
|
|
5183
5183
|
listSolutionSecurityUsers(organizationId: string, solutionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
5184
5184
|
/**
|
|
5185
|
-
*
|
|
5185
|
+
* Retrieve a paginated list of all solutions in an organization that the user has permission to view.
|
|
5186
5186
|
* @summary List all Solutions
|
|
5187
5187
|
* @param {string} organizationId the Organization identifier
|
|
5188
5188
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -5261,7 +5261,7 @@ export declare class SolutionApi extends BaseAPI {
|
|
|
5261
5261
|
*/
|
|
5262
5262
|
export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5263
5263
|
/**
|
|
5264
|
-
*
|
|
5264
|
+
* Create a new workspace.
|
|
5265
5265
|
* @summary Create a new workspace
|
|
5266
5266
|
* @param {string} organizationId The Organization identifier
|
|
5267
5267
|
* @param {WorkspaceCreateRequest} workspaceCreateRequest The Workspace to create
|
|
@@ -5270,7 +5270,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5270
5270
|
*/
|
|
5271
5271
|
createWorkspace: (organizationId: string, workspaceCreateRequest: WorkspaceCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5272
5272
|
/**
|
|
5273
|
-
*
|
|
5273
|
+
* Grant access to a workspace for a user or group.
|
|
5274
5274
|
* @summary Add a control access to the Workspace
|
|
5275
5275
|
* @param {string} organizationId The Organization identifier
|
|
5276
5276
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5280,7 +5280,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5280
5280
|
*/
|
|
5281
5281
|
createWorkspaceAccessControl: (organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5282
5282
|
/**
|
|
5283
|
-
*
|
|
5283
|
+
* Upload a file to workspace storage. Use \'destination\' to specify path, \'overwrite\' to replace existing files.
|
|
5284
5284
|
* @summary Upload a file for the Workspace
|
|
5285
5285
|
* @param {string} organizationId The Organization identifier
|
|
5286
5286
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5292,7 +5292,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5292
5292
|
*/
|
|
5293
5293
|
createWorkspaceFile: (organizationId: string, workspaceId: string, file: File, overwrite?: boolean, destination?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5294
5294
|
/**
|
|
5295
|
-
*
|
|
5295
|
+
* Permanently delete a workspace.
|
|
5296
5296
|
* @summary Delete a workspace
|
|
5297
5297
|
* @param {string} organizationId The Organization identifier
|
|
5298
5298
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5301,7 +5301,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5301
5301
|
*/
|
|
5302
5302
|
deleteWorkspace: (organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5303
5303
|
/**
|
|
5304
|
-
*
|
|
5304
|
+
* Remove a user\'s access to a workspace. Cannot remove the last administrator.
|
|
5305
5305
|
* @summary Remove the specified access from the given Workspace
|
|
5306
5306
|
* @param {string} organizationId The Organization identifier
|
|
5307
5307
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5330,7 +5330,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5330
5330
|
*/
|
|
5331
5331
|
deleteWorkspaceFiles: (organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5332
5332
|
/**
|
|
5333
|
-
*
|
|
5333
|
+
* Retrieve detailed information about a workspace.
|
|
5334
5334
|
* @summary Get the details of a workspace
|
|
5335
5335
|
* @param {string} organizationId The Organization identifier
|
|
5336
5336
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5349,7 +5349,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5349
5349
|
*/
|
|
5350
5350
|
getWorkspaceAccessControl: (organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5351
5351
|
/**
|
|
5352
|
-
*
|
|
5352
|
+
* Download a specific file from workspace storage. Returns file as binary stream.
|
|
5353
5353
|
* @summary Download the Workspace File specified
|
|
5354
5354
|
* @param {string} organizationId The Organization identifier
|
|
5355
5355
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5396,7 +5396,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5396
5396
|
*/
|
|
5397
5397
|
listWorkspaceSecurityUsers: (organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5398
5398
|
/**
|
|
5399
|
-
*
|
|
5399
|
+
* Retrieve a paginated list of all workspaces in an organization that the user has permission to view.
|
|
5400
5400
|
* @summary List all Workspaces
|
|
5401
5401
|
* @param {string} organizationId The Organization identifier
|
|
5402
5402
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -5442,7 +5442,7 @@ export declare const WorkspaceApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5442
5442
|
*/
|
|
5443
5443
|
export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
5444
5444
|
/**
|
|
5445
|
-
*
|
|
5445
|
+
* Create a new workspace.
|
|
5446
5446
|
* @summary Create a new workspace
|
|
5447
5447
|
* @param {string} organizationId The Organization identifier
|
|
5448
5448
|
* @param {WorkspaceCreateRequest} workspaceCreateRequest The Workspace to create
|
|
@@ -5451,7 +5451,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5451
5451
|
*/
|
|
5452
5452
|
createWorkspace(organizationId: string, workspaceCreateRequest: WorkspaceCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>>;
|
|
5453
5453
|
/**
|
|
5454
|
-
*
|
|
5454
|
+
* Grant access to a workspace for a user or group.
|
|
5455
5455
|
* @summary Add a control access to the Workspace
|
|
5456
5456
|
* @param {string} organizationId The Organization identifier
|
|
5457
5457
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5461,7 +5461,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5461
5461
|
*/
|
|
5462
5462
|
createWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceAccessControl>>;
|
|
5463
5463
|
/**
|
|
5464
|
-
*
|
|
5464
|
+
* Upload a file to workspace storage. Use \'destination\' to specify path, \'overwrite\' to replace existing files.
|
|
5465
5465
|
* @summary Upload a file for the Workspace
|
|
5466
5466
|
* @param {string} organizationId The Organization identifier
|
|
5467
5467
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5473,7 +5473,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5473
5473
|
*/
|
|
5474
5474
|
createWorkspaceFile(organizationId: string, workspaceId: string, file: File, overwrite?: boolean, destination?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceFile>>;
|
|
5475
5475
|
/**
|
|
5476
|
-
*
|
|
5476
|
+
* Permanently delete a workspace.
|
|
5477
5477
|
* @summary Delete a workspace
|
|
5478
5478
|
* @param {string} organizationId The Organization identifier
|
|
5479
5479
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5482,7 +5482,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5482
5482
|
*/
|
|
5483
5483
|
deleteWorkspace(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5484
5484
|
/**
|
|
5485
|
-
*
|
|
5485
|
+
* Remove a user\'s access to a workspace. Cannot remove the last administrator.
|
|
5486
5486
|
* @summary Remove the specified access from the given Workspace
|
|
5487
5487
|
* @param {string} organizationId The Organization identifier
|
|
5488
5488
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5511,7 +5511,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5511
5511
|
*/
|
|
5512
5512
|
deleteWorkspaceFiles(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5513
5513
|
/**
|
|
5514
|
-
*
|
|
5514
|
+
* Retrieve detailed information about a workspace.
|
|
5515
5515
|
* @summary Get the details of a workspace
|
|
5516
5516
|
* @param {string} organizationId The Organization identifier
|
|
5517
5517
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5530,7 +5530,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5530
5530
|
*/
|
|
5531
5531
|
getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkspaceAccessControl>>;
|
|
5532
5532
|
/**
|
|
5533
|
-
*
|
|
5533
|
+
* Download a specific file from workspace storage. Returns file as binary stream.
|
|
5534
5534
|
* @summary Download the Workspace File specified
|
|
5535
5535
|
* @param {string} organizationId The Organization identifier
|
|
5536
5536
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5577,7 +5577,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5577
5577
|
*/
|
|
5578
5578
|
listWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5579
5579
|
/**
|
|
5580
|
-
*
|
|
5580
|
+
* Retrieve a paginated list of all workspaces in an organization that the user has permission to view.
|
|
5581
5581
|
* @summary List all Workspaces
|
|
5582
5582
|
* @param {string} organizationId The Organization identifier
|
|
5583
5583
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -5623,7 +5623,7 @@ export declare const WorkspaceApiFp: (configuration?: Configuration) => {
|
|
|
5623
5623
|
*/
|
|
5624
5624
|
export declare const WorkspaceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5625
5625
|
/**
|
|
5626
|
-
*
|
|
5626
|
+
* Create a new workspace.
|
|
5627
5627
|
* @summary Create a new workspace
|
|
5628
5628
|
* @param {string} organizationId The Organization identifier
|
|
5629
5629
|
* @param {WorkspaceCreateRequest} workspaceCreateRequest The Workspace to create
|
|
@@ -5632,7 +5632,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5632
5632
|
*/
|
|
5633
5633
|
createWorkspace(organizationId: string, workspaceCreateRequest: WorkspaceCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Workspace>;
|
|
5634
5634
|
/**
|
|
5635
|
-
*
|
|
5635
|
+
* Grant access to a workspace for a user or group.
|
|
5636
5636
|
* @summary Add a control access to the Workspace
|
|
5637
5637
|
* @param {string} organizationId The Organization identifier
|
|
5638
5638
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5642,7 +5642,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5642
5642
|
*/
|
|
5643
5643
|
createWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: RawAxiosRequestConfig): AxiosPromise<WorkspaceAccessControl>;
|
|
5644
5644
|
/**
|
|
5645
|
-
*
|
|
5645
|
+
* Upload a file to workspace storage. Use \'destination\' to specify path, \'overwrite\' to replace existing files.
|
|
5646
5646
|
* @summary Upload a file for the Workspace
|
|
5647
5647
|
* @param {string} organizationId The Organization identifier
|
|
5648
5648
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5654,7 +5654,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5654
5654
|
*/
|
|
5655
5655
|
createWorkspaceFile(organizationId: string, workspaceId: string, file: File, overwrite?: boolean, destination?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkspaceFile>;
|
|
5656
5656
|
/**
|
|
5657
|
-
*
|
|
5657
|
+
* Permanently delete a workspace.
|
|
5658
5658
|
* @summary Delete a workspace
|
|
5659
5659
|
* @param {string} organizationId The Organization identifier
|
|
5660
5660
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5663,7 +5663,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5663
5663
|
*/
|
|
5664
5664
|
deleteWorkspace(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5665
5665
|
/**
|
|
5666
|
-
*
|
|
5666
|
+
* Remove a user\'s access to a workspace. Cannot remove the last administrator.
|
|
5667
5667
|
* @summary Remove the specified access from the given Workspace
|
|
5668
5668
|
* @param {string} organizationId The Organization identifier
|
|
5669
5669
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5692,7 +5692,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5692
5692
|
*/
|
|
5693
5693
|
deleteWorkspaceFiles(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5694
5694
|
/**
|
|
5695
|
-
*
|
|
5695
|
+
* Retrieve detailed information about a workspace.
|
|
5696
5696
|
* @summary Get the details of a workspace
|
|
5697
5697
|
* @param {string} organizationId The Organization identifier
|
|
5698
5698
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5711,7 +5711,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5711
5711
|
*/
|
|
5712
5712
|
getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkspaceAccessControl>;
|
|
5713
5713
|
/**
|
|
5714
|
-
*
|
|
5714
|
+
* Download a specific file from workspace storage. Returns file as binary stream.
|
|
5715
5715
|
* @summary Download the Workspace File specified
|
|
5716
5716
|
* @param {string} organizationId The Organization identifier
|
|
5717
5717
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5758,7 +5758,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5758
5758
|
*/
|
|
5759
5759
|
listWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5760
5760
|
/**
|
|
5761
|
-
*
|
|
5761
|
+
* Retrieve a paginated list of all workspaces in an organization that the user has permission to view.
|
|
5762
5762
|
* @summary List all Workspaces
|
|
5763
5763
|
* @param {string} organizationId The Organization identifier
|
|
5764
5764
|
* @param {number} [page] Page number to query (first page is at index 0)
|
|
@@ -5804,7 +5804,7 @@ export declare const WorkspaceApiFactory: (configuration?: Configuration, basePa
|
|
|
5804
5804
|
*/
|
|
5805
5805
|
export declare class WorkspaceApi extends BaseAPI {
|
|
5806
5806
|
/**
|
|
5807
|
-
*
|
|
5807
|
+
* Create a new workspace.
|
|
5808
5808
|
* @summary Create a new workspace
|
|
5809
5809
|
* @param {string} organizationId The Organization identifier
|
|
5810
5810
|
* @param {WorkspaceCreateRequest} workspaceCreateRequest The Workspace to create
|
|
@@ -5813,7 +5813,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5813
5813
|
*/
|
|
5814
5814
|
createWorkspace(organizationId: string, workspaceCreateRequest: WorkspaceCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Workspace, any, {}>>;
|
|
5815
5815
|
/**
|
|
5816
|
-
*
|
|
5816
|
+
* Grant access to a workspace for a user or group.
|
|
5817
5817
|
* @summary Add a control access to the Workspace
|
|
5818
5818
|
* @param {string} organizationId The Organization identifier
|
|
5819
5819
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5823,7 +5823,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5823
5823
|
*/
|
|
5824
5824
|
createWorkspaceAccessControl(organizationId: string, workspaceId: string, workspaceAccessControl: WorkspaceAccessControl, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl, any, {}>>;
|
|
5825
5825
|
/**
|
|
5826
|
-
*
|
|
5826
|
+
* Upload a file to workspace storage. Use \'destination\' to specify path, \'overwrite\' to replace existing files.
|
|
5827
5827
|
* @summary Upload a file for the Workspace
|
|
5828
5828
|
* @param {string} organizationId The Organization identifier
|
|
5829
5829
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5835,7 +5835,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5835
5835
|
*/
|
|
5836
5836
|
createWorkspaceFile(organizationId: string, workspaceId: string, file: File, overwrite?: boolean, destination?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceFile, any, {}>>;
|
|
5837
5837
|
/**
|
|
5838
|
-
*
|
|
5838
|
+
* Permanently delete a workspace.
|
|
5839
5839
|
* @summary Delete a workspace
|
|
5840
5840
|
* @param {string} organizationId The Organization identifier
|
|
5841
5841
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5844,7 +5844,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5844
5844
|
*/
|
|
5845
5845
|
deleteWorkspace(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
5846
5846
|
/**
|
|
5847
|
-
*
|
|
5847
|
+
* Remove a user\'s access to a workspace. Cannot remove the last administrator.
|
|
5848
5848
|
* @summary Remove the specified access from the given Workspace
|
|
5849
5849
|
* @param {string} organizationId The Organization identifier
|
|
5850
5850
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5873,7 +5873,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5873
5873
|
*/
|
|
5874
5874
|
deleteWorkspaceFiles(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
5875
5875
|
/**
|
|
5876
|
-
*
|
|
5876
|
+
* Retrieve detailed information about a workspace.
|
|
5877
5877
|
* @summary Get the details of a workspace
|
|
5878
5878
|
* @param {string} organizationId The Organization identifier
|
|
5879
5879
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5892,7 +5892,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5892
5892
|
*/
|
|
5893
5893
|
getWorkspaceAccessControl(organizationId: string, workspaceId: string, identityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkspaceAccessControl, any, {}>>;
|
|
5894
5894
|
/**
|
|
5895
|
-
*
|
|
5895
|
+
* Download a specific file from workspace storage. Returns file as binary stream.
|
|
5896
5896
|
* @summary Download the Workspace File specified
|
|
5897
5897
|
* @param {string} organizationId The Organization identifier
|
|
5898
5898
|
* @param {string} workspaceId The Workspace identifier
|
|
@@ -5939,7 +5939,7 @@ export declare class WorkspaceApi extends BaseAPI {
|
|
|
5939
5939
|
*/
|
|
5940
5940
|
listWorkspaceSecurityUsers(organizationId: string, workspaceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
5941
5941
|
/**
|
|
5942
|
-
*
|
|
5942
|
+
* Retrieve a paginated list of all workspaces in an organization that the user has permission to view.
|
|
5943
5943
|
* @summary List all Workspaces
|
|
5944
5944
|
* @param {string} organizationId The Organization identifier
|
|
5945
5945
|
* @param {number} [page] Page number to query (first page is at index 0)
|