@seekora-ai/admin-api 1.1.81 → 1.1.82
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 +63 -53
- package/api.ts +1445 -1075
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +959 -773
- package/dist/api.js +1306 -998
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +959 -773
- package/dist/esm/api.js +1306 -998
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.82.tgz +0 -0
- package/seekora-ai-admin-api-1.1.81.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Seekora APIs
|
|
3
|
-
*
|
|
3
|
+
* Seekora provides search, suggestions, and store management APIs. **Admin APIs** require JWT (Bearer token from login). **Public/SDK APIs** (search, stores, suggestions, documents) use store credentials: send `x-storeid` (Store ID) and either `x-storesecret` (read) or `x-store-write-secret` (write) in headers. Get these from the Seekora dashboard. Base path for public v1 APIs: `/api/v1`.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
6
|
*
|
|
@@ -6961,12 +6961,6 @@ export interface AnalyticsMergeProfilesRequestBody {
|
|
|
6961
6961
|
* @memberof AnalyticsMergeProfilesRequestBody
|
|
6962
6962
|
*/
|
|
6963
6963
|
'authenticated_id': string;
|
|
6964
|
-
/**
|
|
6965
|
-
*
|
|
6966
|
-
* @type {string}
|
|
6967
|
-
* @memberof AnalyticsMergeProfilesRequestBody
|
|
6968
|
-
*/
|
|
6969
|
-
'xstoreid'?: string;
|
|
6970
6964
|
}
|
|
6971
6965
|
/**
|
|
6972
6966
|
*
|
|
@@ -33150,12 +33144,24 @@ export interface ModelsCreateCustomEventFieldRequest {
|
|
|
33150
33144
|
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33151
33145
|
*/
|
|
33152
33146
|
'max_value'?: number;
|
|
33147
|
+
/**
|
|
33148
|
+
* string min length; array min items
|
|
33149
|
+
* @type {number}
|
|
33150
|
+
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33151
|
+
*/
|
|
33152
|
+
'min_length'?: number;
|
|
33153
33153
|
/**
|
|
33154
33154
|
*
|
|
33155
33155
|
* @type {number}
|
|
33156
33156
|
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33157
33157
|
*/
|
|
33158
33158
|
'min_value'?: number;
|
|
33159
|
+
/**
|
|
33160
|
+
* for object type
|
|
33161
|
+
* @type {Array<ModelsNestedPropertyDefinition>}
|
|
33162
|
+
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33163
|
+
*/
|
|
33164
|
+
'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
|
|
33159
33165
|
/**
|
|
33160
33166
|
*
|
|
33161
33167
|
* @type {string}
|
|
@@ -33169,6 +33175,7 @@ export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
|
|
|
33169
33175
|
readonly Boolean: "boolean";
|
|
33170
33176
|
readonly Datetime: "datetime";
|
|
33171
33177
|
readonly Array: "array";
|
|
33178
|
+
readonly Object: "object";
|
|
33172
33179
|
};
|
|
33173
33180
|
export type ModelsCreateCustomEventFieldRequestFieldTypeEnum = typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum[keyof typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum];
|
|
33174
33181
|
/**
|
|
@@ -33251,6 +33258,31 @@ export interface ModelsMergeProfilesResponse {
|
|
|
33251
33258
|
*/
|
|
33252
33259
|
'success'?: boolean;
|
|
33253
33260
|
}
|
|
33261
|
+
/**
|
|
33262
|
+
*
|
|
33263
|
+
* @export
|
|
33264
|
+
* @interface ModelsNestedPropertyDefinition
|
|
33265
|
+
*/
|
|
33266
|
+
export interface ModelsNestedPropertyDefinition {
|
|
33267
|
+
/**
|
|
33268
|
+
*
|
|
33269
|
+
* @type {string}
|
|
33270
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33271
|
+
*/
|
|
33272
|
+
'name'?: string;
|
|
33273
|
+
/**
|
|
33274
|
+
*
|
|
33275
|
+
* @type {boolean}
|
|
33276
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33277
|
+
*/
|
|
33278
|
+
'required'?: boolean;
|
|
33279
|
+
/**
|
|
33280
|
+
* string, number, boolean, datetime, array, object
|
|
33281
|
+
* @type {string}
|
|
33282
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33283
|
+
*/
|
|
33284
|
+
'type'?: string;
|
|
33285
|
+
}
|
|
33254
33286
|
/**
|
|
33255
33287
|
*
|
|
33256
33288
|
* @export
|
|
@@ -33451,12 +33483,24 @@ export interface ModelsUpdateCustomEventFieldRequest {
|
|
|
33451
33483
|
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33452
33484
|
*/
|
|
33453
33485
|
'max_value'?: number;
|
|
33486
|
+
/**
|
|
33487
|
+
*
|
|
33488
|
+
* @type {number}
|
|
33489
|
+
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33490
|
+
*/
|
|
33491
|
+
'min_length'?: number;
|
|
33454
33492
|
/**
|
|
33455
33493
|
*
|
|
33456
33494
|
* @type {number}
|
|
33457
33495
|
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33458
33496
|
*/
|
|
33459
33497
|
'min_value'?: number;
|
|
33498
|
+
/**
|
|
33499
|
+
*
|
|
33500
|
+
* @type {Array<ModelsNestedPropertyDefinition>}
|
|
33501
|
+
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33502
|
+
*/
|
|
33503
|
+
'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
|
|
33460
33504
|
/**
|
|
33461
33505
|
*
|
|
33462
33506
|
* @type {string}
|
|
@@ -36801,31 +36845,31 @@ export interface V1AdminNotificationsTemplatesCodeSendPostRequest {
|
|
|
36801
36845
|
*/
|
|
36802
36846
|
export interface V1ConnectorsSourcesSourceidUploaddataPostRequest {
|
|
36803
36847
|
/**
|
|
36804
|
-
* Config
|
|
36848
|
+
* Config (e.g. json_upload, csv_upload)
|
|
36805
36849
|
* @type {string}
|
|
36806
36850
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36807
36851
|
*/
|
|
36808
36852
|
'Config': string;
|
|
36809
36853
|
/**
|
|
36810
|
-
* File
|
|
36854
|
+
* File to upload
|
|
36811
36855
|
* @type {File}
|
|
36812
36856
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36813
36857
|
*/
|
|
36814
36858
|
'File': File;
|
|
36815
36859
|
/**
|
|
36816
|
-
*
|
|
36860
|
+
* Source name
|
|
36817
36861
|
* @type {string}
|
|
36818
36862
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36819
36863
|
*/
|
|
36820
36864
|
'Name': string;
|
|
36821
36865
|
/**
|
|
36822
|
-
*
|
|
36866
|
+
* Optional template ID
|
|
36823
36867
|
* @type {string}
|
|
36824
36868
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36825
36869
|
*/
|
|
36826
36870
|
'SourceTemplateId'?: string;
|
|
36827
36871
|
/**
|
|
36828
|
-
*
|
|
36872
|
+
* Data type
|
|
36829
36873
|
* @type {string}
|
|
36830
36874
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36831
36875
|
*/
|
|
@@ -44160,6 +44204,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
44160
44204
|
* @throws {RequiredError}
|
|
44161
44205
|
*/
|
|
44162
44206
|
adminBillingInvoicesIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44207
|
+
/**
|
|
44208
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
44209
|
+
* @summary Get invoice PDF signed URL
|
|
44210
|
+
* @param {string} id Invoice ID
|
|
44211
|
+
* @param {*} [options] Override http request option.
|
|
44212
|
+
* @throws {RequiredError}
|
|
44213
|
+
*/
|
|
44214
|
+
adminBillingInvoicesIdPdfUrlGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44163
44215
|
/**
|
|
44164
44216
|
* Updates an existing invoice
|
|
44165
44217
|
* @summary Update invoice
|
|
@@ -44299,6 +44351,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
44299
44351
|
* @throws {RequiredError}
|
|
44300
44352
|
*/
|
|
44301
44353
|
adminBillingReceiptsIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44354
|
+
/**
|
|
44355
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
44356
|
+
* @summary Get receipt PDF signed URL
|
|
44357
|
+
* @param {number} id Receipt ID
|
|
44358
|
+
* @param {*} [options] Override http request option.
|
|
44359
|
+
* @throws {RequiredError}
|
|
44360
|
+
*/
|
|
44361
|
+
adminBillingReceiptsIdPdfUrlGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44302
44362
|
/**
|
|
44303
44363
|
* Returns saved payment cards from Razorpay for the organization
|
|
44304
44364
|
* @summary Get saved payment cards
|
|
@@ -44538,6 +44598,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44538
44598
|
* @throws {RequiredError}
|
|
44539
44599
|
*/
|
|
44540
44600
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
44601
|
+
/**
|
|
44602
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
44603
|
+
* @summary Get invoice PDF signed URL
|
|
44604
|
+
* @param {string} id Invoice ID
|
|
44605
|
+
* @param {*} [options] Override http request option.
|
|
44606
|
+
* @throws {RequiredError}
|
|
44607
|
+
*/
|
|
44608
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
44541
44609
|
/**
|
|
44542
44610
|
* Updates an existing invoice
|
|
44543
44611
|
* @summary Update invoice
|
|
@@ -44677,6 +44745,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44677
44745
|
* @throws {RequiredError}
|
|
44678
44746
|
*/
|
|
44679
44747
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesReceipt>>;
|
|
44748
|
+
/**
|
|
44749
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
44750
|
+
* @summary Get receipt PDF signed URL
|
|
44751
|
+
* @param {number} id Receipt ID
|
|
44752
|
+
* @param {*} [options] Override http request option.
|
|
44753
|
+
* @throws {RequiredError}
|
|
44754
|
+
*/
|
|
44755
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
44680
44756
|
/**
|
|
44681
44757
|
* Returns saved payment cards from Razorpay for the organization
|
|
44682
44758
|
* @summary Get saved payment cards
|
|
@@ -44916,6 +44992,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
44916
44992
|
* @throws {RequiredError}
|
|
44917
44993
|
*/
|
|
44918
44994
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
44995
|
+
/**
|
|
44996
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
44997
|
+
* @summary Get invoice PDF signed URL
|
|
44998
|
+
* @param {string} id Invoice ID
|
|
44999
|
+
* @param {*} [options] Override http request option.
|
|
45000
|
+
* @throws {RequiredError}
|
|
45001
|
+
*/
|
|
45002
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
44919
45003
|
/**
|
|
44920
45004
|
* Updates an existing invoice
|
|
44921
45005
|
* @summary Update invoice
|
|
@@ -45055,6 +45139,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
45055
45139
|
* @throws {RequiredError}
|
|
45056
45140
|
*/
|
|
45057
45141
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesReceipt>;
|
|
45142
|
+
/**
|
|
45143
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
45144
|
+
* @summary Get receipt PDF signed URL
|
|
45145
|
+
* @param {number} id Receipt ID
|
|
45146
|
+
* @param {*} [options] Override http request option.
|
|
45147
|
+
* @throws {RequiredError}
|
|
45148
|
+
*/
|
|
45149
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
45058
45150
|
/**
|
|
45059
45151
|
* Returns saved payment cards from Razorpay for the organization
|
|
45060
45152
|
* @summary Get saved payment cards
|
|
@@ -45313,6 +45405,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45313
45405
|
* @memberof BillingDashboardApi
|
|
45314
45406
|
*/
|
|
45315
45407
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
45408
|
+
/**
|
|
45409
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
45410
|
+
* @summary Get invoice PDF signed URL
|
|
45411
|
+
* @param {string} id Invoice ID
|
|
45412
|
+
* @param {*} [options] Override http request option.
|
|
45413
|
+
* @throws {RequiredError}
|
|
45414
|
+
* @memberof BillingDashboardApi
|
|
45415
|
+
*/
|
|
45416
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
45316
45417
|
/**
|
|
45317
45418
|
* Updates an existing invoice
|
|
45318
45419
|
* @summary Update invoice
|
|
@@ -45466,6 +45567,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45466
45567
|
* @memberof BillingDashboardApi
|
|
45467
45568
|
*/
|
|
45468
45569
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesReceipt, any, {}>>;
|
|
45570
|
+
/**
|
|
45571
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
45572
|
+
* @summary Get receipt PDF signed URL
|
|
45573
|
+
* @param {number} id Receipt ID
|
|
45574
|
+
* @param {*} [options] Override http request option.
|
|
45575
|
+
* @throws {RequiredError}
|
|
45576
|
+
* @memberof BillingDashboardApi
|
|
45577
|
+
*/
|
|
45578
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
45469
45579
|
/**
|
|
45470
45580
|
* Returns saved payment cards from Razorpay for the organization
|
|
45471
45581
|
* @summary Get saved payment cards
|
|
@@ -46187,102 +46297,110 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46187
46297
|
/**
|
|
46188
46298
|
* List all connectors with optional filtering
|
|
46189
46299
|
* @summary List Connectors
|
|
46300
|
+
* @param {string} xStoreID Store ID
|
|
46190
46301
|
* @param {string} authorization Bearer JWT token
|
|
46191
46302
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46192
46303
|
* @param {string} [provider] Filter by provider
|
|
46193
46304
|
* @param {boolean} [isActive] Filter by active status
|
|
46194
|
-
* @param {number} [storeId] Filter by store ID
|
|
46195
46305
|
* @param {number} [limit] Number of results (default: 50)
|
|
46196
46306
|
* @param {number} [offset] Offset for pagination
|
|
46197
46307
|
* @param {*} [options] Override http request option.
|
|
46198
46308
|
* @throws {RequiredError}
|
|
46199
46309
|
*/
|
|
46200
|
-
|
|
46310
|
+
adminAnalyticsStoreXStoreIDConnectorsGet: (xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46201
46311
|
/**
|
|
46202
46312
|
* Delete a connector and its sync history
|
|
46203
46313
|
* @summary Delete Connector
|
|
46314
|
+
* @param {string} xStoreID Store ID
|
|
46204
46315
|
* @param {string} authorization Bearer JWT token
|
|
46205
46316
|
* @param {number} id Connector ID
|
|
46206
46317
|
* @param {*} [options] Override http request option.
|
|
46207
46318
|
* @throws {RequiredError}
|
|
46208
46319
|
*/
|
|
46209
|
-
|
|
46320
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46210
46321
|
/**
|
|
46211
46322
|
* Retrieve a specific connector by ID
|
|
46212
46323
|
* @summary Get Connector
|
|
46324
|
+
* @param {string} xStoreID Store ID
|
|
46213
46325
|
* @param {string} authorization Bearer JWT token
|
|
46214
46326
|
* @param {number} id Connector ID
|
|
46215
46327
|
* @param {*} [options] Override http request option.
|
|
46216
46328
|
* @throws {RequiredError}
|
|
46217
46329
|
*/
|
|
46218
|
-
|
|
46330
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46219
46331
|
/**
|
|
46220
46332
|
* Get sync history for a connector
|
|
46221
46333
|
* @summary Get Sync History
|
|
46334
|
+
* @param {string} xStoreID Store ID
|
|
46222
46335
|
* @param {string} authorization Bearer JWT token
|
|
46223
46336
|
* @param {number} id Connector ID
|
|
46224
46337
|
* @param {number} [limit] Number of results (default: 20)
|
|
46225
46338
|
* @param {*} [options] Override http request option.
|
|
46226
46339
|
* @throws {RequiredError}
|
|
46227
46340
|
*/
|
|
46228
|
-
|
|
46341
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet: (xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46229
46342
|
/**
|
|
46230
46343
|
* Update an existing connector
|
|
46231
46344
|
* @summary Update Connector
|
|
46345
|
+
* @param {string} xStoreID Store ID
|
|
46232
46346
|
* @param {string} authorization Bearer JWT token
|
|
46233
46347
|
* @param {number} id Connector ID
|
|
46234
46348
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46235
46349
|
* @param {*} [options] Override http request option.
|
|
46236
46350
|
* @throws {RequiredError}
|
|
46237
46351
|
*/
|
|
46238
|
-
|
|
46352
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut: (xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46239
46353
|
/**
|
|
46240
46354
|
* Trigger a sync operation for a connector
|
|
46241
46355
|
* @summary Trigger Sync
|
|
46356
|
+
* @param {string} xStoreID Store ID
|
|
46242
46357
|
* @param {string} authorization Bearer JWT token
|
|
46243
46358
|
* @param {number} id Connector ID
|
|
46244
46359
|
* @param {*} [options] Override http request option.
|
|
46245
46360
|
* @throws {RequiredError}
|
|
46246
46361
|
*/
|
|
46247
|
-
|
|
46362
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46248
46363
|
/**
|
|
46249
46364
|
* Test the connection to a connector\'s external service
|
|
46250
46365
|
* @summary Test Connection
|
|
46366
|
+
* @param {string} xStoreID Store ID
|
|
46251
46367
|
* @param {string} authorization Bearer JWT token
|
|
46252
46368
|
* @param {number} id Connector ID
|
|
46253
46369
|
* @param {*} [options] Override http request option.
|
|
46254
46370
|
* @throws {RequiredError}
|
|
46255
46371
|
*/
|
|
46256
|
-
|
|
46257
|
-
/**
|
|
46258
|
-
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
46259
|
-
* @summary Get validation errors for a job
|
|
46260
|
-
* @param {string} jobid Job ID
|
|
46261
|
-
* @param {*} [options] Override http request option.
|
|
46262
|
-
* @throws {RequiredError}
|
|
46263
|
-
*/
|
|
46264
|
-
v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46372
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46265
46373
|
/**
|
|
46266
46374
|
* Create a new analytics connector for importing or exporting events
|
|
46267
46375
|
* @summary Create Connector
|
|
46376
|
+
* @param {string} xStoreID Store ID
|
|
46268
46377
|
* @param {string} authorization Bearer JWT token
|
|
46269
46378
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46270
46379
|
* @param {*} [options] Override http request option.
|
|
46271
46380
|
* @throws {RequiredError}
|
|
46272
46381
|
*/
|
|
46273
|
-
|
|
46382
|
+
adminAnalyticsStoreXStoreIDConnectorsPost: (xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46274
46383
|
/**
|
|
46275
46384
|
* Get list of available connector providers
|
|
46276
46385
|
* @summary Get Available Providers
|
|
46386
|
+
* @param {string} xStoreID Store ID
|
|
46277
46387
|
* @param {string} authorization Bearer JWT token
|
|
46278
46388
|
* @param {string} [type] Connector type (import, export)
|
|
46279
46389
|
* @param {*} [options] Override http request option.
|
|
46280
46390
|
* @throws {RequiredError}
|
|
46281
46391
|
*/
|
|
46282
|
-
|
|
46392
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet: (xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46283
46393
|
/**
|
|
46284
|
-
*
|
|
46285
|
-
* @summary
|
|
46394
|
+
* Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
|
|
46395
|
+
* @summary Get validation errors for a job
|
|
46396
|
+
* @param {string} jobid Job ID from upload response
|
|
46397
|
+
* @param {*} [options] Override http request option.
|
|
46398
|
+
* @throws {RequiredError}
|
|
46399
|
+
*/
|
|
46400
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46401
|
+
/**
|
|
46402
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
46403
|
+
* @summary Test search for an index
|
|
46286
46404
|
* @param {string} index Index name
|
|
46287
46405
|
* @param {string} q Search query
|
|
46288
46406
|
* @param {*} [options] Override http request option.
|
|
@@ -46290,25 +46408,25 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46290
46408
|
*/
|
|
46291
46409
|
v1ConnectorsSearchIndexGet: (index: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46292
46410
|
/**
|
|
46293
|
-
*
|
|
46294
|
-
* @summary
|
|
46411
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46412
|
+
* @summary List data sources
|
|
46295
46413
|
* @param {*} [options] Override http request option.
|
|
46296
46414
|
* @throws {RequiredError}
|
|
46297
46415
|
*/
|
|
46298
46416
|
v1ConnectorsSourcesGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46299
46417
|
/**
|
|
46300
|
-
*
|
|
46301
|
-
* @summary Create source
|
|
46302
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
46418
|
+
* Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
|
|
46419
|
+
* @summary Create data source
|
|
46420
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46303
46421
|
* @param {*} [options] Override http request option.
|
|
46304
46422
|
* @throws {RequiredError}
|
|
46305
46423
|
*/
|
|
46306
46424
|
v1ConnectorsSourcesPost: (dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46307
46425
|
/**
|
|
46308
|
-
* Update source config
|
|
46309
|
-
* @summary Update source config
|
|
46426
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
46427
|
+
* @summary Update source config
|
|
46310
46428
|
* @param {string} sourceId Source ID
|
|
46311
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
46429
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46312
46430
|
* @param {*} [options] Override http request option.
|
|
46313
46431
|
* @throws {RequiredError}
|
|
46314
46432
|
*/
|
|
@@ -46316,23 +46434,24 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46316
46434
|
[key: string]: any;
|
|
46317
46435
|
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46318
46436
|
/**
|
|
46319
|
-
*
|
|
46320
|
-
* @summary Get source by
|
|
46437
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46438
|
+
* @summary Get source by ID
|
|
46439
|
+
* @param {string} sourceId Source ID
|
|
46321
46440
|
* @param {*} [options] Override http request option.
|
|
46322
46441
|
* @throws {RequiredError}
|
|
46323
46442
|
*/
|
|
46324
|
-
v1ConnectorsSourcesSourceIdGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46443
|
+
v1ConnectorsSourcesSourceIdGet: (sourceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46325
46444
|
/**
|
|
46326
|
-
* Update
|
|
46327
|
-
* @summary Update
|
|
46328
|
-
* @param {string} sourceid Source ID
|
|
46329
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
46445
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
46446
|
+
* @summary Update source index schema
|
|
46447
|
+
* @param {string} sourceid Source ID
|
|
46448
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46330
46449
|
* @param {*} [options] Override http request option.
|
|
46331
46450
|
* @throws {RequiredError}
|
|
46332
46451
|
*/
|
|
46333
46452
|
v1ConnectorsSourcesSourceidUpdateschemaPost: (sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46334
46453
|
/**
|
|
46335
|
-
* Upload source data
|
|
46454
|
+
* Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
|
|
46336
46455
|
* @summary Upload source data
|
|
46337
46456
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46338
46457
|
* @param {*} [options] Override http request option.
|
|
@@ -46340,18 +46459,18 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46340
46459
|
*/
|
|
46341
46460
|
v1ConnectorsSourcesSourceidUploaddataPost: (v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46342
46461
|
/**
|
|
46343
|
-
* Create task
|
|
46344
|
-
* @summary Create task
|
|
46345
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
46462
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
46463
|
+
* @summary Create connector task
|
|
46464
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46346
46465
|
* @param {*} [options] Override http request option.
|
|
46347
46466
|
* @throws {RequiredError}
|
|
46348
46467
|
*/
|
|
46349
46468
|
v1ConnectorsTasksPost: (dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46350
46469
|
/**
|
|
46351
|
-
*
|
|
46470
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46352
46471
|
* @summary Trigger task run
|
|
46353
46472
|
* @param {string} taskId Task ID
|
|
46354
|
-
* @param {number} body
|
|
46473
|
+
* @param {number} body User ID who triggered the run
|
|
46355
46474
|
* @param {*} [options] Override http request option.
|
|
46356
46475
|
* @throws {RequiredError}
|
|
46357
46476
|
*/
|
|
@@ -46365,120 +46484,128 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46365
46484
|
/**
|
|
46366
46485
|
* List all connectors with optional filtering
|
|
46367
46486
|
* @summary List Connectors
|
|
46487
|
+
* @param {string} xStoreID Store ID
|
|
46368
46488
|
* @param {string} authorization Bearer JWT token
|
|
46369
46489
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46370
46490
|
* @param {string} [provider] Filter by provider
|
|
46371
46491
|
* @param {boolean} [isActive] Filter by active status
|
|
46372
|
-
* @param {number} [storeId] Filter by store ID
|
|
46373
46492
|
* @param {number} [limit] Number of results (default: 50)
|
|
46374
46493
|
* @param {number} [offset] Offset for pagination
|
|
46375
46494
|
* @param {*} [options] Override http request option.
|
|
46376
46495
|
* @throws {RequiredError}
|
|
46377
46496
|
*/
|
|
46378
|
-
|
|
46497
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46379
46498
|
[key: string]: any;
|
|
46380
46499
|
}>>;
|
|
46381
46500
|
/**
|
|
46382
46501
|
* Delete a connector and its sync history
|
|
46383
46502
|
* @summary Delete Connector
|
|
46503
|
+
* @param {string} xStoreID Store ID
|
|
46384
46504
|
* @param {string} authorization Bearer JWT token
|
|
46385
46505
|
* @param {number} id Connector ID
|
|
46386
46506
|
* @param {*} [options] Override http request option.
|
|
46387
46507
|
* @throws {RequiredError}
|
|
46388
46508
|
*/
|
|
46389
|
-
|
|
46509
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46390
46510
|
[key: string]: any;
|
|
46391
46511
|
}>>;
|
|
46392
46512
|
/**
|
|
46393
46513
|
* Retrieve a specific connector by ID
|
|
46394
46514
|
* @summary Get Connector
|
|
46515
|
+
* @param {string} xStoreID Store ID
|
|
46395
46516
|
* @param {string} authorization Bearer JWT token
|
|
46396
46517
|
* @param {number} id Connector ID
|
|
46397
46518
|
* @param {*} [options] Override http request option.
|
|
46398
46519
|
* @throws {RequiredError}
|
|
46399
46520
|
*/
|
|
46400
|
-
|
|
46521
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46401
46522
|
[key: string]: any;
|
|
46402
46523
|
}>>;
|
|
46403
46524
|
/**
|
|
46404
46525
|
* Get sync history for a connector
|
|
46405
46526
|
* @summary Get Sync History
|
|
46527
|
+
* @param {string} xStoreID Store ID
|
|
46406
46528
|
* @param {string} authorization Bearer JWT token
|
|
46407
46529
|
* @param {number} id Connector ID
|
|
46408
46530
|
* @param {number} [limit] Number of results (default: 20)
|
|
46409
46531
|
* @param {*} [options] Override http request option.
|
|
46410
46532
|
* @throws {RequiredError}
|
|
46411
46533
|
*/
|
|
46412
|
-
|
|
46534
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46413
46535
|
[key: string]: any;
|
|
46414
46536
|
}>>;
|
|
46415
46537
|
/**
|
|
46416
46538
|
* Update an existing connector
|
|
46417
46539
|
* @summary Update Connector
|
|
46540
|
+
* @param {string} xStoreID Store ID
|
|
46418
46541
|
* @param {string} authorization Bearer JWT token
|
|
46419
46542
|
* @param {number} id Connector ID
|
|
46420
46543
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46421
46544
|
* @param {*} [options] Override http request option.
|
|
46422
46545
|
* @throws {RequiredError}
|
|
46423
46546
|
*/
|
|
46424
|
-
|
|
46547
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46425
46548
|
[key: string]: any;
|
|
46426
46549
|
}>>;
|
|
46427
46550
|
/**
|
|
46428
46551
|
* Trigger a sync operation for a connector
|
|
46429
46552
|
* @summary Trigger Sync
|
|
46553
|
+
* @param {string} xStoreID Store ID
|
|
46430
46554
|
* @param {string} authorization Bearer JWT token
|
|
46431
46555
|
* @param {number} id Connector ID
|
|
46432
46556
|
* @param {*} [options] Override http request option.
|
|
46433
46557
|
* @throws {RequiredError}
|
|
46434
46558
|
*/
|
|
46435
|
-
|
|
46559
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46436
46560
|
[key: string]: any;
|
|
46437
46561
|
}>>;
|
|
46438
46562
|
/**
|
|
46439
46563
|
* Test the connection to a connector\'s external service
|
|
46440
46564
|
* @summary Test Connection
|
|
46565
|
+
* @param {string} xStoreID Store ID
|
|
46441
46566
|
* @param {string} authorization Bearer JWT token
|
|
46442
46567
|
* @param {number} id Connector ID
|
|
46443
46568
|
* @param {*} [options] Override http request option.
|
|
46444
46569
|
* @throws {RequiredError}
|
|
46445
46570
|
*/
|
|
46446
|
-
|
|
46571
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46447
46572
|
[key: string]: any;
|
|
46448
46573
|
}>>;
|
|
46449
|
-
/**
|
|
46450
|
-
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
46451
|
-
* @summary Get validation errors for a job
|
|
46452
|
-
* @param {string} jobid Job ID
|
|
46453
|
-
* @param {*} [options] Override http request option.
|
|
46454
|
-
* @throws {RequiredError}
|
|
46455
|
-
*/
|
|
46456
|
-
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
46457
46574
|
/**
|
|
46458
46575
|
* Create a new analytics connector for importing or exporting events
|
|
46459
46576
|
* @summary Create Connector
|
|
46577
|
+
* @param {string} xStoreID Store ID
|
|
46460
46578
|
* @param {string} authorization Bearer JWT token
|
|
46461
46579
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46462
46580
|
* @param {*} [options] Override http request option.
|
|
46463
46581
|
* @throws {RequiredError}
|
|
46464
46582
|
*/
|
|
46465
|
-
|
|
46583
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46466
46584
|
[key: string]: any;
|
|
46467
46585
|
}>>;
|
|
46468
46586
|
/**
|
|
46469
46587
|
* Get list of available connector providers
|
|
46470
46588
|
* @summary Get Available Providers
|
|
46589
|
+
* @param {string} xStoreID Store ID
|
|
46471
46590
|
* @param {string} authorization Bearer JWT token
|
|
46472
46591
|
* @param {string} [type] Connector type (import, export)
|
|
46473
46592
|
* @param {*} [options] Override http request option.
|
|
46474
46593
|
* @throws {RequiredError}
|
|
46475
46594
|
*/
|
|
46476
|
-
|
|
46595
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46477
46596
|
[key: string]: any;
|
|
46478
46597
|
}>>;
|
|
46479
46598
|
/**
|
|
46480
|
-
*
|
|
46481
|
-
* @summary
|
|
46599
|
+
* Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
|
|
46600
|
+
* @summary Get validation errors for a job
|
|
46601
|
+
* @param {string} jobid Job ID from upload response
|
|
46602
|
+
* @param {*} [options] Override http request option.
|
|
46603
|
+
* @throws {RequiredError}
|
|
46604
|
+
*/
|
|
46605
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
46606
|
+
/**
|
|
46607
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
46608
|
+
* @summary Test search for an index
|
|
46482
46609
|
* @param {string} index Index name
|
|
46483
46610
|
* @param {string} q Search query
|
|
46484
46611
|
* @param {*} [options] Override http request option.
|
|
@@ -46486,25 +46613,25 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46486
46613
|
*/
|
|
46487
46614
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResultResponse>>;
|
|
46488
46615
|
/**
|
|
46489
|
-
*
|
|
46490
|
-
* @summary
|
|
46616
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46617
|
+
* @summary List data sources
|
|
46491
46618
|
* @param {*} [options] Override http request option.
|
|
46492
46619
|
* @throws {RequiredError}
|
|
46493
46620
|
*/
|
|
46494
46621
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSourcesListResponse>>;
|
|
46495
46622
|
/**
|
|
46496
|
-
*
|
|
46497
|
-
* @summary Create source
|
|
46498
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
46623
|
+
* Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
|
|
46624
|
+
* @summary Create data source
|
|
46625
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46499
46626
|
* @param {*} [options] Override http request option.
|
|
46500
46627
|
* @throws {RequiredError}
|
|
46501
46628
|
*/
|
|
46502
46629
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateSourceResponse>>;
|
|
46503
46630
|
/**
|
|
46504
|
-
* Update source config
|
|
46505
|
-
* @summary Update source config
|
|
46631
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
46632
|
+
* @summary Update source config
|
|
46506
46633
|
* @param {string} sourceId Source ID
|
|
46507
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
46634
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46508
46635
|
* @param {*} [options] Override http request option.
|
|
46509
46636
|
* @throws {RequiredError}
|
|
46510
46637
|
*/
|
|
@@ -46512,23 +46639,24 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46512
46639
|
[key: string]: any;
|
|
46513
46640
|
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
46514
46641
|
/**
|
|
46515
|
-
*
|
|
46516
|
-
* @summary Get source by
|
|
46642
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46643
|
+
* @summary Get source by ID
|
|
46644
|
+
* @param {string} sourceId Source ID
|
|
46517
46645
|
* @param {*} [options] Override http request option.
|
|
46518
46646
|
* @throws {RequiredError}
|
|
46519
46647
|
*/
|
|
46520
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
|
|
46648
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
|
|
46521
46649
|
/**
|
|
46522
|
-
* Update
|
|
46523
|
-
* @summary Update
|
|
46524
|
-
* @param {string} sourceid Source ID
|
|
46525
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
46650
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
46651
|
+
* @summary Update source index schema
|
|
46652
|
+
* @param {string} sourceid Source ID
|
|
46653
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46526
46654
|
* @param {*} [options] Override http request option.
|
|
46527
46655
|
* @throws {RequiredError}
|
|
46528
46656
|
*/
|
|
46529
46657
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSchemaResponse>>;
|
|
46530
46658
|
/**
|
|
46531
|
-
* Upload source data
|
|
46659
|
+
* Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
|
|
46532
46660
|
* @summary Upload source data
|
|
46533
46661
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46534
46662
|
* @param {*} [options] Override http request option.
|
|
@@ -46536,18 +46664,18 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46536
46664
|
*/
|
|
46537
46665
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUploadSourceDataResponseWrapper>>;
|
|
46538
46666
|
/**
|
|
46539
|
-
* Create task
|
|
46540
|
-
* @summary Create task
|
|
46541
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
46667
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
46668
|
+
* @summary Create connector task
|
|
46669
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46542
46670
|
* @param {*} [options] Override http request option.
|
|
46543
46671
|
* @throws {RequiredError}
|
|
46544
46672
|
*/
|
|
46545
46673
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateTaskResponse>>;
|
|
46546
46674
|
/**
|
|
46547
|
-
*
|
|
46675
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46548
46676
|
* @summary Trigger task run
|
|
46549
46677
|
* @param {string} taskId Task ID
|
|
46550
|
-
* @param {number} body
|
|
46678
|
+
* @param {number} body User ID who triggered the run
|
|
46551
46679
|
* @param {*} [options] Override http request option.
|
|
46552
46680
|
* @throws {RequiredError}
|
|
46553
46681
|
*/
|
|
@@ -46561,120 +46689,128 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46561
46689
|
/**
|
|
46562
46690
|
* List all connectors with optional filtering
|
|
46563
46691
|
* @summary List Connectors
|
|
46692
|
+
* @param {string} xStoreID Store ID
|
|
46564
46693
|
* @param {string} authorization Bearer JWT token
|
|
46565
46694
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46566
46695
|
* @param {string} [provider] Filter by provider
|
|
46567
46696
|
* @param {boolean} [isActive] Filter by active status
|
|
46568
|
-
* @param {number} [storeId] Filter by store ID
|
|
46569
46697
|
* @param {number} [limit] Number of results (default: 50)
|
|
46570
46698
|
* @param {number} [offset] Offset for pagination
|
|
46571
46699
|
* @param {*} [options] Override http request option.
|
|
46572
46700
|
* @throws {RequiredError}
|
|
46573
46701
|
*/
|
|
46574
|
-
|
|
46702
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46575
46703
|
[key: string]: any;
|
|
46576
46704
|
}>;
|
|
46577
46705
|
/**
|
|
46578
46706
|
* Delete a connector and its sync history
|
|
46579
46707
|
* @summary Delete Connector
|
|
46708
|
+
* @param {string} xStoreID Store ID
|
|
46580
46709
|
* @param {string} authorization Bearer JWT token
|
|
46581
46710
|
* @param {number} id Connector ID
|
|
46582
46711
|
* @param {*} [options] Override http request option.
|
|
46583
46712
|
* @throws {RequiredError}
|
|
46584
46713
|
*/
|
|
46585
|
-
|
|
46714
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46586
46715
|
[key: string]: any;
|
|
46587
46716
|
}>;
|
|
46588
46717
|
/**
|
|
46589
46718
|
* Retrieve a specific connector by ID
|
|
46590
46719
|
* @summary Get Connector
|
|
46720
|
+
* @param {string} xStoreID Store ID
|
|
46591
46721
|
* @param {string} authorization Bearer JWT token
|
|
46592
46722
|
* @param {number} id Connector ID
|
|
46593
46723
|
* @param {*} [options] Override http request option.
|
|
46594
46724
|
* @throws {RequiredError}
|
|
46595
46725
|
*/
|
|
46596
|
-
|
|
46726
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46597
46727
|
[key: string]: any;
|
|
46598
46728
|
}>;
|
|
46599
46729
|
/**
|
|
46600
46730
|
* Get sync history for a connector
|
|
46601
46731
|
* @summary Get Sync History
|
|
46732
|
+
* @param {string} xStoreID Store ID
|
|
46602
46733
|
* @param {string} authorization Bearer JWT token
|
|
46603
46734
|
* @param {number} id Connector ID
|
|
46604
46735
|
* @param {number} [limit] Number of results (default: 20)
|
|
46605
46736
|
* @param {*} [options] Override http request option.
|
|
46606
46737
|
* @throws {RequiredError}
|
|
46607
46738
|
*/
|
|
46608
|
-
|
|
46739
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46609
46740
|
[key: string]: any;
|
|
46610
46741
|
}>;
|
|
46611
46742
|
/**
|
|
46612
46743
|
* Update an existing connector
|
|
46613
46744
|
* @summary Update Connector
|
|
46745
|
+
* @param {string} xStoreID Store ID
|
|
46614
46746
|
* @param {string} authorization Bearer JWT token
|
|
46615
46747
|
* @param {number} id Connector ID
|
|
46616
46748
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46617
46749
|
* @param {*} [options] Override http request option.
|
|
46618
46750
|
* @throws {RequiredError}
|
|
46619
46751
|
*/
|
|
46620
|
-
|
|
46752
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46621
46753
|
[key: string]: any;
|
|
46622
46754
|
}>;
|
|
46623
46755
|
/**
|
|
46624
46756
|
* Trigger a sync operation for a connector
|
|
46625
46757
|
* @summary Trigger Sync
|
|
46758
|
+
* @param {string} xStoreID Store ID
|
|
46626
46759
|
* @param {string} authorization Bearer JWT token
|
|
46627
46760
|
* @param {number} id Connector ID
|
|
46628
46761
|
* @param {*} [options] Override http request option.
|
|
46629
46762
|
* @throws {RequiredError}
|
|
46630
46763
|
*/
|
|
46631
|
-
|
|
46764
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46632
46765
|
[key: string]: any;
|
|
46633
46766
|
}>;
|
|
46634
46767
|
/**
|
|
46635
46768
|
* Test the connection to a connector\'s external service
|
|
46636
46769
|
* @summary Test Connection
|
|
46770
|
+
* @param {string} xStoreID Store ID
|
|
46637
46771
|
* @param {string} authorization Bearer JWT token
|
|
46638
46772
|
* @param {number} id Connector ID
|
|
46639
46773
|
* @param {*} [options] Override http request option.
|
|
46640
46774
|
* @throws {RequiredError}
|
|
46641
46775
|
*/
|
|
46642
|
-
|
|
46776
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46643
46777
|
[key: string]: any;
|
|
46644
46778
|
}>;
|
|
46645
|
-
/**
|
|
46646
|
-
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
46647
|
-
* @summary Get validation errors for a job
|
|
46648
|
-
* @param {string} jobid Job ID
|
|
46649
|
-
* @param {*} [options] Override http request option.
|
|
46650
|
-
* @throws {RequiredError}
|
|
46651
|
-
*/
|
|
46652
|
-
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
46653
46779
|
/**
|
|
46654
46780
|
* Create a new analytics connector for importing or exporting events
|
|
46655
46781
|
* @summary Create Connector
|
|
46782
|
+
* @param {string} xStoreID Store ID
|
|
46656
46783
|
* @param {string} authorization Bearer JWT token
|
|
46657
46784
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46658
46785
|
* @param {*} [options] Override http request option.
|
|
46659
46786
|
* @throws {RequiredError}
|
|
46660
46787
|
*/
|
|
46661
|
-
|
|
46788
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46662
46789
|
[key: string]: any;
|
|
46663
46790
|
}>;
|
|
46664
46791
|
/**
|
|
46665
46792
|
* Get list of available connector providers
|
|
46666
46793
|
* @summary Get Available Providers
|
|
46794
|
+
* @param {string} xStoreID Store ID
|
|
46667
46795
|
* @param {string} authorization Bearer JWT token
|
|
46668
46796
|
* @param {string} [type] Connector type (import, export)
|
|
46669
46797
|
* @param {*} [options] Override http request option.
|
|
46670
46798
|
* @throws {RequiredError}
|
|
46671
46799
|
*/
|
|
46672
|
-
|
|
46800
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46673
46801
|
[key: string]: any;
|
|
46674
46802
|
}>;
|
|
46675
46803
|
/**
|
|
46676
|
-
*
|
|
46677
|
-
* @summary
|
|
46804
|
+
* Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
|
|
46805
|
+
* @summary Get validation errors for a job
|
|
46806
|
+
* @param {string} jobid Job ID from upload response
|
|
46807
|
+
* @param {*} [options] Override http request option.
|
|
46808
|
+
* @throws {RequiredError}
|
|
46809
|
+
*/
|
|
46810
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
46811
|
+
/**
|
|
46812
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
46813
|
+
* @summary Test search for an index
|
|
46678
46814
|
* @param {string} index Index name
|
|
46679
46815
|
* @param {string} q Search query
|
|
46680
46816
|
* @param {*} [options] Override http request option.
|
|
@@ -46682,25 +46818,25 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46682
46818
|
*/
|
|
46683
46819
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResultResponse>;
|
|
46684
46820
|
/**
|
|
46685
|
-
*
|
|
46686
|
-
* @summary
|
|
46821
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46822
|
+
* @summary List data sources
|
|
46687
46823
|
* @param {*} [options] Override http request option.
|
|
46688
46824
|
* @throws {RequiredError}
|
|
46689
46825
|
*/
|
|
46690
46826
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSourcesListResponse>;
|
|
46691
46827
|
/**
|
|
46692
|
-
*
|
|
46693
|
-
* @summary Create source
|
|
46694
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
46828
|
+
* Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
|
|
46829
|
+
* @summary Create data source
|
|
46830
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46695
46831
|
* @param {*} [options] Override http request option.
|
|
46696
46832
|
* @throws {RequiredError}
|
|
46697
46833
|
*/
|
|
46698
46834
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateSourceResponse>;
|
|
46699
46835
|
/**
|
|
46700
|
-
* Update source config
|
|
46701
|
-
* @summary Update source config
|
|
46836
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
46837
|
+
* @summary Update source config
|
|
46702
46838
|
* @param {string} sourceId Source ID
|
|
46703
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
46839
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46704
46840
|
* @param {*} [options] Override http request option.
|
|
46705
46841
|
* @throws {RequiredError}
|
|
46706
46842
|
*/
|
|
@@ -46708,23 +46844,24 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46708
46844
|
[key: string]: any;
|
|
46709
46845
|
}, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
46710
46846
|
/**
|
|
46711
|
-
*
|
|
46712
|
-
* @summary Get source by
|
|
46847
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
46848
|
+
* @summary Get source by ID
|
|
46849
|
+
* @param {string} sourceId Source ID
|
|
46713
46850
|
* @param {*} [options] Override http request option.
|
|
46714
46851
|
* @throws {RequiredError}
|
|
46715
46852
|
*/
|
|
46716
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
|
|
46853
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
|
|
46717
46854
|
/**
|
|
46718
|
-
* Update
|
|
46719
|
-
* @summary Update
|
|
46720
|
-
* @param {string} sourceid Source ID
|
|
46721
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
46855
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
46856
|
+
* @summary Update source index schema
|
|
46857
|
+
* @param {string} sourceid Source ID
|
|
46858
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46722
46859
|
* @param {*} [options] Override http request option.
|
|
46723
46860
|
* @throws {RequiredError}
|
|
46724
46861
|
*/
|
|
46725
46862
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSchemaResponse>;
|
|
46726
46863
|
/**
|
|
46727
|
-
* Upload source data
|
|
46864
|
+
* Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
|
|
46728
46865
|
* @summary Upload source data
|
|
46729
46866
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46730
46867
|
* @param {*} [options] Override http request option.
|
|
@@ -46732,18 +46869,18 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46732
46869
|
*/
|
|
46733
46870
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUploadSourceDataResponseWrapper>;
|
|
46734
46871
|
/**
|
|
46735
|
-
* Create task
|
|
46736
|
-
* @summary Create task
|
|
46737
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
46872
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
46873
|
+
* @summary Create connector task
|
|
46874
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46738
46875
|
* @param {*} [options] Override http request option.
|
|
46739
46876
|
* @throws {RequiredError}
|
|
46740
46877
|
*/
|
|
46741
46878
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateTaskResponse>;
|
|
46742
46879
|
/**
|
|
46743
|
-
*
|
|
46880
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46744
46881
|
* @summary Trigger task run
|
|
46745
46882
|
* @param {string} taskId Task ID
|
|
46746
|
-
* @param {number} body
|
|
46883
|
+
* @param {number} body User ID who triggered the run
|
|
46747
46884
|
* @param {*} [options] Override http request option.
|
|
46748
46885
|
* @throws {RequiredError}
|
|
46749
46886
|
*/
|
|
@@ -46759,47 +46896,50 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46759
46896
|
/**
|
|
46760
46897
|
* List all connectors with optional filtering
|
|
46761
46898
|
* @summary List Connectors
|
|
46899
|
+
* @param {string} xStoreID Store ID
|
|
46762
46900
|
* @param {string} authorization Bearer JWT token
|
|
46763
46901
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46764
46902
|
* @param {string} [provider] Filter by provider
|
|
46765
46903
|
* @param {boolean} [isActive] Filter by active status
|
|
46766
|
-
* @param {number} [storeId] Filter by store ID
|
|
46767
46904
|
* @param {number} [limit] Number of results (default: 50)
|
|
46768
46905
|
* @param {number} [offset] Offset for pagination
|
|
46769
46906
|
* @param {*} [options] Override http request option.
|
|
46770
46907
|
* @throws {RequiredError}
|
|
46771
46908
|
* @memberof ConnectorsApi
|
|
46772
46909
|
*/
|
|
46773
|
-
|
|
46910
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46774
46911
|
[key: string]: any;
|
|
46775
46912
|
}, any, {}>>;
|
|
46776
46913
|
/**
|
|
46777
46914
|
* Delete a connector and its sync history
|
|
46778
46915
|
* @summary Delete Connector
|
|
46916
|
+
* @param {string} xStoreID Store ID
|
|
46779
46917
|
* @param {string} authorization Bearer JWT token
|
|
46780
46918
|
* @param {number} id Connector ID
|
|
46781
46919
|
* @param {*} [options] Override http request option.
|
|
46782
46920
|
* @throws {RequiredError}
|
|
46783
46921
|
* @memberof ConnectorsApi
|
|
46784
46922
|
*/
|
|
46785
|
-
|
|
46923
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46786
46924
|
[key: string]: any;
|
|
46787
46925
|
}, any, {}>>;
|
|
46788
46926
|
/**
|
|
46789
46927
|
* Retrieve a specific connector by ID
|
|
46790
46928
|
* @summary Get Connector
|
|
46929
|
+
* @param {string} xStoreID Store ID
|
|
46791
46930
|
* @param {string} authorization Bearer JWT token
|
|
46792
46931
|
* @param {number} id Connector ID
|
|
46793
46932
|
* @param {*} [options] Override http request option.
|
|
46794
46933
|
* @throws {RequiredError}
|
|
46795
46934
|
* @memberof ConnectorsApi
|
|
46796
46935
|
*/
|
|
46797
|
-
|
|
46936
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46798
46937
|
[key: string]: any;
|
|
46799
46938
|
}, any, {}>>;
|
|
46800
46939
|
/**
|
|
46801
46940
|
* Get sync history for a connector
|
|
46802
46941
|
* @summary Get Sync History
|
|
46942
|
+
* @param {string} xStoreID Store ID
|
|
46803
46943
|
* @param {string} authorization Bearer JWT token
|
|
46804
46944
|
* @param {number} id Connector ID
|
|
46805
46945
|
* @param {number} [limit] Number of results (default: 20)
|
|
@@ -46807,12 +46947,13 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46807
46947
|
* @throws {RequiredError}
|
|
46808
46948
|
* @memberof ConnectorsApi
|
|
46809
46949
|
*/
|
|
46810
|
-
|
|
46950
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46811
46951
|
[key: string]: any;
|
|
46812
46952
|
}, any, {}>>;
|
|
46813
46953
|
/**
|
|
46814
46954
|
* Update an existing connector
|
|
46815
46955
|
* @summary Update Connector
|
|
46956
|
+
* @param {string} xStoreID Store ID
|
|
46816
46957
|
* @param {string} authorization Bearer JWT token
|
|
46817
46958
|
* @param {number} id Connector ID
|
|
46818
46959
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
@@ -46820,69 +46961,73 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46820
46961
|
* @throws {RequiredError}
|
|
46821
46962
|
* @memberof ConnectorsApi
|
|
46822
46963
|
*/
|
|
46823
|
-
|
|
46964
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46824
46965
|
[key: string]: any;
|
|
46825
46966
|
}, any, {}>>;
|
|
46826
46967
|
/**
|
|
46827
46968
|
* Trigger a sync operation for a connector
|
|
46828
46969
|
* @summary Trigger Sync
|
|
46970
|
+
* @param {string} xStoreID Store ID
|
|
46829
46971
|
* @param {string} authorization Bearer JWT token
|
|
46830
46972
|
* @param {number} id Connector ID
|
|
46831
46973
|
* @param {*} [options] Override http request option.
|
|
46832
46974
|
* @throws {RequiredError}
|
|
46833
46975
|
* @memberof ConnectorsApi
|
|
46834
46976
|
*/
|
|
46835
|
-
|
|
46977
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46836
46978
|
[key: string]: any;
|
|
46837
46979
|
}, any, {}>>;
|
|
46838
46980
|
/**
|
|
46839
46981
|
* Test the connection to a connector\'s external service
|
|
46840
46982
|
* @summary Test Connection
|
|
46983
|
+
* @param {string} xStoreID Store ID
|
|
46841
46984
|
* @param {string} authorization Bearer JWT token
|
|
46842
46985
|
* @param {number} id Connector ID
|
|
46843
46986
|
* @param {*} [options] Override http request option.
|
|
46844
46987
|
* @throws {RequiredError}
|
|
46845
46988
|
* @memberof ConnectorsApi
|
|
46846
46989
|
*/
|
|
46847
|
-
|
|
46990
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46848
46991
|
[key: string]: any;
|
|
46849
46992
|
}, any, {}>>;
|
|
46850
|
-
/**
|
|
46851
|
-
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
46852
|
-
* @summary Get validation errors for a job
|
|
46853
|
-
* @param {string} jobid Job ID
|
|
46854
|
-
* @param {*} [options] Override http request option.
|
|
46855
|
-
* @throws {RequiredError}
|
|
46856
|
-
* @memberof ConnectorsApi
|
|
46857
|
-
*/
|
|
46858
|
-
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
46859
46993
|
/**
|
|
46860
46994
|
* Create a new analytics connector for importing or exporting events
|
|
46861
46995
|
* @summary Create Connector
|
|
46996
|
+
* @param {string} xStoreID Store ID
|
|
46862
46997
|
* @param {string} authorization Bearer JWT token
|
|
46863
46998
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46864
46999
|
* @param {*} [options] Override http request option.
|
|
46865
47000
|
* @throws {RequiredError}
|
|
46866
47001
|
* @memberof ConnectorsApi
|
|
46867
47002
|
*/
|
|
46868
|
-
|
|
47003
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46869
47004
|
[key: string]: any;
|
|
46870
47005
|
}, any, {}>>;
|
|
46871
47006
|
/**
|
|
46872
47007
|
* Get list of available connector providers
|
|
46873
47008
|
* @summary Get Available Providers
|
|
47009
|
+
* @param {string} xStoreID Store ID
|
|
46874
47010
|
* @param {string} authorization Bearer JWT token
|
|
46875
47011
|
* @param {string} [type] Connector type (import, export)
|
|
46876
47012
|
* @param {*} [options] Override http request option.
|
|
46877
47013
|
* @throws {RequiredError}
|
|
46878
47014
|
* @memberof ConnectorsApi
|
|
46879
47015
|
*/
|
|
46880
|
-
|
|
47016
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46881
47017
|
[key: string]: any;
|
|
46882
47018
|
}, any, {}>>;
|
|
46883
47019
|
/**
|
|
46884
|
-
*
|
|
46885
|
-
* @summary
|
|
47020
|
+
* Returns validation errors for an upload job (e.g. invalid rows). Use the job ID returned from the upload endpoint. **Auth:** store credentials or JWT.
|
|
47021
|
+
* @summary Get validation errors for a job
|
|
47022
|
+
* @param {string} jobid Job ID from upload response
|
|
47023
|
+
* @param {*} [options] Override http request option.
|
|
47024
|
+
* @throws {RequiredError}
|
|
47025
|
+
* @memberof ConnectorsApi
|
|
47026
|
+
*/
|
|
47027
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
47028
|
+
/**
|
|
47029
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
47030
|
+
* @summary Test search for an index
|
|
46886
47031
|
* @param {string} index Index name
|
|
46887
47032
|
* @param {string} q Search query
|
|
46888
47033
|
* @param {*} [options] Override http request option.
|
|
@@ -46891,27 +47036,27 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46891
47036
|
*/
|
|
46892
47037
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResultResponse, any, {}>>;
|
|
46893
47038
|
/**
|
|
46894
|
-
*
|
|
46895
|
-
* @summary
|
|
47039
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47040
|
+
* @summary List data sources
|
|
46896
47041
|
* @param {*} [options] Override http request option.
|
|
46897
47042
|
* @throws {RequiredError}
|
|
46898
47043
|
* @memberof ConnectorsApi
|
|
46899
47044
|
*/
|
|
46900
47045
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSourcesListResponse, any, {}>>;
|
|
46901
47046
|
/**
|
|
46902
|
-
*
|
|
46903
|
-
* @summary Create source
|
|
46904
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
47047
|
+
* Register a new data source for the store. **Auth:** `x-storeid` and `x-storesecret`. Used by connector integrations to sync data into the search index.
|
|
47048
|
+
* @summary Create data source
|
|
47049
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46905
47050
|
* @param {*} [options] Override http request option.
|
|
46906
47051
|
* @throws {RequiredError}
|
|
46907
47052
|
* @memberof ConnectorsApi
|
|
46908
47053
|
*/
|
|
46909
47054
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateSourceResponse, any, {}>>;
|
|
46910
47055
|
/**
|
|
46911
|
-
* Update source config
|
|
46912
|
-
* @summary Update source config
|
|
47056
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
47057
|
+
* @summary Update source config
|
|
46913
47058
|
* @param {string} sourceId Source ID
|
|
46914
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
47059
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46915
47060
|
* @param {*} [options] Override http request option.
|
|
46916
47061
|
* @throws {RequiredError}
|
|
46917
47062
|
* @memberof ConnectorsApi
|
|
@@ -46920,25 +47065,26 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46920
47065
|
[key: string]: any;
|
|
46921
47066
|
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
46922
47067
|
/**
|
|
46923
|
-
*
|
|
46924
|
-
* @summary Get source by
|
|
47068
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47069
|
+
* @summary Get source by ID
|
|
47070
|
+
* @param {string} sourceId Source ID
|
|
46925
47071
|
* @param {*} [options] Override http request option.
|
|
46926
47072
|
* @throws {RequiredError}
|
|
46927
47073
|
* @memberof ConnectorsApi
|
|
46928
47074
|
*/
|
|
46929
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
|
|
47075
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
|
|
46930
47076
|
/**
|
|
46931
|
-
* Update
|
|
46932
|
-
* @summary Update
|
|
46933
|
-
* @param {string} sourceid Source ID
|
|
46934
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
47077
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
47078
|
+
* @summary Update source index schema
|
|
47079
|
+
* @param {string} sourceid Source ID
|
|
47080
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46935
47081
|
* @param {*} [options] Override http request option.
|
|
46936
47082
|
* @throws {RequiredError}
|
|
46937
47083
|
* @memberof ConnectorsApi
|
|
46938
47084
|
*/
|
|
46939
47085
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSchemaResponse, any, {}>>;
|
|
46940
47086
|
/**
|
|
46941
|
-
* Upload source data
|
|
47087
|
+
* Upload a file (JSON or CSV) to a data source for indexing. **Auth:** `x-storeid` and `x-storesecret`. Use form-data: Name, Type, Config (e.g. json_upload, csv_upload), and File.
|
|
46942
47088
|
* @summary Upload source data
|
|
46943
47089
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46944
47090
|
* @param {*} [options] Override http request option.
|
|
@@ -46947,19 +47093,19 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46947
47093
|
*/
|
|
46948
47094
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUploadSourceDataResponseWrapper, any, {}>>;
|
|
46949
47095
|
/**
|
|
46950
|
-
* Create task
|
|
46951
|
-
* @summary Create task
|
|
46952
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
47096
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
47097
|
+
* @summary Create connector task
|
|
47098
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46953
47099
|
* @param {*} [options] Override http request option.
|
|
46954
47100
|
* @throws {RequiredError}
|
|
46955
47101
|
* @memberof ConnectorsApi
|
|
46956
47102
|
*/
|
|
46957
47103
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateTaskResponse, any, {}>>;
|
|
46958
47104
|
/**
|
|
46959
|
-
*
|
|
47105
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46960
47106
|
* @summary Trigger task run
|
|
46961
47107
|
* @param {string} taskId Task ID
|
|
46962
|
-
* @param {number} body
|
|
47108
|
+
* @param {number} body User ID who triggered the run
|
|
46963
47109
|
* @param {*} [options] Override http request option.
|
|
46964
47110
|
* @throws {RequiredError}
|
|
46965
47111
|
* @memberof ConnectorsApi
|
|
@@ -47024,7 +47170,7 @@ export declare const CreditsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
47024
47170
|
*/
|
|
47025
47171
|
creditsConsumptionHistoryGet: (page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47026
47172
|
/**
|
|
47027
|
-
*
|
|
47173
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47028
47174
|
* @summary Get available credit plans
|
|
47029
47175
|
* @param {*} [options] Override http request option.
|
|
47030
47176
|
* @throws {RequiredError}
|
|
@@ -47109,7 +47255,7 @@ export declare const CreditsApiFp: (configuration?: Configuration) => {
|
|
|
47109
47255
|
*/
|
|
47110
47256
|
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
47111
47257
|
/**
|
|
47112
|
-
*
|
|
47258
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47113
47259
|
* @summary Get available credit plans
|
|
47114
47260
|
* @param {*} [options] Override http request option.
|
|
47115
47261
|
* @throws {RequiredError}
|
|
@@ -47194,7 +47340,7 @@ export declare const CreditsApiFactory: (configuration?: Configuration, basePath
|
|
|
47194
47340
|
*/
|
|
47195
47341
|
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
47196
47342
|
/**
|
|
47197
|
-
*
|
|
47343
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47198
47344
|
* @summary Get available credit plans
|
|
47199
47345
|
* @param {*} [options] Override http request option.
|
|
47200
47346
|
* @throws {RequiredError}
|
|
@@ -47287,7 +47433,7 @@ export declare class CreditsApi extends BaseAPI {
|
|
|
47287
47433
|
*/
|
|
47288
47434
|
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
47289
47435
|
/**
|
|
47290
|
-
*
|
|
47436
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47291
47437
|
* @summary Get available credit plans
|
|
47292
47438
|
* @param {*} [options] Override http request option.
|
|
47293
47439
|
* @throws {RequiredError}
|
|
@@ -47335,10 +47481,10 @@ export type CreditsTransactionsGetTypeEnum = typeof CreditsTransactionsGetTypeEn
|
|
|
47335
47481
|
*/
|
|
47336
47482
|
export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
47337
47483
|
/**
|
|
47338
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
47484
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47339
47485
|
* @summary List Custom Event Types
|
|
47486
|
+
* @param {string} xStoreID Store ID
|
|
47340
47487
|
* @param {string} authorization Bearer JWT token
|
|
47341
|
-
* @param {number} [storeId] Filter by store ID
|
|
47342
47488
|
* @param {boolean} [isActive] Filter by active status
|
|
47343
47489
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47344
47490
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47351,29 +47497,32 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47351
47497
|
* @param {*} [options] Override http request option.
|
|
47352
47498
|
* @throws {RequiredError}
|
|
47353
47499
|
*/
|
|
47354
|
-
|
|
47500
|
+
adminAnalyticsStoreXStoreIDCustomEventsGet: (xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47355
47501
|
/**
|
|
47356
47502
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47357
47503
|
* @summary Delete Custom Event Type
|
|
47504
|
+
* @param {string} xStoreID Store ID
|
|
47358
47505
|
* @param {string} authorization Bearer JWT token
|
|
47359
47506
|
* @param {number} id Event Type ID
|
|
47360
47507
|
* @param {*} [options] Override http request option.
|
|
47361
47508
|
* @throws {RequiredError}
|
|
47362
47509
|
*/
|
|
47363
|
-
|
|
47510
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47364
47511
|
/**
|
|
47365
47512
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47366
47513
|
* @summary Remove Field
|
|
47514
|
+
* @param {string} xStoreID Store ID
|
|
47367
47515
|
* @param {string} authorization Bearer JWT token
|
|
47368
47516
|
* @param {number} id Event Type ID
|
|
47369
47517
|
* @param {number} fid Field ID
|
|
47370
47518
|
* @param {*} [options] Override http request option.
|
|
47371
47519
|
* @throws {RequiredError}
|
|
47372
47520
|
*/
|
|
47373
|
-
|
|
47521
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete: (xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47374
47522
|
/**
|
|
47375
47523
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47376
47524
|
* @summary Update Field
|
|
47525
|
+
* @param {string} xStoreID Store ID
|
|
47377
47526
|
* @param {string} authorization Bearer JWT token
|
|
47378
47527
|
* @param {number} id Event Type ID
|
|
47379
47528
|
* @param {number} fid Field ID
|
|
@@ -47381,64 +47530,70 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47381
47530
|
* @param {*} [options] Override http request option.
|
|
47382
47531
|
* @throws {RequiredError}
|
|
47383
47532
|
*/
|
|
47384
|
-
|
|
47533
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut: (xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47385
47534
|
/**
|
|
47386
47535
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47387
47536
|
* @summary Add Field to Custom Event Type
|
|
47537
|
+
* @param {string} xStoreID Store ID
|
|
47388
47538
|
* @param {string} authorization Bearer JWT token
|
|
47389
47539
|
* @param {number} id Event Type ID
|
|
47390
47540
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47391
47541
|
* @param {*} [options] Override http request option.
|
|
47392
47542
|
* @throws {RequiredError}
|
|
47393
47543
|
*/
|
|
47394
|
-
|
|
47544
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost: (xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47395
47545
|
/**
|
|
47396
47546
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47397
47547
|
* @summary Get Custom Event Type
|
|
47548
|
+
* @param {string} xStoreID Store ID
|
|
47398
47549
|
* @param {string} authorization Bearer JWT token
|
|
47399
47550
|
* @param {number} id Event Type ID
|
|
47400
47551
|
* @param {*} [options] Override http request option.
|
|
47401
47552
|
* @throws {RequiredError}
|
|
47402
47553
|
*/
|
|
47403
|
-
|
|
47554
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47404
47555
|
/**
|
|
47405
47556
|
* Update an existing custom event type. Supports partial updates.
|
|
47406
47557
|
* @summary Update Custom Event Type
|
|
47558
|
+
* @param {string} xStoreID Store ID
|
|
47407
47559
|
* @param {string} authorization Bearer JWT token
|
|
47408
47560
|
* @param {number} id Event Type ID
|
|
47409
47561
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47410
47562
|
* @param {*} [options] Override http request option.
|
|
47411
47563
|
* @throws {RequiredError}
|
|
47412
47564
|
*/
|
|
47413
|
-
|
|
47565
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut: (xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47414
47566
|
/**
|
|
47415
47567
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47416
47568
|
* @summary Get Available Slots
|
|
47569
|
+
* @param {string} xStoreID Store ID
|
|
47417
47570
|
* @param {string} authorization Bearer JWT token
|
|
47418
47571
|
* @param {number} id Event Type ID
|
|
47419
47572
|
* @param {*} [options] Override http request option.
|
|
47420
47573
|
* @throws {RequiredError}
|
|
47421
47574
|
*/
|
|
47422
|
-
|
|
47575
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47423
47576
|
/**
|
|
47424
47577
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47425
47578
|
* @summary Validate Event Payload
|
|
47579
|
+
* @param {string} xStoreID Store ID
|
|
47426
47580
|
* @param {string} authorization Bearer JWT token
|
|
47427
47581
|
* @param {number} id Event Type ID
|
|
47428
47582
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47429
47583
|
* @param {*} [options] Override http request option.
|
|
47430
47584
|
* @throws {RequiredError}
|
|
47431
47585
|
*/
|
|
47432
|
-
|
|
47586
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost: (xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47433
47587
|
/**
|
|
47434
47588
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47435
47589
|
* @summary Create Custom Event Type
|
|
47590
|
+
* @param {string} xStoreID Store ID
|
|
47436
47591
|
* @param {string} authorization Bearer JWT token
|
|
47437
47592
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47438
47593
|
* @param {*} [options] Override http request option.
|
|
47439
47594
|
* @throws {RequiredError}
|
|
47440
47595
|
*/
|
|
47441
|
-
|
|
47596
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost: (xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47442
47597
|
};
|
|
47443
47598
|
/**
|
|
47444
47599
|
* CustomEventsApi - functional programming interface
|
|
@@ -47446,10 +47601,10 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47446
47601
|
*/
|
|
47447
47602
|
export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
47448
47603
|
/**
|
|
47449
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
47604
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47450
47605
|
* @summary List Custom Event Types
|
|
47606
|
+
* @param {string} xStoreID Store ID
|
|
47451
47607
|
* @param {string} authorization Bearer JWT token
|
|
47452
|
-
* @param {number} [storeId] Filter by store ID
|
|
47453
47608
|
* @param {boolean} [isActive] Filter by active status
|
|
47454
47609
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47455
47610
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47462,35 +47617,38 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47462
47617
|
* @param {*} [options] Override http request option.
|
|
47463
47618
|
* @throws {RequiredError}
|
|
47464
47619
|
*/
|
|
47465
|
-
|
|
47620
|
+
adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47466
47621
|
[key: string]: any;
|
|
47467
47622
|
}>>;
|
|
47468
47623
|
/**
|
|
47469
47624
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47470
47625
|
* @summary Delete Custom Event Type
|
|
47626
|
+
* @param {string} xStoreID Store ID
|
|
47471
47627
|
* @param {string} authorization Bearer JWT token
|
|
47472
47628
|
* @param {number} id Event Type ID
|
|
47473
47629
|
* @param {*} [options] Override http request option.
|
|
47474
47630
|
* @throws {RequiredError}
|
|
47475
47631
|
*/
|
|
47476
|
-
|
|
47632
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47477
47633
|
[key: string]: any;
|
|
47478
47634
|
}>>;
|
|
47479
47635
|
/**
|
|
47480
47636
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47481
47637
|
* @summary Remove Field
|
|
47638
|
+
* @param {string} xStoreID Store ID
|
|
47482
47639
|
* @param {string} authorization Bearer JWT token
|
|
47483
47640
|
* @param {number} id Event Type ID
|
|
47484
47641
|
* @param {number} fid Field ID
|
|
47485
47642
|
* @param {*} [options] Override http request option.
|
|
47486
47643
|
* @throws {RequiredError}
|
|
47487
47644
|
*/
|
|
47488
|
-
|
|
47645
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47489
47646
|
[key: string]: any;
|
|
47490
47647
|
}>>;
|
|
47491
47648
|
/**
|
|
47492
47649
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47493
47650
|
* @summary Update Field
|
|
47651
|
+
* @param {string} xStoreID Store ID
|
|
47494
47652
|
* @param {string} authorization Bearer JWT token
|
|
47495
47653
|
* @param {number} id Event Type ID
|
|
47496
47654
|
* @param {number} fid Field ID
|
|
@@ -47498,76 +47656,82 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47498
47656
|
* @param {*} [options] Override http request option.
|
|
47499
47657
|
* @throws {RequiredError}
|
|
47500
47658
|
*/
|
|
47501
|
-
|
|
47659
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47502
47660
|
[key: string]: any;
|
|
47503
47661
|
}>>;
|
|
47504
47662
|
/**
|
|
47505
47663
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47506
47664
|
* @summary Add Field to Custom Event Type
|
|
47665
|
+
* @param {string} xStoreID Store ID
|
|
47507
47666
|
* @param {string} authorization Bearer JWT token
|
|
47508
47667
|
* @param {number} id Event Type ID
|
|
47509
47668
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47510
47669
|
* @param {*} [options] Override http request option.
|
|
47511
47670
|
* @throws {RequiredError}
|
|
47512
47671
|
*/
|
|
47513
|
-
|
|
47672
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47514
47673
|
[key: string]: any;
|
|
47515
47674
|
}>>;
|
|
47516
47675
|
/**
|
|
47517
47676
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47518
47677
|
* @summary Get Custom Event Type
|
|
47678
|
+
* @param {string} xStoreID Store ID
|
|
47519
47679
|
* @param {string} authorization Bearer JWT token
|
|
47520
47680
|
* @param {number} id Event Type ID
|
|
47521
47681
|
* @param {*} [options] Override http request option.
|
|
47522
47682
|
* @throws {RequiredError}
|
|
47523
47683
|
*/
|
|
47524
|
-
|
|
47684
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47525
47685
|
[key: string]: any;
|
|
47526
47686
|
}>>;
|
|
47527
47687
|
/**
|
|
47528
47688
|
* Update an existing custom event type. Supports partial updates.
|
|
47529
47689
|
* @summary Update Custom Event Type
|
|
47690
|
+
* @param {string} xStoreID Store ID
|
|
47530
47691
|
* @param {string} authorization Bearer JWT token
|
|
47531
47692
|
* @param {number} id Event Type ID
|
|
47532
47693
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47533
47694
|
* @param {*} [options] Override http request option.
|
|
47534
47695
|
* @throws {RequiredError}
|
|
47535
47696
|
*/
|
|
47536
|
-
|
|
47697
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47537
47698
|
[key: string]: any;
|
|
47538
47699
|
}>>;
|
|
47539
47700
|
/**
|
|
47540
47701
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47541
47702
|
* @summary Get Available Slots
|
|
47703
|
+
* @param {string} xStoreID Store ID
|
|
47542
47704
|
* @param {string} authorization Bearer JWT token
|
|
47543
47705
|
* @param {number} id Event Type ID
|
|
47544
47706
|
* @param {*} [options] Override http request option.
|
|
47545
47707
|
* @throws {RequiredError}
|
|
47546
47708
|
*/
|
|
47547
|
-
|
|
47709
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47548
47710
|
[key: string]: any;
|
|
47549
47711
|
}>>;
|
|
47550
47712
|
/**
|
|
47551
47713
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47552
47714
|
* @summary Validate Event Payload
|
|
47715
|
+
* @param {string} xStoreID Store ID
|
|
47553
47716
|
* @param {string} authorization Bearer JWT token
|
|
47554
47717
|
* @param {number} id Event Type ID
|
|
47555
47718
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47556
47719
|
* @param {*} [options] Override http request option.
|
|
47557
47720
|
* @throws {RequiredError}
|
|
47558
47721
|
*/
|
|
47559
|
-
|
|
47722
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47560
47723
|
[key: string]: any;
|
|
47561
47724
|
}>>;
|
|
47562
47725
|
/**
|
|
47563
47726
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47564
47727
|
* @summary Create Custom Event Type
|
|
47728
|
+
* @param {string} xStoreID Store ID
|
|
47565
47729
|
* @param {string} authorization Bearer JWT token
|
|
47566
47730
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47567
47731
|
* @param {*} [options] Override http request option.
|
|
47568
47732
|
* @throws {RequiredError}
|
|
47569
47733
|
*/
|
|
47570
|
-
|
|
47734
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47571
47735
|
[key: string]: any;
|
|
47572
47736
|
}>>;
|
|
47573
47737
|
};
|
|
@@ -47577,10 +47741,10 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47577
47741
|
*/
|
|
47578
47742
|
export declare const CustomEventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47579
47743
|
/**
|
|
47580
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
47744
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47581
47745
|
* @summary List Custom Event Types
|
|
47746
|
+
* @param {string} xStoreID Store ID
|
|
47582
47747
|
* @param {string} authorization Bearer JWT token
|
|
47583
|
-
* @param {number} [storeId] Filter by store ID
|
|
47584
47748
|
* @param {boolean} [isActive] Filter by active status
|
|
47585
47749
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47586
47750
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47593,35 +47757,38 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47593
47757
|
* @param {*} [options] Override http request option.
|
|
47594
47758
|
* @throws {RequiredError}
|
|
47595
47759
|
*/
|
|
47596
|
-
|
|
47760
|
+
adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47597
47761
|
[key: string]: any;
|
|
47598
47762
|
}>;
|
|
47599
47763
|
/**
|
|
47600
47764
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47601
47765
|
* @summary Delete Custom Event Type
|
|
47766
|
+
* @param {string} xStoreID Store ID
|
|
47602
47767
|
* @param {string} authorization Bearer JWT token
|
|
47603
47768
|
* @param {number} id Event Type ID
|
|
47604
47769
|
* @param {*} [options] Override http request option.
|
|
47605
47770
|
* @throws {RequiredError}
|
|
47606
47771
|
*/
|
|
47607
|
-
|
|
47772
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47608
47773
|
[key: string]: any;
|
|
47609
47774
|
}>;
|
|
47610
47775
|
/**
|
|
47611
47776
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47612
47777
|
* @summary Remove Field
|
|
47778
|
+
* @param {string} xStoreID Store ID
|
|
47613
47779
|
* @param {string} authorization Bearer JWT token
|
|
47614
47780
|
* @param {number} id Event Type ID
|
|
47615
47781
|
* @param {number} fid Field ID
|
|
47616
47782
|
* @param {*} [options] Override http request option.
|
|
47617
47783
|
* @throws {RequiredError}
|
|
47618
47784
|
*/
|
|
47619
|
-
|
|
47785
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47620
47786
|
[key: string]: any;
|
|
47621
47787
|
}>;
|
|
47622
47788
|
/**
|
|
47623
47789
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47624
47790
|
* @summary Update Field
|
|
47791
|
+
* @param {string} xStoreID Store ID
|
|
47625
47792
|
* @param {string} authorization Bearer JWT token
|
|
47626
47793
|
* @param {number} id Event Type ID
|
|
47627
47794
|
* @param {number} fid Field ID
|
|
@@ -47629,76 +47796,82 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47629
47796
|
* @param {*} [options] Override http request option.
|
|
47630
47797
|
* @throws {RequiredError}
|
|
47631
47798
|
*/
|
|
47632
|
-
|
|
47799
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47633
47800
|
[key: string]: any;
|
|
47634
47801
|
}>;
|
|
47635
47802
|
/**
|
|
47636
47803
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47637
47804
|
* @summary Add Field to Custom Event Type
|
|
47805
|
+
* @param {string} xStoreID Store ID
|
|
47638
47806
|
* @param {string} authorization Bearer JWT token
|
|
47639
47807
|
* @param {number} id Event Type ID
|
|
47640
47808
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47641
47809
|
* @param {*} [options] Override http request option.
|
|
47642
47810
|
* @throws {RequiredError}
|
|
47643
47811
|
*/
|
|
47644
|
-
|
|
47812
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47645
47813
|
[key: string]: any;
|
|
47646
47814
|
}>;
|
|
47647
47815
|
/**
|
|
47648
47816
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47649
47817
|
* @summary Get Custom Event Type
|
|
47818
|
+
* @param {string} xStoreID Store ID
|
|
47650
47819
|
* @param {string} authorization Bearer JWT token
|
|
47651
47820
|
* @param {number} id Event Type ID
|
|
47652
47821
|
* @param {*} [options] Override http request option.
|
|
47653
47822
|
* @throws {RequiredError}
|
|
47654
47823
|
*/
|
|
47655
|
-
|
|
47824
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47656
47825
|
[key: string]: any;
|
|
47657
47826
|
}>;
|
|
47658
47827
|
/**
|
|
47659
47828
|
* Update an existing custom event type. Supports partial updates.
|
|
47660
47829
|
* @summary Update Custom Event Type
|
|
47830
|
+
* @param {string} xStoreID Store ID
|
|
47661
47831
|
* @param {string} authorization Bearer JWT token
|
|
47662
47832
|
* @param {number} id Event Type ID
|
|
47663
47833
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47664
47834
|
* @param {*} [options] Override http request option.
|
|
47665
47835
|
* @throws {RequiredError}
|
|
47666
47836
|
*/
|
|
47667
|
-
|
|
47837
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47668
47838
|
[key: string]: any;
|
|
47669
47839
|
}>;
|
|
47670
47840
|
/**
|
|
47671
47841
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47672
47842
|
* @summary Get Available Slots
|
|
47843
|
+
* @param {string} xStoreID Store ID
|
|
47673
47844
|
* @param {string} authorization Bearer JWT token
|
|
47674
47845
|
* @param {number} id Event Type ID
|
|
47675
47846
|
* @param {*} [options] Override http request option.
|
|
47676
47847
|
* @throws {RequiredError}
|
|
47677
47848
|
*/
|
|
47678
|
-
|
|
47849
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47679
47850
|
[key: string]: any;
|
|
47680
47851
|
}>;
|
|
47681
47852
|
/**
|
|
47682
47853
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47683
47854
|
* @summary Validate Event Payload
|
|
47855
|
+
* @param {string} xStoreID Store ID
|
|
47684
47856
|
* @param {string} authorization Bearer JWT token
|
|
47685
47857
|
* @param {number} id Event Type ID
|
|
47686
47858
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47687
47859
|
* @param {*} [options] Override http request option.
|
|
47688
47860
|
* @throws {RequiredError}
|
|
47689
47861
|
*/
|
|
47690
|
-
|
|
47862
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47691
47863
|
[key: string]: any;
|
|
47692
47864
|
}>;
|
|
47693
47865
|
/**
|
|
47694
47866
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47695
47867
|
* @summary Create Custom Event Type
|
|
47868
|
+
* @param {string} xStoreID Store ID
|
|
47696
47869
|
* @param {string} authorization Bearer JWT token
|
|
47697
47870
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47698
47871
|
* @param {*} [options] Override http request option.
|
|
47699
47872
|
* @throws {RequiredError}
|
|
47700
47873
|
*/
|
|
47701
|
-
|
|
47874
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47702
47875
|
[key: string]: any;
|
|
47703
47876
|
}>;
|
|
47704
47877
|
};
|
|
@@ -47710,10 +47883,10 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47710
47883
|
*/
|
|
47711
47884
|
export declare class CustomEventsApi extends BaseAPI {
|
|
47712
47885
|
/**
|
|
47713
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
47886
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47714
47887
|
* @summary List Custom Event Types
|
|
47888
|
+
* @param {string} xStoreID Store ID
|
|
47715
47889
|
* @param {string} authorization Bearer JWT token
|
|
47716
|
-
* @param {number} [storeId] Filter by store ID
|
|
47717
47890
|
* @param {boolean} [isActive] Filter by active status
|
|
47718
47891
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47719
47892
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47727,24 +47900,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47727
47900
|
* @throws {RequiredError}
|
|
47728
47901
|
* @memberof CustomEventsApi
|
|
47729
47902
|
*/
|
|
47730
|
-
|
|
47903
|
+
adminAnalyticsStoreXStoreIDCustomEventsGet(xStoreID: string, authorization: string, isActive?: boolean, category?: string, search?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47731
47904
|
[key: string]: any;
|
|
47732
47905
|
}, any, {}>>;
|
|
47733
47906
|
/**
|
|
47734
47907
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47735
47908
|
* @summary Delete Custom Event Type
|
|
47909
|
+
* @param {string} xStoreID Store ID
|
|
47736
47910
|
* @param {string} authorization Bearer JWT token
|
|
47737
47911
|
* @param {number} id Event Type ID
|
|
47738
47912
|
* @param {*} [options] Override http request option.
|
|
47739
47913
|
* @throws {RequiredError}
|
|
47740
47914
|
* @memberof CustomEventsApi
|
|
47741
47915
|
*/
|
|
47742
|
-
|
|
47916
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47743
47917
|
[key: string]: any;
|
|
47744
47918
|
}, any, {}>>;
|
|
47745
47919
|
/**
|
|
47746
47920
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47747
47921
|
* @summary Remove Field
|
|
47922
|
+
* @param {string} xStoreID Store ID
|
|
47748
47923
|
* @param {string} authorization Bearer JWT token
|
|
47749
47924
|
* @param {number} id Event Type ID
|
|
47750
47925
|
* @param {number} fid Field ID
|
|
@@ -47752,12 +47927,13 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47752
47927
|
* @throws {RequiredError}
|
|
47753
47928
|
* @memberof CustomEventsApi
|
|
47754
47929
|
*/
|
|
47755
|
-
|
|
47930
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47756
47931
|
[key: string]: any;
|
|
47757
47932
|
}, any, {}>>;
|
|
47758
47933
|
/**
|
|
47759
47934
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47760
47935
|
* @summary Update Field
|
|
47936
|
+
* @param {string} xStoreID Store ID
|
|
47761
47937
|
* @param {string} authorization Bearer JWT token
|
|
47762
47938
|
* @param {number} id Event Type ID
|
|
47763
47939
|
* @param {number} fid Field ID
|
|
@@ -47766,12 +47942,13 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47766
47942
|
* @throws {RequiredError}
|
|
47767
47943
|
* @memberof CustomEventsApi
|
|
47768
47944
|
*/
|
|
47769
|
-
|
|
47945
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47770
47946
|
[key: string]: any;
|
|
47771
47947
|
}, any, {}>>;
|
|
47772
47948
|
/**
|
|
47773
47949
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47774
47950
|
* @summary Add Field to Custom Event Type
|
|
47951
|
+
* @param {string} xStoreID Store ID
|
|
47775
47952
|
* @param {string} authorization Bearer JWT token
|
|
47776
47953
|
* @param {number} id Event Type ID
|
|
47777
47954
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
@@ -47779,24 +47956,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47779
47956
|
* @throws {RequiredError}
|
|
47780
47957
|
* @memberof CustomEventsApi
|
|
47781
47958
|
*/
|
|
47782
|
-
|
|
47959
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47783
47960
|
[key: string]: any;
|
|
47784
47961
|
}, any, {}>>;
|
|
47785
47962
|
/**
|
|
47786
47963
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47787
47964
|
* @summary Get Custom Event Type
|
|
47965
|
+
* @param {string} xStoreID Store ID
|
|
47788
47966
|
* @param {string} authorization Bearer JWT token
|
|
47789
47967
|
* @param {number} id Event Type ID
|
|
47790
47968
|
* @param {*} [options] Override http request option.
|
|
47791
47969
|
* @throws {RequiredError}
|
|
47792
47970
|
* @memberof CustomEventsApi
|
|
47793
47971
|
*/
|
|
47794
|
-
|
|
47972
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47795
47973
|
[key: string]: any;
|
|
47796
47974
|
}, any, {}>>;
|
|
47797
47975
|
/**
|
|
47798
47976
|
* Update an existing custom event type. Supports partial updates.
|
|
47799
47977
|
* @summary Update Custom Event Type
|
|
47978
|
+
* @param {string} xStoreID Store ID
|
|
47800
47979
|
* @param {string} authorization Bearer JWT token
|
|
47801
47980
|
* @param {number} id Event Type ID
|
|
47802
47981
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
@@ -47804,24 +47983,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47804
47983
|
* @throws {RequiredError}
|
|
47805
47984
|
* @memberof CustomEventsApi
|
|
47806
47985
|
*/
|
|
47807
|
-
|
|
47986
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47808
47987
|
[key: string]: any;
|
|
47809
47988
|
}, any, {}>>;
|
|
47810
47989
|
/**
|
|
47811
47990
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47812
47991
|
* @summary Get Available Slots
|
|
47992
|
+
* @param {string} xStoreID Store ID
|
|
47813
47993
|
* @param {string} authorization Bearer JWT token
|
|
47814
47994
|
* @param {number} id Event Type ID
|
|
47815
47995
|
* @param {*} [options] Override http request option.
|
|
47816
47996
|
* @throws {RequiredError}
|
|
47817
47997
|
* @memberof CustomEventsApi
|
|
47818
47998
|
*/
|
|
47819
|
-
|
|
47999
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47820
48000
|
[key: string]: any;
|
|
47821
48001
|
}, any, {}>>;
|
|
47822
48002
|
/**
|
|
47823
48003
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47824
48004
|
* @summary Validate Event Payload
|
|
48005
|
+
* @param {string} xStoreID Store ID
|
|
47825
48006
|
* @param {string} authorization Bearer JWT token
|
|
47826
48007
|
* @param {number} id Event Type ID
|
|
47827
48008
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
@@ -47829,19 +48010,20 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47829
48010
|
* @throws {RequiredError}
|
|
47830
48011
|
* @memberof CustomEventsApi
|
|
47831
48012
|
*/
|
|
47832
|
-
|
|
48013
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47833
48014
|
[key: string]: any;
|
|
47834
48015
|
}, any, {}>>;
|
|
47835
48016
|
/**
|
|
47836
48017
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47837
48018
|
* @summary Create Custom Event Type
|
|
48019
|
+
* @param {string} xStoreID Store ID
|
|
47838
48020
|
* @param {string} authorization Bearer JWT token
|
|
47839
48021
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47840
48022
|
* @param {*} [options] Override http request option.
|
|
47841
48023
|
* @throws {RequiredError}
|
|
47842
48024
|
* @memberof CustomEventsApi
|
|
47843
48025
|
*/
|
|
47844
|
-
|
|
48026
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47845
48027
|
[key: string]: any;
|
|
47846
48028
|
}, any, {}>>;
|
|
47847
48029
|
}
|
|
@@ -48849,27 +49031,27 @@ export declare const DocumentationApiAxiosParamCreator: (configuration?: Configu
|
|
|
48849
49031
|
*/
|
|
48850
49032
|
v1DocsRecreateCollectionPost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48851
49033
|
/**
|
|
48852
|
-
*
|
|
49034
|
+
* Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
|
|
48853
49035
|
* @summary Scrape and index documentation
|
|
48854
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49036
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
48855
49037
|
* @param {*} [options] Override http request option.
|
|
48856
49038
|
* @throws {RequiredError}
|
|
48857
49039
|
*/
|
|
48858
49040
|
v1DocsScrapePost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48859
49041
|
/**
|
|
48860
|
-
*
|
|
49042
|
+
* Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
|
|
48861
49043
|
* @summary Search documentation
|
|
48862
49044
|
* @param {string} query Search query
|
|
48863
|
-
* @param {number} [limit]
|
|
49045
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
48864
49046
|
* @param {*} [options] Override http request option.
|
|
48865
49047
|
* @throws {RequiredError}
|
|
48866
49048
|
*/
|
|
48867
49049
|
v1DocsSearchPost: (query: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48868
49050
|
/**
|
|
48869
|
-
*
|
|
48870
|
-
* @summary Get search suggestions
|
|
48871
|
-
* @param {string} query
|
|
48872
|
-
* @param {number} [limit]
|
|
49051
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49052
|
+
* @summary Get doc search suggestions
|
|
49053
|
+
* @param {string} query Partial search query
|
|
49054
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
48873
49055
|
* @param {*} [options] Override http request option.
|
|
48874
49056
|
* @throws {RequiredError}
|
|
48875
49057
|
*/
|
|
@@ -48932,9 +49114,9 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48932
49114
|
[key: string]: any;
|
|
48933
49115
|
}>>;
|
|
48934
49116
|
/**
|
|
48935
|
-
*
|
|
49117
|
+
* Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
|
|
48936
49118
|
* @summary Scrape and index documentation
|
|
48937
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49119
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
48938
49120
|
* @param {*} [options] Override http request option.
|
|
48939
49121
|
* @throws {RequiredError}
|
|
48940
49122
|
*/
|
|
@@ -48942,10 +49124,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48942
49124
|
[key: string]: any;
|
|
48943
49125
|
}>>;
|
|
48944
49126
|
/**
|
|
48945
|
-
*
|
|
49127
|
+
* Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
|
|
48946
49128
|
* @summary Search documentation
|
|
48947
49129
|
* @param {string} query Search query
|
|
48948
|
-
* @param {number} [limit]
|
|
49130
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
48949
49131
|
* @param {*} [options] Override http request option.
|
|
48950
49132
|
* @throws {RequiredError}
|
|
48951
49133
|
*/
|
|
@@ -48953,10 +49135,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48953
49135
|
[key: string]: any;
|
|
48954
49136
|
}>>;
|
|
48955
49137
|
/**
|
|
48956
|
-
*
|
|
48957
|
-
* @summary Get search suggestions
|
|
48958
|
-
* @param {string} query
|
|
48959
|
-
* @param {number} [limit]
|
|
49138
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49139
|
+
* @summary Get doc search suggestions
|
|
49140
|
+
* @param {string} query Partial search query
|
|
49141
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
48960
49142
|
* @param {*} [options] Override http request option.
|
|
48961
49143
|
* @throws {RequiredError}
|
|
48962
49144
|
*/
|
|
@@ -49023,9 +49205,9 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49023
49205
|
[key: string]: any;
|
|
49024
49206
|
}>;
|
|
49025
49207
|
/**
|
|
49026
|
-
*
|
|
49208
|
+
* Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
|
|
49027
49209
|
* @summary Scrape and index documentation
|
|
49028
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49210
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
49029
49211
|
* @param {*} [options] Override http request option.
|
|
49030
49212
|
* @throws {RequiredError}
|
|
49031
49213
|
*/
|
|
@@ -49033,10 +49215,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49033
49215
|
[key: string]: any;
|
|
49034
49216
|
}>;
|
|
49035
49217
|
/**
|
|
49036
|
-
*
|
|
49218
|
+
* Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
|
|
49037
49219
|
* @summary Search documentation
|
|
49038
49220
|
* @param {string} query Search query
|
|
49039
|
-
* @param {number} [limit]
|
|
49221
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
49040
49222
|
* @param {*} [options] Override http request option.
|
|
49041
49223
|
* @throws {RequiredError}
|
|
49042
49224
|
*/
|
|
@@ -49044,10 +49226,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49044
49226
|
[key: string]: any;
|
|
49045
49227
|
}>;
|
|
49046
49228
|
/**
|
|
49047
|
-
*
|
|
49048
|
-
* @summary Get search suggestions
|
|
49049
|
-
* @param {string} query
|
|
49050
|
-
* @param {number} [limit]
|
|
49229
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49230
|
+
* @summary Get doc search suggestions
|
|
49231
|
+
* @param {string} query Partial search query
|
|
49232
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
49051
49233
|
* @param {*} [options] Override http request option.
|
|
49052
49234
|
* @throws {RequiredError}
|
|
49053
49235
|
*/
|
|
@@ -49120,9 +49302,9 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49120
49302
|
[key: string]: any;
|
|
49121
49303
|
}, any, {}>>;
|
|
49122
49304
|
/**
|
|
49123
|
-
*
|
|
49305
|
+
* Crawls the configured documentation site and indexes all pages for search. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid. Used by doc search integration.
|
|
49124
49306
|
* @summary Scrape and index documentation
|
|
49125
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49307
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
49126
49308
|
* @param {*} [options] Override http request option.
|
|
49127
49309
|
* @throws {RequiredError}
|
|
49128
49310
|
* @memberof DocumentationApi
|
|
@@ -49131,10 +49313,10 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49131
49313
|
[key: string]: any;
|
|
49132
49314
|
}, any, {}>>;
|
|
49133
49315
|
/**
|
|
49134
|
-
*
|
|
49316
|
+
* Full-text search over the indexed documentation. No authentication required. Optional X-Docs-API-Key may be used for higher rate limits. Use `query` and optional `limit` (default 10, max 100).
|
|
49135
49317
|
* @summary Search documentation
|
|
49136
49318
|
* @param {string} query Search query
|
|
49137
|
-
* @param {number} [limit]
|
|
49319
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
49138
49320
|
* @param {*} [options] Override http request option.
|
|
49139
49321
|
* @throws {RequiredError}
|
|
49140
49322
|
* @memberof DocumentationApi
|
|
@@ -49143,10 +49325,10 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49143
49325
|
[key: string]: any;
|
|
49144
49326
|
}, any, {}>>;
|
|
49145
49327
|
/**
|
|
49146
|
-
*
|
|
49147
|
-
* @summary Get search suggestions
|
|
49148
|
-
* @param {string} query
|
|
49149
|
-
* @param {number} [limit]
|
|
49328
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49329
|
+
* @summary Get doc search suggestions
|
|
49330
|
+
* @param {string} query Partial search query
|
|
49331
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
49150
49332
|
* @param {*} [options] Override http request option.
|
|
49151
49333
|
* @throws {RequiredError}
|
|
49152
49334
|
* @memberof DocumentationApi
|
|
@@ -55363,56 +55545,56 @@ export declare class PluralsDeclensionsApi extends BaseAPI {
|
|
|
55363
55545
|
*/
|
|
55364
55546
|
export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55365
55547
|
/**
|
|
55366
|
-
*
|
|
55367
|
-
* @summary Get
|
|
55368
|
-
* @param {string} xStoreid Store ID
|
|
55369
|
-
* @param {string} xStoresecret Store
|
|
55548
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
55549
|
+
* @summary Get suggestions configuration
|
|
55550
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55551
|
+
* @param {string} xStoresecret Store read secret
|
|
55370
55552
|
* @param {*} [options] Override http request option.
|
|
55371
55553
|
* @throws {RequiredError}
|
|
55372
55554
|
*/
|
|
55373
55555
|
v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55374
55556
|
/**
|
|
55375
|
-
*
|
|
55376
|
-
* @summary Get
|
|
55377
|
-
* @param {string} xStoreid Store ID
|
|
55378
|
-
* @param {string} xStoresecret Store
|
|
55379
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55380
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55557
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
55558
|
+
* @summary Get query suggestions (GET)
|
|
55559
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55560
|
+
* @param {string} xStoresecret Store read secret
|
|
55561
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55562
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55381
55563
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55382
|
-
* @param {string} [query] Partial query
|
|
55383
|
-
* @param {string} [q] Alias for
|
|
55384
|
-
* @param {number} [hitsPerPage]
|
|
55385
|
-
* @param {number} [page] Page
|
|
55386
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
55387
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
55388
|
-
* @param {boolean} [includeCategories] Include category
|
|
55389
|
-
* @param {boolean} [includeFacets] Include
|
|
55390
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
55391
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55392
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55393
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
55394
|
-
* @param {number} [maxCategories]
|
|
55395
|
-
* @param {number} [maxFacets]
|
|
55396
|
-
* @param {number} [minPopularity]
|
|
55397
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
55398
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
55399
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
55400
|
-
* @param {string} [userId] User ID
|
|
55401
|
-
* @param {string} [anonId] Anonymous ID
|
|
55402
|
-
* @param {string} [sessionId] Session ID
|
|
55564
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
55565
|
+
* @param {string} [q] Alias for query
|
|
55566
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
55567
|
+
* @param {number} [page] Page for pagination
|
|
55568
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
55569
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
55570
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
55571
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
55572
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
55573
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55574
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55575
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
55576
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
55577
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
55578
|
+
* @param {number} [minPopularity] Min popularity
|
|
55579
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
55580
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
55581
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
55582
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
55583
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
55584
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55403
55585
|
* @param {*} [options] Override http request option.
|
|
55404
55586
|
* @throws {RequiredError}
|
|
55405
55587
|
*/
|
|
55406
55588
|
v1SuggestionsQueriesGet: (xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55407
55589
|
/**
|
|
55408
|
-
* Same as GET
|
|
55409
|
-
* @summary
|
|
55410
|
-
* @param {string} xStoreid Store ID
|
|
55411
|
-
* @param {string} xStoresecret Store
|
|
55412
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55413
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55590
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
55591
|
+
* @summary Get query suggestions (POST)
|
|
55592
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55593
|
+
* @param {string} xStoresecret Store read secret
|
|
55594
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55595
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55414
55596
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55415
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
55597
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55416
55598
|
* @param {*} [options] Override http request option.
|
|
55417
55599
|
* @throws {RequiredError}
|
|
55418
55600
|
*/
|
|
@@ -55424,56 +55606,56 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
55424
55606
|
*/
|
|
55425
55607
|
export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
55426
55608
|
/**
|
|
55427
|
-
*
|
|
55428
|
-
* @summary Get
|
|
55429
|
-
* @param {string} xStoreid Store ID
|
|
55430
|
-
* @param {string} xStoresecret Store
|
|
55609
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
55610
|
+
* @summary Get suggestions configuration
|
|
55611
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55612
|
+
* @param {string} xStoresecret Store read secret
|
|
55431
55613
|
* @param {*} [options] Override http request option.
|
|
55432
55614
|
* @throws {RequiredError}
|
|
55433
55615
|
*/
|
|
55434
55616
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
|
|
55435
55617
|
/**
|
|
55436
|
-
*
|
|
55437
|
-
* @summary Get
|
|
55438
|
-
* @param {string} xStoreid Store ID
|
|
55439
|
-
* @param {string} xStoresecret Store
|
|
55440
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55441
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55618
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
55619
|
+
* @summary Get query suggestions (GET)
|
|
55620
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55621
|
+
* @param {string} xStoresecret Store read secret
|
|
55622
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55623
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55442
55624
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55443
|
-
* @param {string} [query] Partial query
|
|
55444
|
-
* @param {string} [q] Alias for
|
|
55445
|
-
* @param {number} [hitsPerPage]
|
|
55446
|
-
* @param {number} [page] Page
|
|
55447
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
55448
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
55449
|
-
* @param {boolean} [includeCategories] Include category
|
|
55450
|
-
* @param {boolean} [includeFacets] Include
|
|
55451
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
55452
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55453
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55454
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
55455
|
-
* @param {number} [maxCategories]
|
|
55456
|
-
* @param {number} [maxFacets]
|
|
55457
|
-
* @param {number} [minPopularity]
|
|
55458
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
55459
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
55460
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
55461
|
-
* @param {string} [userId] User ID
|
|
55462
|
-
* @param {string} [anonId] Anonymous ID
|
|
55463
|
-
* @param {string} [sessionId] Session ID
|
|
55625
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
55626
|
+
* @param {string} [q] Alias for query
|
|
55627
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
55628
|
+
* @param {number} [page] Page for pagination
|
|
55629
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
55630
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
55631
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
55632
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
55633
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
55634
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55635
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55636
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
55637
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
55638
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
55639
|
+
* @param {number} [minPopularity] Min popularity
|
|
55640
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
55641
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
55642
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
55643
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
55644
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
55645
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55464
55646
|
* @param {*} [options] Override http request option.
|
|
55465
55647
|
* @throws {RequiredError}
|
|
55466
55648
|
*/
|
|
55467
55649
|
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
55468
55650
|
/**
|
|
55469
|
-
* Same as GET
|
|
55470
|
-
* @summary
|
|
55471
|
-
* @param {string} xStoreid Store ID
|
|
55472
|
-
* @param {string} xStoresecret Store
|
|
55473
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55474
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55651
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
55652
|
+
* @summary Get query suggestions (POST)
|
|
55653
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55654
|
+
* @param {string} xStoresecret Store read secret
|
|
55655
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55656
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55475
55657
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55476
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
55658
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55477
55659
|
* @param {*} [options] Override http request option.
|
|
55478
55660
|
* @throws {RequiredError}
|
|
55479
55661
|
*/
|
|
@@ -55485,56 +55667,56 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
|
55485
55667
|
*/
|
|
55486
55668
|
export declare const QuerySuggestionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55487
55669
|
/**
|
|
55488
|
-
*
|
|
55489
|
-
* @summary Get
|
|
55490
|
-
* @param {string} xStoreid Store ID
|
|
55491
|
-
* @param {string} xStoresecret Store
|
|
55670
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
55671
|
+
* @summary Get suggestions configuration
|
|
55672
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55673
|
+
* @param {string} xStoresecret Store read secret
|
|
55492
55674
|
* @param {*} [options] Override http request option.
|
|
55493
55675
|
* @throws {RequiredError}
|
|
55494
55676
|
*/
|
|
55495
55677
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
|
|
55496
55678
|
/**
|
|
55497
|
-
*
|
|
55498
|
-
* @summary Get
|
|
55499
|
-
* @param {string} xStoreid Store ID
|
|
55500
|
-
* @param {string} xStoresecret Store
|
|
55501
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55502
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55679
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
55680
|
+
* @summary Get query suggestions (GET)
|
|
55681
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55682
|
+
* @param {string} xStoresecret Store read secret
|
|
55683
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55684
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55503
55685
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55504
|
-
* @param {string} [query] Partial query
|
|
55505
|
-
* @param {string} [q] Alias for
|
|
55506
|
-
* @param {number} [hitsPerPage]
|
|
55507
|
-
* @param {number} [page] Page
|
|
55508
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
55509
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
55510
|
-
* @param {boolean} [includeCategories] Include category
|
|
55511
|
-
* @param {boolean} [includeFacets] Include
|
|
55512
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
55513
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55514
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55515
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
55516
|
-
* @param {number} [maxCategories]
|
|
55517
|
-
* @param {number} [maxFacets]
|
|
55518
|
-
* @param {number} [minPopularity]
|
|
55519
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
55520
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
55521
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
55522
|
-
* @param {string} [userId] User ID
|
|
55523
|
-
* @param {string} [anonId] Anonymous ID
|
|
55524
|
-
* @param {string} [sessionId] Session ID
|
|
55686
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
55687
|
+
* @param {string} [q] Alias for query
|
|
55688
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
55689
|
+
* @param {number} [page] Page for pagination
|
|
55690
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
55691
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
55692
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
55693
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
55694
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
55695
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55696
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55697
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
55698
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
55699
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
55700
|
+
* @param {number} [minPopularity] Min popularity
|
|
55701
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
55702
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
55703
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
55704
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
55705
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
55706
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55525
55707
|
* @param {*} [options] Override http request option.
|
|
55526
55708
|
* @throws {RequiredError}
|
|
55527
55709
|
*/
|
|
55528
55710
|
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
55529
55711
|
/**
|
|
55530
|
-
* Same as GET
|
|
55531
|
-
* @summary
|
|
55532
|
-
* @param {string} xStoreid Store ID
|
|
55533
|
-
* @param {string} xStoresecret Store
|
|
55534
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55535
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55712
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
55713
|
+
* @summary Get query suggestions (POST)
|
|
55714
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55715
|
+
* @param {string} xStoresecret Store read secret
|
|
55716
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55717
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55536
55718
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55537
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
55719
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55538
55720
|
* @param {*} [options] Override http request option.
|
|
55539
55721
|
* @throws {RequiredError}
|
|
55540
55722
|
*/
|
|
@@ -55548,58 +55730,58 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
|
|
|
55548
55730
|
*/
|
|
55549
55731
|
export declare class QuerySuggestionsApi extends BaseAPI {
|
|
55550
55732
|
/**
|
|
55551
|
-
*
|
|
55552
|
-
* @summary Get
|
|
55553
|
-
* @param {string} xStoreid Store ID
|
|
55554
|
-
* @param {string} xStoresecret Store
|
|
55733
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
55734
|
+
* @summary Get suggestions configuration
|
|
55735
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55736
|
+
* @param {string} xStoresecret Store read secret
|
|
55555
55737
|
* @param {*} [options] Override http request option.
|
|
55556
55738
|
* @throws {RequiredError}
|
|
55557
55739
|
* @memberof QuerySuggestionsApi
|
|
55558
55740
|
*/
|
|
55559
55741
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
|
|
55560
55742
|
/**
|
|
55561
|
-
*
|
|
55562
|
-
* @summary Get
|
|
55563
|
-
* @param {string} xStoreid Store ID
|
|
55564
|
-
* @param {string} xStoresecret Store
|
|
55565
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55566
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55743
|
+
* Autocomplete suggestions for search, ranked by popularity. **Auth:** `x-storeid` and `x-storesecret` (from dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports partial query, filters (analytics_tags), time range (7d/30d/90d), categories, facets, and dropdown recommendations. Use `query` or `q` for the partial search string.
|
|
55744
|
+
* @summary Get query suggestions (GET)
|
|
55745
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55746
|
+
* @param {string} xStoresecret Store read secret
|
|
55747
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55748
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55567
55749
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55568
|
-
* @param {string} [query] Partial query
|
|
55569
|
-
* @param {string} [q] Alias for
|
|
55570
|
-
* @param {number} [hitsPerPage]
|
|
55571
|
-
* @param {number} [page] Page
|
|
55572
|
-
* @param {string} [analyticsTags] Comma-separated
|
|
55573
|
-
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode]
|
|
55574
|
-
* @param {boolean} [includeCategories] Include category
|
|
55575
|
-
* @param {boolean} [includeFacets] Include
|
|
55576
|
-
* @param {boolean} [includeDropdownRecommendations] Include
|
|
55577
|
-
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55578
|
-
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55579
|
-
* @param {boolean} [includeEmptyQueryRecommendations]
|
|
55580
|
-
* @param {number} [maxCategories]
|
|
55581
|
-
* @param {number} [maxFacets]
|
|
55582
|
-
* @param {number} [minPopularity]
|
|
55583
|
-
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange]
|
|
55584
|
-
* @param {boolean} [disableTypoTolerance] Disable fuzzy
|
|
55585
|
-
* @param {string} [filteredTabs] URL-encoded JSON array of
|
|
55586
|
-
* @param {string} [userId] User ID
|
|
55587
|
-
* @param {string} [anonId] Anonymous ID
|
|
55588
|
-
* @param {string} [sessionId] Session ID
|
|
55750
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
55751
|
+
* @param {string} [q] Alias for query
|
|
55752
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
55753
|
+
* @param {number} [page] Page for pagination
|
|
55754
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
55755
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
55756
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
55757
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
55758
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
55759
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
55760
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
55761
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
55762
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
55763
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
55764
|
+
* @param {number} [minPopularity] Min popularity
|
|
55765
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
55766
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
55767
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
55768
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
55769
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
55770
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55589
55771
|
* @param {*} [options] Override http request option.
|
|
55590
55772
|
* @throws {RequiredError}
|
|
55591
55773
|
* @memberof QuerySuggestionsApi
|
|
55592
55774
|
*/
|
|
55593
55775
|
v1SuggestionsQueriesGet(xStoreid: string, xStoresecret: string, xUserId?: string, xAnonId?: string, xSessionId?: string, query?: string, q?: string, hitsPerPage?: number, page?: number, analyticsTags?: string, tagsMatchMode?: V1SuggestionsQueriesGetTagsMatchModeEnum, includeCategories?: boolean, includeFacets?: boolean, includeDropdownRecommendations?: boolean, includeDropdownProductList?: boolean, includeFilteredTabs?: boolean, includeEmptyQueryRecommendations?: boolean, maxCategories?: number, maxFacets?: number, minPopularity?: number, timeRange?: V1SuggestionsQueriesGetTimeRangeEnum, disableTypoTolerance?: boolean, filteredTabs?: string, userId?: string, anonId?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
55594
55776
|
/**
|
|
55595
|
-
* Same as GET
|
|
55596
|
-
* @summary
|
|
55597
|
-
* @param {string} xStoreid Store ID
|
|
55598
|
-
* @param {string} xStoresecret Store
|
|
55599
|
-
* @param {string} [xUserId] User ID for personalization
|
|
55600
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
55777
|
+
* Same as GET; use POST to send a JSON body (e.g. complex filtered_tabs). **Auth:** `x-storeid` and `x-storesecret`. Optional personalization headers: `x-user-id`, `x-anon-id`, `x-session-id`. Request body can include query, hitsPerPage, analytics_tags, include_categories, include_facets, filtered_tabs, etc.
|
|
55778
|
+
* @summary Get query suggestions (POST)
|
|
55779
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
55780
|
+
* @param {string} xStoresecret Store read secret
|
|
55781
|
+
* @param {string} [xUserId] User ID for personalization
|
|
55782
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55601
55783
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55602
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
55784
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55603
55785
|
* @param {*} [options] Override http request option.
|
|
55604
55786
|
* @throws {RequiredError}
|
|
55605
55787
|
* @memberof QuerySuggestionsApi
|
|
@@ -58138,34 +58320,34 @@ export declare class RolesApi extends BaseAPI {
|
|
|
58138
58320
|
*/
|
|
58139
58321
|
export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58140
58322
|
/**
|
|
58141
|
-
*
|
|
58142
|
-
* @summary Bulk index documents
|
|
58143
|
-
* @param {string} xStoreid Store ID
|
|
58144
|
-
* @param {string} xStoreWriteSecret Store
|
|
58145
|
-
* @param {string} xStoreID
|
|
58146
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
58323
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
58324
|
+
* @summary Bulk index documents
|
|
58325
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58326
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58327
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58328
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58147
58329
|
* @param {*} [options] Override http request option.
|
|
58148
58330
|
* @throws {RequiredError}
|
|
58149
58331
|
*/
|
|
58150
58332
|
apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58151
58333
|
/**
|
|
58152
|
-
*
|
|
58153
|
-
* @summary Delete a document
|
|
58154
|
-
* @param {string} xStoreid Store ID
|
|
58155
|
-
* @param {string} xStoreWriteSecret Store
|
|
58156
|
-
* @param {string} xStoreID
|
|
58334
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58335
|
+
* @summary Delete a document
|
|
58336
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58337
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58338
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58157
58339
|
* @param {string} documentID Document ID to delete
|
|
58158
58340
|
* @param {*} [options] Override http request option.
|
|
58159
58341
|
* @throws {RequiredError}
|
|
58160
58342
|
*/
|
|
58161
58343
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58162
58344
|
/**
|
|
58163
|
-
*
|
|
58164
|
-
* @summary Index a single document
|
|
58165
|
-
* @param {string} xStoreid Store ID
|
|
58166
|
-
* @param {string} xStoreWriteSecret Store
|
|
58167
|
-
* @param {string} xStoreID
|
|
58168
|
-
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document
|
|
58345
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
58346
|
+
* @summary Index a single document
|
|
58347
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58348
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58349
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58350
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58169
58351
|
* @param {*} [options] Override http request option.
|
|
58170
58352
|
* @throws {RequiredError}
|
|
58171
58353
|
*/
|
|
@@ -58177,34 +58359,34 @@ export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configur
|
|
|
58177
58359
|
*/
|
|
58178
58360
|
export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
58179
58361
|
/**
|
|
58180
|
-
*
|
|
58181
|
-
* @summary Bulk index documents
|
|
58182
|
-
* @param {string} xStoreid Store ID
|
|
58183
|
-
* @param {string} xStoreWriteSecret Store
|
|
58184
|
-
* @param {string} xStoreID
|
|
58185
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
58362
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
58363
|
+
* @summary Bulk index documents
|
|
58364
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58365
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58366
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58367
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58186
58368
|
* @param {*} [options] Override http request option.
|
|
58187
58369
|
* @throws {RequiredError}
|
|
58188
58370
|
*/
|
|
58189
58371
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
58190
58372
|
/**
|
|
58191
|
-
*
|
|
58192
|
-
* @summary Delete a document
|
|
58193
|
-
* @param {string} xStoreid Store ID
|
|
58194
|
-
* @param {string} xStoreWriteSecret Store
|
|
58195
|
-
* @param {string} xStoreID
|
|
58373
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58374
|
+
* @summary Delete a document
|
|
58375
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58376
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58377
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58196
58378
|
* @param {string} documentID Document ID to delete
|
|
58197
58379
|
* @param {*} [options] Override http request option.
|
|
58198
58380
|
* @throws {RequiredError}
|
|
58199
58381
|
*/
|
|
58200
58382
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
58201
58383
|
/**
|
|
58202
|
-
*
|
|
58203
|
-
* @summary Index a single document
|
|
58204
|
-
* @param {string} xStoreid Store ID
|
|
58205
|
-
* @param {string} xStoreWriteSecret Store
|
|
58206
|
-
* @param {string} xStoreID
|
|
58207
|
-
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document
|
|
58384
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
58385
|
+
* @summary Index a single document
|
|
58386
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58387
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58388
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58389
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58208
58390
|
* @param {*} [options] Override http request option.
|
|
58209
58391
|
* @throws {RequiredError}
|
|
58210
58392
|
*/
|
|
@@ -58216,34 +58398,34 @@ export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
58216
58398
|
*/
|
|
58217
58399
|
export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58218
58400
|
/**
|
|
58219
|
-
*
|
|
58220
|
-
* @summary Bulk index documents
|
|
58221
|
-
* @param {string} xStoreid Store ID
|
|
58222
|
-
* @param {string} xStoreWriteSecret Store
|
|
58223
|
-
* @param {string} xStoreID
|
|
58224
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
58401
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
58402
|
+
* @summary Bulk index documents
|
|
58403
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58404
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58405
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58406
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58225
58407
|
* @param {*} [options] Override http request option.
|
|
58226
58408
|
* @throws {RequiredError}
|
|
58227
58409
|
*/
|
|
58228
58410
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
58229
58411
|
/**
|
|
58230
|
-
*
|
|
58231
|
-
* @summary Delete a document
|
|
58232
|
-
* @param {string} xStoreid Store ID
|
|
58233
|
-
* @param {string} xStoreWriteSecret Store
|
|
58234
|
-
* @param {string} xStoreID
|
|
58412
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58413
|
+
* @summary Delete a document
|
|
58414
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58415
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58416
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58235
58417
|
* @param {string} documentID Document ID to delete
|
|
58236
58418
|
* @param {*} [options] Override http request option.
|
|
58237
58419
|
* @throws {RequiredError}
|
|
58238
58420
|
*/
|
|
58239
58421
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
58240
58422
|
/**
|
|
58241
|
-
*
|
|
58242
|
-
* @summary Index a single document
|
|
58243
|
-
* @param {string} xStoreid Store ID
|
|
58244
|
-
* @param {string} xStoreWriteSecret Store
|
|
58245
|
-
* @param {string} xStoreID
|
|
58246
|
-
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document
|
|
58423
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
58424
|
+
* @summary Index a single document
|
|
58425
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58426
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58427
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58428
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58247
58429
|
* @param {*} [options] Override http request option.
|
|
58248
58430
|
* @throws {RequiredError}
|
|
58249
58431
|
*/
|
|
@@ -58257,23 +58439,23 @@ export declare const SDKDocumentsApiFactory: (configuration?: Configuration, bas
|
|
|
58257
58439
|
*/
|
|
58258
58440
|
export declare class SDKDocumentsApi extends BaseAPI {
|
|
58259
58441
|
/**
|
|
58260
|
-
*
|
|
58261
|
-
* @summary Bulk index documents
|
|
58262
|
-
* @param {string} xStoreid Store ID
|
|
58263
|
-
* @param {string} xStoreWriteSecret Store
|
|
58264
|
-
* @param {string} xStoreID
|
|
58265
|
-
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest
|
|
58442
|
+
* Run multiple document operations in one request (insert, update, upsert, delete). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. Each item can specify its own action.
|
|
58443
|
+
* @summary Bulk index documents
|
|
58444
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58445
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58446
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58447
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58266
58448
|
* @param {*} [options] Override http request option.
|
|
58267
58449
|
* @throws {RequiredError}
|
|
58268
58450
|
* @memberof SDKDocumentsApi
|
|
58269
58451
|
*/
|
|
58270
58452
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
58271
58453
|
/**
|
|
58272
|
-
*
|
|
58273
|
-
* @summary Delete a document
|
|
58274
|
-
* @param {string} xStoreid Store ID
|
|
58275
|
-
* @param {string} xStoreWriteSecret Store
|
|
58276
|
-
* @param {string} xStoreID
|
|
58454
|
+
* Remove a document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58455
|
+
* @summary Delete a document
|
|
58456
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58457
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58458
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58277
58459
|
* @param {string} documentID Document ID to delete
|
|
58278
58460
|
* @param {*} [options] Override http request option.
|
|
58279
58461
|
* @throws {RequiredError}
|
|
@@ -58281,12 +58463,12 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
58281
58463
|
*/
|
|
58282
58464
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
58283
58465
|
/**
|
|
58284
|
-
*
|
|
58285
|
-
* @summary Index a single document
|
|
58286
|
-
* @param {string} xStoreid Store ID
|
|
58287
|
-
* @param {string} xStoreWriteSecret Store
|
|
58288
|
-
* @param {string} xStoreID
|
|
58289
|
-
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document
|
|
58466
|
+
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
58467
|
+
* @summary Index a single document
|
|
58468
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58469
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58470
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58471
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58290
58472
|
* @param {*} [options] Override http request option.
|
|
58291
58473
|
* @throws {RequiredError}
|
|
58292
58474
|
* @memberof SDKDocumentsApi
|
|
@@ -58299,22 +58481,22 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
58299
58481
|
*/
|
|
58300
58482
|
export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58301
58483
|
/**
|
|
58302
|
-
*
|
|
58303
|
-
* @summary Get
|
|
58304
|
-
* @param {string} xStoreid Store ID
|
|
58305
|
-
* @param {string} xStoresecret Store
|
|
58306
|
-
* @param {string} xStoreID
|
|
58484
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58485
|
+
* @summary Get query suggestions configuration
|
|
58486
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58487
|
+
* @param {string} xStoresecret Store read secret
|
|
58488
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58307
58489
|
* @param {*} [options] Override http request option.
|
|
58308
58490
|
* @throws {RequiredError}
|
|
58309
58491
|
*/
|
|
58310
58492
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58311
58493
|
/**
|
|
58312
|
-
*
|
|
58313
|
-
* @summary Update
|
|
58314
|
-
* @param {string} xStoreid Store ID
|
|
58315
|
-
* @param {string} xStoreWriteSecret Store
|
|
58316
|
-
* @param {string} xStoreID
|
|
58317
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
58494
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58495
|
+
* @summary Update query suggestions configuration
|
|
58496
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58497
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58498
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58499
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58318
58500
|
* @param {*} [options] Override http request option.
|
|
58319
58501
|
* @throws {RequiredError}
|
|
58320
58502
|
*/
|
|
@@ -58326,22 +58508,22 @@ export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configurati
|
|
|
58326
58508
|
*/
|
|
58327
58509
|
export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
|
|
58328
58510
|
/**
|
|
58329
|
-
*
|
|
58330
|
-
* @summary Get
|
|
58331
|
-
* @param {string} xStoreid Store ID
|
|
58332
|
-
* @param {string} xStoresecret Store
|
|
58333
|
-
* @param {string} xStoreID
|
|
58511
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58512
|
+
* @summary Get query suggestions configuration
|
|
58513
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58514
|
+
* @param {string} xStoresecret Store read secret
|
|
58515
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58334
58516
|
* @param {*} [options] Override http request option.
|
|
58335
58517
|
* @throws {RequiredError}
|
|
58336
58518
|
*/
|
|
58337
58519
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
58338
58520
|
/**
|
|
58339
|
-
*
|
|
58340
|
-
* @summary Update
|
|
58341
|
-
* @param {string} xStoreid Store ID
|
|
58342
|
-
* @param {string} xStoreWriteSecret Store
|
|
58343
|
-
* @param {string} xStoreID
|
|
58344
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
58521
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58522
|
+
* @summary Update query suggestions configuration
|
|
58523
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58524
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58525
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58526
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58345
58527
|
* @param {*} [options] Override http request option.
|
|
58346
58528
|
* @throws {RequiredError}
|
|
58347
58529
|
*/
|
|
@@ -58353,22 +58535,22 @@ export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configurat
|
|
|
58353
58535
|
*/
|
|
58354
58536
|
export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58355
58537
|
/**
|
|
58356
|
-
*
|
|
58357
|
-
* @summary Get
|
|
58358
|
-
* @param {string} xStoreid Store ID
|
|
58359
|
-
* @param {string} xStoresecret Store
|
|
58360
|
-
* @param {string} xStoreID
|
|
58538
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58539
|
+
* @summary Get query suggestions configuration
|
|
58540
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58541
|
+
* @param {string} xStoresecret Store read secret
|
|
58542
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58361
58543
|
* @param {*} [options] Override http request option.
|
|
58362
58544
|
* @throws {RequiredError}
|
|
58363
58545
|
*/
|
|
58364
58546
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
58365
58547
|
/**
|
|
58366
|
-
*
|
|
58367
|
-
* @summary Update
|
|
58368
|
-
* @param {string} xStoreid Store ID
|
|
58369
|
-
* @param {string} xStoreWriteSecret Store
|
|
58370
|
-
* @param {string} xStoreID
|
|
58371
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
58548
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58549
|
+
* @summary Update query suggestions configuration
|
|
58550
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58551
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58552
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58553
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58372
58554
|
* @param {*} [options] Override http request option.
|
|
58373
58555
|
* @throws {RequiredError}
|
|
58374
58556
|
*/
|
|
@@ -58382,23 +58564,23 @@ export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Confi
|
|
|
58382
58564
|
*/
|
|
58383
58565
|
export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
|
|
58384
58566
|
/**
|
|
58385
|
-
*
|
|
58386
|
-
* @summary Get
|
|
58387
|
-
* @param {string} xStoreid Store ID
|
|
58388
|
-
* @param {string} xStoresecret Store
|
|
58389
|
-
* @param {string} xStoreID
|
|
58567
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58568
|
+
* @summary Get query suggestions configuration
|
|
58569
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58570
|
+
* @param {string} xStoresecret Store read secret
|
|
58571
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58390
58572
|
* @param {*} [options] Override http request option.
|
|
58391
58573
|
* @throws {RequiredError}
|
|
58392
58574
|
* @memberof SDKQuerySuggestionsConfigApi
|
|
58393
58575
|
*/
|
|
58394
58576
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
58395
58577
|
/**
|
|
58396
|
-
*
|
|
58397
|
-
* @summary Update
|
|
58398
|
-
* @param {string} xStoreid Store ID
|
|
58399
|
-
* @param {string} xStoreWriteSecret Store
|
|
58400
|
-
* @param {string} xStoreID
|
|
58401
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
58578
|
+
* Update autocomplete/suggestions settings for the store. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58579
|
+
* @summary Update query suggestions configuration
|
|
58580
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58581
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58582
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58583
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58402
58584
|
* @param {*} [options] Override http request option.
|
|
58403
58585
|
* @throws {RequiredError}
|
|
58404
58586
|
* @memberof SDKQuerySuggestionsConfigApi
|
|
@@ -58411,32 +58593,32 @@ export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
|
|
|
58411
58593
|
*/
|
|
58412
58594
|
export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58413
58595
|
/**
|
|
58414
|
-
*
|
|
58415
|
-
* @summary Clear
|
|
58416
|
-
* @param {string} xStoreid Store ID
|
|
58417
|
-
* @param {string} xStoreWriteSecret Store
|
|
58418
|
-
* @param {string} xStoreID
|
|
58596
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58597
|
+
* @summary Clear all documents
|
|
58598
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58599
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58600
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58419
58601
|
* @param {*} [options] Override http request option.
|
|
58420
58602
|
* @throws {RequiredError}
|
|
58421
58603
|
*/
|
|
58422
58604
|
apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58423
58605
|
/**
|
|
58424
|
-
*
|
|
58425
|
-
* @summary Get
|
|
58426
|
-
* @param {string} xStoreid Store ID
|
|
58427
|
-
* @param {string} xStoresecret Store
|
|
58428
|
-
* @param {string} xStoreID
|
|
58606
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58607
|
+
* @summary Get index schema
|
|
58608
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58609
|
+
* @param {string} xStoresecret Store read secret
|
|
58610
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58429
58611
|
* @param {*} [options] Override http request option.
|
|
58430
58612
|
* @throws {RequiredError}
|
|
58431
58613
|
*/
|
|
58432
58614
|
apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58433
58615
|
/**
|
|
58434
|
-
*
|
|
58435
|
-
* @summary Create or
|
|
58436
|
-
* @param {string} xStoreid Store ID
|
|
58437
|
-
* @param {string} xStoreWriteSecret Store
|
|
58438
|
-
* @param {string} xStoreID
|
|
58439
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
58616
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58617
|
+
* @summary Create or update index schema
|
|
58618
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58619
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58620
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58621
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58440
58622
|
* @param {*} [options] Override http request option.
|
|
58441
58623
|
* @throws {RequiredError}
|
|
58442
58624
|
*/
|
|
@@ -58448,32 +58630,32 @@ export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configurati
|
|
|
58448
58630
|
*/
|
|
58449
58631
|
export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
58450
58632
|
/**
|
|
58451
|
-
*
|
|
58452
|
-
* @summary Clear
|
|
58453
|
-
* @param {string} xStoreid Store ID
|
|
58454
|
-
* @param {string} xStoreWriteSecret Store
|
|
58455
|
-
* @param {string} xStoreID
|
|
58633
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58634
|
+
* @summary Clear all documents
|
|
58635
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58636
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58637
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58456
58638
|
* @param {*} [options] Override http request option.
|
|
58457
58639
|
* @throws {RequiredError}
|
|
58458
58640
|
*/
|
|
58459
58641
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
58460
58642
|
/**
|
|
58461
|
-
*
|
|
58462
|
-
* @summary Get
|
|
58463
|
-
* @param {string} xStoreid Store ID
|
|
58464
|
-
* @param {string} xStoresecret Store
|
|
58465
|
-
* @param {string} xStoreID
|
|
58643
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58644
|
+
* @summary Get index schema
|
|
58645
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58646
|
+
* @param {string} xStoresecret Store read secret
|
|
58647
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58466
58648
|
* @param {*} [options] Override http request option.
|
|
58467
58649
|
* @throws {RequiredError}
|
|
58468
58650
|
*/
|
|
58469
58651
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
58470
58652
|
/**
|
|
58471
|
-
*
|
|
58472
|
-
* @summary Create or
|
|
58473
|
-
* @param {string} xStoreid Store ID
|
|
58474
|
-
* @param {string} xStoreWriteSecret Store
|
|
58475
|
-
* @param {string} xStoreID
|
|
58476
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
58653
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58654
|
+
* @summary Create or update index schema
|
|
58655
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58656
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58657
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58658
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58477
58659
|
* @param {*} [options] Override http request option.
|
|
58478
58660
|
* @throws {RequiredError}
|
|
58479
58661
|
*/
|
|
@@ -58485,32 +58667,32 @@ export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
|
58485
58667
|
*/
|
|
58486
58668
|
export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58487
58669
|
/**
|
|
58488
|
-
*
|
|
58489
|
-
* @summary Clear
|
|
58490
|
-
* @param {string} xStoreid Store ID
|
|
58491
|
-
* @param {string} xStoreWriteSecret Store
|
|
58492
|
-
* @param {string} xStoreID
|
|
58670
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58671
|
+
* @summary Clear all documents
|
|
58672
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58673
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58674
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58493
58675
|
* @param {*} [options] Override http request option.
|
|
58494
58676
|
* @throws {RequiredError}
|
|
58495
58677
|
*/
|
|
58496
58678
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
58497
58679
|
/**
|
|
58498
|
-
*
|
|
58499
|
-
* @summary Get
|
|
58500
|
-
* @param {string} xStoreid Store ID
|
|
58501
|
-
* @param {string} xStoresecret Store
|
|
58502
|
-
* @param {string} xStoreID
|
|
58680
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58681
|
+
* @summary Get index schema
|
|
58682
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58683
|
+
* @param {string} xStoresecret Store read secret
|
|
58684
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58503
58685
|
* @param {*} [options] Override http request option.
|
|
58504
58686
|
* @throws {RequiredError}
|
|
58505
58687
|
*/
|
|
58506
58688
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
58507
58689
|
/**
|
|
58508
|
-
*
|
|
58509
|
-
* @summary Create or
|
|
58510
|
-
* @param {string} xStoreid Store ID
|
|
58511
|
-
* @param {string} xStoreWriteSecret Store
|
|
58512
|
-
* @param {string} xStoreID
|
|
58513
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
58690
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58691
|
+
* @summary Create or update index schema
|
|
58692
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58693
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58694
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58695
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58514
58696
|
* @param {*} [options] Override http request option.
|
|
58515
58697
|
* @throws {RequiredError}
|
|
58516
58698
|
*/
|
|
@@ -58524,34 +58706,34 @@ export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePa
|
|
|
58524
58706
|
*/
|
|
58525
58707
|
export declare class SDKSchemaApi extends BaseAPI {
|
|
58526
58708
|
/**
|
|
58527
|
-
*
|
|
58528
|
-
* @summary Clear
|
|
58529
|
-
* @param {string} xStoreid Store ID
|
|
58530
|
-
* @param {string} xStoreWriteSecret Store
|
|
58531
|
-
* @param {string} xStoreID
|
|
58709
|
+
* Removes all documents from the store\'s search index; schema is preserved. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58710
|
+
* @summary Clear all documents
|
|
58711
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58712
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58713
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58532
58714
|
* @param {*} [options] Override http request option.
|
|
58533
58715
|
* @throws {RequiredError}
|
|
58534
58716
|
* @memberof SDKSchemaApi
|
|
58535
58717
|
*/
|
|
58536
58718
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
58537
58719
|
/**
|
|
58538
|
-
*
|
|
58539
|
-
* @summary Get
|
|
58540
|
-
* @param {string} xStoreid Store ID
|
|
58541
|
-
* @param {string} xStoresecret Store
|
|
58542
|
-
* @param {string} xStoreID
|
|
58720
|
+
* Returns the current search index schema (fields and options) for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58721
|
+
* @summary Get index schema
|
|
58722
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58723
|
+
* @param {string} xStoresecret Store read secret
|
|
58724
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58543
58725
|
* @param {*} [options] Override http request option.
|
|
58544
58726
|
* @throws {RequiredError}
|
|
58545
58727
|
* @memberof SDKSchemaApi
|
|
58546
58728
|
*/
|
|
58547
58729
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
58548
58730
|
/**
|
|
58549
|
-
*
|
|
58550
|
-
* @summary Create or
|
|
58551
|
-
* @param {string} xStoreid Store ID
|
|
58552
|
-
* @param {string} xStoreWriteSecret Store
|
|
58553
|
-
* @param {string} xStoreID
|
|
58554
|
-
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema
|
|
58731
|
+
* Define or update the search index schema (field names, types, searchable/facet options). Mode: `additive` (add fields, keep data) or `replace` (recreate index). **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58732
|
+
* @summary Create or update index schema
|
|
58733
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58734
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58735
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58736
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58555
58737
|
* @param {*} [options] Override http request option.
|
|
58556
58738
|
* @throws {RequiredError}
|
|
58557
58739
|
* @memberof SDKSchemaApi
|
|
@@ -58564,32 +58746,32 @@ export declare class SDKSchemaApi extends BaseAPI {
|
|
|
58564
58746
|
*/
|
|
58565
58747
|
export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58566
58748
|
/**
|
|
58567
|
-
*
|
|
58568
|
-
* @summary Get
|
|
58569
|
-
* @param {string} xStoreid Store ID
|
|
58570
|
-
* @param {string} xStoresecret Store
|
|
58571
|
-
* @param {string} xStoreID
|
|
58749
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58750
|
+
* @summary Get store configuration
|
|
58751
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58752
|
+
* @param {string} xStoresecret Store read secret
|
|
58753
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58572
58754
|
* @param {*} [options] Override http request option.
|
|
58573
58755
|
* @throws {RequiredError}
|
|
58574
58756
|
*/
|
|
58575
58757
|
apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58576
58758
|
/**
|
|
58577
|
-
*
|
|
58578
|
-
* @summary Update
|
|
58579
|
-
* @param {string} xStoreid Store ID
|
|
58580
|
-
* @param {string} xStoreWriteSecret Store
|
|
58581
|
-
* @param {string} xStoreID
|
|
58582
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
58759
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58760
|
+
* @summary Update store configuration
|
|
58761
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58762
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58763
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58764
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58583
58765
|
* @param {*} [options] Override http request option.
|
|
58584
58766
|
* @throws {RequiredError}
|
|
58585
58767
|
*/
|
|
58586
58768
|
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58587
58769
|
/**
|
|
58588
|
-
*
|
|
58589
|
-
* @summary Get
|
|
58590
|
-
* @param {string} xStoreid Store ID
|
|
58591
|
-
* @param {string} xStoresecret Store
|
|
58592
|
-
* @param {string} xStoreID
|
|
58770
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58771
|
+
* @summary Get store config schema
|
|
58772
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58773
|
+
* @param {string} xStoresecret Store read secret
|
|
58774
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58593
58775
|
* @param {*} [options] Override http request option.
|
|
58594
58776
|
* @throws {RequiredError}
|
|
58595
58777
|
*/
|
|
@@ -58601,32 +58783,32 @@ export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Config
|
|
|
58601
58783
|
*/
|
|
58602
58784
|
export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
|
|
58603
58785
|
/**
|
|
58604
|
-
*
|
|
58605
|
-
* @summary Get
|
|
58606
|
-
* @param {string} xStoreid Store ID
|
|
58607
|
-
* @param {string} xStoresecret Store
|
|
58608
|
-
* @param {string} xStoreID
|
|
58786
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58787
|
+
* @summary Get store configuration
|
|
58788
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58789
|
+
* @param {string} xStoresecret Store read secret
|
|
58790
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58609
58791
|
* @param {*} [options] Override http request option.
|
|
58610
58792
|
* @throws {RequiredError}
|
|
58611
58793
|
*/
|
|
58612
58794
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
58613
58795
|
/**
|
|
58614
|
-
*
|
|
58615
|
-
* @summary Update
|
|
58616
|
-
* @param {string} xStoreid Store ID
|
|
58617
|
-
* @param {string} xStoreWriteSecret Store
|
|
58618
|
-
* @param {string} xStoreID
|
|
58619
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
58796
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58797
|
+
* @summary Update store configuration
|
|
58798
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58799
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58800
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58801
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58620
58802
|
* @param {*} [options] Override http request option.
|
|
58621
58803
|
* @throws {RequiredError}
|
|
58622
58804
|
*/
|
|
58623
58805
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
58624
58806
|
/**
|
|
58625
|
-
*
|
|
58626
|
-
* @summary Get
|
|
58627
|
-
* @param {string} xStoreid Store ID
|
|
58628
|
-
* @param {string} xStoresecret Store
|
|
58629
|
-
* @param {string} xStoreID
|
|
58807
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58808
|
+
* @summary Get store config schema
|
|
58809
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58810
|
+
* @param {string} xStoresecret Store read secret
|
|
58811
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58630
58812
|
* @param {*} [options] Override http request option.
|
|
58631
58813
|
* @throws {RequiredError}
|
|
58632
58814
|
*/
|
|
@@ -58638,32 +58820,32 @@ export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
|
|
|
58638
58820
|
*/
|
|
58639
58821
|
export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58640
58822
|
/**
|
|
58641
|
-
*
|
|
58642
|
-
* @summary Get
|
|
58643
|
-
* @param {string} xStoreid Store ID
|
|
58644
|
-
* @param {string} xStoresecret Store
|
|
58645
|
-
* @param {string} xStoreID
|
|
58823
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58824
|
+
* @summary Get store configuration
|
|
58825
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58826
|
+
* @param {string} xStoresecret Store read secret
|
|
58827
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58646
58828
|
* @param {*} [options] Override http request option.
|
|
58647
58829
|
* @throws {RequiredError}
|
|
58648
58830
|
*/
|
|
58649
58831
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
58650
58832
|
/**
|
|
58651
|
-
*
|
|
58652
|
-
* @summary Update
|
|
58653
|
-
* @param {string} xStoreid Store ID
|
|
58654
|
-
* @param {string} xStoreWriteSecret Store
|
|
58655
|
-
* @param {string} xStoreID
|
|
58656
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
58833
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58834
|
+
* @summary Update store configuration
|
|
58835
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58836
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58837
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58838
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58657
58839
|
* @param {*} [options] Override http request option.
|
|
58658
58840
|
* @throws {RequiredError}
|
|
58659
58841
|
*/
|
|
58660
58842
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
58661
58843
|
/**
|
|
58662
|
-
*
|
|
58663
|
-
* @summary Get
|
|
58664
|
-
* @param {string} xStoreid Store ID
|
|
58665
|
-
* @param {string} xStoresecret Store
|
|
58666
|
-
* @param {string} xStoreID
|
|
58844
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58845
|
+
* @summary Get store config schema
|
|
58846
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58847
|
+
* @param {string} xStoresecret Store read secret
|
|
58848
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58667
58849
|
* @param {*} [options] Override http request option.
|
|
58668
58850
|
* @throws {RequiredError}
|
|
58669
58851
|
*/
|
|
@@ -58677,34 +58859,34 @@ export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, b
|
|
|
58677
58859
|
*/
|
|
58678
58860
|
export declare class SDKStoreConfigApi extends BaseAPI {
|
|
58679
58861
|
/**
|
|
58680
|
-
*
|
|
58681
|
-
* @summary Get
|
|
58682
|
-
* @param {string} xStoreid Store ID
|
|
58683
|
-
* @param {string} xStoresecret Store
|
|
58684
|
-
* @param {string} xStoreID
|
|
58862
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58863
|
+
* @summary Get store configuration
|
|
58864
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58865
|
+
* @param {string} xStoresecret Store read secret
|
|
58866
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58685
58867
|
* @param {*} [options] Override http request option.
|
|
58686
58868
|
* @throws {RequiredError}
|
|
58687
58869
|
* @memberof SDKStoreConfigApi
|
|
58688
58870
|
*/
|
|
58689
58871
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
58690
58872
|
/**
|
|
58691
|
-
*
|
|
58692
|
-
* @summary Update
|
|
58693
|
-
* @param {string} xStoreid Store ID
|
|
58694
|
-
* @param {string} xStoreWriteSecret Store
|
|
58695
|
-
* @param {string} xStoreID
|
|
58696
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
58873
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58874
|
+
* @summary Update store configuration
|
|
58875
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58876
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
58877
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58878
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58697
58879
|
* @param {*} [options] Override http request option.
|
|
58698
58880
|
* @throws {RequiredError}
|
|
58699
58881
|
* @memberof SDKStoreConfigApi
|
|
58700
58882
|
*/
|
|
58701
58883
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
58702
58884
|
/**
|
|
58703
|
-
*
|
|
58704
|
-
* @summary Get
|
|
58705
|
-
* @param {string} xStoreid Store ID
|
|
58706
|
-
* @param {string} xStoresecret Store
|
|
58707
|
-
* @param {string} xStoreID
|
|
58885
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58886
|
+
* @summary Get store config schema
|
|
58887
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58888
|
+
* @param {string} xStoresecret Store read secret
|
|
58889
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58708
58890
|
* @param {*} [options] Override http request option.
|
|
58709
58891
|
* @throws {RequiredError}
|
|
58710
58892
|
* @memberof SDKStoreConfigApi
|
|
@@ -58780,11 +58962,11 @@ export declare class SDKStoreCreationApi extends BaseAPI {
|
|
|
58780
58962
|
*/
|
|
58781
58963
|
export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58782
58964
|
/**
|
|
58783
|
-
*
|
|
58784
|
-
* @summary Get
|
|
58785
|
-
* @param {string} xStoreid Store ID
|
|
58786
|
-
* @param {string} xStoresecret Store
|
|
58787
|
-
* @param {string} xStoreID
|
|
58965
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58966
|
+
* @summary Get store info
|
|
58967
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58968
|
+
* @param {string} xStoresecret Store read secret
|
|
58969
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58788
58970
|
* @param {*} [options] Override http request option.
|
|
58789
58971
|
* @throws {RequiredError}
|
|
58790
58972
|
*/
|
|
@@ -58796,11 +58978,11 @@ export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configur
|
|
|
58796
58978
|
*/
|
|
58797
58979
|
export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
|
|
58798
58980
|
/**
|
|
58799
|
-
*
|
|
58800
|
-
* @summary Get
|
|
58801
|
-
* @param {string} xStoreid Store ID
|
|
58802
|
-
* @param {string} xStoresecret Store
|
|
58803
|
-
* @param {string} xStoreID
|
|
58981
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58982
|
+
* @summary Get store info
|
|
58983
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
58984
|
+
* @param {string} xStoresecret Store read secret
|
|
58985
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58804
58986
|
* @param {*} [options] Override http request option.
|
|
58805
58987
|
* @throws {RequiredError}
|
|
58806
58988
|
*/
|
|
@@ -58812,11 +58994,11 @@ export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
|
|
|
58812
58994
|
*/
|
|
58813
58995
|
export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58814
58996
|
/**
|
|
58815
|
-
*
|
|
58816
|
-
* @summary Get
|
|
58817
|
-
* @param {string} xStoreid Store ID
|
|
58818
|
-
* @param {string} xStoresecret Store
|
|
58819
|
-
* @param {string} xStoreID
|
|
58997
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
58998
|
+
* @summary Get store info
|
|
58999
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59000
|
+
* @param {string} xStoresecret Store read secret
|
|
59001
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58820
59002
|
* @param {*} [options] Override http request option.
|
|
58821
59003
|
* @throws {RequiredError}
|
|
58822
59004
|
*/
|
|
@@ -58830,11 +59012,11 @@ export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, bas
|
|
|
58830
59012
|
*/
|
|
58831
59013
|
export declare class SDKStoreInfoApi extends BaseAPI {
|
|
58832
59014
|
/**
|
|
58833
|
-
*
|
|
58834
|
-
* @summary Get
|
|
58835
|
-
* @param {string} xStoreid Store ID
|
|
58836
|
-
* @param {string} xStoresecret Store
|
|
58837
|
-
* @param {string} xStoreID
|
|
59015
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59016
|
+
* @summary Get store info
|
|
59017
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59018
|
+
* @param {string} xStoresecret Store read secret
|
|
59019
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58838
59020
|
* @param {*} [options] Override http request option.
|
|
58839
59021
|
* @throws {RequiredError}
|
|
58840
59022
|
* @memberof SDKStoreInfoApi
|
|
@@ -58899,13 +59081,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58899
59081
|
*/
|
|
58900
59082
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58901
59083
|
/**
|
|
58902
|
-
*
|
|
58903
|
-
* @summary
|
|
58904
|
-
* @param {string} xStoreid Store ID
|
|
58905
|
-
* @param {string} xStoresecret Store
|
|
59084
|
+
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
59085
|
+
* @summary Search (GET)
|
|
59086
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59087
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
58906
59088
|
* @param {string} q Search query
|
|
58907
59089
|
* @param {string} [xUserId] User ID for personalization
|
|
58908
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59090
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
58909
59091
|
* @param {string} [xSessionId] Session ID for personalization
|
|
58910
59092
|
* @param {number} [page] Page number (default: 1)
|
|
58911
59093
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -58949,13 +59131,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58949
59131
|
*/
|
|
58950
59132
|
v1SearchGet: (xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58951
59133
|
/**
|
|
58952
|
-
*
|
|
58953
|
-
* @summary
|
|
58954
|
-
* @param {string} xStoreid Store ID
|
|
58955
|
-
* @param {string} xStoresecret Store
|
|
58956
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
58957
|
-
* @param {string} [xUserId] User ID for personalization
|
|
58958
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59134
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
59135
|
+
* @summary Search (POST)
|
|
59136
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59137
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59138
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59139
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59140
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
58959
59141
|
* @param {string} [xSessionId] Session ID for personalization
|
|
58960
59142
|
* @param {*} [options] Override http request option.
|
|
58961
59143
|
* @throws {RequiredError}
|
|
@@ -59020,13 +59202,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
59020
59202
|
*/
|
|
59021
59203
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
59022
59204
|
/**
|
|
59023
|
-
*
|
|
59024
|
-
* @summary
|
|
59025
|
-
* @param {string} xStoreid Store ID
|
|
59026
|
-
* @param {string} xStoresecret Store
|
|
59205
|
+
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
59206
|
+
* @summary Search (GET)
|
|
59207
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59208
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59027
59209
|
* @param {string} q Search query
|
|
59028
59210
|
* @param {string} [xUserId] User ID for personalization
|
|
59029
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59211
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59030
59212
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59031
59213
|
* @param {number} [page] Page number (default: 1)
|
|
59032
59214
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59070,13 +59252,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
59070
59252
|
*/
|
|
59071
59253
|
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
59072
59254
|
/**
|
|
59073
|
-
*
|
|
59074
|
-
* @summary
|
|
59075
|
-
* @param {string} xStoreid Store ID
|
|
59076
|
-
* @param {string} xStoresecret Store
|
|
59077
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
59078
|
-
* @param {string} [xUserId] User ID for personalization
|
|
59079
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59255
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
59256
|
+
* @summary Search (POST)
|
|
59257
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59258
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59259
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59260
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59261
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59080
59262
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59081
59263
|
* @param {*} [options] Override http request option.
|
|
59082
59264
|
* @throws {RequiredError}
|
|
@@ -59141,13 +59323,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
59141
59323
|
*/
|
|
59142
59324
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
59143
59325
|
/**
|
|
59144
|
-
*
|
|
59145
|
-
* @summary
|
|
59146
|
-
* @param {string} xStoreid Store ID
|
|
59147
|
-
* @param {string} xStoresecret Store
|
|
59326
|
+
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
59327
|
+
* @summary Search (GET)
|
|
59328
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59329
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59148
59330
|
* @param {string} q Search query
|
|
59149
59331
|
* @param {string} [xUserId] User ID for personalization
|
|
59150
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59332
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59151
59333
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59152
59334
|
* @param {number} [page] Page number (default: 1)
|
|
59153
59335
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59191,13 +59373,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
59191
59373
|
*/
|
|
59192
59374
|
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
59193
59375
|
/**
|
|
59194
|
-
*
|
|
59195
|
-
* @summary
|
|
59196
|
-
* @param {string} xStoreid Store ID
|
|
59197
|
-
* @param {string} xStoresecret Store
|
|
59198
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
59199
|
-
* @param {string} [xUserId] User ID for personalization
|
|
59200
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59376
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
59377
|
+
* @summary Search (POST)
|
|
59378
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59379
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59380
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59381
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59382
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59201
59383
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59202
59384
|
* @param {*} [options] Override http request option.
|
|
59203
59385
|
* @throws {RequiredError}
|
|
@@ -59270,13 +59452,13 @@ export declare class SearchApi extends BaseAPI {
|
|
|
59270
59452
|
*/
|
|
59271
59453
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
59272
59454
|
/**
|
|
59273
|
-
*
|
|
59274
|
-
* @summary
|
|
59275
|
-
* @param {string} xStoreid Store ID
|
|
59276
|
-
* @param {string} xStoresecret Store
|
|
59455
|
+
* Same as POST search; all parameters are passed as query params. **Authentication:** `x-storeid` and `x-storesecret` headers. Use `q` for the search query; optional params: `page`, `per_page`, `filter_by`, `sort_by`, `facet_by`, `widget_mode`, `include_suggestions`, etc.
|
|
59456
|
+
* @summary Search (GET)
|
|
59457
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59458
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59277
59459
|
* @param {string} q Search query
|
|
59278
59460
|
* @param {string} [xUserId] User ID for personalization
|
|
59279
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59461
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59280
59462
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59281
59463
|
* @param {number} [page] Page number (default: 1)
|
|
59282
59464
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59321,13 +59503,13 @@ export declare class SearchApi extends BaseAPI {
|
|
|
59321
59503
|
*/
|
|
59322
59504
|
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
59323
59505
|
/**
|
|
59324
|
-
*
|
|
59325
|
-
* @summary
|
|
59326
|
-
* @param {string} xStoreid Store ID
|
|
59327
|
-
* @param {string} xStoresecret Store
|
|
59328
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search
|
|
59329
|
-
* @param {string} [xUserId] User ID for personalization
|
|
59330
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59506
|
+
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
59507
|
+
* @summary Search (POST)
|
|
59508
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59509
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59510
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59511
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59512
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59331
59513
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59332
59514
|
* @param {*} [options] Override http request option.
|
|
59333
59515
|
* @throws {RequiredError}
|
|
@@ -63033,71 +63215,72 @@ export declare const UserProfilesApiAxiosParamCreator: (configuration?: Configur
|
|
|
63033
63215
|
/**
|
|
63034
63216
|
* Returns the user profile for an authenticated user token
|
|
63035
63217
|
* @summary Get User Profile by Auth Token
|
|
63218
|
+
* @param {string} xStoreID Store ID
|
|
63036
63219
|
* @param {string} authToken Authenticated user token
|
|
63037
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63038
63220
|
* @param {*} [options] Override http request option.
|
|
63039
63221
|
* @throws {RequiredError}
|
|
63040
63222
|
*/
|
|
63041
|
-
|
|
63223
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet: (xStoreID: string, authToken: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63042
63224
|
/**
|
|
63043
63225
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63044
63226
|
* @summary Merge User Profiles
|
|
63227
|
+
* @param {string} xStoreID Store ID
|
|
63045
63228
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63046
63229
|
* @param {*} [options] Override http request option.
|
|
63047
63230
|
* @throws {RequiredError}
|
|
63048
63231
|
*/
|
|
63049
|
-
|
|
63232
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost: (xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63050
63233
|
/**
|
|
63051
63234
|
* Returns paginated events for a user with optional filtering
|
|
63052
63235
|
* @summary Get User Events
|
|
63236
|
+
* @param {string} xStoreID Store ID
|
|
63053
63237
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63054
63238
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63055
63239
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63056
63240
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63057
63241
|
* @param {number} [page] Page number (default 1)
|
|
63058
63242
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63059
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63060
63243
|
* @param {*} [options] Override http request option.
|
|
63061
63244
|
* @throws {RequiredError}
|
|
63062
63245
|
*/
|
|
63063
|
-
|
|
63246
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet: (xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63064
63247
|
/**
|
|
63065
63248
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63066
63249
|
* @summary Get User Profile
|
|
63250
|
+
* @param {string} xStoreID Store ID
|
|
63067
63251
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63068
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63069
63252
|
* @param {*} [options] Override http request option.
|
|
63070
63253
|
* @throws {RequiredError}
|
|
63071
63254
|
*/
|
|
63072
|
-
|
|
63255
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63073
63256
|
/**
|
|
63074
63257
|
* Returns all data needed for personalizing the user experience
|
|
63075
63258
|
* @summary Get Personalization Context
|
|
63259
|
+
* @param {string} xStoreID Store ID
|
|
63076
63260
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63077
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63078
63261
|
* @param {*} [options] Override http request option.
|
|
63079
63262
|
* @throws {RequiredError}
|
|
63080
63263
|
*/
|
|
63081
|
-
|
|
63264
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63082
63265
|
/**
|
|
63083
63266
|
* Returns the segments a user belongs to based on their behavior
|
|
63084
63267
|
* @summary Get User Segments
|
|
63268
|
+
* @param {string} xStoreID Store ID
|
|
63085
63269
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63086
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63087
63270
|
* @param {*} [options] Override http request option.
|
|
63088
63271
|
* @throws {RequiredError}
|
|
63089
63272
|
*/
|
|
63090
|
-
|
|
63273
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63091
63274
|
/**
|
|
63092
63275
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63093
63276
|
* @summary Get Similar Users
|
|
63277
|
+
* @param {string} xStoreID Store ID
|
|
63094
63278
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63095
63279
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63096
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63097
63280
|
* @param {*} [options] Override http request option.
|
|
63098
63281
|
* @throws {RequiredError}
|
|
63099
63282
|
*/
|
|
63100
|
-
|
|
63283
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet: (xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63101
63284
|
};
|
|
63102
63285
|
/**
|
|
63103
63286
|
* UserProfilesApi - functional programming interface
|
|
@@ -63107,71 +63290,72 @@ export declare const UserProfilesApiFp: (configuration?: Configuration) => {
|
|
|
63107
63290
|
/**
|
|
63108
63291
|
* Returns the user profile for an authenticated user token
|
|
63109
63292
|
* @summary Get User Profile by Auth Token
|
|
63293
|
+
* @param {string} xStoreID Store ID
|
|
63110
63294
|
* @param {string} authToken Authenticated user token
|
|
63111
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63112
63295
|
* @param {*} [options] Override http request option.
|
|
63113
63296
|
* @throws {RequiredError}
|
|
63114
63297
|
*/
|
|
63115
|
-
|
|
63298
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
|
|
63116
63299
|
/**
|
|
63117
63300
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63118
63301
|
* @summary Merge User Profiles
|
|
63302
|
+
* @param {string} xStoreID Store ID
|
|
63119
63303
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63120
63304
|
* @param {*} [options] Override http request option.
|
|
63121
63305
|
* @throws {RequiredError}
|
|
63122
63306
|
*/
|
|
63123
|
-
|
|
63307
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>>;
|
|
63124
63308
|
/**
|
|
63125
63309
|
* Returns paginated events for a user with optional filtering
|
|
63126
63310
|
* @summary Get User Events
|
|
63311
|
+
* @param {string} xStoreID Store ID
|
|
63127
63312
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63128
63313
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63129
63314
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63130
63315
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63131
63316
|
* @param {number} [page] Page number (default 1)
|
|
63132
63317
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63133
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63134
63318
|
* @param {*} [options] Override http request option.
|
|
63135
63319
|
* @throws {RequiredError}
|
|
63136
63320
|
*/
|
|
63137
|
-
|
|
63321
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>>;
|
|
63138
63322
|
/**
|
|
63139
63323
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63140
63324
|
* @summary Get User Profile
|
|
63325
|
+
* @param {string} xStoreID Store ID
|
|
63141
63326
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63142
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63143
63327
|
* @param {*} [options] Override http request option.
|
|
63144
63328
|
* @throws {RequiredError}
|
|
63145
63329
|
*/
|
|
63146
|
-
|
|
63330
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
|
|
63147
63331
|
/**
|
|
63148
63332
|
* Returns all data needed for personalizing the user experience
|
|
63149
63333
|
* @summary Get Personalization Context
|
|
63334
|
+
* @param {string} xStoreID Store ID
|
|
63150
63335
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63151
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63152
63336
|
* @param {*} [options] Override http request option.
|
|
63153
63337
|
* @throws {RequiredError}
|
|
63154
63338
|
*/
|
|
63155
|
-
|
|
63339
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>>;
|
|
63156
63340
|
/**
|
|
63157
63341
|
* Returns the segments a user belongs to based on their behavior
|
|
63158
63342
|
* @summary Get User Segments
|
|
63343
|
+
* @param {string} xStoreID Store ID
|
|
63159
63344
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63160
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63161
63345
|
* @param {*} [options] Override http request option.
|
|
63162
63346
|
* @throws {RequiredError}
|
|
63163
63347
|
*/
|
|
63164
|
-
|
|
63348
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayString>>;
|
|
63165
63349
|
/**
|
|
63166
63350
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63167
63351
|
* @summary Get Similar Users
|
|
63352
|
+
* @param {string} xStoreID Store ID
|
|
63168
63353
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63169
63354
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63170
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63171
63355
|
* @param {*} [options] Override http request option.
|
|
63172
63356
|
* @throws {RequiredError}
|
|
63173
63357
|
*/
|
|
63174
|
-
|
|
63358
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>>;
|
|
63175
63359
|
};
|
|
63176
63360
|
/**
|
|
63177
63361
|
* UserProfilesApi - factory interface
|
|
@@ -63181,71 +63365,72 @@ export declare const UserProfilesApiFactory: (configuration?: Configuration, bas
|
|
|
63181
63365
|
/**
|
|
63182
63366
|
* Returns the user profile for an authenticated user token
|
|
63183
63367
|
* @summary Get User Profile by Auth Token
|
|
63368
|
+
* @param {string} xStoreID Store ID
|
|
63184
63369
|
* @param {string} authToken Authenticated user token
|
|
63185
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63186
63370
|
* @param {*} [options] Override http request option.
|
|
63187
63371
|
* @throws {RequiredError}
|
|
63188
63372
|
*/
|
|
63189
|
-
|
|
63373
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
|
|
63190
63374
|
/**
|
|
63191
63375
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63192
63376
|
* @summary Merge User Profiles
|
|
63377
|
+
* @param {string} xStoreID Store ID
|
|
63193
63378
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63194
63379
|
* @param {*} [options] Override http request option.
|
|
63195
63380
|
* @throws {RequiredError}
|
|
63196
63381
|
*/
|
|
63197
|
-
|
|
63382
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>;
|
|
63198
63383
|
/**
|
|
63199
63384
|
* Returns paginated events for a user with optional filtering
|
|
63200
63385
|
* @summary Get User Events
|
|
63386
|
+
* @param {string} xStoreID Store ID
|
|
63201
63387
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63202
63388
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63203
63389
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63204
63390
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63205
63391
|
* @param {number} [page] Page number (default 1)
|
|
63206
63392
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63207
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63208
63393
|
* @param {*} [options] Override http request option.
|
|
63209
63394
|
* @throws {RequiredError}
|
|
63210
63395
|
*/
|
|
63211
|
-
|
|
63396
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>;
|
|
63212
63397
|
/**
|
|
63213
63398
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63214
63399
|
* @summary Get User Profile
|
|
63400
|
+
* @param {string} xStoreID Store ID
|
|
63215
63401
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63216
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63217
63402
|
* @param {*} [options] Override http request option.
|
|
63218
63403
|
* @throws {RequiredError}
|
|
63219
63404
|
*/
|
|
63220
|
-
|
|
63405
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
|
|
63221
63406
|
/**
|
|
63222
63407
|
* Returns all data needed for personalizing the user experience
|
|
63223
63408
|
* @summary Get Personalization Context
|
|
63409
|
+
* @param {string} xStoreID Store ID
|
|
63224
63410
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63225
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63226
63411
|
* @param {*} [options] Override http request option.
|
|
63227
63412
|
* @throws {RequiredError}
|
|
63228
63413
|
*/
|
|
63229
|
-
|
|
63414
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>;
|
|
63230
63415
|
/**
|
|
63231
63416
|
* Returns the segments a user belongs to based on their behavior
|
|
63232
63417
|
* @summary Get User Segments
|
|
63418
|
+
* @param {string} xStoreID Store ID
|
|
63233
63419
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63234
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63235
63420
|
* @param {*} [options] Override http request option.
|
|
63236
63421
|
* @throws {RequiredError}
|
|
63237
63422
|
*/
|
|
63238
|
-
|
|
63423
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayString>;
|
|
63239
63424
|
/**
|
|
63240
63425
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63241
63426
|
* @summary Get Similar Users
|
|
63427
|
+
* @param {string} xStoreID Store ID
|
|
63242
63428
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63243
63429
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63244
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63245
63430
|
* @param {*} [options] Override http request option.
|
|
63246
63431
|
* @throws {RequiredError}
|
|
63247
63432
|
*/
|
|
63248
|
-
|
|
63433
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>;
|
|
63249
63434
|
};
|
|
63250
63435
|
/**
|
|
63251
63436
|
* UserProfilesApi - object-oriented interface
|
|
@@ -63257,78 +63442,79 @@ export declare class UserProfilesApi extends BaseAPI {
|
|
|
63257
63442
|
/**
|
|
63258
63443
|
* Returns the user profile for an authenticated user token
|
|
63259
63444
|
* @summary Get User Profile by Auth Token
|
|
63445
|
+
* @param {string} xStoreID Store ID
|
|
63260
63446
|
* @param {string} authToken Authenticated user token
|
|
63261
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63262
63447
|
* @param {*} [options] Override http request option.
|
|
63263
63448
|
* @throws {RequiredError}
|
|
63264
63449
|
* @memberof UserProfilesApi
|
|
63265
63450
|
*/
|
|
63266
|
-
|
|
63451
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
|
|
63267
63452
|
/**
|
|
63268
63453
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63269
63454
|
* @summary Merge User Profiles
|
|
63455
|
+
* @param {string} xStoreID Store ID
|
|
63270
63456
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63271
63457
|
* @param {*} [options] Override http request option.
|
|
63272
63458
|
* @throws {RequiredError}
|
|
63273
63459
|
* @memberof UserProfilesApi
|
|
63274
63460
|
*/
|
|
63275
|
-
|
|
63461
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsMergeProfilesResponse, any, {}>>;
|
|
63276
63462
|
/**
|
|
63277
63463
|
* Returns paginated events for a user with optional filtering
|
|
63278
63464
|
* @summary Get User Events
|
|
63465
|
+
* @param {string} xStoreID Store ID
|
|
63279
63466
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63280
63467
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63281
63468
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63282
63469
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63283
63470
|
* @param {number} [page] Page number (default 1)
|
|
63284
63471
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63285
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63286
63472
|
* @param {*} [options] Override http request option.
|
|
63287
63473
|
* @throws {RequiredError}
|
|
63288
63474
|
* @memberof UserProfilesApi
|
|
63289
63475
|
*/
|
|
63290
|
-
|
|
63476
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserEventsResponse, any, {}>>;
|
|
63291
63477
|
/**
|
|
63292
63478
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63293
63479
|
* @summary Get User Profile
|
|
63480
|
+
* @param {string} xStoreID Store ID
|
|
63294
63481
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63295
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63296
63482
|
* @param {*} [options] Override http request option.
|
|
63297
63483
|
* @throws {RequiredError}
|
|
63298
63484
|
* @memberof UserProfilesApi
|
|
63299
63485
|
*/
|
|
63300
|
-
|
|
63486
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
|
|
63301
63487
|
/**
|
|
63302
63488
|
* Returns all data needed for personalizing the user experience
|
|
63303
63489
|
* @summary Get Personalization Context
|
|
63490
|
+
* @param {string} xStoreID Store ID
|
|
63304
63491
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63305
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63306
63492
|
* @param {*} [options] Override http request option.
|
|
63307
63493
|
* @throws {RequiredError}
|
|
63308
63494
|
* @memberof UserProfilesApi
|
|
63309
63495
|
*/
|
|
63310
|
-
|
|
63496
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsPersonalizationContext, any, {}>>;
|
|
63311
63497
|
/**
|
|
63312
63498
|
* Returns the segments a user belongs to based on their behavior
|
|
63313
63499
|
* @summary Get User Segments
|
|
63500
|
+
* @param {string} xStoreID Store ID
|
|
63314
63501
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63315
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63316
63502
|
* @param {*} [options] Override http request option.
|
|
63317
63503
|
* @throws {RequiredError}
|
|
63318
63504
|
* @memberof UserProfilesApi
|
|
63319
63505
|
*/
|
|
63320
|
-
|
|
63506
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
|
|
63321
63507
|
/**
|
|
63322
63508
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63323
63509
|
* @summary Get Similar Users
|
|
63510
|
+
* @param {string} xStoreID Store ID
|
|
63324
63511
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63325
63512
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63326
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63327
63513
|
* @param {*} [options] Override http request option.
|
|
63328
63514
|
* @throws {RequiredError}
|
|
63329
63515
|
* @memberof UserProfilesApi
|
|
63330
63516
|
*/
|
|
63331
|
-
|
|
63517
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayModelsSimilarUser, any, {}>>;
|
|
63332
63518
|
}
|
|
63333
63519
|
/**
|
|
63334
63520
|
* WebhooksApi - axios parameter creator
|