@coscine/api-client 3.3.0 → 3.3.1

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 CHANGED
@@ -2627,7 +2627,7 @@ const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, confi
2627
2627
 
2628
2628
  /* tslint:disable */
2629
2629
  /**
2630
- *
2630
+ * Accepted languages by the API.
2631
2631
  * @export
2632
2632
  * @enum {string}
2633
2633
  */
@@ -2637,7 +2637,19 @@ var AcceptedLanguage;
2637
2637
  AcceptedLanguage["En"] = "en";
2638
2638
  })(AcceptedLanguage || (AcceptedLanguage = {}));
2639
2639
  /**
2640
- *
2640
+ * Represents the possible HTTP methods associated with file actions.
2641
+ * @export
2642
+ * @enum {string}
2643
+ */
2644
+ var FileActionHttpMethod;
2645
+ (function (FileActionHttpMethod) {
2646
+ FileActionHttpMethod["Get"] = "GET";
2647
+ FileActionHttpMethod["Post"] = "POST";
2648
+ FileActionHttpMethod["Put"] = "PUT";
2649
+ FileActionHttpMethod["Delete"] = "DELETE";
2650
+ })(FileActionHttpMethod || (FileActionHttpMethod = {}));
2651
+ /**
2652
+ * Specifies the supported external authentication services.
2641
2653
  * @export
2642
2654
  * @enum {string}
2643
2655
  */
@@ -2647,7 +2659,7 @@ var IdentityProviders;
2647
2659
  IdentityProviders["OrciD"] = "ORCiD";
2648
2660
  })(IdentityProviders || (IdentityProviders = {}));
2649
2661
  /**
2650
- *
2662
+ * Specifies the type of PID.
2651
2663
  * @export
2652
2664
  * @enum {string}
2653
2665
  */
@@ -2657,7 +2669,7 @@ var PidType;
2657
2669
  PidType["Resource"] = "resource";
2658
2670
  })(PidType || (PidType = {}));
2659
2671
  /**
2660
- *
2672
+ * Specifies the unit of quota.
2661
2673
  * @export
2662
2674
  * @enum {string}
2663
2675
  */
@@ -2671,7 +2683,7 @@ var QuotaUnit;
2671
2683
  QuotaUnit["PebiByte"] = "https://qudt.org/vocab/unit/PebiBYTE";
2672
2684
  })(QuotaUnit || (QuotaUnit = {}));
2673
2685
  /**
2674
- *
2686
+ * Specifies the RDF <i>(Resource Description Framework)</i> format.
2675
2687
  * @export
2676
2688
  * @enum {string}
2677
2689
  */
@@ -2681,7 +2693,7 @@ var RdfFormat;
2681
2693
  RdfFormat["ApplicationLdjson"] = "application/ld+json";
2682
2694
  })(RdfFormat || (RdfFormat = {}));
2683
2695
  /**
2684
- *
2696
+ * Specifies the status of a resource type.
2685
2697
  * @export
2686
2698
  * @enum {string}
2687
2699
  */
@@ -2691,7 +2703,7 @@ var ResourceTypeStatus;
2691
2703
  ResourceTypeStatus["Active"] = "active";
2692
2704
  })(ResourceTypeStatus || (ResourceTypeStatus = {}));
2693
2705
  /**
2694
- *
2706
+ * Specifies the search item type.
2695
2707
  * @export
2696
2708
  * @enum {string}
2697
2709
  */
