@seekora-ai/admin-api 1.0.33 → 1.0.34
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/README.md +16 -2
- package/api.ts +877 -0
- package/dist/api.d.ts +528 -0
- package/dist/api.js +647 -3
- package/dist/esm/api.d.ts +528 -0
- package/dist/esm/api.js +636 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.34.tgz +0 -0
- package/seekora-ai-admin-api-1.0.33.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -491,6 +491,75 @@ export interface DataTypesAutocompleteSuggestion {
|
|
|
491
491
|
*/
|
|
492
492
|
'text'?: string;
|
|
493
493
|
}
|
|
494
|
+
/**
|
|
495
|
+
*
|
|
496
|
+
* @export
|
|
497
|
+
* @interface DataTypesBulkDocumentRequest
|
|
498
|
+
*/
|
|
499
|
+
export interface DataTypesBulkDocumentRequest {
|
|
500
|
+
/**
|
|
501
|
+
* Array of document operations
|
|
502
|
+
* @type {Array<object>}
|
|
503
|
+
* @memberof DataTypesBulkDocumentRequest
|
|
504
|
+
*/
|
|
505
|
+
'documents': Array<object>;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
*
|
|
509
|
+
* @export
|
|
510
|
+
* @interface DataTypesBulkDocumentResponse
|
|
511
|
+
*/
|
|
512
|
+
export interface DataTypesBulkDocumentResponse {
|
|
513
|
+
/**
|
|
514
|
+
* Documents with errors
|
|
515
|
+
* @type {number}
|
|
516
|
+
* @memberof DataTypesBulkDocumentResponse
|
|
517
|
+
*/
|
|
518
|
+
'errorCount'?: number;
|
|
519
|
+
/**
|
|
520
|
+
* Individual operation results
|
|
521
|
+
* @type {Array<DataTypesDocumentResponse>}
|
|
522
|
+
* @memberof DataTypesBulkDocumentResponse
|
|
523
|
+
*/
|
|
524
|
+
'results'?: Array<DataTypesDocumentResponse>;
|
|
525
|
+
/**
|
|
526
|
+
* Successfully processed documents
|
|
527
|
+
* @type {number}
|
|
528
|
+
* @memberof DataTypesBulkDocumentResponse
|
|
529
|
+
*/
|
|
530
|
+
'successCount'?: number;
|
|
531
|
+
/**
|
|
532
|
+
* Total documents processed
|
|
533
|
+
* @type {number}
|
|
534
|
+
* @memberof DataTypesBulkDocumentResponse
|
|
535
|
+
*/
|
|
536
|
+
'totalCount'?: number;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @export
|
|
541
|
+
* @interface DataTypesBulkDocumentResponseWrapper
|
|
542
|
+
*/
|
|
543
|
+
export interface DataTypesBulkDocumentResponseWrapper {
|
|
544
|
+
/**
|
|
545
|
+
*
|
|
546
|
+
* @type {DataTypesBulkDocumentResponse}
|
|
547
|
+
* @memberof DataTypesBulkDocumentResponseWrapper
|
|
548
|
+
*/
|
|
549
|
+
'data'?: DataTypesBulkDocumentResponse;
|
|
550
|
+
/**
|
|
551
|
+
*
|
|
552
|
+
* @type {string}
|
|
553
|
+
* @memberof DataTypesBulkDocumentResponseWrapper
|
|
554
|
+
*/
|
|
555
|
+
'message'?: string;
|
|
556
|
+
/**
|
|
557
|
+
*
|
|
558
|
+
* @type {number}
|
|
559
|
+
* @memberof DataTypesBulkDocumentResponseWrapper
|
|
560
|
+
*/
|
|
561
|
+
'status'?: number;
|
|
562
|
+
}
|
|
494
563
|
/**
|
|
495
564
|
*
|
|
496
565
|
* @export
|
|
@@ -2170,6 +2239,134 @@ export interface DataTypesDetailedCreditBalanceResponse {
|
|
|
2170
2239
|
*/
|
|
2171
2240
|
'warning_threshold'?: number;
|
|
2172
2241
|
}
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
* @export
|
|
2245
|
+
* @interface DataTypesDocumentListResponse
|
|
2246
|
+
*/
|
|
2247
|
+
export interface DataTypesDocumentListResponse {
|
|
2248
|
+
/**
|
|
2249
|
+
* Array of documents
|
|
2250
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
2251
|
+
* @memberof DataTypesDocumentListResponse
|
|
2252
|
+
*/
|
|
2253
|
+
'documents'?: Array<{
|
|
2254
|
+
[key: string]: any;
|
|
2255
|
+
}>;
|
|
2256
|
+
/**
|
|
2257
|
+
* Whether there are more results
|
|
2258
|
+
* @type {boolean}
|
|
2259
|
+
* @memberof DataTypesDocumentListResponse
|
|
2260
|
+
*/
|
|
2261
|
+
'hasMore'?: boolean;
|
|
2262
|
+
/**
|
|
2263
|
+
* Results per page
|
|
2264
|
+
* @type {number}
|
|
2265
|
+
* @memberof DataTypesDocumentListResponse
|
|
2266
|
+
*/
|
|
2267
|
+
'limit'?: number;
|
|
2268
|
+
/**
|
|
2269
|
+
* Current page
|
|
2270
|
+
* @type {number}
|
|
2271
|
+
* @memberof DataTypesDocumentListResponse
|
|
2272
|
+
*/
|
|
2273
|
+
'page'?: number;
|
|
2274
|
+
/**
|
|
2275
|
+
* Total number of documents
|
|
2276
|
+
* @type {number}
|
|
2277
|
+
* @memberof DataTypesDocumentListResponse
|
|
2278
|
+
*/
|
|
2279
|
+
'total'?: number;
|
|
2280
|
+
}
|
|
2281
|
+
/**
|
|
2282
|
+
*
|
|
2283
|
+
* @export
|
|
2284
|
+
* @interface DataTypesDocumentListResponseWrapper
|
|
2285
|
+
*/
|
|
2286
|
+
export interface DataTypesDocumentListResponseWrapper {
|
|
2287
|
+
/**
|
|
2288
|
+
*
|
|
2289
|
+
* @type {DataTypesDocumentListResponse}
|
|
2290
|
+
* @memberof DataTypesDocumentListResponseWrapper
|
|
2291
|
+
*/
|
|
2292
|
+
'data'?: DataTypesDocumentListResponse;
|
|
2293
|
+
/**
|
|
2294
|
+
*
|
|
2295
|
+
* @type {string}
|
|
2296
|
+
* @memberof DataTypesDocumentListResponseWrapper
|
|
2297
|
+
*/
|
|
2298
|
+
'message'?: string;
|
|
2299
|
+
/**
|
|
2300
|
+
*
|
|
2301
|
+
* @type {number}
|
|
2302
|
+
* @memberof DataTypesDocumentListResponseWrapper
|
|
2303
|
+
*/
|
|
2304
|
+
'status'?: number;
|
|
2305
|
+
}
|
|
2306
|
+
/**
|
|
2307
|
+
*
|
|
2308
|
+
* @export
|
|
2309
|
+
* @interface DataTypesDocumentResponse
|
|
2310
|
+
*/
|
|
2311
|
+
export interface DataTypesDocumentResponse {
|
|
2312
|
+
/**
|
|
2313
|
+
* Document data (for get operations)
|
|
2314
|
+
* @type {{ [key: string]: any; }}
|
|
2315
|
+
* @memberof DataTypesDocumentResponse
|
|
2316
|
+
*/
|
|
2317
|
+
'data'?: {
|
|
2318
|
+
[key: string]: any;
|
|
2319
|
+
};
|
|
2320
|
+
/**
|
|
2321
|
+
*
|
|
2322
|
+
* @type {string}
|
|
2323
|
+
* @memberof DataTypesDocumentResponse
|
|
2324
|
+
*/
|
|
2325
|
+
'error'?: string;
|
|
2326
|
+
/**
|
|
2327
|
+
* Document ID (hash-generated or provided)
|
|
2328
|
+
* @type {string}
|
|
2329
|
+
* @memberof DataTypesDocumentResponse
|
|
2330
|
+
*/
|
|
2331
|
+
'id'?: string;
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @type {string}
|
|
2335
|
+
* @memberof DataTypesDocumentResponse
|
|
2336
|
+
*/
|
|
2337
|
+
'message'?: string;
|
|
2338
|
+
/**
|
|
2339
|
+
* success, error, updated, inserted
|
|
2340
|
+
* @type {string}
|
|
2341
|
+
* @memberof DataTypesDocumentResponse
|
|
2342
|
+
*/
|
|
2343
|
+
'status'?: string;
|
|
2344
|
+
}
|
|
2345
|
+
/**
|
|
2346
|
+
*
|
|
2347
|
+
* @export
|
|
2348
|
+
* @interface DataTypesDocumentResponseWrapper
|
|
2349
|
+
*/
|
|
2350
|
+
export interface DataTypesDocumentResponseWrapper {
|
|
2351
|
+
/**
|
|
2352
|
+
*
|
|
2353
|
+
* @type {DataTypesDocumentResponse}
|
|
2354
|
+
* @memberof DataTypesDocumentResponseWrapper
|
|
2355
|
+
*/
|
|
2356
|
+
'data'?: DataTypesDocumentResponse;
|
|
2357
|
+
/**
|
|
2358
|
+
*
|
|
2359
|
+
* @type {string}
|
|
2360
|
+
* @memberof DataTypesDocumentResponseWrapper
|
|
2361
|
+
*/
|
|
2362
|
+
'message'?: string;
|
|
2363
|
+
/**
|
|
2364
|
+
*
|
|
2365
|
+
* @type {number}
|
|
2366
|
+
* @memberof DataTypesDocumentResponseWrapper
|
|
2367
|
+
*/
|
|
2368
|
+
'status'?: number;
|
|
2369
|
+
}
|
|
2173
2370
|
/**
|
|
2174
2371
|
*
|
|
2175
2372
|
* @export
|
|
@@ -9940,6 +10137,69 @@ export declare class CustomStopwordsApi extends BaseAPI {
|
|
|
9940
10137
|
*/
|
|
9941
10138
|
adminStoresXStoreIDStopwordsCustomWordlistsPost(xStoreID: string, body: DataTypesCreateCustomWordListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomWordListResponseWrapper, any>>;
|
|
9942
10139
|
}
|
|
10140
|
+
/**
|
|
10141
|
+
* DocumentsApi - axios parameter creator
|
|
10142
|
+
* @export
|
|
10143
|
+
*/
|
|
10144
|
+
export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10145
|
+
/**
|
|
10146
|
+
* Uploads a document to the specified store
|
|
10147
|
+
* @summary Upload a document
|
|
10148
|
+
* @param {string} xStoreID X-Store ID
|
|
10149
|
+
* @param {File} file Document file
|
|
10150
|
+
* @param {*} [options] Override http request option.
|
|
10151
|
+
* @throws {RequiredError}
|
|
10152
|
+
*/
|
|
10153
|
+
adminStoresXStoreIDUploadPost: (xStoreID: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10154
|
+
};
|
|
10155
|
+
/**
|
|
10156
|
+
* DocumentsApi - functional programming interface
|
|
10157
|
+
* @export
|
|
10158
|
+
*/
|
|
10159
|
+
export declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
10160
|
+
/**
|
|
10161
|
+
* Uploads a document to the specified store
|
|
10162
|
+
* @summary Upload a document
|
|
10163
|
+
* @param {string} xStoreID X-Store ID
|
|
10164
|
+
* @param {File} file Document file
|
|
10165
|
+
* @param {*} [options] Override http request option.
|
|
10166
|
+
* @throws {RequiredError}
|
|
10167
|
+
*/
|
|
10168
|
+
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
10169
|
+
};
|
|
10170
|
+
/**
|
|
10171
|
+
* DocumentsApi - factory interface
|
|
10172
|
+
* @export
|
|
10173
|
+
*/
|
|
10174
|
+
export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10175
|
+
/**
|
|
10176
|
+
* Uploads a document to the specified store
|
|
10177
|
+
* @summary Upload a document
|
|
10178
|
+
* @param {string} xStoreID X-Store ID
|
|
10179
|
+
* @param {File} file Document file
|
|
10180
|
+
* @param {*} [options] Override http request option.
|
|
10181
|
+
* @throws {RequiredError}
|
|
10182
|
+
*/
|
|
10183
|
+
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
10184
|
+
};
|
|
10185
|
+
/**
|
|
10186
|
+
* DocumentsApi - object-oriented interface
|
|
10187
|
+
* @export
|
|
10188
|
+
* @class DocumentsApi
|
|
10189
|
+
* @extends {BaseAPI}
|
|
10190
|
+
*/
|
|
10191
|
+
export declare class DocumentsApi extends BaseAPI {
|
|
10192
|
+
/**
|
|
10193
|
+
* Uploads a document to the specified store
|
|
10194
|
+
* @summary Upload a document
|
|
10195
|
+
* @param {string} xStoreID X-Store ID
|
|
10196
|
+
* @param {File} file Document file
|
|
10197
|
+
* @param {*} [options] Override http request option.
|
|
10198
|
+
* @throws {RequiredError}
|
|
10199
|
+
* @memberof DocumentsApi
|
|
10200
|
+
*/
|
|
10201
|
+
adminStoresXStoreIDUploadPost(xStoreID: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
|
|
10202
|
+
}
|
|
9943
10203
|
/**
|
|
9944
10204
|
* LimitsApi - axios parameter creator
|
|
9945
10205
|
* @export
|
|
@@ -14134,6 +14394,274 @@ export declare class StopwordsApi extends BaseAPI {
|
|
|
14134
14394
|
*/
|
|
14135
14395
|
adminStoresXStoreIDStopwordsWordlistsWordListIDWordsPost(xStoreID: string, wordListID: number, body: DataTypesAddWordsToLanguageListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateWordStatusResponseWrapper, any>>;
|
|
14136
14396
|
}
|
|
14397
|
+
/**
|
|
14398
|
+
* StoreDocumentsApi - axios parameter creator
|
|
14399
|
+
* @export
|
|
14400
|
+
*/
|
|
14401
|
+
export declare const StoreDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14402
|
+
/**
|
|
14403
|
+
* Performs bulk insert, update, upsert, or delete operations on documents. Each document can specify its own action. If same hash is generated for multiple documents, they will be treated as the same document.
|
|
14404
|
+
* @summary Bulk document operations
|
|
14405
|
+
* @param {string} xStoreID X-Store ID
|
|
14406
|
+
* @param {DataTypesBulkDocumentRequest} body Bulk operation data
|
|
14407
|
+
* @param {*} [options] Override http request option.
|
|
14408
|
+
* @throws {RequiredError}
|
|
14409
|
+
*/
|
|
14410
|
+
adminStoresXStoreIDDocumentsBulkPost: (xStoreID: string, body: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14411
|
+
/**
|
|
14412
|
+
* Deletes a document by ID from a store
|
|
14413
|
+
* @summary Delete document
|
|
14414
|
+
* @param {string} xStoreID X-Store ID
|
|
14415
|
+
* @param {string} documentID Document ID
|
|
14416
|
+
* @param {*} [options] Override http request option.
|
|
14417
|
+
* @throws {RequiredError}
|
|
14418
|
+
*/
|
|
14419
|
+
adminStoresXStoreIDDocumentsDocumentIDDelete: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14420
|
+
/**
|
|
14421
|
+
* Retrieves a single document by ID from a store
|
|
14422
|
+
* @summary Get single document
|
|
14423
|
+
* @param {string} xStoreID X-Store ID
|
|
14424
|
+
* @param {string} documentID Document ID
|
|
14425
|
+
* @param {*} [options] Override http request option.
|
|
14426
|
+
* @throws {RequiredError}
|
|
14427
|
+
*/
|
|
14428
|
+
adminStoresXStoreIDDocumentsDocumentIDGet: (xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14429
|
+
/**
|
|
14430
|
+
* Updates an existing document by ID. The document ID will not change even if document properties change.
|
|
14431
|
+
* @summary Update document
|
|
14432
|
+
* @param {string} xStoreID X-Store ID
|
|
14433
|
+
* @param {string} documentID Document ID
|
|
14434
|
+
* @param {object} body Document data
|
|
14435
|
+
* @param {*} [options] Override http request option.
|
|
14436
|
+
* @throws {RequiredError}
|
|
14437
|
+
*/
|
|
14438
|
+
adminStoresXStoreIDDocumentsDocumentIDPut: (xStoreID: string, documentID: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14439
|
+
/**
|
|
14440
|
+
* Retrieves documents from a store with pagination and optional filtering
|
|
14441
|
+
* @summary Get documents from store
|
|
14442
|
+
* @param {string} xStoreID X-Store ID
|
|
14443
|
+
* @param {number} [page] Page number (default: 1)
|
|
14444
|
+
* @param {number} [limit] Results per page (default: 20, max: 100)
|
|
14445
|
+
* @param {string} [search] Search query
|
|
14446
|
+
* @param {string} [filter] JSON filter object
|
|
14447
|
+
* @param {string} [sort] Sort field and direction (e.g., \'created_at:desc\')
|
|
14448
|
+
* @param {*} [options] Override http request option.
|
|
14449
|
+
* @throws {RequiredError}
|
|
14450
|
+
*/
|
|
14451
|
+
adminStoresXStoreIDDocumentsGet: (xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14452
|
+
/**
|
|
14453
|
+
* Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
|
|
14454
|
+
* @summary Insert document
|
|
14455
|
+
* @param {string} xStoreID X-Store ID
|
|
14456
|
+
* @param {object} body Document data
|
|
14457
|
+
* @param {*} [options] Override http request option.
|
|
14458
|
+
* @throws {RequiredError}
|
|
14459
|
+
*/
|
|
14460
|
+
adminStoresXStoreIDDocumentsPost: (xStoreID: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14461
|
+
};
|
|
14462
|
+
/**
|
|
14463
|
+
* StoreDocumentsApi - functional programming interface
|
|
14464
|
+
* @export
|
|
14465
|
+
*/
|
|
14466
|
+
export declare const StoreDocumentsApiFp: (configuration?: Configuration) => {
|
|
14467
|
+
/**
|
|
14468
|
+
* Performs bulk insert, update, upsert, or delete operations on documents. Each document can specify its own action. If same hash is generated for multiple documents, they will be treated as the same document.
|
|
14469
|
+
* @summary Bulk document operations
|
|
14470
|
+
* @param {string} xStoreID X-Store ID
|
|
14471
|
+
* @param {DataTypesBulkDocumentRequest} body Bulk operation data
|
|
14472
|
+
* @param {*} [options] Override http request option.
|
|
14473
|
+
* @throws {RequiredError}
|
|
14474
|
+
*/
|
|
14475
|
+
adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, body: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
14476
|
+
/**
|
|
14477
|
+
* Deletes a document by ID from a store
|
|
14478
|
+
* @summary Delete document
|
|
14479
|
+
* @param {string} xStoreID X-Store ID
|
|
14480
|
+
* @param {string} documentID Document ID
|
|
14481
|
+
* @param {*} [options] Override http request option.
|
|
14482
|
+
* @throws {RequiredError}
|
|
14483
|
+
*/
|
|
14484
|
+
adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
14485
|
+
/**
|
|
14486
|
+
* Retrieves a single document by ID from a store
|
|
14487
|
+
* @summary Get single document
|
|
14488
|
+
* @param {string} xStoreID X-Store ID
|
|
14489
|
+
* @param {string} documentID Document ID
|
|
14490
|
+
* @param {*} [options] Override http request option.
|
|
14491
|
+
* @throws {RequiredError}
|
|
14492
|
+
*/
|
|
14493
|
+
adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
14494
|
+
/**
|
|
14495
|
+
* Updates an existing document by ID. The document ID will not change even if document properties change.
|
|
14496
|
+
* @summary Update document
|
|
14497
|
+
* @param {string} xStoreID X-Store ID
|
|
14498
|
+
* @param {string} documentID Document ID
|
|
14499
|
+
* @param {object} body Document data
|
|
14500
|
+
* @param {*} [options] Override http request option.
|
|
14501
|
+
* @throws {RequiredError}
|
|
14502
|
+
*/
|
|
14503
|
+
adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
14504
|
+
/**
|
|
14505
|
+
* Retrieves documents from a store with pagination and optional filtering
|
|
14506
|
+
* @summary Get documents from store
|
|
14507
|
+
* @param {string} xStoreID X-Store ID
|
|
14508
|
+
* @param {number} [page] Page number (default: 1)
|
|
14509
|
+
* @param {number} [limit] Results per page (default: 20, max: 100)
|
|
14510
|
+
* @param {string} [search] Search query
|
|
14511
|
+
* @param {string} [filter] JSON filter object
|
|
14512
|
+
* @param {string} [sort] Sort field and direction (e.g., \'created_at:desc\')
|
|
14513
|
+
* @param {*} [options] Override http request option.
|
|
14514
|
+
* @throws {RequiredError}
|
|
14515
|
+
*/
|
|
14516
|
+
adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentListResponseWrapper>>;
|
|
14517
|
+
/**
|
|
14518
|
+
* Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
|
|
14519
|
+
* @summary Insert document
|
|
14520
|
+
* @param {string} xStoreID X-Store ID
|
|
14521
|
+
* @param {object} body Document data
|
|
14522
|
+
* @param {*} [options] Override http request option.
|
|
14523
|
+
* @throws {RequiredError}
|
|
14524
|
+
*/
|
|
14525
|
+
adminStoresXStoreIDDocumentsPost(xStoreID: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
14526
|
+
};
|
|
14527
|
+
/**
|
|
14528
|
+
* StoreDocumentsApi - factory interface
|
|
14529
|
+
* @export
|
|
14530
|
+
*/
|
|
14531
|
+
export declare const StoreDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14532
|
+
/**
|
|
14533
|
+
* Performs bulk insert, update, upsert, or delete operations on documents. Each document can specify its own action. If same hash is generated for multiple documents, they will be treated as the same document.
|
|
14534
|
+
* @summary Bulk document operations
|
|
14535
|
+
* @param {string} xStoreID X-Store ID
|
|
14536
|
+
* @param {DataTypesBulkDocumentRequest} body Bulk operation data
|
|
14537
|
+
* @param {*} [options] Override http request option.
|
|
14538
|
+
* @throws {RequiredError}
|
|
14539
|
+
*/
|
|
14540
|
+
adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, body: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
14541
|
+
/**
|
|
14542
|
+
* Deletes a document by ID from a store
|
|
14543
|
+
* @summary Delete document
|
|
14544
|
+
* @param {string} xStoreID X-Store ID
|
|
14545
|
+
* @param {string} documentID Document ID
|
|
14546
|
+
* @param {*} [options] Override http request option.
|
|
14547
|
+
* @throws {RequiredError}
|
|
14548
|
+
*/
|
|
14549
|
+
adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
14550
|
+
/**
|
|
14551
|
+
* Retrieves a single document by ID from a store
|
|
14552
|
+
* @summary Get single document
|
|
14553
|
+
* @param {string} xStoreID X-Store ID
|
|
14554
|
+
* @param {string} documentID Document ID
|
|
14555
|
+
* @param {*} [options] Override http request option.
|
|
14556
|
+
* @throws {RequiredError}
|
|
14557
|
+
*/
|
|
14558
|
+
adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
14559
|
+
/**
|
|
14560
|
+
* Updates an existing document by ID. The document ID will not change even if document properties change.
|
|
14561
|
+
* @summary Update document
|
|
14562
|
+
* @param {string} xStoreID X-Store ID
|
|
14563
|
+
* @param {string} documentID Document ID
|
|
14564
|
+
* @param {object} body Document data
|
|
14565
|
+
* @param {*} [options] Override http request option.
|
|
14566
|
+
* @throws {RequiredError}
|
|
14567
|
+
*/
|
|
14568
|
+
adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
14569
|
+
/**
|
|
14570
|
+
* Retrieves documents from a store with pagination and optional filtering
|
|
14571
|
+
* @summary Get documents from store
|
|
14572
|
+
* @param {string} xStoreID X-Store ID
|
|
14573
|
+
* @param {number} [page] Page number (default: 1)
|
|
14574
|
+
* @param {number} [limit] Results per page (default: 20, max: 100)
|
|
14575
|
+
* @param {string} [search] Search query
|
|
14576
|
+
* @param {string} [filter] JSON filter object
|
|
14577
|
+
* @param {string} [sort] Sort field and direction (e.g., \'created_at:desc\')
|
|
14578
|
+
* @param {*} [options] Override http request option.
|
|
14579
|
+
* @throws {RequiredError}
|
|
14580
|
+
*/
|
|
14581
|
+
adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentListResponseWrapper>;
|
|
14582
|
+
/**
|
|
14583
|
+
* Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
|
|
14584
|
+
* @summary Insert document
|
|
14585
|
+
* @param {string} xStoreID X-Store ID
|
|
14586
|
+
* @param {object} body Document data
|
|
14587
|
+
* @param {*} [options] Override http request option.
|
|
14588
|
+
* @throws {RequiredError}
|
|
14589
|
+
*/
|
|
14590
|
+
adminStoresXStoreIDDocumentsPost(xStoreID: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
14591
|
+
};
|
|
14592
|
+
/**
|
|
14593
|
+
* StoreDocumentsApi - object-oriented interface
|
|
14594
|
+
* @export
|
|
14595
|
+
* @class StoreDocumentsApi
|
|
14596
|
+
* @extends {BaseAPI}
|
|
14597
|
+
*/
|
|
14598
|
+
export declare class StoreDocumentsApi extends BaseAPI {
|
|
14599
|
+
/**
|
|
14600
|
+
* Performs bulk insert, update, upsert, or delete operations on documents. Each document can specify its own action. If same hash is generated for multiple documents, they will be treated as the same document.
|
|
14601
|
+
* @summary Bulk document operations
|
|
14602
|
+
* @param {string} xStoreID X-Store ID
|
|
14603
|
+
* @param {DataTypesBulkDocumentRequest} body Bulk operation data
|
|
14604
|
+
* @param {*} [options] Override http request option.
|
|
14605
|
+
* @throws {RequiredError}
|
|
14606
|
+
* @memberof StoreDocumentsApi
|
|
14607
|
+
*/
|
|
14608
|
+
adminStoresXStoreIDDocumentsBulkPost(xStoreID: string, body: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any>>;
|
|
14609
|
+
/**
|
|
14610
|
+
* Deletes a document by ID from a store
|
|
14611
|
+
* @summary Delete document
|
|
14612
|
+
* @param {string} xStoreID X-Store ID
|
|
14613
|
+
* @param {string} documentID Document ID
|
|
14614
|
+
* @param {*} [options] Override http request option.
|
|
14615
|
+
* @throws {RequiredError}
|
|
14616
|
+
* @memberof StoreDocumentsApi
|
|
14617
|
+
*/
|
|
14618
|
+
adminStoresXStoreIDDocumentsDocumentIDDelete(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any>>;
|
|
14619
|
+
/**
|
|
14620
|
+
* Retrieves a single document by ID from a store
|
|
14621
|
+
* @summary Get single document
|
|
14622
|
+
* @param {string} xStoreID X-Store ID
|
|
14623
|
+
* @param {string} documentID Document ID
|
|
14624
|
+
* @param {*} [options] Override http request option.
|
|
14625
|
+
* @throws {RequiredError}
|
|
14626
|
+
* @memberof StoreDocumentsApi
|
|
14627
|
+
*/
|
|
14628
|
+
adminStoresXStoreIDDocumentsDocumentIDGet(xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any>>;
|
|
14629
|
+
/**
|
|
14630
|
+
* Updates an existing document by ID. The document ID will not change even if document properties change.
|
|
14631
|
+
* @summary Update document
|
|
14632
|
+
* @param {string} xStoreID X-Store ID
|
|
14633
|
+
* @param {string} documentID Document ID
|
|
14634
|
+
* @param {object} body Document data
|
|
14635
|
+
* @param {*} [options] Override http request option.
|
|
14636
|
+
* @throws {RequiredError}
|
|
14637
|
+
* @memberof StoreDocumentsApi
|
|
14638
|
+
*/
|
|
14639
|
+
adminStoresXStoreIDDocumentsDocumentIDPut(xStoreID: string, documentID: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any>>;
|
|
14640
|
+
/**
|
|
14641
|
+
* Retrieves documents from a store with pagination and optional filtering
|
|
14642
|
+
* @summary Get documents from store
|
|
14643
|
+
* @param {string} xStoreID X-Store ID
|
|
14644
|
+
* @param {number} [page] Page number (default: 1)
|
|
14645
|
+
* @param {number} [limit] Results per page (default: 20, max: 100)
|
|
14646
|
+
* @param {string} [search] Search query
|
|
14647
|
+
* @param {string} [filter] JSON filter object
|
|
14648
|
+
* @param {string} [sort] Sort field and direction (e.g., \'created_at:desc\')
|
|
14649
|
+
* @param {*} [options] Override http request option.
|
|
14650
|
+
* @throws {RequiredError}
|
|
14651
|
+
* @memberof StoreDocumentsApi
|
|
14652
|
+
*/
|
|
14653
|
+
adminStoresXStoreIDDocumentsGet(xStoreID: string, page?: number, limit?: number, search?: string, filter?: string, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentListResponseWrapper, any>>;
|
|
14654
|
+
/**
|
|
14655
|
+
* Inserts a new document into a store. If ID is provided, it will be used; otherwise, a hash-based ID will be generated. If a document with the same hash already exists, it will be updated.
|
|
14656
|
+
* @summary Insert document
|
|
14657
|
+
* @param {string} xStoreID X-Store ID
|
|
14658
|
+
* @param {object} body Document data
|
|
14659
|
+
* @param {*} [options] Override http request option.
|
|
14660
|
+
* @throws {RequiredError}
|
|
14661
|
+
* @memberof StoreDocumentsApi
|
|
14662
|
+
*/
|
|
14663
|
+
adminStoresXStoreIDDocumentsPost(xStoreID: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any>>;
|
|
14664
|
+
}
|
|
14137
14665
|
/**
|
|
14138
14666
|
* StoresApi - axios parameter creator
|
|
14139
14667
|
* @export
|