@coscine/api-client 3.5.0 → 3.7.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.
Files changed (62) hide show
  1. package/dist/index.js +2590 -2181
  2. package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +136 -24
  3. package/dist/types/Coscine.Api/@coscine/api/application-profile-api.d.ts +16 -16
  4. package/dist/types/Coscine.Api/@coscine/api/blob-api.d.ts +16 -16
  5. package/dist/types/Coscine.Api/@coscine/api/discipline-api.d.ts +8 -8
  6. package/dist/types/Coscine.Api/@coscine/api/handle-api.d.ts +187 -0
  7. package/dist/types/Coscine.Api/@coscine/api/language-api.d.ts +8 -8
  8. package/dist/types/Coscine.Api/@coscine/api/license-api.d.ts +8 -8
  9. package/dist/types/Coscine.Api/@coscine/api/maintenance-api.d.ts +4 -4
  10. package/dist/types/Coscine.Api/@coscine/api/organization-api.d.ts +18 -10
  11. package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +142 -55
  12. package/dist/types/Coscine.Api/@coscine/api/project-api.d.ts +30 -22
  13. package/dist/types/Coscine.Api/@coscine/api/project-invitation-api.d.ts +16 -16
  14. package/dist/types/Coscine.Api/@coscine/api/project-member-api.d.ts +20 -20
  15. package/dist/types/Coscine.Api/@coscine/api/project-publication-request-api.d.ts +142 -0
  16. package/dist/types/Coscine.Api/@coscine/api/project-quota-api.d.ts +12 -12
  17. package/dist/types/Coscine.Api/@coscine/api/project-resource-api.d.ts +20 -20
  18. package/dist/types/Coscine.Api/@coscine/api/project-resource-quota-api.d.ts +4 -4
  19. package/dist/types/Coscine.Api/@coscine/api/project-resource-type-api.d.ts +4 -4
  20. package/dist/types/Coscine.Api/@coscine/api/resource-api.d.ts +4 -4
  21. package/dist/types/Coscine.Api/@coscine/api/resource-type-api.d.ts +20 -20
  22. package/dist/types/Coscine.Api/@coscine/api/role-api.d.ts +8 -8
  23. package/dist/types/Coscine.Api/@coscine/api/search-api.d.ts +4 -4
  24. package/dist/types/Coscine.Api/@coscine/api/self-api-token-api.d.ts +16 -16
  25. package/dist/types/Coscine.Api/@coscine/api/self-api.d.ts +24 -24
  26. package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts +8 -8
  27. package/dist/types/Coscine.Api/@coscine/api/tos-api.d.ts +4 -4
  28. package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts +108 -14
  29. package/dist/types/Coscine.Api/@coscine/api/user-api.d.ts +4 -4
  30. package/dist/types/Coscine.Api/@coscine/api/visibility-api.d.ts +8 -8
  31. package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts +8 -8
  32. package/dist/types/Coscine.Api/@coscine/model/{language-dto-paged-response.d.ts → activity-log-dto-paged-response.d.ts} +10 -10
  33. package/dist/types/Coscine.Api/@coscine/model/activity-log-dto.d.ts +60 -0
  34. package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.d.ts +24 -0
  35. package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto-response.d.ts → handle-dto-response.d.ts} +9 -9
  36. package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto.d.ts → handle-dto.d.ts} +12 -11
  37. package/dist/types/Coscine.Api/@coscine/model/handle-for-update-dto.d.ts +25 -0
  38. package/dist/types/Coscine.Api/@coscine/model/handle-value-dto.d.ts +72 -0
  39. package/dist/types/Coscine.Api/@coscine/model/handle-value-for-update-dto.d.ts +36 -0
  40. package/dist/types/Coscine.Api/@coscine/model/index.d.ts +15 -2
  41. package/dist/types/Coscine.Api/@coscine/model/license-dto.d.ts +6 -0
  42. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto.d.ts +7 -0
  43. package/dist/types/Coscine.Api/@coscine/model/metadata-tree-extracted-dto.d.ts +50 -0
  44. package/dist/types/Coscine.Api/@coscine/model/organization-dto.d.ts +7 -0
  45. package/dist/types/Coscine.Api/@coscine/model/{title-dto-paged-response.d.ts → pid-dto-paged-response.d.ts} +10 -10
  46. package/dist/types/Coscine.Api/@coscine/model/{user-dto-ienumerable-paged-response.d.ts → pid-dto-response.d.ts} +9 -16
  47. package/dist/types/Coscine.Api/@coscine/model/pid-dto.d.ts +49 -0
  48. package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +1 -1
  49. package/dist/types/Coscine.Api/@coscine/model/publication-advisory-service-dto.d.ts +30 -0
  50. package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto-response.d.ts +43 -0
  51. package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto.d.ts +36 -0
  52. package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto.d.ts +6 -0
  53. package/dist/types/Coscine.Api/@coscine/model/resource-dto.d.ts +6 -0
  54. package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto.d.ts +6 -0
  55. package/dist/types/Coscine.Api/@coscine/model/user-institute-dto.d.ts +7 -0
  56. package/dist/types/Coscine.Api/@coscine/model/user-organization-dto.d.ts +7 -0
  57. package/dist/types/Coscine.Api/api.d.ts +2 -0
  58. package/dist/types/apis.d.ts +13 -1
  59. package/dist/types/index.d.ts +26 -2
  60. package/package.json +2 -2
  61. package/dist/types/Coscine.Api/@coscine/model/project-admin-dto-ienumerable-paged-response.d.ts +0 -50
  62. package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-ienumerable-paged-response.d.ts +0 -50
