@coscine/api-client 3.7.0 → 3.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +965 -778
- package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +63 -0
- package/dist/types/Coscine.Api/@coscine/api/application-profile-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/blob-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/discipline-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/handle-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/language-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/license-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/maintenance-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/organization-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/project-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-invitation-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/project-member-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-publication-request-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/project-quota-api.d.ts +12 -12
- package/dist/types/Coscine.Api/@coscine/api/project-resource-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-resource-quota-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/project-resource-type-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/provenance-api.d.ts +228 -0
- package/dist/types/Coscine.Api/@coscine/api/resource-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/resource-type-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/role-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/search-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/self-api-token-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/self-api.d.ts +24 -24
- package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/tos-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts +228 -23
- package/dist/types/Coscine.Api/@coscine/api/user-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/visibility-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/model/deployed-graph-dto-paged-response.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/deployed-graph-dto.d.ts +30 -0
- package/dist/types/Coscine.Api/@coscine/model/extracted-metadata-tree-for-creation-dto.d.ts +44 -0
- package/dist/types/Coscine.Api/@coscine/model/extracted-metadata-tree-for-update-dto.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/hash-parameters-dto.d.ts +30 -0
- package/dist/types/Coscine.Api/@coscine/model/index.d.ts +11 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto.d.ts +13 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-for-deletion-dto.d.ts +36 -0
- package/dist/types/Coscine.Api/@coscine/model/provenance-dto-response.d.ts +43 -0
- package/dist/types/Coscine.Api/@coscine/model/provenance-dto.d.ts +62 -0
- package/dist/types/Coscine.Api/@coscine/model/provenance-for-update-dto.d.ts +62 -0
- package/dist/types/Coscine.Api/@coscine/model/provenance-parameters-dto.d.ts +56 -0
- package/dist/types/Coscine.Api/@coscine/model/rdf-format.d.ts +1 -0
- package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/resource-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/variant-dto.d.ts +30 -0
- package/dist/types/Coscine.Api/api.d.ts +1 -0
- package/dist/types/apis.d.ts +4 -0
- package/dist/types/index.d.ts +8 -0
- package/package.json +1 -1
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Coscine Web API
|
|
3
|
+
* Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0
|
|
6
|
+
* Contact: servicedesk@itc.rwth-aachen.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../../base';
|
|
15
|
+
import { ProvenanceDtoResponse } from '../../@coscine/model';
|
|
16
|
+
import { ProvenanceForUpdateDto } from '../../@coscine/model';
|
|
17
|
+
/**
|
|
18
|
+
* ProvenanceApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const ProvenanceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
25
|
+
* @param {string} projectId
|
|
26
|
+
* @param {string} resourceId
|
|
27
|
+
* @param {*} [options] Override http request option.
|
|
28
|
+
* @throws {RequiredError}
|
|
29
|
+
*/
|
|
30
|
+
apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions: (projectId: string, resourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @summary Retrieves the specific provenance information associated with a resource.
|
|
34
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
35
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
36
|
+
* @param {string} path Gets or sets the path of the metadata tree.
|
|
37
|
+
* @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
getSpecificProvenance: (projectId: string, resourceId: string, path: string, version?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
+
/**
|
|
43
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
44
|
+
* @summary Updates existing specific provenance information of a resource.
|
|
45
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
46
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
47
|
+
* @param {ProvenanceForUpdateDto} [provenanceForUpdateDto] The updated provenance information.
|
|
48
|
+
* @param {*} [options] Override http request option.
|
|
49
|
+
* @throws {RequiredError}
|
|
50
|
+
*/
|
|
51
|
+
updateSpecificProvenance: (projectId: string, resourceId: string, provenanceForUpdateDto?: ProvenanceForUpdateDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* ProvenanceApi - functional programming interface
|
|
55
|
+
* @export
|
|
56
|
+
*/
|
|
57
|
+
export declare const ProvenanceApiFp: (configuration?: Configuration) => {
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
61
|
+
* @param {string} projectId
|
|
62
|
+
* @param {string} resourceId
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(projectId: string, resourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @summary Retrieves the specific provenance information associated with a resource.
|
|
70
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
71
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
72
|
+
* @param {string} path Gets or sets the path of the metadata tree.
|
|
73
|
+
* @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
getSpecificProvenance(projectId: string, resourceId: string, path: string, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProvenanceDtoResponse>>;
|
|
78
|
+
/**
|
|
79
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
80
|
+
* @summary Updates existing specific provenance information of a resource.
|
|
81
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
82
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
83
|
+
* @param {ProvenanceForUpdateDto} [provenanceForUpdateDto] The updated provenance information.
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
updateSpecificProvenance(projectId: string, resourceId: string, provenanceForUpdateDto?: ProvenanceForUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* ProvenanceApi - factory interface
|
|
91
|
+
* @export
|
|
92
|
+
*/
|
|
93
|
+
export declare const ProvenanceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
94
|
+
/**
|
|
95
|
+
*
|
|
96
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
97
|
+
* @param {ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest} requestParameters Request parameters.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters: ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @summary Retrieves the specific provenance information associated with a resource.
|
|
105
|
+
* @param {ProvenanceApiGetSpecificProvenanceRequest} requestParameters Request parameters.
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
getSpecificProvenance(requestParameters: ProvenanceApiGetSpecificProvenanceRequest, options?: AxiosRequestConfig): AxiosPromise<ProvenanceDtoResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
112
|
+
* @summary Updates existing specific provenance information of a resource.
|
|
113
|
+
* @param {ProvenanceApiUpdateSpecificProvenanceRequest} requestParameters Request parameters.
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
updateSpecificProvenance(requestParameters: ProvenanceApiUpdateSpecificProvenanceRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* Request parameters for apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions operation in ProvenanceApi.
|
|
121
|
+
* @export
|
|
122
|
+
* @interface ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest
|
|
123
|
+
*/
|
|
124
|
+
export interface ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest {
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @type {string}
|
|
128
|
+
* @memberof ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions
|
|
129
|
+
*/
|
|
130
|
+
readonly projectId: string;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions
|
|
135
|
+
*/
|
|
136
|
+
readonly resourceId: string;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Request parameters for getSpecificProvenance operation in ProvenanceApi.
|
|
140
|
+
* @export
|
|
141
|
+
* @interface ProvenanceApiGetSpecificProvenanceRequest
|
|
142
|
+
*/
|
|
143
|
+
export interface ProvenanceApiGetSpecificProvenanceRequest {
|
|
144
|
+
/**
|
|
145
|
+
* The unique identifier or slug of the project.
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof ProvenanceApiGetSpecificProvenance
|
|
148
|
+
*/
|
|
149
|
+
readonly projectId: string;
|
|
150
|
+
/**
|
|
151
|
+
* The unique identifier of the resource.
|
|
152
|
+
* @type {string}
|
|
153
|
+
* @memberof ProvenanceApiGetSpecificProvenance
|
|
154
|
+
*/
|
|
155
|
+
readonly resourceId: string;
|
|
156
|
+
/**
|
|
157
|
+
* Gets or sets the path of the metadata tree.
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof ProvenanceApiGetSpecificProvenance
|
|
160
|
+
*/
|
|
161
|
+
readonly path: string;
|
|
162
|
+
/**
|
|
163
|
+
* Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
164
|
+
* @type {number}
|
|
165
|
+
* @memberof ProvenanceApiGetSpecificProvenance
|
|
166
|
+
*/
|
|
167
|
+
readonly version?: number;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* Request parameters for updateSpecificProvenance operation in ProvenanceApi.
|
|
171
|
+
* @export
|
|
172
|
+
* @interface ProvenanceApiUpdateSpecificProvenanceRequest
|
|
173
|
+
*/
|
|
174
|
+
export interface ProvenanceApiUpdateSpecificProvenanceRequest {
|
|
175
|
+
/**
|
|
176
|
+
* The unique identifier or slug of the project.
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof ProvenanceApiUpdateSpecificProvenance
|
|
179
|
+
*/
|
|
180
|
+
readonly projectId: string;
|
|
181
|
+
/**
|
|
182
|
+
* The unique identifier of the resource.
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof ProvenanceApiUpdateSpecificProvenance
|
|
185
|
+
*/
|
|
186
|
+
readonly resourceId: string;
|
|
187
|
+
/**
|
|
188
|
+
* The updated provenance information.
|
|
189
|
+
* @type {ProvenanceForUpdateDto}
|
|
190
|
+
* @memberof ProvenanceApiUpdateSpecificProvenance
|
|
191
|
+
*/
|
|
192
|
+
readonly provenanceForUpdateDto?: ProvenanceForUpdateDto;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* ProvenanceApi - object-oriented interface
|
|
196
|
+
* @export
|
|
197
|
+
* @class ProvenanceApi
|
|
198
|
+
* @extends {BaseAPI}
|
|
199
|
+
*/
|
|
200
|
+
export declare class ProvenanceApi extends BaseAPI {
|
|
201
|
+
/**
|
|
202
|
+
*
|
|
203
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
204
|
+
* @param {ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest} requestParameters Request parameters.
|
|
205
|
+
* @param {*} [options] Override http request option.
|
|
206
|
+
* @throws {RequiredError}
|
|
207
|
+
* @memberof ProvenanceApi
|
|
208
|
+
*/
|
|
209
|
+
apiV2ProjectsProjectIdResourcesResourceIdProvenanceOptions(requestParameters: ProvenanceApiApiV2ProjectsProjectIdResourcesResourceIdProvenanceOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @summary Retrieves the specific provenance information associated with a resource.
|
|
213
|
+
* @param {ProvenanceApiGetSpecificProvenanceRequest} requestParameters Request parameters.
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
* @memberof ProvenanceApi
|
|
217
|
+
*/
|
|
218
|
+
getSpecificProvenance(requestParameters: ProvenanceApiGetSpecificProvenanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProvenanceDtoResponse, any>>;
|
|
219
|
+
/**
|
|
220
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
221
|
+
* @summary Updates existing specific provenance information of a resource.
|
|
222
|
+
* @param {ProvenanceApiUpdateSpecificProvenanceRequest} requestParameters Request parameters.
|
|
223
|
+
* @param {*} [options] Override http request option.
|
|
224
|
+
* @throws {RequiredError}
|
|
225
|
+
* @memberof ProvenanceApi
|
|
226
|
+
*/
|
|
227
|
+
updateSpecificProvenance(requestParameters: ProvenanceApiUpdateSpecificProvenanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
228
|
+
}
|
|
@@ -26,7 +26,7 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
26
26
|
*/
|
|
27
27
|
apiV2ResourcesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
*
|
|
30
30
|
* @summary Retrieves a resource by its ID.
|
|
31
31
|
* @param {string} resourceId The ID of the resource to retrieve.
|
|
32
32
|
* @param {*} [options] Override http request option.
|
|
@@ -47,7 +47,7 @@ export declare const ResourceApiFp: (configuration?: Configuration) => {
|
|
|
47
47
|
*/
|
|
48
48
|
apiV2ResourcesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
*
|
|
51
51
|
* @summary Retrieves a resource by its ID.
|
|
52
52
|
* @param {string} resourceId The ID of the resource to retrieve.
|
|
53
53
|
* @param {*} [options] Override http request option.
|
|
@@ -68,7 +68,7 @@ export declare const ResourceApiFactory: (configuration?: Configuration, basePat
|
|
|
68
68
|
*/
|
|
69
69
|
apiV2ResourcesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
71
|
+
*
|
|
72
72
|
* @summary Retrieves a resource by its ID.
|
|
73
73
|
* @param {ResourceApiGetResourceRequest} requestParameters Request parameters.
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
@@ -105,7 +105,7 @@ export declare class ResourceApi extends BaseAPI {
|
|
|
105
105
|
*/
|
|
106
106
|
apiV2ResourcesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
*
|
|
109
109
|
* @summary Retrieves a resource by its ID.
|
|
110
110
|
* @param {ResourceApiGetResourceRequest} requestParameters Request parameters.
|
|
111
111
|
* @param {*} [options] Override http request option.
|
|
@@ -30,7 +30,7 @@ export declare const ResourceTypeApiAxiosParamCreator: (configuration?: Configur
|
|
|
30
30
|
*/
|
|
31
31
|
apiV2ResourceTypesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
*
|
|
34
34
|
* @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
|
|
35
35
|
* @param {number} gitlabProjectId The ID of the GitLab project.
|
|
36
36
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
@@ -40,7 +40,7 @@ export declare const ResourceTypeApiAxiosParamCreator: (configuration?: Configur
|
|
|
40
40
|
*/
|
|
41
41
|
getAllGitlabBranchesForProject: (gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
*
|
|
44
44
|
* @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
|
|
45
45
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
46
46
|
* @param {string} accessToken GitLab Project or Group Access Token.
|
|
@@ -49,14 +49,14 @@ export declare const ResourceTypeApiAxiosParamCreator: (configuration?: Configur
|
|
|
49
49
|
*/
|
|
50
50
|
getAllGitlabProjects: (domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
51
|
/**
|
|
52
|
-
*
|
|
52
|
+
*
|
|
53
53
|
* @summary Retrieves the entire global resource types information.
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
55
55
|
* @throws {RequiredError}
|
|
56
56
|
*/
|
|
57
57
|
getAllResourceTypesInformation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
*
|
|
60
60
|
* @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
|
|
61
61
|
* @param {number} gitlabProjectId The ID of the GitLab project.
|
|
62
62
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
@@ -66,7 +66,7 @@ export declare const ResourceTypeApiAxiosParamCreator: (configuration?: Configur
|
|
|
66
66
|
*/
|
|
67
67
|
getGitlabProject: (gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
*
|
|
70
70
|
* @summary Retrieves the resource type information for a specific resource type.
|
|
71
71
|
* @param {string} resourceTypeId The ID of the resource type to retrieve.
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
@@ -87,7 +87,7 @@ export declare const ResourceTypeApiFp: (configuration?: Configuration) => {
|
|
|
87
87
|
*/
|
|
88
88
|
apiV2ResourceTypesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
*
|
|
91
91
|
* @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
|
|
92
92
|
* @param {number} gitlabProjectId The ID of the GitLab project.
|
|
93
93
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
@@ -97,7 +97,7 @@ export declare const ResourceTypeApiFp: (configuration?: Configuration) => {
|
|
|
97
97
|
*/
|
|
98
98
|
getAllGitlabBranchesForProject(gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabBranchDtoIEnumerableResponse>>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
*
|
|
101
101
|
* @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
|
|
102
102
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
103
103
|
* @param {string} accessToken GitLab Project or Group Access Token.
|
|
@@ -106,14 +106,14 @@ export declare const ResourceTypeApiFp: (configuration?: Configuration) => {
|
|
|
106
106
|
*/
|
|
107
107
|
getAllGitlabProjects(domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabProjectDtoIEnumerableResponse>>;
|
|
108
108
|
/**
|
|
109
|
-
*
|
|
109
|
+
*
|
|
110
110
|
* @summary Retrieves the entire global resource types information.
|
|
111
111
|
* @param {*} [options] Override http request option.
|
|
112
112
|
* @throws {RequiredError}
|
|
113
113
|
*/
|
|
114
114
|
getAllResourceTypesInformation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>>;
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
116
|
+
*
|
|
117
117
|
* @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
|
|
118
118
|
* @param {number} gitlabProjectId The ID of the GitLab project.
|
|
119
119
|
* @param {string} domain Domain/Host of the GitLab Provider.
|
|
@@ -123,7 +123,7 @@ export declare const ResourceTypeApiFp: (configuration?: Configuration) => {
|
|
|
123
123
|
*/
|
|
124
124
|
getGitlabProject(gitlabProjectId: number, domain: string, accessToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GitlabProjectDtoResponse>>;
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
126
|
+
*
|
|
127
127
|
* @summary Retrieves the resource type information for a specific resource type.
|
|
128
128
|
* @param {string} resourceTypeId The ID of the resource type to retrieve.
|
|
129
129
|
* @param {*} [options] Override http request option.
|
|
@@ -144,7 +144,7 @@ export declare const ResourceTypeApiFactory: (configuration?: Configuration, bas
|
|
|
144
144
|
*/
|
|
145
145
|
apiV2ResourceTypesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
*
|
|
148
148
|
* @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
|
|
149
149
|
* @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
@@ -152,7 +152,7 @@ export declare const ResourceTypeApiFactory: (configuration?: Configuration, bas
|
|
|
152
152
|
*/
|
|
153
153
|
getAllGitlabBranchesForProject(requestParameters: ResourceTypeApiGetAllGitlabBranchesForProjectRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabBranchDtoIEnumerableResponse>;
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
155
|
+
*
|
|
156
156
|
* @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
|
|
157
157
|
* @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
@@ -160,14 +160,14 @@ export declare const ResourceTypeApiFactory: (configuration?: Configuration, bas
|
|
|
160
160
|
*/
|
|
161
161
|
getAllGitlabProjects(requestParameters: ResourceTypeApiGetAllGitlabProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabProjectDtoIEnumerableResponse>;
|
|
162
162
|
/**
|
|
163
|
-
*
|
|
163
|
+
*
|
|
164
164
|
* @summary Retrieves the entire global resource types information.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
167
167
|
*/
|
|
168
168
|
getAllResourceTypesInformation(options?: AxiosRequestConfig): AxiosPromise<ResourceTypeInformationDtoIEnumerableResponse>;
|
|
169
169
|
/**
|
|
170
|
-
*
|
|
170
|
+
*
|
|
171
171
|
* @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
|
|
172
172
|
* @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters.
|
|
173
173
|
* @param {*} [options] Override http request option.
|
|
@@ -175,7 +175,7 @@ export declare const ResourceTypeApiFactory: (configuration?: Configuration, bas
|
|
|
175
175
|
*/
|
|
176
176
|
getGitlabProject(requestParameters: ResourceTypeApiGetGitlabProjectRequest, options?: AxiosRequestConfig): AxiosPromise<GitlabProjectDtoResponse>;
|
|
177
177
|
/**
|
|
178
|
-
*
|
|
178
|
+
*
|
|
179
179
|
* @summary Retrieves the resource type information for a specific resource type.
|
|
180
180
|
* @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters.
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
@@ -281,7 +281,7 @@ export declare class ResourceTypeApi extends BaseAPI {
|
|
|
281
281
|
*/
|
|
282
282
|
apiV2ResourceTypesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
283
283
|
/**
|
|
284
|
-
*
|
|
284
|
+
*
|
|
285
285
|
* @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
|
|
286
286
|
* @param {ResourceTypeApiGetAllGitlabBranchesForProjectRequest} requestParameters Request parameters.
|
|
287
287
|
* @param {*} [options] Override http request option.
|
|
@@ -290,7 +290,7 @@ export declare class ResourceTypeApi extends BaseAPI {
|
|
|
290
290
|
*/
|
|
291
291
|
getAllGitlabBranchesForProject(requestParameters: ResourceTypeApiGetAllGitlabBranchesForProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabBranchDtoIEnumerableResponse, any>>;
|
|
292
292
|
/**
|
|
293
|
-
*
|
|
293
|
+
*
|
|
294
294
|
* @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
|
|
295
295
|
* @param {ResourceTypeApiGetAllGitlabProjectsRequest} requestParameters Request parameters.
|
|
296
296
|
* @param {*} [options] Override http request option.
|
|
@@ -299,7 +299,7 @@ export declare class ResourceTypeApi extends BaseAPI {
|
|
|
299
299
|
*/
|
|
300
300
|
getAllGitlabProjects(requestParameters: ResourceTypeApiGetAllGitlabProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabProjectDtoIEnumerableResponse, any>>;
|
|
301
301
|
/**
|
|
302
|
-
*
|
|
302
|
+
*
|
|
303
303
|
* @summary Retrieves the entire global resource types information.
|
|
304
304
|
* @param {*} [options] Override http request option.
|
|
305
305
|
* @throws {RequiredError}
|
|
@@ -307,7 +307,7 @@ export declare class ResourceTypeApi extends BaseAPI {
|
|
|
307
307
|
*/
|
|
308
308
|
getAllResourceTypesInformation(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceTypeInformationDtoIEnumerableResponse, any>>;
|
|
309
309
|
/**
|
|
310
|
-
*
|
|
310
|
+
*
|
|
311
311
|
* @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
|
|
312
312
|
* @param {ResourceTypeApiGetGitlabProjectRequest} requestParameters Request parameters.
|
|
313
313
|
* @param {*} [options] Override http request option.
|
|
@@ -316,7 +316,7 @@ export declare class ResourceTypeApi extends BaseAPI {
|
|
|
316
316
|
*/
|
|
317
317
|
getGitlabProject(requestParameters: ResourceTypeApiGetGitlabProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GitlabProjectDtoResponse, any>>;
|
|
318
318
|
/**
|
|
319
|
-
*
|
|
319
|
+
*
|
|
320
320
|
* @summary Retrieves the resource type information for a specific resource type.
|
|
321
321
|
* @param {ResourceTypeApiGetResourceTypeInformationRequest} requestParameters Request parameters.
|
|
322
322
|
* @param {*} [options] Override http request option.
|
|
@@ -27,7 +27,7 @@ export declare const RoleApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2RolesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
*
|
|
31
31
|
* @summary Retrieves a role by ID.
|
|
32
32
|
* @param {string} roleId The ID of the role.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ export declare const RoleApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
35
35
|
*/
|
|
36
36
|
getRole: (roleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
*
|
|
39
39
|
* @summary Retrieves all roles.
|
|
40
40
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
41
41
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -58,7 +58,7 @@ export declare const RoleApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2RolesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
*
|
|
62
62
|
* @summary Retrieves a role by ID.
|
|
63
63
|
* @param {string} roleId The ID of the role.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const RoleApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
getRole(roleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleDtoResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
*
|
|
70
70
|
* @summary Retrieves all roles.
|
|
71
71
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
72
72
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -89,7 +89,7 @@ export declare const RoleApiFactory: (configuration?: Configuration, basePath?:
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2RolesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
*
|
|
93
93
|
* @summary Retrieves a role by ID.
|
|
94
94
|
* @param {RoleApiGetRoleRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const RoleApiFactory: (configuration?: Configuration, basePath?:
|
|
|
97
97
|
*/
|
|
98
98
|
getRole(requestParameters: RoleApiGetRoleRequest, options?: AxiosRequestConfig): AxiosPromise<RoleDtoResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
*
|
|
101
101
|
* @summary Retrieves all roles.
|
|
102
102
|
* @param {RoleApiGetRolesRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class RoleApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2RolesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
*
|
|
163
163
|
* @summary Retrieves a role by ID.
|
|
164
164
|
* @param {RoleApiGetRoleRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class RoleApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getRole(requestParameters: RoleApiGetRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleDtoResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
*
|
|
172
172
|
* @summary Retrieves all roles.
|
|
173
173
|
* @param {RoleApiGetRolesRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -27,7 +27,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2SearchOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
*
|
|
31
31
|
* @summary Retrieves a search result by given search parameters.
|
|
32
32
|
* @param {string} [query] The search query
|
|
33
33
|
* @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
|
|
@@ -54,7 +54,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
54
54
|
*/
|
|
55
55
|
apiV2SearchOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
*
|
|
58
58
|
* @summary Retrieves a search result by given search parameters.
|
|
59
59
|
* @param {string} [query] The search query
|
|
60
60
|
* @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
|
|
@@ -81,7 +81,7 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
81
81
|
*/
|
|
82
82
|
apiV2SearchOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
83
83
|
/**
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @summary Retrieves a search result by given search parameters.
|
|
86
86
|
* @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters.
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
@@ -154,7 +154,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
154
154
|
*/
|
|
155
155
|
apiV2SearchOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
157
|
+
*
|
|
158
158
|
* @summary Retrieves a search result by given search parameters.
|
|
159
159
|
* @param {SearchApiGetSearchResultsRequest} requestParameters Request parameters.
|
|
160
160
|
* @param {*} [options] Override http request option.
|