@coscine/api-client 3.4.3 → 3.6.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 +2523 -2215
- package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +136 -24
- 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 +187 -0
- 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 +18 -10
- package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +142 -55
- 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 +142 -0
- 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/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 +108 -14
- 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/{language-dto-paged-response.d.ts → activity-log-dto-paged-response.d.ts} +10 -10
- package/dist/types/Coscine.Api/@coscine/model/activity-log-dto.d.ts +60 -0
- package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.d.ts +24 -0
- package/dist/types/Coscine.Api/@coscine/model/file-tree-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto-response.d.ts → handle-dto-response.d.ts} +9 -9
- package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto.d.ts → handle-dto.d.ts} +12 -11
- package/dist/types/Coscine.Api/@coscine/model/handle-for-update-dto.d.ts +25 -0
- package/dist/types/Coscine.Api/@coscine/model/handle-value-dto.d.ts +72 -0
- package/dist/types/Coscine.Api/@coscine/model/handle-value-for-update-dto.d.ts +36 -0
- package/dist/types/Coscine.Api/@coscine/model/index.d.ts +15 -2
- package/dist/types/Coscine.Api/@coscine/model/license-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-extracted-dto.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/organization-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/{title-dto-paged-response.d.ts → pid-dto-paged-response.d.ts} +10 -10
- package/dist/types/Coscine.Api/@coscine/model/{user-dto-ienumerable-paged-response.d.ts → pid-dto-response.d.ts} +9 -16
- package/dist/types/Coscine.Api/@coscine/model/pid-dto.d.ts +49 -0
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +1 -1
- package/dist/types/Coscine.Api/@coscine/model/publication-advisory-service-dto.d.ts +30 -0
- package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto-response.d.ts +43 -0
- package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto.d.ts +36 -0
- package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/user-institute-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/user-organization-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/api.d.ts +2 -0
- package/dist/types/apis.d.ts +9 -1
- package/dist/types/index.d.ts +18 -2
- package/package.json +2 -2
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto-ienumerable-paged-response.d.ts +0 -50
- package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-ienumerable-paged-response.d.ts +0 -50
|
@@ -24,7 +24,7 @@ import { UserTermsOfServiceAcceptDto } from '../../@coscine/model';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
28
28
|
* @summary Accepts the current Terms Of Service for the current authenticated user.
|
|
29
29
|
* @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto]
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +39,7 @@ export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
39
39
|
*/
|
|
40
40
|
apiV2SelfOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
43
43
|
* @summary Confirms the email of a user.
|
|
44
44
|
* @param {string} confirmationToken Gets or initializes the confirmation token for user email confirmation.
|
|
45
45
|
* @param {*} [options] Override http request option.
|
|
@@ -47,14 +47,14 @@ export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
47
47
|
*/
|
|
48
48
|
confirmUserEmail: (confirmationToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
51
51
|
* @summary Retrieves the current authenticated user.
|
|
52
52
|
* @param {*} [options] Override http request option.
|
|
53
53
|
* @throws {RequiredError}
|
|
54
54
|
*/
|
|
55
55
|
getCurrentUser: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
58
58
|
* @summary Initiates user merging for the current user.
|
|
59
59
|
* @param {IdentityProviders} identityProvider The identity provider from which user data is to be merged.
|
|
60
60
|
* @param {*} [options] Override http request option.
|
|
@@ -62,7 +62,7 @@ export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
62
62
|
*/
|
|
63
63
|
initiateUserMerge: (identityProvider: IdentityProviders, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
|
-
*
|
|
65
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
66
66
|
* @summary Resolves a project invitation for the authenticated user.
|
|
67
67
|
* @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data.
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
@@ -70,7 +70,7 @@ export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
70
70
|
*/
|
|
71
71
|
resolveProjectInvitation: (projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
74
74
|
* @summary Updates the current authenticated user.
|
|
75
75
|
* @param {UserForUpdateDto} [userForUpdateDto] The updated user data.
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
@@ -84,7 +84,7 @@ export declare const SelfApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
84
84
|
*/
|
|
85
85
|
export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
88
88
|
* @summary Accepts the current Terms Of Service for the current authenticated user.
|
|
89
89
|
* @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto]
|
|
90
90
|
* @param {*} [options] Override http request option.
|
|
@@ -99,7 +99,7 @@ export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
|
99
99
|
*/
|
|
100
100
|
apiV2SelfOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
103
103
|
* @summary Confirms the email of a user.
|
|
104
104
|
* @param {string} confirmationToken Gets or initializes the confirmation token for user email confirmation.
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
@@ -107,14 +107,14 @@ export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
|
107
107
|
*/
|
|
108
108
|
confirmUserEmail(confirmationToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
109
109
|
/**
|
|
110
|
-
*
|
|
110
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
111
111
|
* @summary Retrieves the current authenticated user.
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
115
115
|
getCurrentUser(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDtoResponse>>;
|
|
116
116
|
/**
|
|
117
|
-
*
|
|
117
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
118
118
|
* @summary Initiates user merging for the current user.
|
|
119
119
|
* @param {IdentityProviders} identityProvider The identity provider from which user data is to be merged.
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
@@ -122,7 +122,7 @@ export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
*/
|
|
123
123
|
initiateUserMerge(identityProvider: IdentityProviders, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserMergeDtoResponse>>;
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
126
126
|
* @summary Resolves a project invitation for the authenticated user.
|
|
127
127
|
* @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data.
|
|
128
128
|
* @param {*} [options] Override http request option.
|
|
@@ -130,7 +130,7 @@ export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
|
130
130
|
*/
|
|
131
131
|
resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
133
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
134
134
|
* @summary Updates the current authenticated user.
|
|
135
135
|
* @param {UserForUpdateDto} [userForUpdateDto] The updated user data.
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
@@ -144,7 +144,7 @@ export declare const SelfApiFp: (configuration?: Configuration) => {
|
|
|
144
144
|
*/
|
|
145
145
|
export declare const SelfApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
148
148
|
* @summary Accepts the current Terms Of Service for the current authenticated user.
|
|
149
149
|
* @param {SelfApiAcceptCurrentTosRequest} requestParameters Request parameters.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare const SelfApiFactory: (configuration?: Configuration, basePath?:
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2SelfOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Confirms the email of a user.
|
|
164
164
|
* @param {SelfApiConfirmUserEmailRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -167,14 +167,14 @@ export declare const SelfApiFactory: (configuration?: Configuration, basePath?:
|
|
|
167
167
|
*/
|
|
168
168
|
confirmUserEmail(requestParameters: SelfApiConfirmUserEmailRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
169
169
|
/**
|
|
170
|
-
*
|
|
170
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
171
171
|
* @summary Retrieves the current authenticated user.
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
*/
|
|
175
175
|
getCurrentUser(options?: AxiosRequestConfig): AxiosPromise<UserDtoResponse>;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
178
178
|
* @summary Initiates user merging for the current user.
|
|
179
179
|
* @param {SelfApiInitiateUserMergeRequest} requestParameters Request parameters.
|
|
180
180
|
* @param {*} [options] Override http request option.
|
|
@@ -182,7 +182,7 @@ export declare const SelfApiFactory: (configuration?: Configuration, basePath?:
|
|
|
182
182
|
*/
|
|
183
183
|
initiateUserMerge(requestParameters: SelfApiInitiateUserMergeRequest, options?: AxiosRequestConfig): AxiosPromise<UserMergeDtoResponse>;
|
|
184
184
|
/**
|
|
185
|
-
*
|
|
185
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
186
186
|
* @summary Resolves a project invitation for the authenticated user.
|
|
187
187
|
* @param {SelfApiResolveProjectInvitationRequest} requestParameters Request parameters.
|
|
188
188
|
* @param {*} [options] Override http request option.
|
|
@@ -190,7 +190,7 @@ export declare const SelfApiFactory: (configuration?: Configuration, basePath?:
|
|
|
190
190
|
*/
|
|
191
191
|
resolveProjectInvitation(requestParameters?: SelfApiResolveProjectInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
193
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
194
194
|
* @summary Updates the current authenticated user.
|
|
195
195
|
* @param {SelfApiUpdateCurrentUserRequest} requestParameters Request parameters.
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
@@ -271,7 +271,7 @@ export interface SelfApiUpdateCurrentUserRequest {
|
|
|
271
271
|
*/
|
|
272
272
|
export declare class SelfApi extends BaseAPI {
|
|
273
273
|
/**
|
|
274
|
-
*
|
|
274
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
275
275
|
* @summary Accepts the current Terms Of Service for the current authenticated user.
|
|
276
276
|
* @param {SelfApiAcceptCurrentTosRequest} requestParameters Request parameters.
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
@@ -288,7 +288,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
288
288
|
*/
|
|
289
289
|
apiV2SelfOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
290
290
|
/**
|
|
291
|
-
*
|
|
291
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
292
292
|
* @summary Confirms the email of a user.
|
|
293
293
|
* @param {SelfApiConfirmUserEmailRequest} requestParameters Request parameters.
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
@@ -297,7 +297,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
297
297
|
*/
|
|
298
298
|
confirmUserEmail(requestParameters: SelfApiConfirmUserEmailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
299
299
|
/**
|
|
300
|
-
*
|
|
300
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
301
301
|
* @summary Retrieves the current authenticated user.
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
@@ -305,7 +305,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
305
305
|
*/
|
|
306
306
|
getCurrentUser(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDtoResponse, any>>;
|
|
307
307
|
/**
|
|
308
|
-
*
|
|
308
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
309
309
|
* @summary Initiates user merging for the current user.
|
|
310
310
|
* @param {SelfApiInitiateUserMergeRequest} requestParameters Request parameters.
|
|
311
311
|
* @param {*} [options] Override http request option.
|
|
@@ -314,7 +314,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
314
314
|
*/
|
|
315
315
|
initiateUserMerge(requestParameters: SelfApiInitiateUserMergeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserMergeDtoResponse, any>>;
|
|
316
316
|
/**
|
|
317
|
-
*
|
|
317
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
318
318
|
* @summary Resolves a project invitation for the authenticated user.
|
|
319
319
|
* @param {SelfApiResolveProjectInvitationRequest} requestParameters Request parameters.
|
|
320
320
|
* @param {*} [options] Override http request option.
|
|
@@ -323,7 +323,7 @@ export declare class SelfApi extends BaseAPI {
|
|
|
323
323
|
*/
|
|
324
324
|
resolveProjectInvitation(requestParameters?: SelfApiResolveProjectInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
325
325
|
/**
|
|
326
|
-
*
|
|
326
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
327
327
|
* @summary Updates the current authenticated user.
|
|
328
328
|
* @param {SelfApiUpdateCurrentUserRequest} requestParameters Request parameters.
|
|
329
329
|
* @param {*} [options] Override http request option.
|
|
@@ -27,7 +27,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2TitlesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves a title by ID.
|
|
32
32
|
* @param {string} titleId The ID of the title.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
35
35
|
*/
|
|
36
36
|
getTitle: (titleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
39
39
|
* @summary Retrieves all titles.
|
|
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 TitleApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2TitlesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
62
62
|
* @summary Retrieves a title by ID.
|
|
63
63
|
* @param {string} titleId The ID of the title.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
getTitle(titleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves all titles.
|
|
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 TitleApiFactory: (configuration?: Configuration, basePath?:
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2TitlesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves a title by ID.
|
|
94
94
|
* @param {TitleApiGetTitleRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const TitleApiFactory: (configuration?: Configuration, basePath?:
|
|
|
97
97
|
*/
|
|
98
98
|
getTitle(requestParameters: TitleApiGetTitleRequest, options?: AxiosRequestConfig): AxiosPromise<TitleDtoResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
101
101
|
* @summary Retrieves all titles.
|
|
102
102
|
* @param {TitleApiGetTitlesRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class TitleApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2TitlesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Retrieves a title by ID.
|
|
164
164
|
* @param {TitleApiGetTitleRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class TitleApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getTitle(requestParameters: TitleApiGetTitleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TitleDtoResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
172
172
|
* @summary Retrieves all titles.
|
|
173
173
|
* @param {TitleApiGetTitlesRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -26,7 +26,7 @@ export declare const TosApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
26
26
|
*/
|
|
27
27
|
apiV2TosOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
30
30
|
* @summary Retrieves the current Terms of Service version.
|
|
31
31
|
* @param {*} [options] Override http request option.
|
|
32
32
|
* @throws {RequiredError}
|
|
@@ -46,7 +46,7 @@ export declare const TosApiFp: (configuration?: Configuration) => {
|
|
|
46
46
|
*/
|
|
47
47
|
apiV2TosOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
50
50
|
* @summary Retrieves the current Terms of Service version.
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
@@ -66,7 +66,7 @@ export declare const TosApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
66
66
|
*/
|
|
67
67
|
apiV2TosOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves the current Terms of Service version.
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @throws {RequiredError}
|
|
@@ -89,7 +89,7 @@ export declare class TosApi extends BaseAPI {
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2TosOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves the current Terms of Service version.
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
@@ -33,7 +33,7 @@ export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
33
33
|
*/
|
|
34
34
|
apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: (projectId: string, resourceId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
37
37
|
* @summary Creates a new metadata tree for a resource.
|
|
38
38
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
39
39
|
* @param {string} resourceId The unique identifier of the resource.
|
|
@@ -56,21 +56,35 @@ export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
56
56
|
*/
|
|
57
57
|
getFileTree: (projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
60
60
|
* @summary Retrieves the metadata tree associated with a resource.
|
|
61
61
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
62
62
|
* @param {string} resourceId The unique identifier of the resource.
|
|
63
63
|
* @param {string} [path] Gets or sets the path of the metadata tree.
|
|
64
64
|
* @param {RdfFormat} [format] Gets or sets the format of the RDF data.
|
|
65
|
+
* @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included.
|
|
65
66
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
66
67
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
67
68
|
* @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
|
|
68
69
|
* @param {*} [options] Override http request option.
|
|
69
70
|
* @throws {RequiredError}
|
|
70
71
|
*/
|
|
71
|
-
getMetadataTree: (projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
getMetadataTree: (projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
73
|
/**
|
|
73
|
-
*
|
|
74
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
75
|
+
* @summary Retrieves the specific metadata tree associated with a resource.
|
|
76
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
77
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
78
|
+
* @param {string} [path] Gets or sets the path of the metadata tree.
|
|
79
|
+
* @param {RdfFormat} [format] Gets or sets the format of the RDF data.
|
|
80
|
+
* @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included.
|
|
81
|
+
* @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
getSpecificMetadataTree: (projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, version?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
/**
|
|
87
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
74
88
|
* @summary Updates an existing metadata tree of a resource.
|
|
75
89
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
76
90
|
* @param {string} resourceId The unique identifier of the resource.
|
|
@@ -95,7 +109,7 @@ export declare const TreeApiFp: (configuration?: Configuration) => {
|
|
|
95
109
|
*/
|
|
96
110
|
apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
97
111
|
/**
|
|
98
|
-
*
|
|
112
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
99
113
|
* @summary Creates a new metadata tree for a resource.
|
|
100
114
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
101
115
|
* @param {string} resourceId The unique identifier of the resource.
|
|
@@ -118,21 +132,35 @@ export declare const TreeApiFp: (configuration?: Configuration) => {
|
|
|
118
132
|
*/
|
|
119
133
|
getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTreeDtoPagedResponse>>;
|
|
120
134
|
/**
|
|
121
|
-
*
|
|
135
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
122
136
|
* @summary Retrieves the metadata tree associated with a resource.
|
|
123
137
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
124
138
|
* @param {string} resourceId The unique identifier of the resource.
|
|
125
139
|
* @param {string} [path] Gets or sets the path of the metadata tree.
|
|
126
140
|
* @param {RdfFormat} [format] Gets or sets the format of the RDF data.
|
|
141
|
+
* @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included.
|
|
127
142
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
128
143
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
129
144
|
* @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
|
|
130
145
|
* @param {*} [options] Override http request option.
|
|
131
146
|
* @throws {RequiredError}
|
|
132
147
|
*/
|
|
133
|
-
getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoPagedResponse>>;
|
|
148
|
+
getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoPagedResponse>>;
|
|
134
149
|
/**
|
|
135
|
-
*
|
|
150
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
151
|
+
* @summary Retrieves the specific metadata tree associated with a resource.
|
|
152
|
+
* @param {string} projectId The unique identifier or slug of the project.
|
|
153
|
+
* @param {string} resourceId The unique identifier of the resource.
|
|
154
|
+
* @param {string} [path] Gets or sets the path of the metadata tree.
|
|
155
|
+
* @param {RdfFormat} [format] Gets or sets the format of the RDF data.
|
|
156
|
+
* @param {boolean} [includeExtractedMetadata] Gets or sets if extracted metadata should be included.
|
|
157
|
+
* @param {number} [version] Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
getSpecificMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, includeExtractedMetadata?: boolean, version?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>>;
|
|
162
|
+
/**
|
|
163
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
136
164
|
* @summary Updates an existing metadata tree of a resource.
|
|
137
165
|
* @param {string} projectId The unique identifier or slug of the project.
|
|
138
166
|
* @param {string} resourceId The unique identifier of the resource.
|
|
@@ -156,7 +184,7 @@ export declare const TreeApiFactory: (configuration?: Configuration, basePath?:
|
|
|
156
184
|
*/
|
|
157
185
|
apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(requestParameters: TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
158
186
|
/**
|
|
159
|
-
*
|
|
187
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
160
188
|
* @summary Creates a new metadata tree for a resource.
|
|
161
189
|
* @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters.
|
|
162
190
|
* @param {*} [options] Override http request option.
|
|
@@ -172,7 +200,7 @@ export declare const TreeApiFactory: (configuration?: Configuration, basePath?:
|
|
|
172
200
|
*/
|
|
173
201
|
getFileTree(requestParameters: TreeApiGetFileTreeRequest, options?: AxiosRequestConfig): AxiosPromise<FileTreeDtoPagedResponse>;
|
|
174
202
|
/**
|
|
175
|
-
*
|
|
203
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
176
204
|
* @summary Retrieves the metadata tree associated with a resource.
|
|
177
205
|
* @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters.
|
|
178
206
|
* @param {*} [options] Override http request option.
|
|
@@ -180,7 +208,15 @@ export declare const TreeApiFactory: (configuration?: Configuration, basePath?:
|
|
|
180
208
|
*/
|
|
181
209
|
getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoPagedResponse>;
|
|
182
210
|
/**
|
|
183
|
-
*
|
|
211
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
212
|
+
* @summary Retrieves the specific metadata tree associated with a resource.
|
|
213
|
+
* @param {TreeApiGetSpecificMetadataTreeRequest} requestParameters Request parameters.
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
*/
|
|
217
|
+
getSpecificMetadataTree(requestParameters: TreeApiGetSpecificMetadataTreeRequest, options?: AxiosRequestConfig): AxiosPromise<MetadataTreeDtoResponse>;
|
|
218
|
+
/**
|
|
219
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
184
220
|
* @summary Updates an existing metadata tree of a resource.
|
|
185
221
|
* @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters.
|
|
186
222
|
* @param {*} [options] Override http request option.
|
|
@@ -305,6 +341,12 @@ export interface TreeApiGetMetadataTreeRequest {
|
|
|
305
341
|
* @memberof TreeApiGetMetadataTree
|
|
306
342
|
*/
|
|
307
343
|
readonly format?: RdfFormat;
|
|
344
|
+
/**
|
|
345
|
+
* Gets or sets if extracted metadata should be included.
|
|
346
|
+
* @type {boolean}
|
|
347
|
+
* @memberof TreeApiGetMetadataTree
|
|
348
|
+
*/
|
|
349
|
+
readonly includeExtractedMetadata?: boolean;
|
|
308
350
|
/**
|
|
309
351
|
* The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
310
352
|
* @type {number}
|
|
@@ -324,6 +366,49 @@ export interface TreeApiGetMetadataTreeRequest {
|
|
|
324
366
|
*/
|
|
325
367
|
readonly orderBy?: string;
|
|
326
368
|
}
|
|
369
|
+
/**
|
|
370
|
+
* Request parameters for getSpecificMetadataTree operation in TreeApi.
|
|
371
|
+
* @export
|
|
372
|
+
* @interface TreeApiGetSpecificMetadataTreeRequest
|
|
373
|
+
*/
|
|
374
|
+
export interface TreeApiGetSpecificMetadataTreeRequest {
|
|
375
|
+
/**
|
|
376
|
+
* The unique identifier or slug of the project.
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
379
|
+
*/
|
|
380
|
+
readonly projectId: string;
|
|
381
|
+
/**
|
|
382
|
+
* The unique identifier of the resource.
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
385
|
+
*/
|
|
386
|
+
readonly resourceId: string;
|
|
387
|
+
/**
|
|
388
|
+
* Gets or sets the path of the metadata tree.
|
|
389
|
+
* @type {string}
|
|
390
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
391
|
+
*/
|
|
392
|
+
readonly path?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Gets or sets the format of the RDF data.
|
|
395
|
+
* @type {RdfFormat}
|
|
396
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
397
|
+
*/
|
|
398
|
+
readonly format?: RdfFormat;
|
|
399
|
+
/**
|
|
400
|
+
* Gets or sets if extracted metadata should be included.
|
|
401
|
+
* @type {boolean}
|
|
402
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
403
|
+
*/
|
|
404
|
+
readonly includeExtractedMetadata?: boolean;
|
|
405
|
+
/**
|
|
406
|
+
* Gets or sets the desired version. If the version is null, the newest will be returned.
|
|
407
|
+
* @type {number}
|
|
408
|
+
* @memberof TreeApiGetSpecificMetadataTree
|
|
409
|
+
*/
|
|
410
|
+
readonly version?: number;
|
|
411
|
+
}
|
|
327
412
|
/**
|
|
328
413
|
* Request parameters for updateMetadataTree operation in TreeApi.
|
|
329
414
|
* @export
|
|
@@ -366,7 +451,7 @@ export declare class TreeApi extends BaseAPI {
|
|
|
366
451
|
*/
|
|
367
452
|
apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(requestParameters: TreeApiApiV2ProjectsProjectIdResourcesResourceIdTreesOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
368
453
|
/**
|
|
369
|
-
*
|
|
454
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
370
455
|
* @summary Creates a new metadata tree for a resource.
|
|
371
456
|
* @param {TreeApiCreateMetadataTreeRequest} requestParameters Request parameters.
|
|
372
457
|
* @param {*} [options] Override http request option.
|
|
@@ -384,7 +469,7 @@ export declare class TreeApi extends BaseAPI {
|
|
|
384
469
|
*/
|
|
385
470
|
getFileTree(requestParameters: TreeApiGetFileTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTreeDtoPagedResponse, any>>;
|
|
386
471
|
/**
|
|
387
|
-
*
|
|
472
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
388
473
|
* @summary Retrieves the metadata tree associated with a resource.
|
|
389
474
|
* @param {TreeApiGetMetadataTreeRequest} requestParameters Request parameters.
|
|
390
475
|
* @param {*} [options] Override http request option.
|
|
@@ -393,7 +478,16 @@ export declare class TreeApi extends BaseAPI {
|
|
|
393
478
|
*/
|
|
394
479
|
getMetadataTree(requestParameters: TreeApiGetMetadataTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataTreeDtoPagedResponse, any>>;
|
|
395
480
|
/**
|
|
396
|
-
*
|
|
481
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
482
|
+
* @summary Retrieves the specific metadata tree associated with a resource.
|
|
483
|
+
* @param {TreeApiGetSpecificMetadataTreeRequest} requestParameters Request parameters.
|
|
484
|
+
* @param {*} [options] Override http request option.
|
|
485
|
+
* @throws {RequiredError}
|
|
486
|
+
* @memberof TreeApi
|
|
487
|
+
*/
|
|
488
|
+
getSpecificMetadataTree(requestParameters: TreeApiGetSpecificMetadataTreeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataTreeDtoResponse, any>>;
|
|
489
|
+
/**
|
|
490
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
397
491
|
* @summary Updates an existing metadata tree of a resource.
|
|
398
492
|
* @param {TreeApiUpdateMetadataTreeRequest} requestParameters Request parameters.
|
|
399
493
|
* @param {*} [options] Override http request option.
|
|
@@ -26,7 +26,7 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
26
26
|
*/
|
|
27
27
|
apiV2UsersOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
30
30
|
* @summary Retrieves all users.
|
|
31
31
|
* @param {string} searchTerm Gets or sets the search term.
|
|
32
32
|
* @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \"firstName\".
|
|
@@ -48,7 +48,7 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
48
48
|
*/
|
|
49
49
|
apiV2UsersOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
50
50
|
/**
|
|
51
|
-
*
|
|
51
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
52
52
|
* @summary Retrieves all users.
|
|
53
53
|
* @param {string} searchTerm Gets or sets the search term.
|
|
54
54
|
* @param {string} [orderBy] Gets or sets the field by which the search results are ordered. Defaults to \"firstName\".
|
|
@@ -70,7 +70,7 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
70
70
|
*/
|
|
71
71
|
apiV2UsersOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
74
74
|
* @summary Retrieves all users.
|
|
75
75
|
* @param {UserApiGetUsersRequest} requestParameters Request parameters.
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
@@ -113,7 +113,7 @@ export declare class UserApi extends BaseAPI {
|
|
|
113
113
|
*/
|
|
114
114
|
apiV2UsersOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
116
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
117
117
|
* @summary Retrieves all users.
|
|
118
118
|
* @param {UserApiGetUsersRequest} requestParameters Request parameters.
|
|
119
119
|
* @param {*} [options] Override http request option.
|
|
@@ -27,7 +27,7 @@ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configurat
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2VisibilitiesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves all visibilities.
|
|
32
32
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
33
33
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -37,7 +37,7 @@ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configurat
|
|
|
37
37
|
*/
|
|
38
38
|
getVisibilities: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
40
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
41
41
|
* @summary Retrieves a visibility by ID.
|
|
42
42
|
* @param {string} visibilityId The ID of the visibility.
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
@@ -58,7 +58,7 @@ export declare const VisibilityApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2VisibilitiesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
62
62
|
* @summary Retrieves all visibilities.
|
|
63
63
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
64
64
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -68,7 +68,7 @@ export declare const VisibilityApiFp: (configuration?: Configuration) => {
|
|
|
68
68
|
*/
|
|
69
69
|
getVisibilities(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VisibilityDtoPagedResponse>>;
|
|
70
70
|
/**
|
|
71
|
-
*
|
|
71
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
72
72
|
* @summary Retrieves a visibility by ID.
|
|
73
73
|
* @param {string} visibilityId The ID of the visibility.
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
@@ -89,7 +89,7 @@ export declare const VisibilityApiFactory: (configuration?: Configuration, baseP
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2VisibilitiesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves all visibilities.
|
|
94
94
|
* @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const VisibilityApiFactory: (configuration?: Configuration, baseP
|
|
|
97
97
|
*/
|
|
98
98
|
getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: AxiosRequestConfig): AxiosPromise<VisibilityDtoPagedResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
101
101
|
* @summary Retrieves a visibility by ID.
|
|
102
102
|
* @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class VisibilityApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2VisibilitiesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Retrieves all visibilities.
|
|
164
164
|
* @param {VisibilityApiGetVisibilitiesRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class VisibilityApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getVisibilities(requestParameters?: VisibilityApiGetVisibilitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VisibilityDtoPagedResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
172
172
|
* @summary Retrieves a visibility by ID.
|
|
173
173
|
* @param {VisibilityApiGetVisibilityRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|