@coscine/api-client 2.8.0 → 2.9.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.
@@ -52,14 +52,16 @@ const SearchApiAxiosParamCreator = function (configuration) {
52
52
  /**
53
53
  *
54
54
  * @summary Search Elasticsearch
55
- * @param {string} [query] Elasticsearch query
56
- * @param {boolean} [user] Specify user or only public metadata records could be found
57
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
58
- * @param {Array<string>} [languages] Set the used languages
55
+ * @param {string} [searchQuery] The actual search query
56
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
57
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
58
+ * @param {Array<string>} [includedLanguages] Set the used languages
59
+ * @param {number} [pageNumber] The requested page number
60
+ * @param {number} [pageSize] The size of a page
59
61
  * @param {*} [options] Override http request option.
60
62
  * @throws {RequiredError}
61
63
  */
62
- searchSearch: (query, user, adv, languages, options = {}) => __awaiter(this, void 0, void 0, function* () {
64
+ searchSearch: (searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
63
65
  const localVarPath = `/Search`;
64
66
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
67
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -72,17 +74,23 @@ const SearchApiAxiosParamCreator = function (configuration) {
72
74
  const localVarQueryParameter = {};
73
75
  // authentication JWT token required
74
76
  yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
75
- if (query !== undefined) {
76
- localVarQueryParameter['query'] = query;
77
+ if (searchQuery !== undefined) {
78
+ localVarQueryParameter['SearchQuery'] = searchQuery;
77
79
  }
78
- if (user !== undefined) {
79
- localVarQueryParameter['user'] = user;
80
+ if (includeUsers !== undefined) {
81
+ localVarQueryParameter['IncludeUsers'] = includeUsers;
80
82
  }
81
- if (adv !== undefined) {
82
- localVarQueryParameter['adv'] = adv;
83
+ if (useAdvancedSyntax !== undefined) {
84
+ localVarQueryParameter['UseAdvancedSyntax'] = useAdvancedSyntax;
83
85
  }
84
- if (languages) {
85
- localVarQueryParameter['languages'] = languages;
86
+ if (includedLanguages) {
87
+ localVarQueryParameter['IncludedLanguages'] = includedLanguages;
88
+ }
89
+ if (pageNumber !== undefined) {
90
+ localVarQueryParameter['PageNumber'] = pageNumber;
91
+ }
92
+ if (pageSize !== undefined) {
93
+ localVarQueryParameter['PageSize'] = pageSize;
86
94
  }
87
95
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
88
96
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -105,16 +113,18 @@ const SearchApiFp = function (configuration) {
105
113
  /**
106
114
  *
107
115
  * @summary Search Elasticsearch
108
- * @param {string} [query] Elasticsearch query
109
- * @param {boolean} [user] Specify user or only public metadata records could be found
110
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
111
- * @param {Array<string>} [languages] Set the used languages
116
+ * @param {string} [searchQuery] The actual search query
117
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
118
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
119
+ * @param {Array<string>} [includedLanguages] Set the used languages
120
+ * @param {number} [pageNumber] The requested page number
121
+ * @param {number} [pageSize] The size of a page
112
122
  * @param {*} [options] Override http request option.
113
123
  * @throws {RequiredError}
114
124
  */
115
- searchSearch(query, user, adv, languages, options) {
125
+ searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options) {
116
126
  return __awaiter(this, void 0, void 0, function* () {
117
- const localVarAxiosArgs = yield localVarAxiosParamCreator.searchSearch(query, user, adv, languages, options);
127
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options);
118
128
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
119
129
  });
120
130
  },
@@ -131,15 +141,17 @@ const SearchApiFactory = function (configuration, basePath, axios) {
131
141
  /**
132
142
  *
133
143
  * @summary Search Elasticsearch
134
- * @param {string} [query] Elasticsearch query
135
- * @param {boolean} [user] Specify user or only public metadata records could be found
136
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
137
- * @param {Array<string>} [languages] Set the used languages
144
+ * @param {string} [searchQuery] The actual search query
145
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
146
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
147
+ * @param {Array<string>} [includedLanguages] Set the used languages
148
+ * @param {number} [pageNumber] The requested page number
149
+ * @param {number} [pageSize] The size of a page
138
150
  * @param {*} [options] Override http request option.
139
151
  * @throws {RequiredError}
140
152
  */
141
- searchSearch(query, user, adv, languages, options) {
142
- return localVarFp.searchSearch(query, user, adv, languages, options).then((request) => request(axios, basePath));
153
+ searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options) {
154
+ return localVarFp.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options).then((request) => request(axios, basePath));
143
155
  },
144
156
  };
145
157
  };
@@ -154,16 +166,18 @@ class SearchApi extends base_1.BaseAPI {
154
166
  /**
155
167
  *
156
168
  * @summary Search Elasticsearch
157
- * @param {string} [query] Elasticsearch query
158
- * @param {boolean} [user] Specify user or only public metadata records could be found
159
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
160
- * @param {Array<string>} [languages] Set the used languages
169
+ * @param {string} [searchQuery] The actual search query
170
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
171
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
172
+ * @param {Array<string>} [includedLanguages] Set the used languages
173
+ * @param {number} [pageNumber] The requested page number
174
+ * @param {number} [pageSize] The size of a page
161
175
  * @param {*} [options] Override http request option.
162
176
  * @throws {RequiredError}
163
177
  * @memberof SearchApi
164
178
  */
165
- searchSearch(query, user, adv, languages, options) {
166
- return (0, exports.SearchApiFp)(this.configuration).searchSearch(query, user, adv, languages, options).then((request) => request(this.axios, this.basePath));
179
+ searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options) {
180
+ return (0, exports.SearchApiFp)(this.configuration).searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options).then((request) => request(this.axios, this.basePath));
167
181
  }
168
182
  }
169
183
  exports.SearchApi = SearchApi;
@@ -1 +1 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/Coscine.Api.Search/api.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;;;;;;;;;;;;;AAIH,kDAAiE;AACjE,yDAAyD;AACzD,aAAa;AACb,qCAA4N;AAC5N,aAAa;AACb,iCAA4F;AA2B5F;;;;GAIG;AAEH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,iCAAqB,CAAA;IACrB,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACzB,CAAC,EAJW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAInB;AAgBD;;;GAGG;AACI,MAAM,0BAA0B,GAAG,UAAU,aAA6B;IAC7E,OAAO;QACH;;;;;;;;;WASG;QACH,YAAY,EAAE,CAAO,KAAc,EAAE,IAAc,EAAE,GAAa,EAAE,SAAyB,EAAE,UAAe,EAAE,EAAwB,EAAE;YACtI,MAAM,YAAY,GAAG,SAAS,CAAC;YAC/B,oFAAoF;YACpF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,uBAAc,CAAC,CAAC;YAC7D,IAAI,WAAW,CAAC;YAChB,IAAI,aAAa,EAAE;gBACf,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;aAC3C;YAED,MAAM,sBAAsB,iCAAK,MAAM,EAAE,KAAK,IAAK,WAAW,GAAK,OAAO,CAAC,CAAC;YAC5E,MAAM,uBAAuB,GAAG,EAAS,CAAC;YAC1C,MAAM,sBAAsB,GAAG,EAAS,CAAC;YAEzC,oCAAoC;YACpC,MAAM,IAAA,0BAAiB,EAAC,uBAAuB,EAAE,eAAe,EAAE,aAAa,CAAC,CAAA;YAEhF,IAAI,KAAK,KAAK,SAAS,EAAE;gBACrB,sBAAsB,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;aAC3C;YAED,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,sBAAsB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;aACzC;YAED,IAAI,GAAG,KAAK,SAAS,EAAE;gBACnB,sBAAsB,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;aACvC;YAED,IAAI,SAAS,EAAE;gBACX,sBAAsB,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;aACnD;YAID,IAAA,wBAAe,EAAC,cAAc,EAAE,sBAAsB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YACvE,IAAI,sBAAsB,GAAG,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3F,sBAAsB,CAAC,OAAO,iDAAO,uBAAuB,GAAK,sBAAsB,GAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAE7G,OAAO;gBACH,GAAG,EAAE,IAAA,qBAAY,EAAC,cAAc,CAAC;gBACjC,OAAO,EAAE,sBAAsB;aAClC,CAAC;QACN,CAAC,CAAA;KACJ,CAAA;AACL,CAAC,CAAC;AAxDW,QAAA,0BAA0B,8BAwDrC;AAEF;;;GAGG;AACI,MAAM,WAAW,GAAG,UAAS,aAA6B;IAC7D,MAAM,yBAAyB,GAAG,IAAA,kCAA0B,EAAC,aAAa,CAAC,CAAA;IAC3E,OAAO;QACH;;;;;;;;;WASG;QACG,YAAY,CAAC,KAAc,EAAE,IAAc,EAAE,GAAa,EAAE,SAAyB,EAAE,OAAa;;gBACtG,MAAM,iBAAiB,GAAG,MAAM,yBAAyB,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;gBAC7G,OAAO,IAAA,8BAAqB,EAAC,iBAAiB,EAAE,eAAW,EAAE,gBAAS,EAAE,aAAa,CAAC,CAAC;YAC3F,CAAC;SAAA;KACJ,CAAA;AACL,CAAC,CAAC;AAlBW,QAAA,WAAW,eAkBtB;AAEF;;;GAGG;AACI,MAAM,gBAAgB,GAAG,UAAU,aAA6B,EAAE,QAAiB,EAAE,KAAqB;IAC7G,MAAM,UAAU,GAAG,IAAA,mBAAW,EAAC,aAAa,CAAC,CAAA;IAC7C,OAAO;QACH;;;;;;;;;WASG;QACH,YAAY,CAAC,KAAc,EAAE,IAAc,EAAE,GAAa,EAAE,SAAyB,EAAE,OAAa;YAChG,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrH,CAAC;KACJ,CAAC;AACN,CAAC,CAAC;AAjBW,QAAA,gBAAgB,oBAiB3B;AAEF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,cAAO;IAClC;;;;;;;;;;OAUG;IACI,YAAY,CAAC,KAAc,EAAE,IAAc,EAAE,GAAa,EAAE,SAAyB,EAAE,OAAa;QACvG,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpJ,CAAC;CACJ;AAfD,8BAeC"}
1
+ {"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/Coscine.Api.Search/api.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;;;;;;;;;;;;;AAIH,kDAAiE;AACjE,yDAAyD;AACzD,aAAa;AACb,qCAA4N;AAC5N,aAAa;AACb,iCAA4F;AA2B5F;;;;GAIG;AAEH,IAAY,QAIX;AAJD,WAAY,QAAQ;IAChB,iCAAqB,CAAA;IACrB,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACzB,CAAC,EAJW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAInB;AAGD;;;GAGG;AACI,MAAM,0BAA0B,GAAG,UAAU,aAA6B;IAC7E,OAAO;QACH;;;;;;;;;;;WAWG;QACH,YAAY,EAAE,CAAO,WAAoB,EAAE,YAAsB,EAAE,iBAA2B,EAAE,iBAAiC,EAAE,UAAmB,EAAE,QAAiB,EAAE,UAAe,EAAE,EAAwB,EAAE;YAClN,MAAM,YAAY,GAAG,SAAS,CAAC;YAC/B,oFAAoF;YACpF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,uBAAc,CAAC,CAAC;YAC7D,IAAI,WAAW,CAAC;YAChB,IAAI,aAAa,EAAE;gBACf,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;aAC3C;YAED,MAAM,sBAAsB,iCAAK,MAAM,EAAE,KAAK,IAAK,WAAW,GAAK,OAAO,CAAC,CAAC;YAC5E,MAAM,uBAAuB,GAAG,EAAS,CAAC;YAC1C,MAAM,sBAAsB,GAAG,EAAS,CAAC;YAEzC,oCAAoC;YACpC,MAAM,IAAA,0BAAiB,EAAC,uBAAuB,EAAE,eAAe,EAAE,aAAa,CAAC,CAAA;YAEhF,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,sBAAsB,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC;aACvD;YAED,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC5B,sBAAsB,CAAC,cAAc,CAAC,GAAG,YAAY,CAAC;aACzD;YAED,IAAI,iBAAiB,KAAK,SAAS,EAAE;gBACjC,sBAAsB,CAAC,mBAAmB,CAAC,GAAG,iBAAiB,CAAC;aACnE;YAED,IAAI,iBAAiB,EAAE;gBACnB,sBAAsB,CAAC,mBAAmB,CAAC,GAAG,iBAAiB,CAAC;aACnE;YAED,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,sBAAsB,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC;aACrD;YAED,IAAI,QAAQ,KAAK,SAAS,EAAE;gBACxB,sBAAsB,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;aACjD;YAID,IAAA,wBAAe,EAAC,cAAc,EAAE,sBAAsB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YACvE,IAAI,sBAAsB,GAAG,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3F,sBAAsB,CAAC,OAAO,iDAAO,uBAAuB,GAAK,sBAAsB,GAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAE7G,OAAO;gBACH,GAAG,EAAE,IAAA,qBAAY,EAAC,cAAc,CAAC;gBACjC,OAAO,EAAE,sBAAsB;aAClC,CAAC;QACN,CAAC,CAAA;KACJ,CAAA;AACL,CAAC,CAAC;AAlEW,QAAA,0BAA0B,8BAkErC;AAEF;;;GAGG;AACI,MAAM,WAAW,GAAG,UAAS,aAA6B;IAC7D,MAAM,yBAAyB,GAAG,IAAA,kCAA0B,EAAC,aAAa,CAAC,CAAA;IAC3E,OAAO;QACH;;;;;;;;;;;WAWG;QACG,YAAY,CAAC,WAAoB,EAAE,YAAsB,EAAE,iBAA2B,EAAE,iBAAiC,EAAE,UAAmB,EAAE,QAAiB,EAAE,OAAa;;gBAClL,MAAM,iBAAiB,GAAG,MAAM,yBAAyB,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACvK,OAAO,IAAA,8BAAqB,EAAC,iBAAiB,EAAE,eAAW,EAAE,gBAAS,EAAE,aAAa,CAAC,CAAC;YAC3F,CAAC;SAAA;KACJ,CAAA;AACL,CAAC,CAAC;AApBW,QAAA,WAAW,eAoBtB;AAEF;;;GAGG;AACI,MAAM,gBAAgB,GAAG,UAAU,aAA6B,EAAE,QAAiB,EAAE,KAAqB;IAC7G,MAAM,UAAU,GAAG,IAAA,mBAAW,EAAC,aAAa,CAAC,CAAA;IAC7C,OAAO;QACH;;;;;;;;;;;WAWG;QACH,YAAY,CAAC,WAAoB,EAAE,YAAsB,EAAE,iBAA2B,EAAE,iBAAiC,EAAE,UAAmB,EAAE,QAAiB,EAAE,OAAa;YAC5K,OAAO,UAAU,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/K,CAAC;KACJ,CAAC;AACN,CAAC,CAAC;AAnBW,QAAA,gBAAgB,oBAmB3B;AAEF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,cAAO;IAClC;;;;;;;;;;;;OAYG;IACI,YAAY,CAAC,WAAoB,EAAE,YAAsB,EAAE,iBAA2B,EAAE,iBAAiC,EAAE,UAAmB,EAAE,QAAiB,EAAE,OAAa;QACnL,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9M,CAAC;CACJ;AAjBD,8BAiBC"}
@@ -20,7 +20,7 @@ exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.B
20
20
  // Some imports not used depending on template conditions
21
21
  // @ts-ignore
22
22
  const axios_1 = __importDefault(require("axios"));
23
- exports.BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Search".replace(/\/+$/, "");
23
+ exports.BASE_PATH = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Search".replace(/\/+$/, "");
24
24
  /**
25
25
  *
26
26
  * @export
@@ -47,19 +47,6 @@ export declare enum ItemType {
47
47
  Project = "Project",
48
48
  Resource = "Resource"
49
49
  }
50
- /**
51
- * Search result return object
52
- * @export
53
- * @interface SearchResult
54
- */
55
- export interface SearchResult {
56
- /**
57
- * Search result files
58
- * @type {Array<ItemSearchResult>}
59
- * @memberof SearchResult
60
- */
61
- items?: Array<ItemSearchResult> | null;
62
- }
63
50
  /**
64
51
  * SearchApi - axios parameter creator
65
52
  * @export
@@ -68,14 +55,16 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
68
55
  /**
69
56
  *
70
57
  * @summary Search Elasticsearch
71
- * @param {string} [query] Elasticsearch query
72
- * @param {boolean} [user] Specify user or only public metadata records could be found
73
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
74
- * @param {Array<string>} [languages] Set the used languages
58
+ * @param {string} [searchQuery] The actual search query
59
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
60
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
61
+ * @param {Array<string>} [includedLanguages] Set the used languages
62
+ * @param {number} [pageNumber] The requested page number
63
+ * @param {number} [pageSize] The size of a page
75
64
  * @param {*} [options] Override http request option.
76
65
  * @throws {RequiredError}
77
66
  */
78
- searchSearch: (query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any) => Promise<RequestArgs>;
67
+ searchSearch: (searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any) => Promise<RequestArgs>;
79
68
  };
80
69
  /**
81
70
  * SearchApi - functional programming interface
@@ -85,14 +74,16 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
85
74
  /**
86
75
  *
87
76
  * @summary Search Elasticsearch
88
- * @param {string} [query] Elasticsearch query
89
- * @param {boolean} [user] Specify user or only public metadata records could be found
90
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
91
- * @param {Array<string>} [languages] Set the used languages
77
+ * @param {string} [searchQuery] The actual search query
78
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
79
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
80
+ * @param {Array<string>} [includedLanguages] Set the used languages
81
+ * @param {number} [pageNumber] The requested page number
82
+ * @param {number} [pageSize] The size of a page
92
83
  * @param {*} [options] Override http request option.
93
84
  * @throws {RequiredError}
94
85
  */
95
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>>;
86
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemSearchResult>>>;
96
87
  };
97
88
  /**
98
89
  * SearchApi - factory interface
@@ -102,14 +93,16 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
102
93
  /**
103
94
  *
104
95
  * @summary Search Elasticsearch
105
- * @param {string} [query] Elasticsearch query
106
- * @param {boolean} [user] Specify user or only public metadata records could be found
107
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
108
- * @param {Array<string>} [languages] Set the used languages
96
+ * @param {string} [searchQuery] The actual search query
97
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
98
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
99
+ * @param {Array<string>} [includedLanguages] Set the used languages
100
+ * @param {number} [pageNumber] The requested page number
101
+ * @param {number} [pageSize] The size of a page
109
102
  * @param {*} [options] Override http request option.
110
103
  * @throws {RequiredError}
111
104
  */
112
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): AxiosPromise<SearchResult>;
105
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<Array<ItemSearchResult>>;
113
106
  };
114
107
  /**
115
108
  * SearchApi - object-oriented interface
@@ -121,13 +114,15 @@ export declare class SearchApi extends BaseAPI {
121
114
  /**
122
115
  *
123
116
  * @summary Search Elasticsearch
124
- * @param {string} [query] Elasticsearch query
125
- * @param {boolean} [user] Specify user or only public metadata records could be found
126
- * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax
127
- * @param {Array<string>} [languages] Set the used languages
117
+ * @param {string} [searchQuery] The actual search query
118
+ * @param {boolean} [includeUsers] Specify user or only public metadata records could be found
119
+ * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax
120
+ * @param {Array<string>} [includedLanguages] Set the used languages
121
+ * @param {number} [pageNumber] The requested page number
122
+ * @param {number} [pageSize] The size of a page
128
123
  * @param {*} [options] Override http request option.
129
124
  * @throws {RequiredError}
130
125
  * @memberof SearchApi
131
126
  */
132
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<import("axios").AxiosResponse<SearchResult>>;
127
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any): Promise<import("axios").AxiosResponse<ItemSearchResult[]>>;
133
128
  }