@@ -2821,7 +2833,7 @@ const ApplicationProfileApiAxiosParamCreator = function (configuration) {
2821
2833
  * @param {AcceptedLanguage} [language]
2822
2834
  * @param {boolean} [modules]
2823
2835
  * @param {number} [pageNumber]
2824
- * @param {number} [pageSize]
2836
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
2825
2837
  * @param {string} [orderBy]
2826
2838
  * @param {*} [options] Override http request option.
2827
2839
  * @throws {RequiredError}
@@ -2952,7 +2964,7 @@ const ApplicationProfileApiFp = function (configuration) {
2952
2964
  * @param {AcceptedLanguage} [language]
2953
2965
  * @param {boolean} [modules]
2954
2966
  * @param {number} [pageNumber]
2955
- * @param {number} [pageSize]
2967
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
2956
2968
  * @param {string} [orderBy]
2957
2969
  * @param {*} [options] Override http request option.
2958
2970
  * @throws {RequiredError}
@@ -3023,7 +3035,7 @@ const ApplicationProfileApiFactory = function (configuration, basePath, axios) {
3023
3035
  * @param {AcceptedLanguage} [language]
3024
3036
  * @param {boolean} [modules]
3025
3037
  * @param {number} [pageNumber]
3026
- * @param {number} [pageSize]
3038
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3027
3039
  * @param {string} [orderBy]
3028
3040
  * @param {*} [options] Override http request option.
3029
3041
  * @throws {RequiredError}
@@ -3479,7 +3491,7 @@ const DisciplineApiAxiosParamCreator = function (configuration) {
3479
3491
  *
3480
3492
  * @summary Retrieves all disciplines.
3481
3493
  * @param {number} [pageNumber]
3482
- * @param {number} [pageSize]
3494
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3483
3495
  * @param {string} [orderBy]
3484
3496
  * @param {*} [options] Override http request option.
3485
3497
  * @throws {RequiredError}
@@ -3552,7 +3564,7 @@ const DisciplineApiFp = function (configuration) {
3552
3564
  *
3553
3565
  * @summary Retrieves all disciplines.
3554
3566
  * @param {number} [pageNumber]
3555
- * @param {number} [pageSize]
3567
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3556
3568
  * @param {string} [orderBy]
3557
3569
  * @param {*} [options] Override http request option.
3558
3570
  * @throws {RequiredError}
@@ -3595,7 +3607,7 @@ const DisciplineApiFactory = function (configuration, basePath, axios) {
3595
3607
  *
3596
3608
  * @summary Retrieves all disciplines.
3597
3609
  * @param {number} [pageNumber]
3598
- * @param {number} [pageSize]
3610
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3599
3611
  * @param {string} [orderBy]
3600
3612
  * @param {*} [options] Override http request option.
3601
3613
  * @throws {RequiredError}
@@ -3673,7 +3685,7 @@ const LanguageApiAxiosParamCreator = function (configuration) {
3673
3685
  *
3674
3686
  * @summary Retrieves all languages.
3675
3687
  * @param {number} [pageNumber]
3676
- * @param {number} [pageSize]
3688
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3677
3689
  * @param {string} [orderBy]
3678
3690
  * @param {*} [options] Override http request option.
3679
3691
  * @throws {RequiredError}
@@ -3746,7 +3758,7 @@ const LanguageApiFp = function (configuration) {
3746
3758
  *
3747
3759
  * @summary Retrieves all languages.
3748
3760
  * @param {number} [pageNumber]
3749
- * @param {number} [pageSize]
3761
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3750
3762
  * @param {string} [orderBy]
3751
3763
  * @param {*} [options] Override http request option.
3752
3764
  * @throws {RequiredError}
@@ -3789,7 +3801,7 @@ const LanguageApiFactory = function (configuration, basePath, axios) {
3789
3801
  *
3790
3802
  * @summary Retrieves all languages.
3791
3803
  * @param {number} [pageNumber]
3792
- * @param {number} [pageSize]
3804
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3793
3805
  * @param {string} [orderBy]
3794
3806
  * @param {*} [options] Override http request option.
3795
3807
  * @throws {RequiredError}
@@ -3867,7 +3879,7 @@ const LicenseApiAxiosParamCreator = function (configuration) {
3867
3879
  *
3868
3880
  * @summary Retrieves all licenses.
3869
3881
  * @param {number} [pageNumber]
3870
- * @param {number} [pageSize]
3882
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3871
3883
  * @param {string} [orderBy]
3872
3884
  * @param {*} [options] Override http request option.
3873
3885
  * @throws {RequiredError}
@@ -3940,7 +3952,7 @@ const LicenseApiFp = function (configuration) {
3940
3952
  *
3941
3953
  * @summary Retrieves all licenses.
3942
3954
  * @param {number} [pageNumber]
3943
- * @param {number} [pageSize]
3955
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3944
3956
  * @param {string} [orderBy]
3945
3957
  * @param {*} [options] Override http request option.
3946
3958
  * @throws {RequiredError}
@@ -3983,7 +3995,7 @@ const LicenseApiFactory = function (configuration, basePath, axios) {
3983
3995
  *
3984
3996
  * @summary Retrieves all licenses.
3985
3997
  * @param {number} [pageNumber]
3986
- * @param {number} [pageSize]
3998
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
3987
3999
  * @param {string} [orderBy]
3988
4000
  * @param {*} [options] Override http request option.
3989
4001
  * @throws {RequiredError}
@@ -4184,7 +4196,7 @@ const OrganizationApiAxiosParamCreator = function (configuration) {
4184
4196
  * @summary Retrieves all organizations.
4185
4197
  * @param {string} [searchTerm]
4186
4198
  * @param {number} [pageNumber]
4187
- * @param {number} [pageSize]
4199
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4188
4200
  * @param {string} [orderBy]
4189
4201
  * @param {*} [options] Override http request option.
4190
4202
  * @throws {RequiredError}
@@ -4261,7 +4273,7 @@ const OrganizationApiFp = function (configuration) {
4261
4273
  * @summary Retrieves all organizations.
4262
4274
  * @param {string} [searchTerm]
4263
4275
  * @param {number} [pageNumber]
4264
- * @param {number} [pageSize]
4276
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4265
4277
  * @param {string} [orderBy]
4266
4278
  * @param {*} [options] Override http request option.
4267
4279
  * @throws {RequiredError}
@@ -4305,7 +4317,7 @@ const OrganizationApiFactory = function (configuration, basePath, axios) {
4305
4317
  * @summary Retrieves all organizations.
4306
4318
  * @param {string} [searchTerm]
4307
4319
  * @param {number} [pageNumber]
4308
- * @param {number} [pageSize]
4320
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4309
4321
  * @param {string} [orderBy]
4310
4322
  * @param {*} [options] Override http request option.
4311
4323
  * @throws {RequiredError}
@@ -4648,7 +4660,7 @@ const ProjectApiAxiosParamCreator = function (configuration) {
4648
4660
  * @summary Retrieves all projects.
4649
4661
  * @param {boolean} [topLevel]
4650
4662
  * @param {number} [pageNumber]
4651
- * @param {number} [pageSize]
4663
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4652
4664
  * @param {string} [orderBy]
4653
4665
  * @param {*} [options] Override http request option.
4654
4666
  * @throws {RequiredError}
@@ -4786,7 +4798,7 @@ const ProjectApiFp = function (configuration) {
4786
4798
  * @summary Retrieves all projects.
4787
4799
  * @param {boolean} [topLevel]
4788
4800
  * @param {number} [pageNumber]
4789
- * @param {number} [pageSize]
4801
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4790
4802
  * @param {string} [orderBy]
4791
4803
  * @param {*} [options] Override http request option.
4792
4804
  * @throws {RequiredError}
@@ -4865,7 +4877,7 @@ const ProjectApiFactory = function (configuration, basePath, axios) {
4865
4877
  * @summary Retrieves all projects.
4866
4878
  * @param {boolean} [topLevel]
4867
4879
  * @param {number} [pageNumber]
4868
- * @param {number} [pageSize]
4880
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
4869
4881
  * @param {string} [orderBy]
4870
4882
  * @param {*} [options] Override http request option.
4871
4883
  * @throws {RequiredError}
@@ -5032,7 +5044,7 @@ const ProjectInvitationApiAxiosParamCreator = function (configuration) {
5032
5044
  * @summary Retrieves all project invitations for a specified project.
5033
5045
  * @param {string} projectId The Id or slug of the project.
5034
5046
  * @param {number} [pageNumber]
5035
- * @param {number} [pageSize]
5047
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5036
5048
  * @param {string} [orderBy]
5037
5049
  * @param {*} [options] Override http request option.
5038
5050
  * @throws {RequiredError}
@@ -5139,7 +5151,7 @@ const ProjectInvitationApiFp = function (configuration) {
5139
5151
  * @summary Retrieves all project invitations for a specified project.
5140
5152
  * @param {string} projectId The Id or slug of the project.
5141
5153
  * @param {number} [pageNumber]
5142
- * @param {number} [pageSize]
5154
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5143
5155
  * @param {string} [orderBy]
5144
5156
  * @param {*} [options] Override http request option.
5145
5157
  * @throws {RequiredError}
@@ -5207,7 +5219,7 @@ const ProjectInvitationApiFactory = function (configuration, basePath, axios) {
5207
5219
  * @summary Retrieves all project invitations for a specified project.
5208
5220
  * @param {string} projectId The Id or slug of the project.
5209
5221
  * @param {number} [pageNumber]
5210
- * @param {number} [pageSize]
5222
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5211
5223
  * @param {string} [orderBy]
5212
5224
  * @param {*} [options] Override http request option.
5213
5225
  * @throws {RequiredError}
@@ -5363,7 +5375,7 @@ const ProjectMemberApiAxiosParamCreator = function (configuration) {
5363
5375
  * @summary Retrieves all project memberships for a specified project.
5364
5376
  * @param {string} projectId The Id or slug of the project.
5365
5377
  * @param {number} [pageNumber]
5366
- * @param {number} [pageSize]
5378
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5367
5379
  * @param {string} [orderBy]
5368
5380
  * @param {*} [options] Override http request option.
5369
5381
  * @throws {RequiredError}
@@ -5508,7 +5520,7 @@ const ProjectMemberApiFp = function (configuration) {
5508
5520
  * @summary Retrieves all project memberships for a specified project.
5509
5521
  * @param {string} projectId The Id or slug of the project.
5510
5522
  * @param {number} [pageNumber]
5511
- * @param {number} [pageSize]
5523
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5512
5524
  * @param {string} [orderBy]
5513
5525
  * @param {*} [options] Override http request option.
5514
5526
  * @throws {RequiredError}
@@ -5591,7 +5603,7 @@ const ProjectMemberApiFactory = function (configuration, basePath, axios) {
5591
5603
  * @summary Retrieves all project memberships for a specified project.
5592
5604
  * @param {string} projectId The Id or slug of the project.
5593
5605
  * @param {number} [pageNumber]
5594
- * @param {number} [pageSize]
5606
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5595
5607
  * @param {string} [orderBy]
5596
5608
  * @param {*} [options] Override http request option.
5597
5609
  * @throws {RequiredError}
@@ -5690,7 +5702,7 @@ const ProjectQuotaApiAxiosParamCreator = function (configuration) {
5690
5702
  * @summary Retrieves all project quotas for a specified project.
5691
5703
  * @param {string} projectId The Id or slug of the project.
5692
5704
  * @param {number} [pageNumber]
5693
- * @param {number} [pageSize]
5705
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5694
5706
  * @param {string} [orderBy]
5695
5707
  * @param {*} [options] Override http request option.
5696
5708
  * @throws {RequiredError}
@@ -5807,7 +5819,7 @@ const ProjectQuotaApiFp = function (configuration) {
5807
5819
  * @summary Retrieves all project quotas for a specified project.
5808
5820
  * @param {string} projectId The Id or slug of the project.
5809
5821
  * @param {number} [pageNumber]
5810
- * @param {number} [pageSize]
5822
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5811
5823
  * @param {string} [orderBy]
5812
5824
  * @param {*} [options] Override http request option.
5813
5825
  * @throws {RequiredError}
@@ -5868,7 +5880,7 @@ const ProjectQuotaApiFactory = function (configuration, basePath, axios) {
5868
5880
  * @summary Retrieves all project quotas for a specified project.
5869
5881
  * @param {string} projectId The Id or slug of the project.
5870
5882
  * @param {number} [pageNumber]
5871
- * @param {number} [pageSize]
5883
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
5872
5884
  * @param {string} [orderBy]
5873
5885
  * @param {*} [options] Override http request option.
5874
5886
  * @throws {RequiredError}
@@ -6036,7 +6048,7 @@ const ProjectResourceApiAxiosParamCreator = function (configuration) {
6036
6048
  * @summary Retrieves all resources for a specified project.
6037
6049
  * @param {string} projectId The Id or slug of the project.
6038
6050
  * @param {number} [pageNumber]
6039
- * @param {number} [pageSize]
6051
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
6040
6052
  * @param {string} [orderBy]
6041
6053
  * @param {*} [options] Override http request option.
6042
6054
  * @throws {RequiredError}
@@ -6181,7 +6193,7 @@ const ProjectResourceApiFp = function (configuration) {
6181
6193
  * @summary Retrieves all resources for a specified project.
6182
6194
  * @param {string} projectId The Id or slug of the project.
6183
6195
  * @param {number} [pageNumber]
6184
- * @param {number} [pageSize]
6196
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
6185
6197
  * @param {string} [orderBy]
6186
6198
  * @param {*} [options] Override http request option.
6187
6199
  * @throws {RequiredError}
@@ -6264,7 +6276,7 @@ const ProjectResourceApiFactory = function (configuration, basePath, axios) {
6264
6276
  * @summary Retrieves all resources for a specified project.
6265
6277
  * @param {string} projectId The Id or slug of the project.
6266
6278
  * @param {number} [pageNumber]
6267
- * @param {number} [pageSize]
6279
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
6268
6280
  * @param {string} [orderBy]
6269
6281
  * @param {*} [options] Override http request option.
6270
6282
  * @throws {RequiredError}
@@ -6731,8 +6743,8 @@ const ResourceTypeApiAxiosParamCreator = function (configuration) {
6731
6743
  *
6732
6744
  * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
6733
6745
  * @param {number} gitlabProjectId The ID of the GitLab project.
6734
- * @param {string} domain
6735
- * @param {string} accessToken
6746
+ * @param {string} domain Domain/Host of the GitLab Provider
6747
+ * @param {string} accessToken GitLab Project or Group Access Token
6736
6748
  * @param {*} [options] Override http request option.
6737
6749
  * @throws {RequiredError}
6738
6750
  */
@@ -6773,8 +6785,8 @@ const ResourceTypeApiAxiosParamCreator = function (configuration) {
6773
6785
  /**
6774
6786
  *
6775
6787
  * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
6776
- * @param {string} domain
6777
- * @param {string} accessToken
6788
+ * @param {string} domain Domain/Host of the GitLab Provider
6789
+ * @param {string} accessToken GitLab Project or Group Access Token
6778
6790
  * @param {*} [options] Override http request option.
6779
6791
  * @throws {RequiredError}
6780
6792
  */
@@ -6840,8 +6852,8 @@ const ResourceTypeApiAxiosParamCreator = function (configuration) {
6840
6852
  *
6841
6853
  * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
6842
6854
  * @param {number} gitlabProjectId The ID of the GitLab project.
6843
- * @param {string} domain
6844
- * @param {string} accessToken
6855
+ * @param {string} domain Domain/Host of the GitLab Provider
6856
+ * @param {string} accessToken GitLab Project or Group Access Token
6845
6857
  * @param {*} [options] Override http request option.
6846
6858
  * @throws {RequiredError}
6847
6859
  */
@@ -6935,8 +6947,8 @@ const ResourceTypeApiFp = function (configuration) {
6935
6947
  *
6936
6948
  * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
6937
6949
  * @param {number} gitlabProjectId The ID of the GitLab project.
6938
- * @param {string} domain
6939
- * @param {string} accessToken
6950
+ * @param {string} domain Domain/Host of the GitLab Provider
6951
+ * @param {string} accessToken GitLab Project or Group Access Token
6940
6952
  * @param {*} [options] Override http request option.
6941
6953
  * @throws {RequiredError}
6942
6954
  */
@@ -6949,8 +6961,8 @@ const ResourceTypeApiFp = function (configuration) {
6949
6961
  /**
6950
6962
  *
6951
6963
  * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
6952
- * @param {string} domain
6953
- * @param {string} accessToken
6964
+ * @param {string} domain Domain/Host of the GitLab Provider
6965
+ * @param {string} accessToken GitLab Project or Group Access Token
6954
6966
  * @param {*} [options] Override http request option.
6955
6967
  * @throws {RequiredError}
6956
6968
  */
@@ -6976,8 +6988,8 @@ const ResourceTypeApiFp = function (configuration) {
6976
6988
  *
6977
6989
  * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
6978
6990
  * @param {number} gitlabProjectId The ID of the GitLab project.
6979
- * @param {string} domain
6980
- * @param {string} accessToken
6991
+ * @param {string} domain Domain/Host of the GitLab Provider
6992
+ * @param {string} accessToken GitLab Project or Group Access Token
6981
6993
  * @param {*} [options] Override http request option.
6982
6994
  * @throws {RequiredError}
6983
6995
  */
@@ -7022,8 +7034,8 @@ const ResourceTypeApiFactory = function (configuration, basePath, axios) {
7022
7034
  *
7023
7035
  * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
7024
7036
  * @param {number} gitlabProjectId The ID of the GitLab project.
7025
- * @param {string} domain
7026
- * @param {string} accessToken
7037
+ * @param {string} domain Domain/Host of the GitLab Provider
7038
+ * @param {string} accessToken GitLab Project or Group Access Token
7027
7039
  * @param {*} [options] Override http request option.
7028
7040
  * @throws {RequiredError}
7029
7041
  */
@@ -7033,8 +7045,8 @@ const ResourceTypeApiFactory = function (configuration, basePath, axios) {
7033
7045
  /**
7034
7046
  *
7035
7047
  * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
7036
- * @param {string} domain
7037
- * @param {string} accessToken
7048
+ * @param {string} domain Domain/Host of the GitLab Provider
7049
+ * @param {string} accessToken GitLab Project or Group Access Token
7038
7050
  * @param {*} [options] Override http request option.
7039
7051
  * @throws {RequiredError}
7040
7052
  */
@@ -7054,8 +7066,8 @@ const ResourceTypeApiFactory = function (configuration, basePath, axios) {
7054
7066
  *
7055
7067
  * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
7056
7068
  * @param {number} gitlabProjectId The ID of the GitLab project.
7057
- * @param {string} domain
7058
- * @param {string} accessToken
7069
+ * @param {string} domain Domain/Host of the GitLab Provider
7070
+ * @param {string} accessToken GitLab Project or Group Access Token
7059
7071
  * @param {*} [options] Override http request option.
7060
7072
  * @throws {RequiredError}
7061
7073
  */
@@ -7142,7 +7154,7 @@ const RoleApiAxiosParamCreator = function (configuration) {
7142
7154
  *
7143
7155
  * @summary Retrieves all roles.
7144
7156
  * @param {number} [pageNumber]
7145
- * @param {number} [pageSize]
7157
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7146
7158
  * @param {string} [orderBy]
7147
7159
  * @param {*} [options] Override http request option.
7148
7160
  * @throws {RequiredError}
@@ -7215,7 +7227,7 @@ const RoleApiFp = function (configuration) {
7215
7227
  *
7216
7228
  * @summary Retrieves all roles.
7217
7229
  * @param {number} [pageNumber]
7218
- * @param {number} [pageSize]
7230
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7219
7231
  * @param {string} [orderBy]
7220
7232
  * @param {*} [options] Override http request option.
7221
7233
  * @throws {RequiredError}
@@ -7258,7 +7270,7 @@ const RoleApiFactory = function (configuration, basePath, axios) {
7258
7270
  *
7259
7271
  * @summary Retrieves all roles.
7260
7272
  * @param {number} [pageNumber]
7261
- * @param {number} [pageSize]
7273
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7262
7274
  * @param {string} [orderBy]
7263
7275
  * @param {*} [options] Override http request option.
7264
7276
  * @throws {RequiredError}
@@ -7304,12 +7316,12 @@ const SearchApiAxiosParamCreator = function (configuration) {
7304
7316
  /**
7305
7317
  *
7306
7318
  * @summary Retrieves a search result by given search parameters.
7307
- * @param {string} [query]
7308
- * @param {boolean} [useAdvancedSyntax]
7309
- * @param {Array<string>} [languages]
7310
- * @param {SearchCategoryType} [category]
7319
+ * @param {string} [query] The search query
7320
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
7321
+ * @param {Array<string>} [languages] Set the used languages
7322
+ * @param {SearchCategoryType} [category] Set the category filter
7311
7323
  * @param {number} [pageNumber]
7312
- * @param {number} [pageSize]
7324
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7313
7325
  * @param {string} [orderBy]
7314
7326
  * @param {*} [options] Override http request option.
7315
7327
  * @throws {RequiredError}
@@ -7380,12 +7392,12 @@ const SearchApiFp = function (configuration) {
7380
7392
  /**
7381
7393
  *
7382
7394
  * @summary Retrieves a search result by given search parameters.
7383
- * @param {string} [query]
7384
- * @param {boolean} [useAdvancedSyntax]
7385
- * @param {Array<string>} [languages]
7386
- * @param {SearchCategoryType} [category]
7395
+ * @param {string} [query] The search query
7396
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
7397
+ * @param {Array<string>} [languages] Set the used languages
7398
+ * @param {SearchCategoryType} [category] Set the category filter
7387
7399
  * @param {number} [pageNumber]
7388
- * @param {number} [pageSize]
7400
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7389
7401
  * @param {string} [orderBy]
7390
7402
  * @param {*} [options] Override http request option.
7391
7403
  * @throws {RequiredError}
@@ -7417,12 +7429,12 @@ const SearchApiFactory = function (configuration, basePath, axios) {
7417
7429
  /**
7418
7430
  *
7419
7431
  * @summary Retrieves a search result by given search parameters.
7420
- * @param {string} [query]
7421
- * @param {boolean} [useAdvancedSyntax]
7422
- * @param {Array<string>} [languages]
7423
- * @param {SearchCategoryType} [category]
7432
+ * @param {string} [query] The search query
7433
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
7434
+ * @param {Array<string>} [languages] Set the used languages
7435
+ * @param {SearchCategoryType} [category] Set the category filter
7424
7436
  * @param {number} [pageNumber]
7425
- * @param {number} [pageSize]
7437
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7426
7438
  * @param {string} [orderBy]
7427
7439
  * @param {*} [options] Override http request option.
7428
7440
  * @throws {RequiredError}
@@ -7892,7 +7904,7 @@ const SelfApiTokenApiAxiosParamCreator = function (configuration) {
7892
7904
  *
7893
7905
  * @summary Retrieves all API tokens for the current authenticated user.
7894
7906
  * @param {number} [pageNumber]
7895
- * @param {number} [pageSize]
7907
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
7896
7908
  * @param {string} [orderBy]
7897
7909
  * @param {*} [options] Override http request option.
7898
7910
  * @throws {RequiredError}
@@ -8027,7 +8039,7 @@ const SelfApiTokenApiFp = function (configuration) {
8027
8039
  *
8028
8040
  * @summary Retrieves all API tokens for the current authenticated user.
8029
8041
  * @param {number} [pageNumber]
8030
- * @param {number} [pageSize]
8042
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8031
8043
  * @param {string} [orderBy]
8032
8044
  * @param {*} [options] Override http request option.
8033
8045
  * @throws {RequiredError}
@@ -8096,7 +8108,7 @@ const SelfApiTokenApiFactory = function (configuration, basePath, axios) {
8096
8108
  *
8097
8109
  * @summary Retrieves all API tokens for the current authenticated user.
8098
8110
  * @param {number} [pageNumber]
8099
- * @param {number} [pageSize]
8111
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8100
8112
  * @param {string} [orderBy]
8101
8113
  * @param {*} [options] Override http request option.
8102
8114
  * @throws {RequiredError}
@@ -8194,7 +8206,7 @@ const TitleApiAxiosParamCreator = function (configuration) {
8194
8206
  *
8195
8207
  * @summary Retrieves all titles.
8196
8208
  * @param {number} [pageNumber]
8197
- * @param {number} [pageSize]
8209
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8198
8210
  * @param {string} [orderBy]
8199
8211
  * @param {*} [options] Override http request option.
8200
8212
  * @throws {RequiredError}
@@ -8267,7 +8279,7 @@ const TitleApiFp = function (configuration) {
8267
8279
  *
8268
8280
  * @summary Retrieves all titles.
8269
8281
  * @param {number} [pageNumber]
8270
- * @param {number} [pageSize]
8282
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8271
8283
  * @param {string} [orderBy]
8272
8284
  * @param {*} [options] Override http request option.
8273
8285
  * @throws {RequiredError}
@@ -8310,7 +8322,7 @@ const TitleApiFactory = function (configuration, basePath, axios) {
8310
8322
  *
8311
8323
  * @summary Retrieves all titles.
8312
8324
  * @param {number} [pageNumber]
8313
- * @param {number} [pageSize]
8325
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8314
8326
  * @param {string} [orderBy]
8315
8327
  * @param {*} [options] Override http request option.
8316
8328
  * @throws {RequiredError}
@@ -8528,7 +8540,7 @@ const TreeApiAxiosParamCreator = function (configuration) {
8528
8540
  * @param {string} resourceId The unique identifier of the resource.
8529
8541
  * @param {string} [path]
8530
8542
  * @param {number} [pageNumber]
8531
- * @param {number} [pageSize]
8543
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8532
8544
  * @param {string} [orderBy]
8533
8545
  * @param {*} [options] Override http request option.
8534
8546
  * @throws {RequiredError}
@@ -8578,9 +8590,9 @@ const TreeApiAxiosParamCreator = function (configuration) {
8578
8590
  * @param {string} projectId The unique identifier or slug of the project.
8579
8591
  * @param {string} resourceId The unique identifier of the resource.
8580
8592
  * @param {string} [path]
8581
- * @param {RdfFormat} [format]
8593
+ * @param {RdfFormat} [format] Value indicating whether to list folder contents recursively, including subfolders.
8582
8594
  * @param {number} [pageNumber]
8583
- * @param {number} [pageSize]
8595
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8584
8596
  * @param {string} [orderBy]
8585
8597
  * @param {*} [options] Override http request option.
8586
8598
  * @throws {RequiredError}
@@ -8710,7 +8722,7 @@ const TreeApiFp = function (configuration) {
8710
8722
  * @param {string} resourceId The unique identifier of the resource.
8711
8723
  * @param {string} [path]
8712
8724
  * @param {number} [pageNumber]
8713
- * @param {number} [pageSize]
8725
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8714
8726
  * @param {string} [orderBy]
8715
8727
  * @param {*} [options] Override http request option.
8716
8728
  * @throws {RequiredError}
@@ -8727,9 +8739,9 @@ const TreeApiFp = function (configuration) {
8727
8739
  * @param {string} projectId The unique identifier or slug of the project.
8728
8740
  * @param {string} resourceId The unique identifier of the resource.
8729
8741
  * @param {string} [path]
8730
- * @param {RdfFormat} [format]
8742
+ * @param {RdfFormat} [format] Value indicating whether to list folder contents recursively, including subfolders.
8731
8743
  * @param {number} [pageNumber]
8732
- * @param {number} [pageSize]
8744
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8733
8745
  * @param {string} [orderBy]
8734
8746
  * @param {*} [options] Override http request option.
8735
8747
  * @throws {RequiredError}
@@ -8794,7 +8806,7 @@ const TreeApiFactory = function (configuration, basePath, axios) {
8794
8806
  * @param {string} resourceId The unique identifier of the resource.
8795
8807
  * @param {string} [path]
8796
8808
  * @param {number} [pageNumber]
8797
- * @param {number} [pageSize]
8809
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8798
8810
  * @param {string} [orderBy]
8799
8811
  * @param {*} [options] Override http request option.
8800
8812
  * @throws {RequiredError}
@@ -8808,9 +8820,9 @@ const TreeApiFactory = function (configuration, basePath, axios) {
8808
8820
  * @param {string} projectId The unique identifier or slug of the project.
8809
8821
  * @param {string} resourceId The unique identifier of the resource.
8810
8822
  * @param {string} [path]
8811
- * @param {RdfFormat} [format]
8823
+ * @param {RdfFormat} [format] Value indicating whether to list folder contents recursively, including subfolders.
8812
8824
  * @param {number} [pageNumber]
8813
- * @param {number} [pageSize]
8825
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
8814
8826
  * @param {string} [orderBy]
8815
8827
  * @param {*} [options] Override http request option.
8816
8828
  * @throws {RequiredError}
@@ -9005,7 +9017,7 @@ const VisibilityApiAxiosParamCreator = function (configuration) {
9005
9017
  *
9006
9018
  * @summary Retrieves all visibilities.
9007
9019
  * @param {number} [pageNumber]
9008
- * @param {number} [pageSize]
9020
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9009
9021
  * @param {string} [orderBy]
9010
9022
  * @param {*} [options] Override http request option.
9011
9023
  * @throws {RequiredError}
@@ -9096,7 +9108,7 @@ const VisibilityApiFp = function (configuration) {
9096
9108
  *
9097
9109
  * @summary Retrieves all visibilities.
9098
9110
  * @param {number} [pageNumber]
9099
- * @param {number} [pageSize]
9111
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9100
9112
  * @param {string} [orderBy]
9101
9113
  * @param {*} [options] Override http request option.
9102
9114
  * @throws {RequiredError}
@@ -9142,7 +9154,7 @@ const VisibilityApiFactory = function (configuration, basePath, axios) {
9142
9154
  *
9143
9155
  * @summary Retrieves all visibilities.
9144
9156
  * @param {number} [pageNumber]
9145
- * @param {number} [pageSize]
9157
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9146
9158
  * @param {string} [orderBy]
9147
9159
  * @param {*} [options] Override http request option.
9148
9160
  * @throws {RequiredError}
@@ -9201,7 +9213,7 @@ const VocabularyApiAxiosParamCreator = function (configuration) {
9201
9213
  * @param {string} [searchTerm]
9202
9214
  * @param {AcceptedLanguage} [language]
9203
9215
  * @param {number} [pageNumber]
9204
- * @param {number} [pageSize]
9216
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9205
9217
  * @param {string} [orderBy]
9206
9218
  * @param {*} [options] Override http request option.
9207
9219
  * @throws {RequiredError}
@@ -9283,13 +9295,13 @@ const VocabularyApiAxiosParamCreator = function (configuration) {
9283
9295
  * @param {string} _class
9284
9296
  * @param {string} [searchTerm]
9285
9297
  * @param {AcceptedLanguage} [language]
9298
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
9286
9299
  * @param {number} [pageNumber]
9287
- * @param {number} [pageSize]
9288
9300
  * @param {string} [orderBy]
9289
9301
  * @param {*} [options] Override http request option.
9290
9302
  * @throws {RequiredError}
9291
9303
  */
9292
- getVocabularyInstances: (_class, searchTerm, language, pageNumber, pageSize, orderBy, options = {}) => __awaiter(this, void 0, void 0, function* () {
9304
+ getVocabularyInstances: (_class, searchTerm, language, pageSize, pageNumber, orderBy, options = {}) => __awaiter(this, void 0, void 0, function* () {
9293
9305
  // verify required parameter '_class' is not null or undefined
9294
9306
  assertParamExists('getVocabularyInstances', '_class', _class);
9295
9307
  const localVarPath = `/api/v2/vocabularies/instances`;
@@ -9313,12 +9325,12 @@ const VocabularyApiAxiosParamCreator = function (configuration) {
9313
9325
  if (language !== undefined) {
9314
9326
  localVarQueryParameter['Language'] = language;
9315
9327
  }
9316
- if (pageNumber !== undefined) {
9317
- localVarQueryParameter['PageNumber'] = pageNumber;
9318
- }
9319
9328
  if (pageSize !== undefined) {
9320
9329
  localVarQueryParameter['PageSize'] = pageSize;
9321
9330
  }
9331
+ if (pageNumber !== undefined) {
9332
+ localVarQueryParameter['PageNumber'] = pageNumber;
9333
+ }
9322
9334
  if (orderBy !== undefined) {
9323
9335
  localVarQueryParameter['OrderBy'] = orderBy;
9324
9336
  }
@@ -9357,7 +9369,7 @@ const VocabularyApiFp = function (configuration) {
9357
9369
  * @param {string} [searchTerm]
9358
9370
  * @param {AcceptedLanguage} [language]
9359
9371
  * @param {number} [pageNumber]
9360
- * @param {number} [pageSize]
9372
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9361
9373
  * @param {string} [orderBy]
9362
9374
  * @param {*} [options] Override http request option.
9363
9375
  * @throws {RequiredError}
@@ -9388,15 +9400,15 @@ const VocabularyApiFp = function (configuration) {
9388
9400
  * @param {string} _class
9389
9401
  * @param {string} [searchTerm]
9390
9402
  * @param {AcceptedLanguage} [language]
9403
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
9391
9404
  * @param {number} [pageNumber]
9392
- * @param {number} [pageSize]
9393
9405
  * @param {string} [orderBy]
9394
9406
  * @param {*} [options] Override http request option.
9395
9407
  * @throws {RequiredError}
9396
9408
  */
9397
- getVocabularyInstances(_class, searchTerm, language, pageNumber, pageSize, orderBy, options) {
9409
+ getVocabularyInstances(_class, searchTerm, language, pageSize, pageNumber, orderBy, options) {
9398
9410
  return __awaiter(this, void 0, void 0, function* () {
9399
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getVocabularyInstances(_class, searchTerm, language, pageNumber, pageSize, orderBy, options);
9411
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getVocabularyInstances(_class, searchTerm, language, pageSize, pageNumber, orderBy, options);
9400
9412
  return createRequestFunction(localVarAxiosArgs, axios, BASE_PATH, configuration);
9401
9413
  });
9402
9414
  },
@@ -9424,7 +9436,7 @@ const VocabularyApiFactory = function (configuration, basePath, axios) {
9424
9436
  * @param {string} [searchTerm]
9425
9437
  * @param {AcceptedLanguage} [language]
9426
9438
  * @param {number} [pageNumber]
9427
- * @param {number} [pageSize]
9439
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;50&#x60;.
9428
9440
  * @param {string} [orderBy]
9429
9441
  * @param {*} [options] Override http request option.
9430
9442
  * @throws {RequiredError}
@@ -9449,14 +9461,14 @@ const VocabularyApiFactory = function (configuration, basePath, axios) {
9449
9461
  * @param {string} _class
9450
9462
  * @param {string} [searchTerm]
9451
9463
  * @param {AcceptedLanguage} [language]
9464
+ * @param {number} [pageSize] Number of items per page. The maximum number of items per page is &#x60;150&#x60;.
9452
9465
  * @param {number} [pageNumber]
9453
- * @param {number} [pageSize]
9454
9466
  * @param {string} [orderBy]
9455
9467
  * @param {*} [options] Override http request option.
9456
9468
  * @throws {RequiredError}
9457
9469
  */
9458
- getVocabularyInstances(_class, searchTerm, language, pageNumber, pageSize, orderBy, options) {
9459
- return localVarFp.getVocabularyInstances(_class, searchTerm, language, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath));
9470
+ getVocabularyInstances(_class, searchTerm, language, pageSize, pageNumber, orderBy, options) {
9471
+ return localVarFp.getVocabularyInstances(_class, searchTerm, language, pageSize, pageNumber, orderBy, options).then((request) => request(axios, basePath));
9460
9472
  },
9461
9473
  };
9462
9474
  };