@@ -27,7 +27,7 @@ export declare const ProjectResourceTypeApiAxiosParamCreator: (configuration?: C
27
27
  */
28
28
  apiV2ProjectsProjectIdResourceTypesOptions: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
29
29
  /**
30
- *
30
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
31
31
  * @summary Retrieves the available resource types information for a specific project.
32
32
  * @param {string} projectId The Id or slug of the project.
33
33
  * @param {*} [options] Override http request option.
@@ -49,7 +49,7 @@ export declare const ProjectResourceTypeApiFp: (configuration?: Configuration) =
49
49
  */
50
50
  apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
51
51
  /**
52
- *
52
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
53
53
  * @summary Retrieves the available resource types information for a specific project.
54
54
  * @param {string} projectId The Id or slug of the project.
55
55
  * @param {*} [options] Override http request option.
@@ -71,7 +71,7 @@ export declare const ProjectResourceTypeApiFactory: (configuration?: Configurati
71
71
  */
72
72
  apiV2ProjectsProjectIdResourceTypesOptions(requestParameters: ProjectResourceTypeApiApiV2ProjectsProjectIdResourceTypesOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
73
73
  /**
74
- *
74
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
75
75
  * @summary Retrieves the available resource types information for a specific project.
76
76
  * @param {ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest} requestParameters Request parameters.
77
77
  * @param {*} [options] Override http request option.
@@ -122,7 +122,7 @@ export declare class ProjectResourceTypeApi extends BaseAPI {
122
122
  */
123
123
  apiV2ProjectsProjectIdResourceTypesOptions(requestParameters: ProjectResourceTypeApiApiV2ProjectsProjectIdResourceTypesOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
124
124
  /**
125
- *
125
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
126
126
  * @summary Retrieves the available resource types information for a specific project.
127
127
  * @param {ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest} requestParameters Request parameters.
128
128
  * @param {*} [options] Override http request option.
@@ -26,7 +26,7 @@ export declare const ResourceApiAxiosParamCreator: (configuration?: Configuratio
26
26
  */
27
27
  apiV2ResourcesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
28
28
  /**
29
- *
29
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
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.
@@ -28,7 +28,7 @@ export declare const SelfApiTokenApiAxiosParamCreator: (configuration?: Configur
28
28
  */
29
29
  apiV2SelfApiTokensOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
30
  /**
31
- *
31
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
32
32
  * @summary Creates an API token for the current authenticated user.
33
33
  * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation.
34
34
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ export declare const SelfApiTokenApiAxiosParamCreator: (configuration?: Configur
36
36
  */
37
37
  createApiToken: (apiTokenForCreationDto?: ApiTokenForCreationDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
38
38
  /**
39
- *
39
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
40
40
  * @summary Retrieves all API tokens for the current authenticated user.
41
41
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
42
42
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
@@ -46,7 +46,7 @@ export declare const SelfApiTokenApiAxiosParamCreator: (configuration?: Configur
46
46
  */
47
47
  getAllApiTokens: (pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48
48
  /**
49
- *
49
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
50
50
  * @summary Retrieves an API token for the current authenticated user.
51
51
  * @param {string} apiTokenId The ID of the token.
52
52
  * @param {*} [options] Override http request option.
@@ -54,7 +54,7 @@ export declare const SelfApiTokenApiAxiosParamCreator: (configuration?: Configur
54
54
  */
55
55
  getApiToken: (apiTokenId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
56
  /**
57
- *
57
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
58
58
  * @summary Revokes an API token for the current authenticated user.
59
59
  * @param {string} apiTokenId The ID of the token.
60
60
  * @param {*} [options] Override http request option.
@@ -75,7 +75,7 @@ export declare const SelfApiTokenApiFp: (configuration?: Configuration) => {
75
75
  */
76
76
  apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
77
77
  /**
78
- *
78
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
79
79
  * @summary Creates an API token for the current authenticated user.
80
80
  * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation.
81
81
  * @param {*} [options] Override http request option.
@@ -83,7 +83,7 @@ export declare const SelfApiTokenApiFp: (configuration?: Configuration) => {
83
83
  */
84
84
  createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>>;
85
85
  /**
86
- *
86
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
87
87
  * @summary Retrieves all API tokens for the current authenticated user.
88
88
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
89
89
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
@@ -93,7 +93,7 @@ export declare const SelfApiTokenApiFp: (configuration?: Configuration) => {
93
93
  */
94
94
  getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoPagedResponse>>;
95
95
  /**
96
- *
96
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
97
97
  * @summary Retrieves an API token for the current authenticated user.
98
98
  * @param {string} apiTokenId The ID of the token.
99
99
  * @param {*} [options] Override http request option.
@@ -101,7 +101,7 @@ export declare const SelfApiTokenApiFp: (configuration?: Configuration) => {
101
101
  */
102
102
  getApiToken(apiTokenId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>>;
103
103
  /**
104
- *
104
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
105
105
  * @summary Revokes an API token for the current authenticated user.
106
106
  * @param {string} apiTokenId The ID of the token.
107
107
  * @param {*} [options] Override http request option.
@@ -122,7 +122,7 @@ export declare const SelfApiTokenApiFactory: (configuration?: Configuration, bas
122
122
  */
123
123
  apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
124
124
  /**
125
- *
125
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
126
126
  * @summary Creates an API token for the current authenticated user.
127
127
  * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters.
128
128
  * @param {*} [options] Override http request option.
@@ -130,7 +130,7 @@ export declare const SelfApiTokenApiFactory: (configuration?: Configuration, bas
130
130
  */
131
131
  createApiToken(requestParameters?: SelfApiTokenApiCreateApiTokenRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoResponse>;
132
132
  /**
133
- *
133
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
134
134
  * @summary Retrieves all API tokens for the current authenticated user.
135
135
  * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters.
136
136
  * @param {*} [options] Override http request option.
@@ -138,7 +138,7 @@ export declare const SelfApiTokenApiFactory: (configuration?: Configuration, bas
138
138
  */
139
139
  getAllApiTokens(requestParameters?: SelfApiTokenApiGetAllApiTokensRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoPagedResponse>;
140
140
  /**
141
- *
141
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
142
142
  * @summary Retrieves an API token for the current authenticated user.
143
143
  * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters.
144
144
  * @param {*} [options] Override http request option.
@@ -146,7 +146,7 @@ export declare const SelfApiTokenApiFactory: (configuration?: Configuration, bas
146
146
  */
147
147
  getApiToken(requestParameters: SelfApiTokenApiGetApiTokenRequest, options?: AxiosRequestConfig): AxiosPromise<ApiTokenDtoResponse>;
148
148
  /**
149
- *
149
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
150
150
  * @summary Revokes an API token for the current authenticated user.
151
151
  * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters.
152
152
  * @param {*} [options] Override http request option.
@@ -234,7 +234,7 @@ export declare class SelfApiTokenApi extends BaseAPI {
234
234
  */
235
235
  apiV2SelfApiTokensOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
236
236
  /**
237
- *
237
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
238
238
  * @summary Creates an API token for the current authenticated user.
239
239
  * @param {SelfApiTokenApiCreateApiTokenRequest} requestParameters Request parameters.
240
240
  * @param {*} [options] Override http request option.
@@ -243,7 +243,7 @@ export declare class SelfApiTokenApi extends BaseAPI {
243
243
  */
244
244
  createApiToken(requestParameters?: SelfApiTokenApiCreateApiTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoResponse, any>>;
245
245
  /**
246
- *
246
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
247
247
  * @summary Retrieves all API tokens for the current authenticated user.
248
248
  * @param {SelfApiTokenApiGetAllApiTokensRequest} requestParameters Request parameters.
249
249
  * @param {*} [options] Override http request option.
@@ -252,7 +252,7 @@ export declare class SelfApiTokenApi extends BaseAPI {
252
252
  */
253
253
  getAllApiTokens(requestParameters?: SelfApiTokenApiGetAllApiTokensRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoPagedResponse, any>>;
254
254
  /**
255
- *
255
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
256
256
  * @summary Retrieves an API token for the current authenticated user.
257
257
  * @param {SelfApiTokenApiGetApiTokenRequest} requestParameters Request parameters.
258
258
  * @param {*} [options] Override http request option.
@@ -261,7 +261,7 @@ export declare class SelfApiTokenApi extends BaseAPI {
261
261
  */
262
262
  getApiToken(requestParameters: SelfApiTokenApiGetApiTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiTokenDtoResponse, any>>;
263
263
  /**
264
- *
264
+ * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
265
265
  * @summary Revokes an API token for the current authenticated user.
266
266
  * @param {SelfApiTokenApiRevokeTokenRequest} requestParameters Request parameters.
267
267
  * @param {*} [options] Override http request option.