@@ -115,7 +115,7 @@ declare function implementations(axios?: AxiosInstance): {
115
115
  roleIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Project/api").RoleObject[]>;
116
116
  };
117
117
  SearchApi: {
118
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search/api").SearchResult>;
118
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: string[], pageNumber?: number, pageSize?: number, options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search/api").ItemSearchResult[]>;
119
119
  };
120
120
  ShibbolethApi: {
121
121
  shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): import("axios").AxiosPromise<any>;
@@ -114,7 +114,7 @@ declare const apis: {
114
114
  roleIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Project").RoleObject[]>;
115
115
  };
116
116
  SearchApi: {
117
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").SearchResult>;
117
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: string[], pageNumber?: number, pageSize?: number, options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").ItemSearchResult[]>;
118
118
  };
119
119
  ShibbolethApi: {
120
120
  shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): import("axios").AxiosPromise<any>;
@@ -268,7 +268,7 @@ export declare const RoleApi: {
268
268
  roleIndex(options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Project").RoleObject[]>;
269
269
  };
270
270
  export declare const SearchApi: {
271
- searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: string[], options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").SearchResult>;
271
+ searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: string[], pageNumber?: number, pageSize?: number, options?: any): import("axios").AxiosPromise<import("./Coscine.Api.Search").ItemSearchResult[]>;
272
272
  };
273
273
  export declare const ShibbolethApi: {
274
274
  shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): import("axios").AxiosPromise<any>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coscine/api-client",
3
- "version": "2.8.0",
3
+ "version": "2.9.0",
4
4
  "description": "This project contains the generated api connection classes.",
5
5
  "keywords": [
6
6
  "coscine",
@@ -122,5 +122,5 @@
122
122
  "dependencies": {
123
123
  "axios": "^0.21.1"
124
124
  },
125
- "packageManager": "yarn@3.2.4"
125
+ "packageManager": "yarn@3.3.0"
126
126
  }