@seekora-ai/admin-api 1.1.75 → 1.1.76
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 +14 -2
- package/api.ts +899 -61
- package/dist/api.d.ts +518 -0
- package/dist/api.js +612 -1
- package/dist/esm/api.d.ts +518 -0
- package/dist/esm/api.js +603 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.76.tgz +0 -0
- package/seekora-ai-admin-api-1.1.75.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -7015,6 +7015,124 @@ export interface DataTypesChannelStatus {
|
|
|
7015
7015
|
*/
|
|
7016
7016
|
'status'?: string;
|
|
7017
7017
|
}
|
|
7018
|
+
/**
|
|
7019
|
+
*
|
|
7020
|
+
* @export
|
|
7021
|
+
* @interface DataTypesClearDocumentsResponse
|
|
7022
|
+
*/
|
|
7023
|
+
export interface DataTypesClearDocumentsResponse {
|
|
7024
|
+
/**
|
|
7025
|
+
*
|
|
7026
|
+
* @type {number}
|
|
7027
|
+
* @memberof DataTypesClearDocumentsResponse
|
|
7028
|
+
*/
|
|
7029
|
+
'deleted_count'?: number;
|
|
7030
|
+
/**
|
|
7031
|
+
*
|
|
7032
|
+
* @type {string}
|
|
7033
|
+
* @memberof DataTypesClearDocumentsResponse
|
|
7034
|
+
*/
|
|
7035
|
+
'message'?: string;
|
|
7036
|
+
}
|
|
7037
|
+
/**
|
|
7038
|
+
*
|
|
7039
|
+
* @export
|
|
7040
|
+
* @interface DataTypesClearDocumentsResponseWrapper
|
|
7041
|
+
*/
|
|
7042
|
+
export interface DataTypesClearDocumentsResponseWrapper {
|
|
7043
|
+
/**
|
|
7044
|
+
*
|
|
7045
|
+
* @type {DataTypesClearDocumentsResponse}
|
|
7046
|
+
* @memberof DataTypesClearDocumentsResponseWrapper
|
|
7047
|
+
*/
|
|
7048
|
+
'data'?: DataTypesClearDocumentsResponse;
|
|
7049
|
+
/**
|
|
7050
|
+
*
|
|
7051
|
+
* @type {string}
|
|
7052
|
+
* @memberof DataTypesClearDocumentsResponseWrapper
|
|
7053
|
+
*/
|
|
7054
|
+
'message'?: string;
|
|
7055
|
+
/**
|
|
7056
|
+
*
|
|
7057
|
+
* @type {number}
|
|
7058
|
+
* @memberof DataTypesClearDocumentsResponseWrapper
|
|
7059
|
+
*/
|
|
7060
|
+
'status'?: number;
|
|
7061
|
+
}
|
|
7062
|
+
/**
|
|
7063
|
+
*
|
|
7064
|
+
* @export
|
|
7065
|
+
* @interface DataTypesCollectionSchemaRequest
|
|
7066
|
+
*/
|
|
7067
|
+
export interface DataTypesCollectionSchemaRequest {
|
|
7068
|
+
/**
|
|
7069
|
+
* Required for mode=replace
|
|
7070
|
+
* @type {boolean}
|
|
7071
|
+
* @memberof DataTypesCollectionSchemaRequest
|
|
7072
|
+
*/
|
|
7073
|
+
'confirm_delete'?: boolean;
|
|
7074
|
+
/**
|
|
7075
|
+
* Field to use for default sorting
|
|
7076
|
+
* @type {string}
|
|
7077
|
+
* @memberof DataTypesCollectionSchemaRequest
|
|
7078
|
+
*/
|
|
7079
|
+
'default_sorting_field'?: string;
|
|
7080
|
+
/**
|
|
7081
|
+
* Enable nested field support (for object types)
|
|
7082
|
+
* @type {boolean}
|
|
7083
|
+
* @memberof DataTypesCollectionSchemaRequest
|
|
7084
|
+
*/
|
|
7085
|
+
'enable_nested_fields'?: boolean;
|
|
7086
|
+
/**
|
|
7087
|
+
*
|
|
7088
|
+
* @type {Array<DataTypesSchemaField>}
|
|
7089
|
+
* @memberof DataTypesCollectionSchemaRequest
|
|
7090
|
+
*/
|
|
7091
|
+
'fields': Array<DataTypesSchemaField>;
|
|
7092
|
+
/**
|
|
7093
|
+
* \"additive\" (default) | \"replace\"
|
|
7094
|
+
* @type {string}
|
|
7095
|
+
* @memberof DataTypesCollectionSchemaRequest
|
|
7096
|
+
*/
|
|
7097
|
+
'mode'?: string;
|
|
7098
|
+
}
|
|
7099
|
+
/**
|
|
7100
|
+
*
|
|
7101
|
+
* @export
|
|
7102
|
+
* @interface DataTypesCollectionSchemaResponse
|
|
7103
|
+
*/
|
|
7104
|
+
export interface DataTypesCollectionSchemaResponse {
|
|
7105
|
+
/**
|
|
7106
|
+
*
|
|
7107
|
+
* @type {number}
|
|
7108
|
+
* @memberof DataTypesCollectionSchemaResponse
|
|
7109
|
+
*/
|
|
7110
|
+
'created_at'?: number;
|
|
7111
|
+
/**
|
|
7112
|
+
*
|
|
7113
|
+
* @type {string}
|
|
7114
|
+
* @memberof DataTypesCollectionSchemaResponse
|
|
7115
|
+
*/
|
|
7116
|
+
'default_sorting_field'?: string;
|
|
7117
|
+
/**
|
|
7118
|
+
*
|
|
7119
|
+
* @type {Array<DataTypesSchemaField>}
|
|
7120
|
+
* @memberof DataTypesCollectionSchemaResponse
|
|
7121
|
+
*/
|
|
7122
|
+
'fields'?: Array<DataTypesSchemaField>;
|
|
7123
|
+
/**
|
|
7124
|
+
*
|
|
7125
|
+
* @type {string}
|
|
7126
|
+
* @memberof DataTypesCollectionSchemaResponse
|
|
7127
|
+
*/
|
|
7128
|
+
'name'?: string;
|
|
7129
|
+
/**
|
|
7130
|
+
*
|
|
7131
|
+
* @type {number}
|
|
7132
|
+
* @memberof DataTypesCollectionSchemaResponse
|
|
7133
|
+
*/
|
|
7134
|
+
'num_documents'?: number;
|
|
7135
|
+
}
|
|
7018
7136
|
/**
|
|
7019
7137
|
*
|
|
7020
7138
|
* @export
|
|
@@ -20374,6 +20492,61 @@ export interface DataTypesSchemaBasedDefaultsResponseWrapper {
|
|
|
20374
20492
|
*/
|
|
20375
20493
|
'status'?: number;
|
|
20376
20494
|
}
|
|
20495
|
+
/**
|
|
20496
|
+
*
|
|
20497
|
+
* @export
|
|
20498
|
+
* @interface DataTypesSchemaField
|
|
20499
|
+
*/
|
|
20500
|
+
export interface DataTypesSchemaField {
|
|
20501
|
+
/**
|
|
20502
|
+
*
|
|
20503
|
+
* @type {boolean}
|
|
20504
|
+
* @memberof DataTypesSchemaField
|
|
20505
|
+
*/
|
|
20506
|
+
'facet'?: boolean;
|
|
20507
|
+
/**
|
|
20508
|
+
* Whether to index this field for search
|
|
20509
|
+
* @type {boolean}
|
|
20510
|
+
* @memberof DataTypesSchemaField
|
|
20511
|
+
*/
|
|
20512
|
+
'index'?: boolean;
|
|
20513
|
+
/**
|
|
20514
|
+
* Whether to enable infix search for this field
|
|
20515
|
+
* @type {boolean}
|
|
20516
|
+
* @memberof DataTypesSchemaField
|
|
20517
|
+
*/
|
|
20518
|
+
'infix'?: boolean;
|
|
20519
|
+
/**
|
|
20520
|
+
* Locale for language-specific tokenization
|
|
20521
|
+
* @type {string}
|
|
20522
|
+
* @memberof DataTypesSchemaField
|
|
20523
|
+
*/
|
|
20524
|
+
'locale'?: string;
|
|
20525
|
+
/**
|
|
20526
|
+
*
|
|
20527
|
+
* @type {string}
|
|
20528
|
+
* @memberof DataTypesSchemaField
|
|
20529
|
+
*/
|
|
20530
|
+
'name': string;
|
|
20531
|
+
/**
|
|
20532
|
+
* Whether this field is optional (default: false)
|
|
20533
|
+
* @type {boolean}
|
|
20534
|
+
* @memberof DataTypesSchemaField
|
|
20535
|
+
*/
|
|
20536
|
+
'optional'?: boolean;
|
|
20537
|
+
/**
|
|
20538
|
+
* Whether this field can be used for sorting
|
|
20539
|
+
* @type {boolean}
|
|
20540
|
+
* @memberof DataTypesSchemaField
|
|
20541
|
+
*/
|
|
20542
|
+
'sort'?: boolean;
|
|
20543
|
+
/**
|
|
20544
|
+
* string, int32, int64, float, bool, string[], int32[], int64[], float[], bool[], object, object[], auto
|
|
20545
|
+
* @type {string}
|
|
20546
|
+
* @memberof DataTypesSchemaField
|
|
20547
|
+
*/
|
|
20548
|
+
'type': string;
|
|
20549
|
+
}
|
|
20377
20550
|
/**
|
|
20378
20551
|
*
|
|
20379
20552
|
* @export
|
|
@@ -20430,6 +20603,31 @@ export interface DataTypesSchemaOptionsResponseWrapper {
|
|
|
20430
20603
|
*/
|
|
20431
20604
|
'status'?: number;
|
|
20432
20605
|
}
|
|
20606
|
+
/**
|
|
20607
|
+
*
|
|
20608
|
+
* @export
|
|
20609
|
+
* @interface DataTypesSchemaResponseWrapper
|
|
20610
|
+
*/
|
|
20611
|
+
export interface DataTypesSchemaResponseWrapper {
|
|
20612
|
+
/**
|
|
20613
|
+
*
|
|
20614
|
+
* @type {DataTypesCollectionSchemaResponse}
|
|
20615
|
+
* @memberof DataTypesSchemaResponseWrapper
|
|
20616
|
+
*/
|
|
20617
|
+
'data'?: DataTypesCollectionSchemaResponse;
|
|
20618
|
+
/**
|
|
20619
|
+
*
|
|
20620
|
+
* @type {string}
|
|
20621
|
+
* @memberof DataTypesSchemaResponseWrapper
|
|
20622
|
+
*/
|
|
20623
|
+
'message'?: string;
|
|
20624
|
+
/**
|
|
20625
|
+
*
|
|
20626
|
+
* @type {number}
|
|
20627
|
+
* @memberof DataTypesSchemaResponseWrapper
|
|
20628
|
+
*/
|
|
20629
|
+
'status'?: number;
|
|
20630
|
+
}
|
|
20433
20631
|
/**
|
|
20434
20632
|
*
|
|
20435
20633
|
* @export
|
|
@@ -21430,6 +21628,12 @@ export interface DataTypesStoreAccessWithDetails {
|
|
|
21430
21628
|
* @interface DataTypesStoreConfigWithOnboardingResponse
|
|
21431
21629
|
*/
|
|
21432
21630
|
export interface DataTypesStoreConfigWithOnboardingResponse {
|
|
21631
|
+
/**
|
|
21632
|
+
* If true, allows search without authentication
|
|
21633
|
+
* @type {boolean}
|
|
21634
|
+
* @memberof DataTypesStoreConfigWithOnboardingResponse
|
|
21635
|
+
*/
|
|
21636
|
+
'allow_public_search'?: boolean;
|
|
21433
21637
|
/**
|
|
21434
21638
|
* Store configuration
|
|
21435
21639
|
* @type {DataTypesIndexConfig}
|
|
@@ -29529,6 +29733,167 @@ export declare const V1SuggestionsQueriesGetTimeRangeEnum: {
|
|
|
29529
29733
|
readonly _90d: "90d";
|
|
29530
29734
|
};
|
|
29531
29735
|
export type V1SuggestionsQueriesGetTimeRangeEnum = typeof V1SuggestionsQueriesGetTimeRangeEnum[keyof typeof V1SuggestionsQueriesGetTimeRangeEnum];
|
|
29736
|
+
/**
|
|
29737
|
+
* SDKDocumentsApi - axios parameter creator
|
|
29738
|
+
* @export
|
|
29739
|
+
*/
|
|
29740
|
+
export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29741
|
+
/**
|
|
29742
|
+
* Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
|
|
29743
|
+
* @summary Bulk index documents (Public SDK API)
|
|
29744
|
+
* @param {string} xStoreid Store ID
|
|
29745
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29746
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29747
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
|
|
29748
|
+
* @param {*} [options] Override http request option.
|
|
29749
|
+
* @throws {RequiredError}
|
|
29750
|
+
*/
|
|
29751
|
+
apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29752
|
+
/**
|
|
29753
|
+
* Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
|
|
29754
|
+
* @summary Delete a document (Public SDK API)
|
|
29755
|
+
* @param {string} xStoreid Store ID
|
|
29756
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29757
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29758
|
+
* @param {string} documentID Document ID to delete
|
|
29759
|
+
* @param {*} [options] Override http request option.
|
|
29760
|
+
* @throws {RequiredError}
|
|
29761
|
+
*/
|
|
29762
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29763
|
+
/**
|
|
29764
|
+
* Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. 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.
|
|
29765
|
+
* @summary Index a single document (Public SDK API)
|
|
29766
|
+
* @param {string} xStoreid Store ID
|
|
29767
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29768
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29769
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
|
|
29770
|
+
* @param {*} [options] Override http request option.
|
|
29771
|
+
* @throws {RequiredError}
|
|
29772
|
+
*/
|
|
29773
|
+
apiV1StoresXStoreIDDocumentsPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29774
|
+
};
|
|
29775
|
+
/**
|
|
29776
|
+
* SDKDocumentsApi - functional programming interface
|
|
29777
|
+
* @export
|
|
29778
|
+
*/
|
|
29779
|
+
export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
29780
|
+
/**
|
|
29781
|
+
* Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
|
|
29782
|
+
* @summary Bulk index documents (Public SDK API)
|
|
29783
|
+
* @param {string} xStoreid Store ID
|
|
29784
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29785
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29786
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
|
|
29787
|
+
* @param {*} [options] Override http request option.
|
|
29788
|
+
* @throws {RequiredError}
|
|
29789
|
+
*/
|
|
29790
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
29791
|
+
/**
|
|
29792
|
+
* Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
|
|
29793
|
+
* @summary Delete a document (Public SDK API)
|
|
29794
|
+
* @param {string} xStoreid Store ID
|
|
29795
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29796
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29797
|
+
* @param {string} documentID Document ID to delete
|
|
29798
|
+
* @param {*} [options] Override http request option.
|
|
29799
|
+
* @throws {RequiredError}
|
|
29800
|
+
*/
|
|
29801
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
29802
|
+
/**
|
|
29803
|
+
* Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. 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.
|
|
29804
|
+
* @summary Index a single document (Public SDK API)
|
|
29805
|
+
* @param {string} xStoreid Store ID
|
|
29806
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29807
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29808
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
|
|
29809
|
+
* @param {*} [options] Override http request option.
|
|
29810
|
+
* @throws {RequiredError}
|
|
29811
|
+
*/
|
|
29812
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
29813
|
+
};
|
|
29814
|
+
/**
|
|
29815
|
+
* SDKDocumentsApi - factory interface
|
|
29816
|
+
* @export
|
|
29817
|
+
*/
|
|
29818
|
+
export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29819
|
+
/**
|
|
29820
|
+
* Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
|
|
29821
|
+
* @summary Bulk index documents (Public SDK API)
|
|
29822
|
+
* @param {string} xStoreid Store ID
|
|
29823
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29824
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29825
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
|
|
29826
|
+
* @param {*} [options] Override http request option.
|
|
29827
|
+
* @throws {RequiredError}
|
|
29828
|
+
*/
|
|
29829
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
29830
|
+
/**
|
|
29831
|
+
* Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
|
|
29832
|
+
* @summary Delete a document (Public SDK API)
|
|
29833
|
+
* @param {string} xStoreid Store ID
|
|
29834
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29835
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29836
|
+
* @param {string} documentID Document ID to delete
|
|
29837
|
+
* @param {*} [options] Override http request option.
|
|
29838
|
+
* @throws {RequiredError}
|
|
29839
|
+
*/
|
|
29840
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
29841
|
+
/**
|
|
29842
|
+
* Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. 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.
|
|
29843
|
+
* @summary Index a single document (Public SDK API)
|
|
29844
|
+
* @param {string} xStoreid Store ID
|
|
29845
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29846
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29847
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
|
|
29848
|
+
* @param {*} [options] Override http request option.
|
|
29849
|
+
* @throws {RequiredError}
|
|
29850
|
+
*/
|
|
29851
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
29852
|
+
};
|
|
29853
|
+
/**
|
|
29854
|
+
* SDKDocumentsApi - object-oriented interface
|
|
29855
|
+
* @export
|
|
29856
|
+
* @class SDKDocumentsApi
|
|
29857
|
+
* @extends {BaseAPI}
|
|
29858
|
+
*/
|
|
29859
|
+
export declare class SDKDocumentsApi extends BaseAPI {
|
|
29860
|
+
/**
|
|
29861
|
+
* Performs bulk insert, update, upsert, or delete operations on documents using the public SDK API. Requires x-store-write-secret for authentication. Each document may specify its own action (insert, update, upsert, delete).
|
|
29862
|
+
* @summary Bulk index documents (Public SDK API)
|
|
29863
|
+
* @param {string} xStoreid Store ID
|
|
29864
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29865
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29866
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest Bulk operation data
|
|
29867
|
+
* @param {*} [options] Override http request option.
|
|
29868
|
+
* @throws {RequiredError}
|
|
29869
|
+
* @memberof SDKDocumentsApi
|
|
29870
|
+
*/
|
|
29871
|
+
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
29872
|
+
/**
|
|
29873
|
+
* Deletes a document by ID from a store using the public SDK API. Requires x-store-write-secret for authentication.
|
|
29874
|
+
* @summary Delete a document (Public SDK API)
|
|
29875
|
+
* @param {string} xStoreid Store ID
|
|
29876
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29877
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29878
|
+
* @param {string} documentID Document ID to delete
|
|
29879
|
+
* @param {*} [options] Override http request option.
|
|
29880
|
+
* @throws {RequiredError}
|
|
29881
|
+
* @memberof SDKDocumentsApi
|
|
29882
|
+
*/
|
|
29883
|
+
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
29884
|
+
/**
|
|
29885
|
+
* Indexes a new document into a store using the public SDK API. Requires x-store-write-secret for authentication. 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.
|
|
29886
|
+
* @summary Index a single document (Public SDK API)
|
|
29887
|
+
* @param {string} xStoreid Store ID
|
|
29888
|
+
* @param {string} xStoreWriteSecret Store Write Secret (required for write operations)
|
|
29889
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
29890
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document data
|
|
29891
|
+
* @param {*} [options] Override http request option.
|
|
29892
|
+
* @throws {RequiredError}
|
|
29893
|
+
* @memberof SDKDocumentsApi
|
|
29894
|
+
*/
|
|
29895
|
+
apiV1StoresXStoreIDDocumentsPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesDocumentRequest: DataTypesDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
29896
|
+
}
|
|
29532
29897
|
/**
|
|
29533
29898
|
* SDKQuerySuggestionsConfigApi - axios parameter creator
|
|
29534
29899
|
* @export
|
|
@@ -29641,6 +30006,159 @@ export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
|
|
|
29641
30006
|
*/
|
|
29642
30007
|
apiV1StoresXStoreIDQuerySuggestionsConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, querySuggestionsServiceUpdateSuggestionConfigRequest: QuerySuggestionsServiceUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
29643
30008
|
}
|
|
30009
|
+
/**
|
|
30010
|
+
* SDKSchemaApi - axios parameter creator
|
|
30011
|
+
* @export
|
|
30012
|
+
*/
|
|
30013
|
+
export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30014
|
+
/**
|
|
30015
|
+
* Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
|
|
30016
|
+
* @summary Clear All Documents (Public SDK API)
|
|
30017
|
+
* @param {string} xStoreid Store ID
|
|
30018
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30019
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30020
|
+
* @param {*} [options] Override http request option.
|
|
30021
|
+
* @throws {RequiredError}
|
|
30022
|
+
*/
|
|
30023
|
+
apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30024
|
+
/**
|
|
30025
|
+
* Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
|
|
30026
|
+
* @summary Get Collection Schema (Public SDK API)
|
|
30027
|
+
* @param {string} xStoreid Store ID
|
|
30028
|
+
* @param {string} xStoresecret Store Read Secret
|
|
30029
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30030
|
+
* @param {*} [options] Override http request option.
|
|
30031
|
+
* @throws {RequiredError}
|
|
30032
|
+
*/
|
|
30033
|
+
apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30034
|
+
/**
|
|
30035
|
+
* Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
|
|
30036
|
+
* @summary Create or Update Collection Schema (Public SDK API)
|
|
30037
|
+
* @param {string} xStoreid Store ID
|
|
30038
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30039
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30040
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
|
|
30041
|
+
* @param {*} [options] Override http request option.
|
|
30042
|
+
* @throws {RequiredError}
|
|
30043
|
+
*/
|
|
30044
|
+
apiV1StoresXStoreIDSchemaPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30045
|
+
};
|
|
30046
|
+
/**
|
|
30047
|
+
* SDKSchemaApi - functional programming interface
|
|
30048
|
+
* @export
|
|
30049
|
+
*/
|
|
30050
|
+
export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
30051
|
+
/**
|
|
30052
|
+
* Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
|
|
30053
|
+
* @summary Clear All Documents (Public SDK API)
|
|
30054
|
+
* @param {string} xStoreid Store ID
|
|
30055
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30056
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30057
|
+
* @param {*} [options] Override http request option.
|
|
30058
|
+
* @throws {RequiredError}
|
|
30059
|
+
*/
|
|
30060
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
30061
|
+
/**
|
|
30062
|
+
* Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
|
|
30063
|
+
* @summary Get Collection Schema (Public SDK API)
|
|
30064
|
+
* @param {string} xStoreid Store ID
|
|
30065
|
+
* @param {string} xStoresecret Store Read Secret
|
|
30066
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30067
|
+
* @param {*} [options] Override http request option.
|
|
30068
|
+
* @throws {RequiredError}
|
|
30069
|
+
*/
|
|
30070
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
30071
|
+
/**
|
|
30072
|
+
* Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
|
|
30073
|
+
* @summary Create or Update Collection Schema (Public SDK API)
|
|
30074
|
+
* @param {string} xStoreid Store ID
|
|
30075
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30076
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30077
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
|
|
30078
|
+
* @param {*} [options] Override http request option.
|
|
30079
|
+
* @throws {RequiredError}
|
|
30080
|
+
*/
|
|
30081
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
30082
|
+
};
|
|
30083
|
+
/**
|
|
30084
|
+
* SDKSchemaApi - factory interface
|
|
30085
|
+
* @export
|
|
30086
|
+
*/
|
|
30087
|
+
export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30088
|
+
/**
|
|
30089
|
+
* Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
|
|
30090
|
+
* @summary Clear All Documents (Public SDK API)
|
|
30091
|
+
* @param {string} xStoreid Store ID
|
|
30092
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30093
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30094
|
+
* @param {*} [options] Override http request option.
|
|
30095
|
+
* @throws {RequiredError}
|
|
30096
|
+
*/
|
|
30097
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
30098
|
+
/**
|
|
30099
|
+
* Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
|
|
30100
|
+
* @summary Get Collection Schema (Public SDK API)
|
|
30101
|
+
* @param {string} xStoreid Store ID
|
|
30102
|
+
* @param {string} xStoresecret Store Read Secret
|
|
30103
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30104
|
+
* @param {*} [options] Override http request option.
|
|
30105
|
+
* @throws {RequiredError}
|
|
30106
|
+
*/
|
|
30107
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
30108
|
+
/**
|
|
30109
|
+
* Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
|
|
30110
|
+
* @summary Create or Update Collection Schema (Public SDK API)
|
|
30111
|
+
* @param {string} xStoreid Store ID
|
|
30112
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30113
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30114
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
|
|
30115
|
+
* @param {*} [options] Override http request option.
|
|
30116
|
+
* @throws {RequiredError}
|
|
30117
|
+
*/
|
|
30118
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
30119
|
+
};
|
|
30120
|
+
/**
|
|
30121
|
+
* SDKSchemaApi - object-oriented interface
|
|
30122
|
+
* @export
|
|
30123
|
+
* @class SDKSchemaApi
|
|
30124
|
+
* @extends {BaseAPI}
|
|
30125
|
+
*/
|
|
30126
|
+
export declare class SDKSchemaApi extends BaseAPI {
|
|
30127
|
+
/**
|
|
30128
|
+
* Deletes all documents from a store\'s collection without deleting the collection itself. Requires x-store-write-secret for authentication.
|
|
30129
|
+
* @summary Clear All Documents (Public SDK API)
|
|
30130
|
+
* @param {string} xStoreid Store ID
|
|
30131
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30132
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30133
|
+
* @param {*} [options] Override http request option.
|
|
30134
|
+
* @throws {RequiredError}
|
|
30135
|
+
* @memberof SDKSchemaApi
|
|
30136
|
+
*/
|
|
30137
|
+
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
30138
|
+
/**
|
|
30139
|
+
* Retrieves the current collection schema for a store. Requires x-storesecret (read secret) for authentication.
|
|
30140
|
+
* @summary Get Collection Schema (Public SDK API)
|
|
30141
|
+
* @param {string} xStoreid Store ID
|
|
30142
|
+
* @param {string} xStoresecret Store Read Secret
|
|
30143
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30144
|
+
* @param {*} [options] Override http request option.
|
|
30145
|
+
* @throws {RequiredError}
|
|
30146
|
+
* @memberof SDKSchemaApi
|
|
30147
|
+
*/
|
|
30148
|
+
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
30149
|
+
/**
|
|
30150
|
+
* Creates a new collection schema or updates an existing one. Mode can be \'additive\' (add new fields, preserve data) or \'replace\' (delete and recreate collection). Requires x-store-write-secret for authentication.
|
|
30151
|
+
* @summary Create or Update Collection Schema (Public SDK API)
|
|
30152
|
+
* @param {string} xStoreid Store ID
|
|
30153
|
+
* @param {string} xStoreWriteSecret Store Write Secret
|
|
30154
|
+
* @param {string} xStoreID X-Store ID (must match x-storeid header)
|
|
30155
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema request
|
|
30156
|
+
* @param {*} [options] Override http request option.
|
|
30157
|
+
* @throws {RequiredError}
|
|
30158
|
+
* @memberof SDKSchemaApi
|
|
30159
|
+
*/
|
|
30160
|
+
apiV1StoresXStoreIDSchemaPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesCollectionSchemaRequest: DataTypesCollectionSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
30161
|
+
}
|
|
29644
30162
|
/**
|
|
29645
30163
|
* SDKStoreConfigApi - axios parameter creator
|
|
29646
30164
|
* @export
|