@seekora-ai/admin-api 1.1.81 → 1.1.83
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 +78 -53
- package/api.ts +2111 -1037
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1684 -792
- package/dist/api.js +1306 -999
- 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 +1684 -792
- package/dist/esm/api.js +1306 -999
- 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.83.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
|
*
|
|
@@ -12467,7 +12461,6 @@ export interface DataTypesBillingAlertRequest {
|
|
|
12467
12461
|
}
|
|
12468
12462
|
export declare const DataTypesBillingAlertRequestAlertTypeEnum: {
|
|
12469
12463
|
readonly LowBalance: "low_balance";
|
|
12470
|
-
readonly ExpiringCredits: "expiring_credits";
|
|
12471
12464
|
readonly DaysRemaining: "days_remaining";
|
|
12472
12465
|
};
|
|
12473
12466
|
export type DataTypesBillingAlertRequestAlertTypeEnum = typeof DataTypesBillingAlertRequestAlertTypeEnum[keyof typeof DataTypesBillingAlertRequestAlertTypeEnum];
|
|
@@ -12532,6 +12525,86 @@ export interface DataTypesBillingOrderDetailsResponse {
|
|
|
12532
12525
|
*/
|
|
12533
12526
|
'transactions'?: Array<DataTypesOrderTransactionDisplay>;
|
|
12534
12527
|
}
|
|
12528
|
+
/**
|
|
12529
|
+
*
|
|
12530
|
+
* @export
|
|
12531
|
+
* @interface DataTypesBillingOverviewNewResponse
|
|
12532
|
+
*/
|
|
12533
|
+
export interface DataTypesBillingOverviewNewResponse {
|
|
12534
|
+
/**
|
|
12535
|
+
* Credit balance information
|
|
12536
|
+
* @type {DataTypesCreditBalanceInfo}
|
|
12537
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12538
|
+
*/
|
|
12539
|
+
'credit_balance'?: DataTypesCreditBalanceInfo;
|
|
12540
|
+
/**
|
|
12541
|
+
*
|
|
12542
|
+
* @type {string}
|
|
12543
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12544
|
+
*/
|
|
12545
|
+
'currency'?: string;
|
|
12546
|
+
/**
|
|
12547
|
+
* Current plan information
|
|
12548
|
+
* @type {DataTypesCurrentPlanInfo}
|
|
12549
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12550
|
+
*/
|
|
12551
|
+
'current_plan'?: DataTypesCurrentPlanInfo;
|
|
12552
|
+
/**
|
|
12553
|
+
* Next charge information (for subscriptions)
|
|
12554
|
+
* @type {DataTypesNextChargeInfo}
|
|
12555
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12556
|
+
*/
|
|
12557
|
+
'next_charge'?: DataTypesNextChargeInfo;
|
|
12558
|
+
/**
|
|
12559
|
+
* Projected runout information
|
|
12560
|
+
* @type {DataTypesProjectedRunoutInfo}
|
|
12561
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12562
|
+
*/
|
|
12563
|
+
'projected_runout'?: DataTypesProjectedRunoutInfo;
|
|
12564
|
+
/**
|
|
12565
|
+
* Total spent
|
|
12566
|
+
* @type {number}
|
|
12567
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12568
|
+
*/
|
|
12569
|
+
'total_spent'?: number;
|
|
12570
|
+
/**
|
|
12571
|
+
* Detailed usage metrics for ALL consumables
|
|
12572
|
+
* @type {DataTypesDetailedUsageMetrics}
|
|
12573
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12574
|
+
*/
|
|
12575
|
+
'usage_metrics'?: DataTypesDetailedUsageMetrics;
|
|
12576
|
+
/**
|
|
12577
|
+
* Usage summary for current period
|
|
12578
|
+
* @type {DataTypesUsageSummary}
|
|
12579
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12580
|
+
*/
|
|
12581
|
+
'usage_summary'?: DataTypesUsageSummary;
|
|
12582
|
+
}
|
|
12583
|
+
/**
|
|
12584
|
+
*
|
|
12585
|
+
* @export
|
|
12586
|
+
* @interface DataTypesBooleanFeatureMetric
|
|
12587
|
+
*/
|
|
12588
|
+
export interface DataTypesBooleanFeatureMetric {
|
|
12589
|
+
/**
|
|
12590
|
+
*
|
|
12591
|
+
* @type {string}
|
|
12592
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12593
|
+
*/
|
|
12594
|
+
'display_label'?: string;
|
|
12595
|
+
/**
|
|
12596
|
+
*
|
|
12597
|
+
* @type {boolean}
|
|
12598
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12599
|
+
*/
|
|
12600
|
+
'enabled'?: boolean;
|
|
12601
|
+
/**
|
|
12602
|
+
*
|
|
12603
|
+
* @type {string}
|
|
12604
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12605
|
+
*/
|
|
12606
|
+
'feature_name'?: string;
|
|
12607
|
+
}
|
|
12535
12608
|
/**
|
|
12536
12609
|
*
|
|
12537
12610
|
* @export
|
|
@@ -13362,6 +13435,129 @@ export interface DataTypesConfigurationSchemaResponseWrapper {
|
|
|
13362
13435
|
*/
|
|
13363
13436
|
'status'?: number;
|
|
13364
13437
|
}
|
|
13438
|
+
/**
|
|
13439
|
+
*
|
|
13440
|
+
* @export
|
|
13441
|
+
* @interface DataTypesConsumableMetric
|
|
13442
|
+
*/
|
|
13443
|
+
export interface DataTypesConsumableMetric {
|
|
13444
|
+
/**
|
|
13445
|
+
*
|
|
13446
|
+
* @type {number}
|
|
13447
|
+
* @memberof DataTypesConsumableMetric
|
|
13448
|
+
*/
|
|
13449
|
+
'current_usage'?: number;
|
|
13450
|
+
/**
|
|
13451
|
+
*
|
|
13452
|
+
* @type {string}
|
|
13453
|
+
* @memberof DataTypesConsumableMetric
|
|
13454
|
+
*/
|
|
13455
|
+
'description'?: string;
|
|
13456
|
+
/**
|
|
13457
|
+
*
|
|
13458
|
+
* @type {string}
|
|
13459
|
+
* @memberof DataTypesConsumableMetric
|
|
13460
|
+
*/
|
|
13461
|
+
'display_label'?: string;
|
|
13462
|
+
/**
|
|
13463
|
+
*
|
|
13464
|
+
* @type {string}
|
|
13465
|
+
* @memberof DataTypesConsumableMetric
|
|
13466
|
+
*/
|
|
13467
|
+
'feature_name'?: string;
|
|
13468
|
+
/**
|
|
13469
|
+
*
|
|
13470
|
+
* @type {boolean}
|
|
13471
|
+
* @memberof DataTypesConsumableMetric
|
|
13472
|
+
*/
|
|
13473
|
+
'is_unlimited'?: boolean;
|
|
13474
|
+
/**
|
|
13475
|
+
*
|
|
13476
|
+
* @type {number}
|
|
13477
|
+
* @memberof DataTypesConsumableMetric
|
|
13478
|
+
*/
|
|
13479
|
+
'limit'?: number;
|
|
13480
|
+
/**
|
|
13481
|
+
*
|
|
13482
|
+
* @type {string}
|
|
13483
|
+
* @memberof DataTypesConsumableMetric
|
|
13484
|
+
*/
|
|
13485
|
+
'next_reset'?: string;
|
|
13486
|
+
/**
|
|
13487
|
+
*
|
|
13488
|
+
* @type {number}
|
|
13489
|
+
* @memberof DataTypesConsumableMetric
|
|
13490
|
+
*/
|
|
13491
|
+
'remaining'?: number;
|
|
13492
|
+
/**
|
|
13493
|
+
* \"monthly\", \"never\", etc.
|
|
13494
|
+
* @type {string}
|
|
13495
|
+
* @memberof DataTypesConsumableMetric
|
|
13496
|
+
*/
|
|
13497
|
+
'reset_period'?: string;
|
|
13498
|
+
/**
|
|
13499
|
+
*
|
|
13500
|
+
* @type {number}
|
|
13501
|
+
* @memberof DataTypesConsumableMetric
|
|
13502
|
+
*/
|
|
13503
|
+
'usage_percentage'?: number;
|
|
13504
|
+
/**
|
|
13505
|
+
* \"normal\", \"warning\", \"critical\"
|
|
13506
|
+
* @type {string}
|
|
13507
|
+
* @memberof DataTypesConsumableMetric
|
|
13508
|
+
*/
|
|
13509
|
+
'warning_level'?: string;
|
|
13510
|
+
}
|
|
13511
|
+
/**
|
|
13512
|
+
*
|
|
13513
|
+
* @export
|
|
13514
|
+
* @interface DataTypesConsumptionHistoryResponse
|
|
13515
|
+
*/
|
|
13516
|
+
export interface DataTypesConsumptionHistoryResponse {
|
|
13517
|
+
/**
|
|
13518
|
+
*
|
|
13519
|
+
* @type {Array<DataTypesCreditConsumption>}
|
|
13520
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13521
|
+
*/
|
|
13522
|
+
'consumptions'?: Array<DataTypesCreditConsumption>;
|
|
13523
|
+
/**
|
|
13524
|
+
*
|
|
13525
|
+
* @type {DataTypesPaginationInfo}
|
|
13526
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13527
|
+
*/
|
|
13528
|
+
'pagination'?: DataTypesPaginationInfo;
|
|
13529
|
+
/**
|
|
13530
|
+
*
|
|
13531
|
+
* @type {DataTypesConsumptionSummary}
|
|
13532
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13533
|
+
*/
|
|
13534
|
+
'summary'?: DataTypesConsumptionSummary;
|
|
13535
|
+
}
|
|
13536
|
+
/**
|
|
13537
|
+
*
|
|
13538
|
+
* @export
|
|
13539
|
+
* @interface DataTypesConsumptionSummary
|
|
13540
|
+
*/
|
|
13541
|
+
export interface DataTypesConsumptionSummary {
|
|
13542
|
+
/**
|
|
13543
|
+
*
|
|
13544
|
+
* @type {number}
|
|
13545
|
+
* @memberof DataTypesConsumptionSummary
|
|
13546
|
+
*/
|
|
13547
|
+
'total_consumptions'?: number;
|
|
13548
|
+
/**
|
|
13549
|
+
*
|
|
13550
|
+
* @type {number}
|
|
13551
|
+
* @memberof DataTypesConsumptionSummary
|
|
13552
|
+
*/
|
|
13553
|
+
'total_credits_used'?: number;
|
|
13554
|
+
/**
|
|
13555
|
+
*
|
|
13556
|
+
* @type {number}
|
|
13557
|
+
* @memberof DataTypesConsumptionSummary
|
|
13558
|
+
*/
|
|
13559
|
+
'unique_endpoints'?: number;
|
|
13560
|
+
}
|
|
13365
13561
|
/**
|
|
13366
13562
|
* Request payload for creating a new analytics rule
|
|
13367
13563
|
* @export
|
|
@@ -14640,6 +14836,142 @@ export interface DataTypesCreditAdjustmentDto {
|
|
|
14640
14836
|
*/
|
|
14641
14837
|
'status'?: string;
|
|
14642
14838
|
}
|
|
14839
|
+
/**
|
|
14840
|
+
*
|
|
14841
|
+
* @export
|
|
14842
|
+
* @interface DataTypesCreditBalanceInfo
|
|
14843
|
+
*/
|
|
14844
|
+
export interface DataTypesCreditBalanceInfo {
|
|
14845
|
+
/**
|
|
14846
|
+
*
|
|
14847
|
+
* @type {number}
|
|
14848
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14849
|
+
*/
|
|
14850
|
+
'subscription_credits_available'?: number;
|
|
14851
|
+
/**
|
|
14852
|
+
*
|
|
14853
|
+
* @type {number}
|
|
14854
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14855
|
+
*/
|
|
14856
|
+
'subscription_credits_consumed'?: number;
|
|
14857
|
+
/**
|
|
14858
|
+
*
|
|
14859
|
+
* @type {number}
|
|
14860
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14861
|
+
*/
|
|
14862
|
+
'subscription_credits_total'?: number;
|
|
14863
|
+
/**
|
|
14864
|
+
*
|
|
14865
|
+
* @type {number}
|
|
14866
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14867
|
+
*/
|
|
14868
|
+
'topup_credits_available'?: number;
|
|
14869
|
+
/**
|
|
14870
|
+
*
|
|
14871
|
+
* @type {number}
|
|
14872
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14873
|
+
*/
|
|
14874
|
+
'topup_credits_consumed'?: number;
|
|
14875
|
+
/**
|
|
14876
|
+
*
|
|
14877
|
+
* @type {number}
|
|
14878
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14879
|
+
*/
|
|
14880
|
+
'topup_credits_total'?: number;
|
|
14881
|
+
/**
|
|
14882
|
+
*
|
|
14883
|
+
* @type {number}
|
|
14884
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14885
|
+
*/
|
|
14886
|
+
'total_consumed_this_cycle'?: number;
|
|
14887
|
+
/**
|
|
14888
|
+
*
|
|
14889
|
+
* @type {number}
|
|
14890
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14891
|
+
*/
|
|
14892
|
+
'total_credits'?: number;
|
|
14893
|
+
}
|
|
14894
|
+
/**
|
|
14895
|
+
*
|
|
14896
|
+
* @export
|
|
14897
|
+
* @interface DataTypesCreditConsumption
|
|
14898
|
+
*/
|
|
14899
|
+
export interface DataTypesCreditConsumption {
|
|
14900
|
+
/**
|
|
14901
|
+
*
|
|
14902
|
+
* @type {string}
|
|
14903
|
+
* @memberof DataTypesCreditConsumption
|
|
14904
|
+
*/
|
|
14905
|
+
'api_endpoint'?: string;
|
|
14906
|
+
/**
|
|
14907
|
+
*
|
|
14908
|
+
* @type {string}
|
|
14909
|
+
* @memberof DataTypesCreditConsumption
|
|
14910
|
+
*/
|
|
14911
|
+
'consumed_at'?: string;
|
|
14912
|
+
/**
|
|
14913
|
+
*
|
|
14914
|
+
* @type {number}
|
|
14915
|
+
* @memberof DataTypesCreditConsumption
|
|
14916
|
+
*/
|
|
14917
|
+
'consumption_id'?: number;
|
|
14918
|
+
/**
|
|
14919
|
+
*
|
|
14920
|
+
* @type {string}
|
|
14921
|
+
* @memberof DataTypesCreditConsumption
|
|
14922
|
+
*/
|
|
14923
|
+
'credit_source'?: string;
|
|
14924
|
+
/**
|
|
14925
|
+
*
|
|
14926
|
+
* @type {number}
|
|
14927
|
+
* @memberof DataTypesCreditConsumption
|
|
14928
|
+
*/
|
|
14929
|
+
'credits_consumed'?: number;
|
|
14930
|
+
/**
|
|
14931
|
+
*
|
|
14932
|
+
* @type {number}
|
|
14933
|
+
* @memberof DataTypesCreditConsumption
|
|
14934
|
+
*/
|
|
14935
|
+
'execution_time_ms'?: number;
|
|
14936
|
+
/**
|
|
14937
|
+
*
|
|
14938
|
+
* @type {{ [key: string]: any; }}
|
|
14939
|
+
* @memberof DataTypesCreditConsumption
|
|
14940
|
+
*/
|
|
14941
|
+
'fifo_details'?: {
|
|
14942
|
+
[key: string]: any;
|
|
14943
|
+
};
|
|
14944
|
+
/**
|
|
14945
|
+
*
|
|
14946
|
+
* @type {string}
|
|
14947
|
+
* @memberof DataTypesCreditConsumption
|
|
14948
|
+
*/
|
|
14949
|
+
'http_method'?: string;
|
|
14950
|
+
/**
|
|
14951
|
+
*
|
|
14952
|
+
* @type {number}
|
|
14953
|
+
* @memberof DataTypesCreditConsumption
|
|
14954
|
+
*/
|
|
14955
|
+
'org_id'?: number;
|
|
14956
|
+
/**
|
|
14957
|
+
*
|
|
14958
|
+
* @type {string}
|
|
14959
|
+
* @memberof DataTypesCreditConsumption
|
|
14960
|
+
*/
|
|
14961
|
+
'request_id'?: string;
|
|
14962
|
+
/**
|
|
14963
|
+
*
|
|
14964
|
+
* @type {number}
|
|
14965
|
+
* @memberof DataTypesCreditConsumption
|
|
14966
|
+
*/
|
|
14967
|
+
'response_status'?: number;
|
|
14968
|
+
/**
|
|
14969
|
+
*
|
|
14970
|
+
* @type {number}
|
|
14971
|
+
* @memberof DataTypesCreditConsumption
|
|
14972
|
+
*/
|
|
14973
|
+
'store_id'?: number;
|
|
14974
|
+
}
|
|
14643
14975
|
/**
|
|
14644
14976
|
*
|
|
14645
14977
|
* @export
|
|
@@ -14739,7 +15071,7 @@ export interface DataTypesCreditPlan {
|
|
|
14739
15071
|
*/
|
|
14740
15072
|
'price': number;
|
|
14741
15073
|
/**
|
|
14742
|
-
*
|
|
15074
|
+
* Deprecated: kept for DB compat, ignored
|
|
14743
15075
|
* @type {number}
|
|
14744
15076
|
* @memberof DataTypesCreditPlan
|
|
14745
15077
|
*/
|
|
@@ -15383,6 +15715,139 @@ export interface DataTypesDefaultMenu {
|
|
|
15383
15715
|
*/
|
|
15384
15716
|
'sortOrder'?: number;
|
|
15385
15717
|
}
|
|
15718
|
+
/**
|
|
15719
|
+
*
|
|
15720
|
+
* @export
|
|
15721
|
+
* @interface DataTypesDetailedUsageMetrics
|
|
15722
|
+
*/
|
|
15723
|
+
export interface DataTypesDetailedUsageMetrics {
|
|
15724
|
+
/**
|
|
15725
|
+
* Analytics
|
|
15726
|
+
* @type {DataTypesConsumableMetric}
|
|
15727
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15728
|
+
*/
|
|
15729
|
+
'analytics_events'?: DataTypesConsumableMetric;
|
|
15730
|
+
/**
|
|
15731
|
+
*
|
|
15732
|
+
* @type {DataTypesConsumableMetric}
|
|
15733
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15734
|
+
*/
|
|
15735
|
+
'analytics_events_total'?: DataTypesConsumableMetric;
|
|
15736
|
+
/**
|
|
15737
|
+
*
|
|
15738
|
+
* @type {DataTypesConsumableMetric}
|
|
15739
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15740
|
+
*/
|
|
15741
|
+
'analytics_history'?: DataTypesConsumableMetric;
|
|
15742
|
+
/**
|
|
15743
|
+
*
|
|
15744
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15745
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15746
|
+
*/
|
|
15747
|
+
'api_access'?: DataTypesBooleanFeatureMetric;
|
|
15748
|
+
/**
|
|
15749
|
+
*
|
|
15750
|
+
* @type {DataTypesConsumableMetric}
|
|
15751
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15752
|
+
*/
|
|
15753
|
+
'api_calls'?: DataTypesConsumableMetric;
|
|
15754
|
+
/**
|
|
15755
|
+
* Credits and API
|
|
15756
|
+
* @type {DataTypesConsumableMetric}
|
|
15757
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15758
|
+
*/
|
|
15759
|
+
'credits'?: DataTypesConsumableMetric;
|
|
15760
|
+
/**
|
|
15761
|
+
*
|
|
15762
|
+
* @type {DataTypesConsumableMetric}
|
|
15763
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15764
|
+
*/
|
|
15765
|
+
'credits_used'?: DataTypesConsumableMetric;
|
|
15766
|
+
/**
|
|
15767
|
+
* Boolean features
|
|
15768
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15769
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15770
|
+
*/
|
|
15771
|
+
'custom_domain'?: DataTypesBooleanFeatureMetric;
|
|
15772
|
+
/**
|
|
15773
|
+
*
|
|
15774
|
+
* @type {DataTypesConsumableMetric}
|
|
15775
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15776
|
+
*/
|
|
15777
|
+
'query_suggestions'?: DataTypesConsumableMetric;
|
|
15778
|
+
/**
|
|
15779
|
+
*
|
|
15780
|
+
* @type {DataTypesConsumableMetric}
|
|
15781
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15782
|
+
*/
|
|
15783
|
+
'record_size'?: DataTypesConsumableMetric;
|
|
15784
|
+
/**
|
|
15785
|
+
* Records/Documents
|
|
15786
|
+
* @type {DataTypesConsumableMetric}
|
|
15787
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15788
|
+
*/
|
|
15789
|
+
'records'?: DataTypesConsumableMetric;
|
|
15790
|
+
/**
|
|
15791
|
+
*
|
|
15792
|
+
* @type {DataTypesStringFeatureMetric}
|
|
15793
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15794
|
+
*/
|
|
15795
|
+
'reports'?: DataTypesStringFeatureMetric;
|
|
15796
|
+
/**
|
|
15797
|
+
*
|
|
15798
|
+
* @type {DataTypesConsumableMetric}
|
|
15799
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15800
|
+
*/
|
|
15801
|
+
'rules'?: DataTypesConsumableMetric;
|
|
15802
|
+
/**
|
|
15803
|
+
* Search features
|
|
15804
|
+
* @type {DataTypesConsumableMetric}
|
|
15805
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15806
|
+
*/
|
|
15807
|
+
'search_requests'?: DataTypesConsumableMetric;
|
|
15808
|
+
/**
|
|
15809
|
+
*
|
|
15810
|
+
* @type {DataTypesConsumableMetric}
|
|
15811
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15812
|
+
*/
|
|
15813
|
+
'stopwords'?: DataTypesConsumableMetric;
|
|
15814
|
+
/**
|
|
15815
|
+
* Store-related
|
|
15816
|
+
* @type {DataTypesConsumableMetric}
|
|
15817
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15818
|
+
*/
|
|
15819
|
+
'stores'?: DataTypesConsumableMetric;
|
|
15820
|
+
/**
|
|
15821
|
+
* String features
|
|
15822
|
+
* @type {DataTypesStringFeatureMetric}
|
|
15823
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15824
|
+
*/
|
|
15825
|
+
'support_level'?: DataTypesStringFeatureMetric;
|
|
15826
|
+
/**
|
|
15827
|
+
*
|
|
15828
|
+
* @type {DataTypesConsumableMetric}
|
|
15829
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15830
|
+
*/
|
|
15831
|
+
'synonyms'?: DataTypesConsumableMetric;
|
|
15832
|
+
/**
|
|
15833
|
+
* Team
|
|
15834
|
+
* @type {DataTypesConsumableMetric}
|
|
15835
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15836
|
+
*/
|
|
15837
|
+
'team_members'?: DataTypesConsumableMetric;
|
|
15838
|
+
/**
|
|
15839
|
+
*
|
|
15840
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15841
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15842
|
+
*/
|
|
15843
|
+
'webhooks'?: DataTypesBooleanFeatureMetric;
|
|
15844
|
+
/**
|
|
15845
|
+
*
|
|
15846
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15847
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15848
|
+
*/
|
|
15849
|
+
'white_labeling'?: DataTypesBooleanFeatureMetric;
|
|
15850
|
+
}
|
|
15386
15851
|
/**
|
|
15387
15852
|
*
|
|
15388
15853
|
* @export
|
|
@@ -18067,6 +18532,56 @@ export interface DataTypesGenericResponseDataTypesBillingOrderDetailsResponse {
|
|
|
18067
18532
|
*/
|
|
18068
18533
|
'status'?: number;
|
|
18069
18534
|
}
|
|
18535
|
+
/**
|
|
18536
|
+
*
|
|
18537
|
+
* @export
|
|
18538
|
+
* @interface DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18539
|
+
*/
|
|
18540
|
+
export interface DataTypesGenericResponseDataTypesBillingOverviewNewResponse {
|
|
18541
|
+
/**
|
|
18542
|
+
*
|
|
18543
|
+
* @type {DataTypesBillingOverviewNewResponse}
|
|
18544
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18545
|
+
*/
|
|
18546
|
+
'data'?: DataTypesBillingOverviewNewResponse;
|
|
18547
|
+
/**
|
|
18548
|
+
*
|
|
18549
|
+
* @type {string}
|
|
18550
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18551
|
+
*/
|
|
18552
|
+
'message'?: string;
|
|
18553
|
+
/**
|
|
18554
|
+
*
|
|
18555
|
+
* @type {number}
|
|
18556
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18557
|
+
*/
|
|
18558
|
+
'status'?: number;
|
|
18559
|
+
}
|
|
18560
|
+
/**
|
|
18561
|
+
*
|
|
18562
|
+
* @export
|
|
18563
|
+
* @interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18564
|
+
*/
|
|
18565
|
+
export interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse {
|
|
18566
|
+
/**
|
|
18567
|
+
*
|
|
18568
|
+
* @type {DataTypesConsumptionHistoryResponse}
|
|
18569
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18570
|
+
*/
|
|
18571
|
+
'data'?: DataTypesConsumptionHistoryResponse;
|
|
18572
|
+
/**
|
|
18573
|
+
*
|
|
18574
|
+
* @type {string}
|
|
18575
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18576
|
+
*/
|
|
18577
|
+
'message'?: string;
|
|
18578
|
+
/**
|
|
18579
|
+
*
|
|
18580
|
+
* @type {number}
|
|
18581
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18582
|
+
*/
|
|
18583
|
+
'status'?: number;
|
|
18584
|
+
}
|
|
18070
18585
|
/**
|
|
18071
18586
|
*
|
|
18072
18587
|
* @export
|
|
@@ -21569,6 +22084,43 @@ export interface DataTypesNewsLetterRequestsListResponse {
|
|
|
21569
22084
|
*/
|
|
21570
22085
|
'status'?: number;
|
|
21571
22086
|
}
|
|
22087
|
+
/**
|
|
22088
|
+
*
|
|
22089
|
+
* @export
|
|
22090
|
+
* @interface DataTypesNextChargeInfo
|
|
22091
|
+
*/
|
|
22092
|
+
export interface DataTypesNextChargeInfo {
|
|
22093
|
+
/**
|
|
22094
|
+
*
|
|
22095
|
+
* @type {number}
|
|
22096
|
+
* @memberof DataTypesNextChargeInfo
|
|
22097
|
+
*/
|
|
22098
|
+
'amount'?: number;
|
|
22099
|
+
/**
|
|
22100
|
+
*
|
|
22101
|
+
* @type {string}
|
|
22102
|
+
* @memberof DataTypesNextChargeInfo
|
|
22103
|
+
*/
|
|
22104
|
+
'charge_date'?: string;
|
|
22105
|
+
/**
|
|
22106
|
+
*
|
|
22107
|
+
* @type {string}
|
|
22108
|
+
* @memberof DataTypesNextChargeInfo
|
|
22109
|
+
*/
|
|
22110
|
+
'currency'?: string;
|
|
22111
|
+
/**
|
|
22112
|
+
*
|
|
22113
|
+
* @type {string}
|
|
22114
|
+
* @memberof DataTypesNextChargeInfo
|
|
22115
|
+
*/
|
|
22116
|
+
'description'?: string;
|
|
22117
|
+
/**
|
|
22118
|
+
*
|
|
22119
|
+
* @type {number}
|
|
22120
|
+
* @memberof DataTypesNextChargeInfo
|
|
22121
|
+
*/
|
|
22122
|
+
'subscription_id'?: number;
|
|
22123
|
+
}
|
|
21572
22124
|
/**
|
|
21573
22125
|
*
|
|
21574
22126
|
* @export
|
|
@@ -24126,6 +24678,37 @@ export interface DataTypesOverrideActions {
|
|
|
24126
24678
|
*/
|
|
24127
24679
|
'stop_processing'?: boolean;
|
|
24128
24680
|
}
|
|
24681
|
+
/**
|
|
24682
|
+
*
|
|
24683
|
+
* @export
|
|
24684
|
+
* @interface DataTypesPaginationInfo
|
|
24685
|
+
*/
|
|
24686
|
+
export interface DataTypesPaginationInfo {
|
|
24687
|
+
/**
|
|
24688
|
+
*
|
|
24689
|
+
* @type {number}
|
|
24690
|
+
* @memberof DataTypesPaginationInfo
|
|
24691
|
+
*/
|
|
24692
|
+
'limit'?: number;
|
|
24693
|
+
/**
|
|
24694
|
+
*
|
|
24695
|
+
* @type {number}
|
|
24696
|
+
* @memberof DataTypesPaginationInfo
|
|
24697
|
+
*/
|
|
24698
|
+
'page'?: number;
|
|
24699
|
+
/**
|
|
24700
|
+
*
|
|
24701
|
+
* @type {number}
|
|
24702
|
+
* @memberof DataTypesPaginationInfo
|
|
24703
|
+
*/
|
|
24704
|
+
'total'?: number;
|
|
24705
|
+
/**
|
|
24706
|
+
*
|
|
24707
|
+
* @type {number}
|
|
24708
|
+
* @memberof DataTypesPaginationInfo
|
|
24709
|
+
*/
|
|
24710
|
+
'total_pages'?: number;
|
|
24711
|
+
}
|
|
24129
24712
|
/**
|
|
24130
24713
|
*
|
|
24131
24714
|
* @export
|
|
@@ -25142,6 +25725,37 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
25142
25725
|
*/
|
|
25143
25726
|
'status'?: number;
|
|
25144
25727
|
}
|
|
25728
|
+
/**
|
|
25729
|
+
*
|
|
25730
|
+
* @export
|
|
25731
|
+
* @interface DataTypesProjectedRunoutInfo
|
|
25732
|
+
*/
|
|
25733
|
+
export interface DataTypesProjectedRunoutInfo {
|
|
25734
|
+
/**
|
|
25735
|
+
*
|
|
25736
|
+
* @type {number}
|
|
25737
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25738
|
+
*/
|
|
25739
|
+
'average_daily_consumption'?: number;
|
|
25740
|
+
/**
|
|
25741
|
+
*
|
|
25742
|
+
* @type {number}
|
|
25743
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25744
|
+
*/
|
|
25745
|
+
'days_remaining'?: number;
|
|
25746
|
+
/**
|
|
25747
|
+
*
|
|
25748
|
+
* @type {string}
|
|
25749
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25750
|
+
*/
|
|
25751
|
+
'projected_runout_date'?: string;
|
|
25752
|
+
/**
|
|
25753
|
+
* \"normal\", \"warning\", \"critical\"
|
|
25754
|
+
* @type {string}
|
|
25755
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25756
|
+
*/
|
|
25757
|
+
'warning_level'?: string;
|
|
25758
|
+
}
|
|
25145
25759
|
/**
|
|
25146
25760
|
*
|
|
25147
25761
|
* @export
|
|
@@ -28761,6 +29375,31 @@ export interface DataTypesStoresListResponse {
|
|
|
28761
29375
|
*/
|
|
28762
29376
|
'status'?: number;
|
|
28763
29377
|
}
|
|
29378
|
+
/**
|
|
29379
|
+
*
|
|
29380
|
+
* @export
|
|
29381
|
+
* @interface DataTypesStringFeatureMetric
|
|
29382
|
+
*/
|
|
29383
|
+
export interface DataTypesStringFeatureMetric {
|
|
29384
|
+
/**
|
|
29385
|
+
*
|
|
29386
|
+
* @type {string}
|
|
29387
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29388
|
+
*/
|
|
29389
|
+
'display_label'?: string;
|
|
29390
|
+
/**
|
|
29391
|
+
*
|
|
29392
|
+
* @type {string}
|
|
29393
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29394
|
+
*/
|
|
29395
|
+
'feature_name'?: string;
|
|
29396
|
+
/**
|
|
29397
|
+
*
|
|
29398
|
+
* @type {string}
|
|
29399
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29400
|
+
*/
|
|
29401
|
+
'value'?: string;
|
|
29402
|
+
}
|
|
28764
29403
|
/**
|
|
28765
29404
|
*
|
|
28766
29405
|
* @export
|
|
@@ -31000,6 +31639,43 @@ export interface DataTypesUsageBreakdownRow {
|
|
|
31000
31639
|
*/
|
|
31001
31640
|
'timestamp'?: string;
|
|
31002
31641
|
}
|
|
31642
|
+
/**
|
|
31643
|
+
*
|
|
31644
|
+
* @export
|
|
31645
|
+
* @interface DataTypesUsageSummary
|
|
31646
|
+
*/
|
|
31647
|
+
export interface DataTypesUsageSummary {
|
|
31648
|
+
/**
|
|
31649
|
+
* \"This month\", \"Last 30 days\", etc.
|
|
31650
|
+
* @type {string}
|
|
31651
|
+
* @memberof DataTypesUsageSummary
|
|
31652
|
+
*/
|
|
31653
|
+
'period'?: string;
|
|
31654
|
+
/**
|
|
31655
|
+
*
|
|
31656
|
+
* @type {number}
|
|
31657
|
+
* @memberof DataTypesUsageSummary
|
|
31658
|
+
*/
|
|
31659
|
+
'records'?: number;
|
|
31660
|
+
/**
|
|
31661
|
+
*
|
|
31662
|
+
* @type {number}
|
|
31663
|
+
* @memberof DataTypesUsageSummary
|
|
31664
|
+
*/
|
|
31665
|
+
'search_requests'?: number;
|
|
31666
|
+
/**
|
|
31667
|
+
*
|
|
31668
|
+
* @type {number}
|
|
31669
|
+
* @memberof DataTypesUsageSummary
|
|
31670
|
+
*/
|
|
31671
|
+
'store_count'?: number;
|
|
31672
|
+
/**
|
|
31673
|
+
*
|
|
31674
|
+
* @type {number}
|
|
31675
|
+
* @memberof DataTypesUsageSummary
|
|
31676
|
+
*/
|
|
31677
|
+
'total_credits_used'?: number;
|
|
31678
|
+
}
|
|
31003
31679
|
/**
|
|
31004
31680
|
*
|
|
31005
31681
|
* @export
|
|
@@ -32221,43 +32897,67 @@ export interface FeatureLimitServiceAPICallStatus {
|
|
|
32221
32897
|
*/
|
|
32222
32898
|
export interface FeatureLimitServiceCreditStatus {
|
|
32223
32899
|
/**
|
|
32224
|
-
*
|
|
32900
|
+
* Remaining in THIS cycle (total - consumed_this_cycle)
|
|
32225
32901
|
* @type {number}
|
|
32226
32902
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32227
32903
|
*/
|
|
32228
32904
|
'available'?: number;
|
|
32229
32905
|
/**
|
|
32230
|
-
*
|
|
32906
|
+
* Credits consumed in THIS billing cycle
|
|
32231
32907
|
* @type {number}
|
|
32232
32908
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32233
32909
|
*/
|
|
32234
|
-
'
|
|
32910
|
+
'consumed_this_cycle'?: number;
|
|
32235
32911
|
/**
|
|
32236
|
-
*
|
|
32237
|
-
* @type {
|
|
32912
|
+
* Billing cycle end date
|
|
32913
|
+
* @type {string}
|
|
32238
32914
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32239
32915
|
*/
|
|
32240
|
-
'
|
|
32916
|
+
'cycle_end'?: string;
|
|
32241
32917
|
/**
|
|
32242
|
-
*
|
|
32918
|
+
* Billing cycle start date
|
|
32243
32919
|
* @type {string}
|
|
32244
32920
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32245
32921
|
*/
|
|
32246
|
-
'
|
|
32922
|
+
'cycle_start'?: string;
|
|
32247
32923
|
/**
|
|
32248
|
-
*
|
|
32924
|
+
* True if actual balance (subscription + topup) <= 0
|
|
32249
32925
|
* @type {boolean}
|
|
32250
32926
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32251
32927
|
*/
|
|
32252
32928
|
'is_exhausted'?: boolean;
|
|
32253
32929
|
/**
|
|
32254
|
-
*
|
|
32930
|
+
* All-time consumed credits
|
|
32931
|
+
* @type {number}
|
|
32932
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32933
|
+
*/
|
|
32934
|
+
'lifetime_consumed'?: number;
|
|
32935
|
+
/**
|
|
32936
|
+
* All-time purchased credits
|
|
32937
|
+
* @type {number}
|
|
32938
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32939
|
+
*/
|
|
32940
|
+
'lifetime_purchased'?: number;
|
|
32941
|
+
/**
|
|
32942
|
+
* Actual subscription balance (includes rollover across cycles)
|
|
32943
|
+
* @type {number}
|
|
32944
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32945
|
+
*/
|
|
32946
|
+
'subscription_available'?: number;
|
|
32947
|
+
/**
|
|
32948
|
+
* Actual top-up balance (purchased credits, never expire)
|
|
32949
|
+
* @type {number}
|
|
32950
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32951
|
+
*/
|
|
32952
|
+
'topup_available'?: number;
|
|
32953
|
+
/**
|
|
32954
|
+
* THIS cycle\'s allocated credits (e.g., 1,600,000/month)
|
|
32255
32955
|
* @type {number}
|
|
32256
32956
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32257
32957
|
*/
|
|
32258
32958
|
'total'?: number;
|
|
32259
32959
|
/**
|
|
32260
|
-
*
|
|
32960
|
+
* consumed_this_cycle / total * 100
|
|
32261
32961
|
* @type {number}
|
|
32262
32962
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32263
32963
|
*/
|
|
@@ -33150,12 +33850,24 @@ export interface ModelsCreateCustomEventFieldRequest {
|
|
|
33150
33850
|
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33151
33851
|
*/
|
|
33152
33852
|
'max_value'?: number;
|
|
33853
|
+
/**
|
|
33854
|
+
* string min length; array min items
|
|
33855
|
+
* @type {number}
|
|
33856
|
+
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33857
|
+
*/
|
|
33858
|
+
'min_length'?: number;
|
|
33153
33859
|
/**
|
|
33154
33860
|
*
|
|
33155
33861
|
* @type {number}
|
|
33156
33862
|
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33157
33863
|
*/
|
|
33158
33864
|
'min_value'?: number;
|
|
33865
|
+
/**
|
|
33866
|
+
* for object type
|
|
33867
|
+
* @type {Array<ModelsNestedPropertyDefinition>}
|
|
33868
|
+
* @memberof ModelsCreateCustomEventFieldRequest
|
|
33869
|
+
*/
|
|
33870
|
+
'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
|
|
33159
33871
|
/**
|
|
33160
33872
|
*
|
|
33161
33873
|
* @type {string}
|
|
@@ -33169,6 +33881,7 @@ export declare const ModelsCreateCustomEventFieldRequestFieldTypeEnum: {
|
|
|
33169
33881
|
readonly Boolean: "boolean";
|
|
33170
33882
|
readonly Datetime: "datetime";
|
|
33171
33883
|
readonly Array: "array";
|
|
33884
|
+
readonly Object: "object";
|
|
33172
33885
|
};
|
|
33173
33886
|
export type ModelsCreateCustomEventFieldRequestFieldTypeEnum = typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum[keyof typeof ModelsCreateCustomEventFieldRequestFieldTypeEnum];
|
|
33174
33887
|
/**
|
|
@@ -33251,6 +33964,31 @@ export interface ModelsMergeProfilesResponse {
|
|
|
33251
33964
|
*/
|
|
33252
33965
|
'success'?: boolean;
|
|
33253
33966
|
}
|
|
33967
|
+
/**
|
|
33968
|
+
*
|
|
33969
|
+
* @export
|
|
33970
|
+
* @interface ModelsNestedPropertyDefinition
|
|
33971
|
+
*/
|
|
33972
|
+
export interface ModelsNestedPropertyDefinition {
|
|
33973
|
+
/**
|
|
33974
|
+
*
|
|
33975
|
+
* @type {string}
|
|
33976
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33977
|
+
*/
|
|
33978
|
+
'name'?: string;
|
|
33979
|
+
/**
|
|
33980
|
+
*
|
|
33981
|
+
* @type {boolean}
|
|
33982
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33983
|
+
*/
|
|
33984
|
+
'required'?: boolean;
|
|
33985
|
+
/**
|
|
33986
|
+
* string, number, boolean, datetime, array, object
|
|
33987
|
+
* @type {string}
|
|
33988
|
+
* @memberof ModelsNestedPropertyDefinition
|
|
33989
|
+
*/
|
|
33990
|
+
'type'?: string;
|
|
33991
|
+
}
|
|
33254
33992
|
/**
|
|
33255
33993
|
*
|
|
33256
33994
|
* @export
|
|
@@ -33451,12 +34189,24 @@ export interface ModelsUpdateCustomEventFieldRequest {
|
|
|
33451
34189
|
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33452
34190
|
*/
|
|
33453
34191
|
'max_value'?: number;
|
|
34192
|
+
/**
|
|
34193
|
+
*
|
|
34194
|
+
* @type {number}
|
|
34195
|
+
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
34196
|
+
*/
|
|
34197
|
+
'min_length'?: number;
|
|
33454
34198
|
/**
|
|
33455
34199
|
*
|
|
33456
34200
|
* @type {number}
|
|
33457
34201
|
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
33458
34202
|
*/
|
|
33459
34203
|
'min_value'?: number;
|
|
34204
|
+
/**
|
|
34205
|
+
*
|
|
34206
|
+
* @type {Array<ModelsNestedPropertyDefinition>}
|
|
34207
|
+
* @memberof ModelsUpdateCustomEventFieldRequest
|
|
34208
|
+
*/
|
|
34209
|
+
'nested_schema'?: Array<ModelsNestedPropertyDefinition>;
|
|
33460
34210
|
/**
|
|
33461
34211
|
*
|
|
33462
34212
|
* @type {string}
|
|
@@ -36801,31 +37551,31 @@ export interface V1AdminNotificationsTemplatesCodeSendPostRequest {
|
|
|
36801
37551
|
*/
|
|
36802
37552
|
export interface V1ConnectorsSourcesSourceidUploaddataPostRequest {
|
|
36803
37553
|
/**
|
|
36804
|
-
* Config
|
|
37554
|
+
* Config (e.g. json_upload, csv_upload)
|
|
36805
37555
|
* @type {string}
|
|
36806
37556
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36807
37557
|
*/
|
|
36808
37558
|
'Config': string;
|
|
36809
37559
|
/**
|
|
36810
|
-
* File
|
|
37560
|
+
* File to upload
|
|
36811
37561
|
* @type {File}
|
|
36812
37562
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36813
37563
|
*/
|
|
36814
37564
|
'File': File;
|
|
36815
37565
|
/**
|
|
36816
|
-
*
|
|
37566
|
+
* Source name
|
|
36817
37567
|
* @type {string}
|
|
36818
37568
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36819
37569
|
*/
|
|
36820
37570
|
'Name': string;
|
|
36821
37571
|
/**
|
|
36822
|
-
*
|
|
37572
|
+
* Optional template ID
|
|
36823
37573
|
* @type {string}
|
|
36824
37574
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36825
37575
|
*/
|
|
36826
37576
|
'SourceTemplateId'?: string;
|
|
36827
37577
|
/**
|
|
36828
|
-
*
|
|
37578
|
+
* Data type
|
|
36829
37579
|
* @type {string}
|
|
36830
37580
|
* @memberof V1ConnectorsSourcesSourceidUploaddataPostRequest
|
|
36831
37581
|
*/
|
|
@@ -44160,6 +44910,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
44160
44910
|
* @throws {RequiredError}
|
|
44161
44911
|
*/
|
|
44162
44912
|
adminBillingInvoicesIdGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44913
|
+
/**
|
|
44914
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
44915
|
+
* @summary Get invoice PDF signed URL
|
|
44916
|
+
* @param {string} id Invoice ID
|
|
44917
|
+
* @param {*} [options] Override http request option.
|
|
44918
|
+
* @throws {RequiredError}
|
|
44919
|
+
*/
|
|
44920
|
+
adminBillingInvoicesIdPdfUrlGet: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44163
44921
|
/**
|
|
44164
44922
|
* Updates an existing invoice
|
|
44165
44923
|
* @summary Update invoice
|
|
@@ -44299,6 +45057,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
44299
45057
|
* @throws {RequiredError}
|
|
44300
45058
|
*/
|
|
44301
45059
|
adminBillingReceiptsIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45060
|
+
/**
|
|
45061
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
45062
|
+
* @summary Get receipt PDF signed URL
|
|
45063
|
+
* @param {number} id Receipt ID
|
|
45064
|
+
* @param {*} [options] Override http request option.
|
|
45065
|
+
* @throws {RequiredError}
|
|
45066
|
+
*/
|
|
45067
|
+
adminBillingReceiptsIdPdfUrlGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44302
45068
|
/**
|
|
44303
45069
|
* Returns saved payment cards from Razorpay for the organization
|
|
44304
45070
|
* @summary Get saved payment cards
|
|
@@ -44538,6 +45304,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44538
45304
|
* @throws {RequiredError}
|
|
44539
45305
|
*/
|
|
44540
45306
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
45307
|
+
/**
|
|
45308
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
45309
|
+
* @summary Get invoice PDF signed URL
|
|
45310
|
+
* @param {string} id Invoice ID
|
|
45311
|
+
* @param {*} [options] Override http request option.
|
|
45312
|
+
* @throws {RequiredError}
|
|
45313
|
+
*/
|
|
45314
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
44541
45315
|
/**
|
|
44542
45316
|
* Updates an existing invoice
|
|
44543
45317
|
* @summary Update invoice
|
|
@@ -44618,7 +45392,7 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44618
45392
|
* @param {*} [options] Override http request option.
|
|
44619
45393
|
* @throws {RequiredError}
|
|
44620
45394
|
*/
|
|
44621
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45395
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewNewResponse>>;
|
|
44622
45396
|
/**
|
|
44623
45397
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
44624
45398
|
* @summary Get payment transactions
|
|
@@ -44677,6 +45451,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44677
45451
|
* @throws {RequiredError}
|
|
44678
45452
|
*/
|
|
44679
45453
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesReceipt>>;
|
|
45454
|
+
/**
|
|
45455
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
45456
|
+
* @summary Get receipt PDF signed URL
|
|
45457
|
+
* @param {number} id Receipt ID
|
|
45458
|
+
* @param {*} [options] Override http request option.
|
|
45459
|
+
* @throws {RequiredError}
|
|
45460
|
+
*/
|
|
45461
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
44680
45462
|
/**
|
|
44681
45463
|
* Returns saved payment cards from Razorpay for the organization
|
|
44682
45464
|
* @summary Get saved payment cards
|
|
@@ -44916,6 +45698,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
44916
45698
|
* @throws {RequiredError}
|
|
44917
45699
|
*/
|
|
44918
45700
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
45701
|
+
/**
|
|
45702
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
45703
|
+
* @summary Get invoice PDF signed URL
|
|
45704
|
+
* @param {string} id Invoice ID
|
|
45705
|
+
* @param {*} [options] Override http request option.
|
|
45706
|
+
* @throws {RequiredError}
|
|
45707
|
+
*/
|
|
45708
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
44919
45709
|
/**
|
|
44920
45710
|
* Updates an existing invoice
|
|
44921
45711
|
* @summary Update invoice
|
|
@@ -44996,7 +45786,7 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
44996
45786
|
* @param {*} [options] Override http request option.
|
|
44997
45787
|
* @throws {RequiredError}
|
|
44998
45788
|
*/
|
|
44999
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45789
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewNewResponse>;
|
|
45000
45790
|
/**
|
|
45001
45791
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
45002
45792
|
* @summary Get payment transactions
|
|
@@ -45055,6 +45845,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
45055
45845
|
* @throws {RequiredError}
|
|
45056
45846
|
*/
|
|
45057
45847
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesReceipt>;
|
|
45848
|
+
/**
|
|
45849
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
45850
|
+
* @summary Get receipt PDF signed URL
|
|
45851
|
+
* @param {number} id Receipt ID
|
|
45852
|
+
* @param {*} [options] Override http request option.
|
|
45853
|
+
* @throws {RequiredError}
|
|
45854
|
+
*/
|
|
45855
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
45058
45856
|
/**
|
|
45059
45857
|
* Returns saved payment cards from Razorpay for the organization
|
|
45060
45858
|
* @summary Get saved payment cards
|
|
@@ -45313,6 +46111,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45313
46111
|
* @memberof BillingDashboardApi
|
|
45314
46112
|
*/
|
|
45315
46113
|
adminBillingInvoicesIdGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
46114
|
+
/**
|
|
46115
|
+
* Returns a fresh presigned URL for the invoice PDF. Use this for viewing the invoice in the browser; the URL expires after 1 hour.
|
|
46116
|
+
* @summary Get invoice PDF signed URL
|
|
46117
|
+
* @param {string} id Invoice ID
|
|
46118
|
+
* @param {*} [options] Override http request option.
|
|
46119
|
+
* @throws {RequiredError}
|
|
46120
|
+
* @memberof BillingDashboardApi
|
|
46121
|
+
*/
|
|
46122
|
+
adminBillingInvoicesIdPdfUrlGet(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
45316
46123
|
/**
|
|
45317
46124
|
* Updates an existing invoice
|
|
45318
46125
|
* @summary Update invoice
|
|
@@ -45401,7 +46208,7 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45401
46208
|
* @throws {RequiredError}
|
|
45402
46209
|
* @memberof BillingDashboardApi
|
|
45403
46210
|
*/
|
|
45404
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
46211
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingOverviewNewResponse, any, {}>>;
|
|
45405
46212
|
/**
|
|
45406
46213
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
45407
46214
|
* @summary Get payment transactions
|
|
@@ -45466,6 +46273,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45466
46273
|
* @memberof BillingDashboardApi
|
|
45467
46274
|
*/
|
|
45468
46275
|
adminBillingReceiptsIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesReceipt, any, {}>>;
|
|
46276
|
+
/**
|
|
46277
|
+
* Returns a fresh presigned URL for the receipt PDF. Use this for viewing the receipt in the browser; the URL expires after 1 hour.
|
|
46278
|
+
* @summary Get receipt PDF signed URL
|
|
46279
|
+
* @param {number} id Receipt ID
|
|
46280
|
+
* @param {*} [options] Override http request option.
|
|
46281
|
+
* @throws {RequiredError}
|
|
46282
|
+
* @memberof BillingDashboardApi
|
|
46283
|
+
*/
|
|
46284
|
+
adminBillingReceiptsIdPdfUrlGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
45469
46285
|
/**
|
|
45470
46286
|
* Returns saved payment cards from Razorpay for the organization
|
|
45471
46287
|
* @summary Get saved payment cards
|
|
@@ -46187,102 +47003,110 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46187
47003
|
/**
|
|
46188
47004
|
* List all connectors with optional filtering
|
|
46189
47005
|
* @summary List Connectors
|
|
47006
|
+
* @param {string} xStoreID Store ID
|
|
46190
47007
|
* @param {string} authorization Bearer JWT token
|
|
46191
47008
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46192
47009
|
* @param {string} [provider] Filter by provider
|
|
46193
47010
|
* @param {boolean} [isActive] Filter by active status
|
|
46194
|
-
* @param {number} [storeId] Filter by store ID
|
|
46195
47011
|
* @param {number} [limit] Number of results (default: 50)
|
|
46196
47012
|
* @param {number} [offset] Offset for pagination
|
|
46197
47013
|
* @param {*} [options] Override http request option.
|
|
46198
47014
|
* @throws {RequiredError}
|
|
46199
47015
|
*/
|
|
46200
|
-
|
|
47016
|
+
adminAnalyticsStoreXStoreIDConnectorsGet: (xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46201
47017
|
/**
|
|
46202
47018
|
* Delete a connector and its sync history
|
|
46203
47019
|
* @summary Delete Connector
|
|
47020
|
+
* @param {string} xStoreID Store ID
|
|
46204
47021
|
* @param {string} authorization Bearer JWT token
|
|
46205
47022
|
* @param {number} id Connector ID
|
|
46206
47023
|
* @param {*} [options] Override http request option.
|
|
46207
47024
|
* @throws {RequiredError}
|
|
46208
47025
|
*/
|
|
46209
|
-
|
|
47026
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46210
47027
|
/**
|
|
46211
47028
|
* Retrieve a specific connector by ID
|
|
46212
47029
|
* @summary Get Connector
|
|
47030
|
+
* @param {string} xStoreID Store ID
|
|
46213
47031
|
* @param {string} authorization Bearer JWT token
|
|
46214
47032
|
* @param {number} id Connector ID
|
|
46215
47033
|
* @param {*} [options] Override http request option.
|
|
46216
47034
|
* @throws {RequiredError}
|
|
46217
47035
|
*/
|
|
46218
|
-
|
|
47036
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46219
47037
|
/**
|
|
46220
47038
|
* Get sync history for a connector
|
|
46221
47039
|
* @summary Get Sync History
|
|
47040
|
+
* @param {string} xStoreID Store ID
|
|
46222
47041
|
* @param {string} authorization Bearer JWT token
|
|
46223
47042
|
* @param {number} id Connector ID
|
|
46224
47043
|
* @param {number} [limit] Number of results (default: 20)
|
|
46225
47044
|
* @param {*} [options] Override http request option.
|
|
46226
47045
|
* @throws {RequiredError}
|
|
46227
47046
|
*/
|
|
46228
|
-
|
|
47047
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet: (xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46229
47048
|
/**
|
|
46230
47049
|
* Update an existing connector
|
|
46231
47050
|
* @summary Update Connector
|
|
47051
|
+
* @param {string} xStoreID Store ID
|
|
46232
47052
|
* @param {string} authorization Bearer JWT token
|
|
46233
47053
|
* @param {number} id Connector ID
|
|
46234
47054
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46235
47055
|
* @param {*} [options] Override http request option.
|
|
46236
47056
|
* @throws {RequiredError}
|
|
46237
47057
|
*/
|
|
46238
|
-
|
|
47058
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut: (xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46239
47059
|
/**
|
|
46240
47060
|
* Trigger a sync operation for a connector
|
|
46241
47061
|
* @summary Trigger Sync
|
|
47062
|
+
* @param {string} xStoreID Store ID
|
|
46242
47063
|
* @param {string} authorization Bearer JWT token
|
|
46243
47064
|
* @param {number} id Connector ID
|
|
46244
47065
|
* @param {*} [options] Override http request option.
|
|
46245
47066
|
* @throws {RequiredError}
|
|
46246
47067
|
*/
|
|
46247
|
-
|
|
47068
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46248
47069
|
/**
|
|
46249
47070
|
* Test the connection to a connector\'s external service
|
|
46250
47071
|
* @summary Test Connection
|
|
47072
|
+
* @param {string} xStoreID Store ID
|
|
46251
47073
|
* @param {string} authorization Bearer JWT token
|
|
46252
47074
|
* @param {number} id Connector ID
|
|
46253
47075
|
* @param {*} [options] Override http request option.
|
|
46254
47076
|
* @throws {RequiredError}
|
|
46255
47077
|
*/
|
|
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>;
|
|
47078
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46265
47079
|
/**
|
|
46266
47080
|
* Create a new analytics connector for importing or exporting events
|
|
46267
47081
|
* @summary Create Connector
|
|
47082
|
+
* @param {string} xStoreID Store ID
|
|
46268
47083
|
* @param {string} authorization Bearer JWT token
|
|
46269
47084
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46270
47085
|
* @param {*} [options] Override http request option.
|
|
46271
47086
|
* @throws {RequiredError}
|
|
46272
47087
|
*/
|
|
46273
|
-
|
|
47088
|
+
adminAnalyticsStoreXStoreIDConnectorsPost: (xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46274
47089
|
/**
|
|
46275
47090
|
* Get list of available connector providers
|
|
46276
47091
|
* @summary Get Available Providers
|
|
47092
|
+
* @param {string} xStoreID Store ID
|
|
46277
47093
|
* @param {string} authorization Bearer JWT token
|
|
46278
47094
|
* @param {string} [type] Connector type (import, export)
|
|
46279
47095
|
* @param {*} [options] Override http request option.
|
|
46280
47096
|
* @throws {RequiredError}
|
|
46281
47097
|
*/
|
|
46282
|
-
|
|
47098
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet: (xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46283
47099
|
/**
|
|
46284
|
-
*
|
|
46285
|
-
* @summary
|
|
47100
|
+
* 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.
|
|
47101
|
+
* @summary Get validation errors for a job
|
|
47102
|
+
* @param {string} jobid Job ID from upload response
|
|
47103
|
+
* @param {*} [options] Override http request option.
|
|
47104
|
+
* @throws {RequiredError}
|
|
47105
|
+
*/
|
|
47106
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47107
|
+
/**
|
|
47108
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
47109
|
+
* @summary Test search for an index
|
|
46286
47110
|
* @param {string} index Index name
|
|
46287
47111
|
* @param {string} q Search query
|
|
46288
47112
|
* @param {*} [options] Override http request option.
|
|
@@ -46290,25 +47114,25 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46290
47114
|
*/
|
|
46291
47115
|
v1ConnectorsSearchIndexGet: (index: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46292
47116
|
/**
|
|
46293
|
-
*
|
|
46294
|
-
* @summary
|
|
47117
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47118
|
+
* @summary List data sources
|
|
46295
47119
|
* @param {*} [options] Override http request option.
|
|
46296
47120
|
* @throws {RequiredError}
|
|
46297
47121
|
*/
|
|
46298
47122
|
v1ConnectorsSourcesGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46299
47123
|
/**
|
|
46300
|
-
*
|
|
46301
|
-
* @summary Create source
|
|
46302
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
47124
|
+
* 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.
|
|
47125
|
+
* @summary Create data source
|
|
47126
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46303
47127
|
* @param {*} [options] Override http request option.
|
|
46304
47128
|
* @throws {RequiredError}
|
|
46305
47129
|
*/
|
|
46306
47130
|
v1ConnectorsSourcesPost: (dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46307
47131
|
/**
|
|
46308
|
-
* Update source config
|
|
46309
|
-
* @summary Update source config
|
|
47132
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
47133
|
+
* @summary Update source config
|
|
46310
47134
|
* @param {string} sourceId Source ID
|
|
46311
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
47135
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46312
47136
|
* @param {*} [options] Override http request option.
|
|
46313
47137
|
* @throws {RequiredError}
|
|
46314
47138
|
*/
|
|
@@ -46316,23 +47140,24 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46316
47140
|
[key: string]: any;
|
|
46317
47141
|
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46318
47142
|
/**
|
|
46319
|
-
*
|
|
46320
|
-
* @summary Get source by
|
|
47143
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47144
|
+
* @summary Get source by ID
|
|
47145
|
+
* @param {string} sourceId Source ID
|
|
46321
47146
|
* @param {*} [options] Override http request option.
|
|
46322
47147
|
* @throws {RequiredError}
|
|
46323
47148
|
*/
|
|
46324
|
-
v1ConnectorsSourcesSourceIdGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47149
|
+
v1ConnectorsSourcesSourceIdGet: (sourceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46325
47150
|
/**
|
|
46326
|
-
* Update
|
|
46327
|
-
* @summary Update
|
|
46328
|
-
* @param {string} sourceid Source ID
|
|
46329
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
47151
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
47152
|
+
* @summary Update source index schema
|
|
47153
|
+
* @param {string} sourceid Source ID
|
|
47154
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46330
47155
|
* @param {*} [options] Override http request option.
|
|
46331
47156
|
* @throws {RequiredError}
|
|
46332
47157
|
*/
|
|
46333
47158
|
v1ConnectorsSourcesSourceidUpdateschemaPost: (sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46334
47159
|
/**
|
|
46335
|
-
* Upload source data
|
|
47160
|
+
* 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
47161
|
* @summary Upload source data
|
|
46337
47162
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46338
47163
|
* @param {*} [options] Override http request option.
|
|
@@ -46340,18 +47165,18 @@ export declare const ConnectorsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
46340
47165
|
*/
|
|
46341
47166
|
v1ConnectorsSourcesSourceidUploaddataPost: (v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46342
47167
|
/**
|
|
46343
|
-
* Create task
|
|
46344
|
-
* @summary Create task
|
|
46345
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
47168
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
47169
|
+
* @summary Create connector task
|
|
47170
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46346
47171
|
* @param {*} [options] Override http request option.
|
|
46347
47172
|
* @throws {RequiredError}
|
|
46348
47173
|
*/
|
|
46349
47174
|
v1ConnectorsTasksPost: (dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46350
47175
|
/**
|
|
46351
|
-
*
|
|
47176
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46352
47177
|
* @summary Trigger task run
|
|
46353
47178
|
* @param {string} taskId Task ID
|
|
46354
|
-
* @param {number} body
|
|
47179
|
+
* @param {number} body User ID who triggered the run
|
|
46355
47180
|
* @param {*} [options] Override http request option.
|
|
46356
47181
|
* @throws {RequiredError}
|
|
46357
47182
|
*/
|
|
@@ -46365,120 +47190,128 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46365
47190
|
/**
|
|
46366
47191
|
* List all connectors with optional filtering
|
|
46367
47192
|
* @summary List Connectors
|
|
47193
|
+
* @param {string} xStoreID Store ID
|
|
46368
47194
|
* @param {string} authorization Bearer JWT token
|
|
46369
47195
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46370
47196
|
* @param {string} [provider] Filter by provider
|
|
46371
47197
|
* @param {boolean} [isActive] Filter by active status
|
|
46372
|
-
* @param {number} [storeId] Filter by store ID
|
|
46373
47198
|
* @param {number} [limit] Number of results (default: 50)
|
|
46374
47199
|
* @param {number} [offset] Offset for pagination
|
|
46375
47200
|
* @param {*} [options] Override http request option.
|
|
46376
47201
|
* @throws {RequiredError}
|
|
46377
47202
|
*/
|
|
46378
|
-
|
|
47203
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46379
47204
|
[key: string]: any;
|
|
46380
47205
|
}>>;
|
|
46381
47206
|
/**
|
|
46382
47207
|
* Delete a connector and its sync history
|
|
46383
47208
|
* @summary Delete Connector
|
|
47209
|
+
* @param {string} xStoreID Store ID
|
|
46384
47210
|
* @param {string} authorization Bearer JWT token
|
|
46385
47211
|
* @param {number} id Connector ID
|
|
46386
47212
|
* @param {*} [options] Override http request option.
|
|
46387
47213
|
* @throws {RequiredError}
|
|
46388
47214
|
*/
|
|
46389
|
-
|
|
47215
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46390
47216
|
[key: string]: any;
|
|
46391
47217
|
}>>;
|
|
46392
47218
|
/**
|
|
46393
47219
|
* Retrieve a specific connector by ID
|
|
46394
47220
|
* @summary Get Connector
|
|
47221
|
+
* @param {string} xStoreID Store ID
|
|
46395
47222
|
* @param {string} authorization Bearer JWT token
|
|
46396
47223
|
* @param {number} id Connector ID
|
|
46397
47224
|
* @param {*} [options] Override http request option.
|
|
46398
47225
|
* @throws {RequiredError}
|
|
46399
47226
|
*/
|
|
46400
|
-
|
|
47227
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46401
47228
|
[key: string]: any;
|
|
46402
47229
|
}>>;
|
|
46403
47230
|
/**
|
|
46404
47231
|
* Get sync history for a connector
|
|
46405
47232
|
* @summary Get Sync History
|
|
47233
|
+
* @param {string} xStoreID Store ID
|
|
46406
47234
|
* @param {string} authorization Bearer JWT token
|
|
46407
47235
|
* @param {number} id Connector ID
|
|
46408
47236
|
* @param {number} [limit] Number of results (default: 20)
|
|
46409
47237
|
* @param {*} [options] Override http request option.
|
|
46410
47238
|
* @throws {RequiredError}
|
|
46411
47239
|
*/
|
|
46412
|
-
|
|
47240
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46413
47241
|
[key: string]: any;
|
|
46414
47242
|
}>>;
|
|
46415
47243
|
/**
|
|
46416
47244
|
* Update an existing connector
|
|
46417
47245
|
* @summary Update Connector
|
|
47246
|
+
* @param {string} xStoreID Store ID
|
|
46418
47247
|
* @param {string} authorization Bearer JWT token
|
|
46419
47248
|
* @param {number} id Connector ID
|
|
46420
47249
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46421
47250
|
* @param {*} [options] Override http request option.
|
|
46422
47251
|
* @throws {RequiredError}
|
|
46423
47252
|
*/
|
|
46424
|
-
|
|
47253
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46425
47254
|
[key: string]: any;
|
|
46426
47255
|
}>>;
|
|
46427
47256
|
/**
|
|
46428
47257
|
* Trigger a sync operation for a connector
|
|
46429
47258
|
* @summary Trigger Sync
|
|
47259
|
+
* @param {string} xStoreID Store ID
|
|
46430
47260
|
* @param {string} authorization Bearer JWT token
|
|
46431
47261
|
* @param {number} id Connector ID
|
|
46432
47262
|
* @param {*} [options] Override http request option.
|
|
46433
47263
|
* @throws {RequiredError}
|
|
46434
47264
|
*/
|
|
46435
|
-
|
|
47265
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46436
47266
|
[key: string]: any;
|
|
46437
47267
|
}>>;
|
|
46438
47268
|
/**
|
|
46439
47269
|
* Test the connection to a connector\'s external service
|
|
46440
47270
|
* @summary Test Connection
|
|
47271
|
+
* @param {string} xStoreID Store ID
|
|
46441
47272
|
* @param {string} authorization Bearer JWT token
|
|
46442
47273
|
* @param {number} id Connector ID
|
|
46443
47274
|
* @param {*} [options] Override http request option.
|
|
46444
47275
|
* @throws {RequiredError}
|
|
46445
47276
|
*/
|
|
46446
|
-
|
|
47277
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46447
47278
|
[key: string]: any;
|
|
46448
47279
|
}>>;
|
|
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
47280
|
/**
|
|
46458
47281
|
* Create a new analytics connector for importing or exporting events
|
|
46459
47282
|
* @summary Create Connector
|
|
47283
|
+
* @param {string} xStoreID Store ID
|
|
46460
47284
|
* @param {string} authorization Bearer JWT token
|
|
46461
47285
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46462
47286
|
* @param {*} [options] Override http request option.
|
|
46463
47287
|
* @throws {RequiredError}
|
|
46464
47288
|
*/
|
|
46465
|
-
|
|
47289
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46466
47290
|
[key: string]: any;
|
|
46467
47291
|
}>>;
|
|
46468
47292
|
/**
|
|
46469
47293
|
* Get list of available connector providers
|
|
46470
47294
|
* @summary Get Available Providers
|
|
47295
|
+
* @param {string} xStoreID Store ID
|
|
46471
47296
|
* @param {string} authorization Bearer JWT token
|
|
46472
47297
|
* @param {string} [type] Connector type (import, export)
|
|
46473
47298
|
* @param {*} [options] Override http request option.
|
|
46474
47299
|
* @throws {RequiredError}
|
|
46475
47300
|
*/
|
|
46476
|
-
|
|
47301
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
46477
47302
|
[key: string]: any;
|
|
46478
47303
|
}>>;
|
|
46479
47304
|
/**
|
|
46480
|
-
*
|
|
46481
|
-
* @summary
|
|
47305
|
+
* 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.
|
|
47306
|
+
* @summary Get validation errors for a job
|
|
47307
|
+
* @param {string} jobid Job ID from upload response
|
|
47308
|
+
* @param {*} [options] Override http request option.
|
|
47309
|
+
* @throws {RequiredError}
|
|
47310
|
+
*/
|
|
47311
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesValidationErrorResponse>>;
|
|
47312
|
+
/**
|
|
47313
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
47314
|
+
* @summary Test search for an index
|
|
46482
47315
|
* @param {string} index Index name
|
|
46483
47316
|
* @param {string} q Search query
|
|
46484
47317
|
* @param {*} [options] Override http request option.
|
|
@@ -46486,25 +47319,25 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46486
47319
|
*/
|
|
46487
47320
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResultResponse>>;
|
|
46488
47321
|
/**
|
|
46489
|
-
*
|
|
46490
|
-
* @summary
|
|
47322
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47323
|
+
* @summary List data sources
|
|
46491
47324
|
* @param {*} [options] Override http request option.
|
|
46492
47325
|
* @throws {RequiredError}
|
|
46493
47326
|
*/
|
|
46494
47327
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSourcesListResponse>>;
|
|
46495
47328
|
/**
|
|
46496
|
-
*
|
|
46497
|
-
* @summary Create source
|
|
46498
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
47329
|
+
* 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.
|
|
47330
|
+
* @summary Create data source
|
|
47331
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46499
47332
|
* @param {*} [options] Override http request option.
|
|
46500
47333
|
* @throws {RequiredError}
|
|
46501
47334
|
*/
|
|
46502
47335
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateSourceResponse>>;
|
|
46503
47336
|
/**
|
|
46504
|
-
* Update source config
|
|
46505
|
-
* @summary Update source config
|
|
47337
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
47338
|
+
* @summary Update source config
|
|
46506
47339
|
* @param {string} sourceId Source ID
|
|
46507
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
47340
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46508
47341
|
* @param {*} [options] Override http request option.
|
|
46509
47342
|
* @throws {RequiredError}
|
|
46510
47343
|
*/
|
|
@@ -46512,23 +47345,24 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46512
47345
|
[key: string]: any;
|
|
46513
47346
|
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
46514
47347
|
/**
|
|
46515
|
-
*
|
|
46516
|
-
* @summary Get source by
|
|
47348
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47349
|
+
* @summary Get source by ID
|
|
47350
|
+
* @param {string} sourceId Source ID
|
|
46517
47351
|
* @param {*} [options] Override http request option.
|
|
46518
47352
|
* @throws {RequiredError}
|
|
46519
47353
|
*/
|
|
46520
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
|
|
47354
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>>;
|
|
46521
47355
|
/**
|
|
46522
|
-
* Update
|
|
46523
|
-
* @summary Update
|
|
46524
|
-
* @param {string} sourceid Source ID
|
|
46525
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
47356
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
47357
|
+
* @summary Update source index schema
|
|
47358
|
+
* @param {string} sourceid Source ID
|
|
47359
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46526
47360
|
* @param {*} [options] Override http request option.
|
|
46527
47361
|
* @throws {RequiredError}
|
|
46528
47362
|
*/
|
|
46529
47363
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUpdateSchemaResponse>>;
|
|
46530
47364
|
/**
|
|
46531
|
-
* Upload source data
|
|
47365
|
+
* 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
47366
|
* @summary Upload source data
|
|
46533
47367
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46534
47368
|
* @param {*} [options] Override http request option.
|
|
@@ -46536,18 +47370,18 @@ export declare const ConnectorsApiFp: (configuration?: Configuration) => {
|
|
|
46536
47370
|
*/
|
|
46537
47371
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUploadSourceDataResponseWrapper>>;
|
|
46538
47372
|
/**
|
|
46539
|
-
* Create task
|
|
46540
|
-
* @summary Create task
|
|
46541
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
47373
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
47374
|
+
* @summary Create connector task
|
|
47375
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46542
47376
|
* @param {*} [options] Override http request option.
|
|
46543
47377
|
* @throws {RequiredError}
|
|
46544
47378
|
*/
|
|
46545
47379
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreateTaskResponse>>;
|
|
46546
47380
|
/**
|
|
46547
|
-
*
|
|
47381
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46548
47382
|
* @summary Trigger task run
|
|
46549
47383
|
* @param {string} taskId Task ID
|
|
46550
|
-
* @param {number} body
|
|
47384
|
+
* @param {number} body User ID who triggered the run
|
|
46551
47385
|
* @param {*} [options] Override http request option.
|
|
46552
47386
|
* @throws {RequiredError}
|
|
46553
47387
|
*/
|
|
@@ -46561,120 +47395,128 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46561
47395
|
/**
|
|
46562
47396
|
* List all connectors with optional filtering
|
|
46563
47397
|
* @summary List Connectors
|
|
47398
|
+
* @param {string} xStoreID Store ID
|
|
46564
47399
|
* @param {string} authorization Bearer JWT token
|
|
46565
47400
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46566
47401
|
* @param {string} [provider] Filter by provider
|
|
46567
47402
|
* @param {boolean} [isActive] Filter by active status
|
|
46568
|
-
* @param {number} [storeId] Filter by store ID
|
|
46569
47403
|
* @param {number} [limit] Number of results (default: 50)
|
|
46570
47404
|
* @param {number} [offset] Offset for pagination
|
|
46571
47405
|
* @param {*} [options] Override http request option.
|
|
46572
47406
|
* @throws {RequiredError}
|
|
46573
47407
|
*/
|
|
46574
|
-
|
|
47408
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46575
47409
|
[key: string]: any;
|
|
46576
47410
|
}>;
|
|
46577
47411
|
/**
|
|
46578
47412
|
* Delete a connector and its sync history
|
|
46579
47413
|
* @summary Delete Connector
|
|
47414
|
+
* @param {string} xStoreID Store ID
|
|
46580
47415
|
* @param {string} authorization Bearer JWT token
|
|
46581
47416
|
* @param {number} id Connector ID
|
|
46582
47417
|
* @param {*} [options] Override http request option.
|
|
46583
47418
|
* @throws {RequiredError}
|
|
46584
47419
|
*/
|
|
46585
|
-
|
|
47420
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46586
47421
|
[key: string]: any;
|
|
46587
47422
|
}>;
|
|
46588
47423
|
/**
|
|
46589
47424
|
* Retrieve a specific connector by ID
|
|
46590
47425
|
* @summary Get Connector
|
|
47426
|
+
* @param {string} xStoreID Store ID
|
|
46591
47427
|
* @param {string} authorization Bearer JWT token
|
|
46592
47428
|
* @param {number} id Connector ID
|
|
46593
47429
|
* @param {*} [options] Override http request option.
|
|
46594
47430
|
* @throws {RequiredError}
|
|
46595
47431
|
*/
|
|
46596
|
-
|
|
47432
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46597
47433
|
[key: string]: any;
|
|
46598
47434
|
}>;
|
|
46599
47435
|
/**
|
|
46600
47436
|
* Get sync history for a connector
|
|
46601
47437
|
* @summary Get Sync History
|
|
47438
|
+
* @param {string} xStoreID Store ID
|
|
46602
47439
|
* @param {string} authorization Bearer JWT token
|
|
46603
47440
|
* @param {number} id Connector ID
|
|
46604
47441
|
* @param {number} [limit] Number of results (default: 20)
|
|
46605
47442
|
* @param {*} [options] Override http request option.
|
|
46606
47443
|
* @throws {RequiredError}
|
|
46607
47444
|
*/
|
|
46608
|
-
|
|
47445
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46609
47446
|
[key: string]: any;
|
|
46610
47447
|
}>;
|
|
46611
47448
|
/**
|
|
46612
47449
|
* Update an existing connector
|
|
46613
47450
|
* @summary Update Connector
|
|
47451
|
+
* @param {string} xStoreID Store ID
|
|
46614
47452
|
* @param {string} authorization Bearer JWT token
|
|
46615
47453
|
* @param {number} id Connector ID
|
|
46616
47454
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
46617
47455
|
* @param {*} [options] Override http request option.
|
|
46618
47456
|
* @throws {RequiredError}
|
|
46619
47457
|
*/
|
|
46620
|
-
|
|
47458
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46621
47459
|
[key: string]: any;
|
|
46622
47460
|
}>;
|
|
46623
47461
|
/**
|
|
46624
47462
|
* Trigger a sync operation for a connector
|
|
46625
47463
|
* @summary Trigger Sync
|
|
47464
|
+
* @param {string} xStoreID Store ID
|
|
46626
47465
|
* @param {string} authorization Bearer JWT token
|
|
46627
47466
|
* @param {number} id Connector ID
|
|
46628
47467
|
* @param {*} [options] Override http request option.
|
|
46629
47468
|
* @throws {RequiredError}
|
|
46630
47469
|
*/
|
|
46631
|
-
|
|
47470
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46632
47471
|
[key: string]: any;
|
|
46633
47472
|
}>;
|
|
46634
47473
|
/**
|
|
46635
47474
|
* Test the connection to a connector\'s external service
|
|
46636
47475
|
* @summary Test Connection
|
|
47476
|
+
* @param {string} xStoreID Store ID
|
|
46637
47477
|
* @param {string} authorization Bearer JWT token
|
|
46638
47478
|
* @param {number} id Connector ID
|
|
46639
47479
|
* @param {*} [options] Override http request option.
|
|
46640
47480
|
* @throws {RequiredError}
|
|
46641
47481
|
*/
|
|
46642
|
-
|
|
47482
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46643
47483
|
[key: string]: any;
|
|
46644
47484
|
}>;
|
|
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
47485
|
/**
|
|
46654
47486
|
* Create a new analytics connector for importing or exporting events
|
|
46655
47487
|
* @summary Create Connector
|
|
47488
|
+
* @param {string} xStoreID Store ID
|
|
46656
47489
|
* @param {string} authorization Bearer JWT token
|
|
46657
47490
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46658
47491
|
* @param {*} [options] Override http request option.
|
|
46659
47492
|
* @throws {RequiredError}
|
|
46660
47493
|
*/
|
|
46661
|
-
|
|
47494
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46662
47495
|
[key: string]: any;
|
|
46663
47496
|
}>;
|
|
46664
47497
|
/**
|
|
46665
47498
|
* Get list of available connector providers
|
|
46666
47499
|
* @summary Get Available Providers
|
|
47500
|
+
* @param {string} xStoreID Store ID
|
|
46667
47501
|
* @param {string} authorization Bearer JWT token
|
|
46668
47502
|
* @param {string} [type] Connector type (import, export)
|
|
46669
47503
|
* @param {*} [options] Override http request option.
|
|
46670
47504
|
* @throws {RequiredError}
|
|
46671
47505
|
*/
|
|
46672
|
-
|
|
47506
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
46673
47507
|
[key: string]: any;
|
|
46674
47508
|
}>;
|
|
46675
47509
|
/**
|
|
46676
|
-
*
|
|
46677
|
-
* @summary
|
|
47510
|
+
* 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.
|
|
47511
|
+
* @summary Get validation errors for a job
|
|
47512
|
+
* @param {string} jobid Job ID from upload response
|
|
47513
|
+
* @param {*} [options] Override http request option.
|
|
47514
|
+
* @throws {RequiredError}
|
|
47515
|
+
*/
|
|
47516
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesValidationErrorResponse>;
|
|
47517
|
+
/**
|
|
47518
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
47519
|
+
* @summary Test search for an index
|
|
46678
47520
|
* @param {string} index Index name
|
|
46679
47521
|
* @param {string} q Search query
|
|
46680
47522
|
* @param {*} [options] Override http request option.
|
|
@@ -46682,25 +47524,25 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46682
47524
|
*/
|
|
46683
47525
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResultResponse>;
|
|
46684
47526
|
/**
|
|
46685
|
-
*
|
|
46686
|
-
* @summary
|
|
47527
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47528
|
+
* @summary List data sources
|
|
46687
47529
|
* @param {*} [options] Override http request option.
|
|
46688
47530
|
* @throws {RequiredError}
|
|
46689
47531
|
*/
|
|
46690
47532
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSourcesListResponse>;
|
|
46691
47533
|
/**
|
|
46692
|
-
*
|
|
46693
|
-
* @summary Create source
|
|
46694
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
47534
|
+
* 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.
|
|
47535
|
+
* @summary Create data source
|
|
47536
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46695
47537
|
* @param {*} [options] Override http request option.
|
|
46696
47538
|
* @throws {RequiredError}
|
|
46697
47539
|
*/
|
|
46698
47540
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateSourceResponse>;
|
|
46699
47541
|
/**
|
|
46700
|
-
* Update source config
|
|
46701
|
-
* @summary Update source config
|
|
47542
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
47543
|
+
* @summary Update source config
|
|
46702
47544
|
* @param {string} sourceId Source ID
|
|
46703
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
47545
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46704
47546
|
* @param {*} [options] Override http request option.
|
|
46705
47547
|
* @throws {RequiredError}
|
|
46706
47548
|
*/
|
|
@@ -46708,23 +47550,24 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46708
47550
|
[key: string]: any;
|
|
46709
47551
|
}, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
46710
47552
|
/**
|
|
46711
|
-
*
|
|
46712
|
-
* @summary Get source by
|
|
47553
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47554
|
+
* @summary Get source by ID
|
|
47555
|
+
* @param {string} sourceId Source ID
|
|
46713
47556
|
* @param {*} [options] Override http request option.
|
|
46714
47557
|
* @throws {RequiredError}
|
|
46715
47558
|
*/
|
|
46716
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
|
|
47559
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSourceConfigResponseWrapper>;
|
|
46717
47560
|
/**
|
|
46718
|
-
* Update
|
|
46719
|
-
* @summary Update
|
|
46720
|
-
* @param {string} sourceid Source ID
|
|
46721
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
47561
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
47562
|
+
* @summary Update source index schema
|
|
47563
|
+
* @param {string} sourceid Source ID
|
|
47564
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46722
47565
|
* @param {*} [options] Override http request option.
|
|
46723
47566
|
* @throws {RequiredError}
|
|
46724
47567
|
*/
|
|
46725
47568
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUpdateSchemaResponse>;
|
|
46726
47569
|
/**
|
|
46727
|
-
* Upload source data
|
|
47570
|
+
* 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
47571
|
* @summary Upload source data
|
|
46729
47572
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46730
47573
|
* @param {*} [options] Override http request option.
|
|
@@ -46732,18 +47575,18 @@ export declare const ConnectorsApiFactory: (configuration?: Configuration, baseP
|
|
|
46732
47575
|
*/
|
|
46733
47576
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUploadSourceDataResponseWrapper>;
|
|
46734
47577
|
/**
|
|
46735
|
-
* Create task
|
|
46736
|
-
* @summary Create task
|
|
46737
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
47578
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
47579
|
+
* @summary Create connector task
|
|
47580
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46738
47581
|
* @param {*} [options] Override http request option.
|
|
46739
47582
|
* @throws {RequiredError}
|
|
46740
47583
|
*/
|
|
46741
47584
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreateTaskResponse>;
|
|
46742
47585
|
/**
|
|
46743
|
-
*
|
|
47586
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46744
47587
|
* @summary Trigger task run
|
|
46745
47588
|
* @param {string} taskId Task ID
|
|
46746
|
-
* @param {number} body
|
|
47589
|
+
* @param {number} body User ID who triggered the run
|
|
46747
47590
|
* @param {*} [options] Override http request option.
|
|
46748
47591
|
* @throws {RequiredError}
|
|
46749
47592
|
*/
|
|
@@ -46759,47 +47602,50 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46759
47602
|
/**
|
|
46760
47603
|
* List all connectors with optional filtering
|
|
46761
47604
|
* @summary List Connectors
|
|
47605
|
+
* @param {string} xStoreID Store ID
|
|
46762
47606
|
* @param {string} authorization Bearer JWT token
|
|
46763
47607
|
* @param {string} [connectorType] Filter by connector type (import, export)
|
|
46764
47608
|
* @param {string} [provider] Filter by provider
|
|
46765
47609
|
* @param {boolean} [isActive] Filter by active status
|
|
46766
|
-
* @param {number} [storeId] Filter by store ID
|
|
46767
47610
|
* @param {number} [limit] Number of results (default: 50)
|
|
46768
47611
|
* @param {number} [offset] Offset for pagination
|
|
46769
47612
|
* @param {*} [options] Override http request option.
|
|
46770
47613
|
* @throws {RequiredError}
|
|
46771
47614
|
* @memberof ConnectorsApi
|
|
46772
47615
|
*/
|
|
46773
|
-
|
|
47616
|
+
adminAnalyticsStoreXStoreIDConnectorsGet(xStoreID: string, authorization: string, connectorType?: string, provider?: string, isActive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46774
47617
|
[key: string]: any;
|
|
46775
47618
|
}, any, {}>>;
|
|
46776
47619
|
/**
|
|
46777
47620
|
* Delete a connector and its sync history
|
|
46778
47621
|
* @summary Delete Connector
|
|
47622
|
+
* @param {string} xStoreID Store ID
|
|
46779
47623
|
* @param {string} authorization Bearer JWT token
|
|
46780
47624
|
* @param {number} id Connector ID
|
|
46781
47625
|
* @param {*} [options] Override http request option.
|
|
46782
47626
|
* @throws {RequiredError}
|
|
46783
47627
|
* @memberof ConnectorsApi
|
|
46784
47628
|
*/
|
|
46785
|
-
|
|
47629
|
+
adminAnalyticsStoreXStoreIDConnectorsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46786
47630
|
[key: string]: any;
|
|
46787
47631
|
}, any, {}>>;
|
|
46788
47632
|
/**
|
|
46789
47633
|
* Retrieve a specific connector by ID
|
|
46790
47634
|
* @summary Get Connector
|
|
47635
|
+
* @param {string} xStoreID Store ID
|
|
46791
47636
|
* @param {string} authorization Bearer JWT token
|
|
46792
47637
|
* @param {number} id Connector ID
|
|
46793
47638
|
* @param {*} [options] Override http request option.
|
|
46794
47639
|
* @throws {RequiredError}
|
|
46795
47640
|
* @memberof ConnectorsApi
|
|
46796
47641
|
*/
|
|
46797
|
-
|
|
47642
|
+
adminAnalyticsStoreXStoreIDConnectorsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46798
47643
|
[key: string]: any;
|
|
46799
47644
|
}, any, {}>>;
|
|
46800
47645
|
/**
|
|
46801
47646
|
* Get sync history for a connector
|
|
46802
47647
|
* @summary Get Sync History
|
|
47648
|
+
* @param {string} xStoreID Store ID
|
|
46803
47649
|
* @param {string} authorization Bearer JWT token
|
|
46804
47650
|
* @param {number} id Connector ID
|
|
46805
47651
|
* @param {number} [limit] Number of results (default: 20)
|
|
@@ -46807,12 +47653,13 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46807
47653
|
* @throws {RequiredError}
|
|
46808
47654
|
* @memberof ConnectorsApi
|
|
46809
47655
|
*/
|
|
46810
|
-
|
|
47656
|
+
adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet(xStoreID: string, authorization: string, id: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46811
47657
|
[key: string]: any;
|
|
46812
47658
|
}, any, {}>>;
|
|
46813
47659
|
/**
|
|
46814
47660
|
* Update an existing connector
|
|
46815
47661
|
* @summary Update Connector
|
|
47662
|
+
* @param {string} xStoreID Store ID
|
|
46816
47663
|
* @param {string} authorization Bearer JWT token
|
|
46817
47664
|
* @param {number} id Connector ID
|
|
46818
47665
|
* @param {ConnectorsUpdateConnectorRequest} connectorsUpdateConnectorRequest Updated connector configuration
|
|
@@ -46820,69 +47667,73 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46820
47667
|
* @throws {RequiredError}
|
|
46821
47668
|
* @memberof ConnectorsApi
|
|
46822
47669
|
*/
|
|
46823
|
-
|
|
47670
|
+
adminAnalyticsStoreXStoreIDConnectorsIdPut(xStoreID: string, authorization: string, id: number, connectorsUpdateConnectorRequest: ConnectorsUpdateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46824
47671
|
[key: string]: any;
|
|
46825
47672
|
}, any, {}>>;
|
|
46826
47673
|
/**
|
|
46827
47674
|
* Trigger a sync operation for a connector
|
|
46828
47675
|
* @summary Trigger Sync
|
|
47676
|
+
* @param {string} xStoreID Store ID
|
|
46829
47677
|
* @param {string} authorization Bearer JWT token
|
|
46830
47678
|
* @param {number} id Connector ID
|
|
46831
47679
|
* @param {*} [options] Override http request option.
|
|
46832
47680
|
* @throws {RequiredError}
|
|
46833
47681
|
* @memberof ConnectorsApi
|
|
46834
47682
|
*/
|
|
46835
|
-
|
|
47683
|
+
adminAnalyticsStoreXStoreIDConnectorsIdSyncPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46836
47684
|
[key: string]: any;
|
|
46837
47685
|
}, any, {}>>;
|
|
46838
47686
|
/**
|
|
46839
47687
|
* Test the connection to a connector\'s external service
|
|
46840
47688
|
* @summary Test Connection
|
|
47689
|
+
* @param {string} xStoreID Store ID
|
|
46841
47690
|
* @param {string} authorization Bearer JWT token
|
|
46842
47691
|
* @param {number} id Connector ID
|
|
46843
47692
|
* @param {*} [options] Override http request option.
|
|
46844
47693
|
* @throws {RequiredError}
|
|
46845
47694
|
* @memberof ConnectorsApi
|
|
46846
47695
|
*/
|
|
46847
|
-
|
|
47696
|
+
adminAnalyticsStoreXStoreIDConnectorsIdTestPost(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46848
47697
|
[key: string]: any;
|
|
46849
47698
|
}, 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
47699
|
/**
|
|
46860
47700
|
* Create a new analytics connector for importing or exporting events
|
|
46861
47701
|
* @summary Create Connector
|
|
47702
|
+
* @param {string} xStoreID Store ID
|
|
46862
47703
|
* @param {string} authorization Bearer JWT token
|
|
46863
47704
|
* @param {ConnectorsCreateConnectorRequest} connectorsCreateConnectorRequest Connector configuration
|
|
46864
47705
|
* @param {*} [options] Override http request option.
|
|
46865
47706
|
* @throws {RequiredError}
|
|
46866
47707
|
* @memberof ConnectorsApi
|
|
46867
47708
|
*/
|
|
46868
|
-
|
|
47709
|
+
adminAnalyticsStoreXStoreIDConnectorsPost(xStoreID: string, authorization: string, connectorsCreateConnectorRequest: ConnectorsCreateConnectorRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46869
47710
|
[key: string]: any;
|
|
46870
47711
|
}, any, {}>>;
|
|
46871
47712
|
/**
|
|
46872
47713
|
* Get list of available connector providers
|
|
46873
47714
|
* @summary Get Available Providers
|
|
47715
|
+
* @param {string} xStoreID Store ID
|
|
46874
47716
|
* @param {string} authorization Bearer JWT token
|
|
46875
47717
|
* @param {string} [type] Connector type (import, export)
|
|
46876
47718
|
* @param {*} [options] Override http request option.
|
|
46877
47719
|
* @throws {RequiredError}
|
|
46878
47720
|
* @memberof ConnectorsApi
|
|
46879
47721
|
*/
|
|
46880
|
-
|
|
47722
|
+
adminAnalyticsStoreXStoreIDConnectorsProvidersGet(xStoreID: string, authorization: string, type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
46881
47723
|
[key: string]: any;
|
|
46882
47724
|
}, any, {}>>;
|
|
46883
47725
|
/**
|
|
46884
|
-
*
|
|
46885
|
-
* @summary
|
|
47726
|
+
* 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.
|
|
47727
|
+
* @summary Get validation errors for a job
|
|
47728
|
+
* @param {string} jobid Job ID from upload response
|
|
47729
|
+
* @param {*} [options] Override http request option.
|
|
47730
|
+
* @throws {RequiredError}
|
|
47731
|
+
* @memberof ConnectorsApi
|
|
47732
|
+
*/
|
|
47733
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesValidationErrorResponse, any, {}>>;
|
|
47734
|
+
/**
|
|
47735
|
+
* Run a test search against a connector index. **Auth:** store credentials. Query param `q` is required. Use to verify connector sync results.
|
|
47736
|
+
* @summary Test search for an index
|
|
46886
47737
|
* @param {string} index Index name
|
|
46887
47738
|
* @param {string} q Search query
|
|
46888
47739
|
* @param {*} [options] Override http request option.
|
|
@@ -46891,27 +47742,27 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46891
47742
|
*/
|
|
46892
47743
|
v1ConnectorsSearchIndexGet(index: string, q: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResultResponse, any, {}>>;
|
|
46893
47744
|
/**
|
|
46894
|
-
*
|
|
46895
|
-
* @summary
|
|
47745
|
+
* List all data sources for the store. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47746
|
+
* @summary List data sources
|
|
46896
47747
|
* @param {*} [options] Override http request option.
|
|
46897
47748
|
* @throws {RequiredError}
|
|
46898
47749
|
* @memberof ConnectorsApi
|
|
46899
47750
|
*/
|
|
46900
47751
|
v1ConnectorsSourcesGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSourcesListResponse, any, {}>>;
|
|
46901
47752
|
/**
|
|
46902
|
-
*
|
|
46903
|
-
* @summary Create source
|
|
46904
|
-
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source
|
|
47753
|
+
* 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.
|
|
47754
|
+
* @summary Create data source
|
|
47755
|
+
* @param {DataTypesCreateSourceRequest} dataTypesCreateSourceRequest Source configuration
|
|
46905
47756
|
* @param {*} [options] Override http request option.
|
|
46906
47757
|
* @throws {RequiredError}
|
|
46907
47758
|
* @memberof ConnectorsApi
|
|
46908
47759
|
*/
|
|
46909
47760
|
v1ConnectorsSourcesPost(dataTypesCreateSourceRequest: DataTypesCreateSourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateSourceResponse, any, {}>>;
|
|
46910
47761
|
/**
|
|
46911
|
-
* Update source config
|
|
46912
|
-
* @summary Update source config
|
|
47762
|
+
* Update configuration for a data source. **Auth:** store credentials or JWT. Body: `config` object with key-value settings.
|
|
47763
|
+
* @summary Update source config
|
|
46913
47764
|
* @param {string} sourceId Source ID
|
|
46914
|
-
* @param {{ [key: string]: any; }} requestBody Config
|
|
47765
|
+
* @param {{ [key: string]: any; }} requestBody Config key-value map
|
|
46915
47766
|
* @param {*} [options] Override http request option.
|
|
46916
47767
|
* @throws {RequiredError}
|
|
46917
47768
|
* @memberof ConnectorsApi
|
|
@@ -46920,25 +47771,26 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46920
47771
|
[key: string]: any;
|
|
46921
47772
|
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
46922
47773
|
/**
|
|
46923
|
-
*
|
|
46924
|
-
* @summary Get source by
|
|
47774
|
+
* Fetch a single data source by ID. **Auth:** `x-storeid` and `x-storesecret`.
|
|
47775
|
+
* @summary Get source by ID
|
|
47776
|
+
* @param {string} sourceId Source ID
|
|
46925
47777
|
* @param {*} [options] Override http request option.
|
|
46926
47778
|
* @throws {RequiredError}
|
|
46927
47779
|
* @memberof ConnectorsApi
|
|
46928
47780
|
*/
|
|
46929
|
-
v1ConnectorsSourcesSourceIdGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
|
|
47781
|
+
v1ConnectorsSourcesSourceIdGet(sourceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSourceConfigResponseWrapper, any, {}>>;
|
|
46930
47782
|
/**
|
|
46931
|
-
* Update
|
|
46932
|
-
* @summary Update
|
|
46933
|
-
* @param {string} sourceid Source ID
|
|
46934
|
-
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema
|
|
47783
|
+
* Update the search index schema for a connector source. **Auth:** `x-storeid` and `x-storesecret`. Body: schema definition.
|
|
47784
|
+
* @summary Update source index schema
|
|
47785
|
+
* @param {string} sourceid Source ID
|
|
47786
|
+
* @param {DataTypesUpdateIndexSchemaRequest} dataTypesUpdateIndexSchemaRequest Schema definition
|
|
46935
47787
|
* @param {*} [options] Override http request option.
|
|
46936
47788
|
* @throws {RequiredError}
|
|
46937
47789
|
* @memberof ConnectorsApi
|
|
46938
47790
|
*/
|
|
46939
47791
|
v1ConnectorsSourcesSourceidUpdateschemaPost(sourceid: string, dataTypesUpdateIndexSchemaRequest: DataTypesUpdateIndexSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUpdateSchemaResponse, any, {}>>;
|
|
46940
47792
|
/**
|
|
46941
|
-
* Upload source data
|
|
47793
|
+
* 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
47794
|
* @summary Upload source data
|
|
46943
47795
|
* @param {V1ConnectorsSourcesSourceidUploaddataPostRequest} [v1ConnectorsSourcesSourceidUploaddataPostRequest]
|
|
46944
47796
|
* @param {*} [options] Override http request option.
|
|
@@ -46947,19 +47799,19 @@ export declare class ConnectorsApi extends BaseAPI {
|
|
|
46947
47799
|
*/
|
|
46948
47800
|
v1ConnectorsSourcesSourceidUploaddataPost(v1ConnectorsSourcesSourceidUploaddataPostRequest?: V1ConnectorsSourcesSourceidUploaddataPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUploadSourceDataResponseWrapper, any, {}>>;
|
|
46949
47801
|
/**
|
|
46950
|
-
* Create task
|
|
46951
|
-
* @summary Create task
|
|
46952
|
-
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task
|
|
47802
|
+
* Create a sync task for a data source. **Auth:** `x-storeid` and `x-storesecret`. Task defines when and how to sync data.
|
|
47803
|
+
* @summary Create connector task
|
|
47804
|
+
* @param {DataTypesCreateTaskRequest} dataTypesCreateTaskRequest Task configuration
|
|
46953
47805
|
* @param {*} [options] Override http request option.
|
|
46954
47806
|
* @throws {RequiredError}
|
|
46955
47807
|
* @memberof ConnectorsApi
|
|
46956
47808
|
*/
|
|
46957
47809
|
v1ConnectorsTasksPost(dataTypesCreateTaskRequest: DataTypesCreateTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreateTaskResponse, any, {}>>;
|
|
46958
47810
|
/**
|
|
46959
|
-
*
|
|
47811
|
+
* Run a connector sync task once. **Auth:** `x-storeid` and `x-storesecret`. Body can include initiated_by (user ID).
|
|
46960
47812
|
* @summary Trigger task run
|
|
46961
47813
|
* @param {string} taskId Task ID
|
|
46962
|
-
* @param {number} body
|
|
47814
|
+
* @param {number} body User ID who triggered the run
|
|
46963
47815
|
* @param {*} [options] Override http request option.
|
|
46964
47816
|
* @throws {RequiredError}
|
|
46965
47817
|
* @memberof ConnectorsApi
|
|
@@ -47024,7 +47876,7 @@ export declare const CreditsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
47024
47876
|
*/
|
|
47025
47877
|
creditsConsumptionHistoryGet: (page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47026
47878
|
/**
|
|
47027
|
-
*
|
|
47879
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47028
47880
|
* @summary Get available credit plans
|
|
47029
47881
|
* @param {*} [options] Override http request option.
|
|
47030
47882
|
* @throws {RequiredError}
|
|
@@ -47107,9 +47959,9 @@ export declare const CreditsApiFp: (configuration?: Configuration) => {
|
|
|
47107
47959
|
* @param {*} [options] Override http request option.
|
|
47108
47960
|
* @throws {RequiredError}
|
|
47109
47961
|
*/
|
|
47110
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
47962
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesConsumptionHistoryResponse>>;
|
|
47111
47963
|
/**
|
|
47112
|
-
*
|
|
47964
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47113
47965
|
* @summary Get available credit plans
|
|
47114
47966
|
* @param {*} [options] Override http request option.
|
|
47115
47967
|
* @throws {RequiredError}
|
|
@@ -47192,9 +48044,9 @@ export declare const CreditsApiFactory: (configuration?: Configuration, basePath
|
|
|
47192
48044
|
* @param {*} [options] Override http request option.
|
|
47193
48045
|
* @throws {RequiredError}
|
|
47194
48046
|
*/
|
|
47195
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
48047
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesConsumptionHistoryResponse>;
|
|
47196
48048
|
/**
|
|
47197
|
-
*
|
|
48049
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47198
48050
|
* @summary Get available credit plans
|
|
47199
48051
|
* @param {*} [options] Override http request option.
|
|
47200
48052
|
* @throws {RequiredError}
|
|
@@ -47285,9 +48137,9 @@ export declare class CreditsApi extends BaseAPI {
|
|
|
47285
48137
|
* @throws {RequiredError}
|
|
47286
48138
|
* @memberof CreditsApi
|
|
47287
48139
|
*/
|
|
47288
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
48140
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesConsumptionHistoryResponse, any, {}>>;
|
|
47289
48141
|
/**
|
|
47290
|
-
*
|
|
48142
|
+
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47291
48143
|
* @summary Get available credit plans
|
|
47292
48144
|
* @param {*} [options] Override http request option.
|
|
47293
48145
|
* @throws {RequiredError}
|
|
@@ -47335,10 +48187,10 @@ export type CreditsTransactionsGetTypeEnum = typeof CreditsTransactionsGetTypeEn
|
|
|
47335
48187
|
*/
|
|
47336
48188
|
export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
47337
48189
|
/**
|
|
47338
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
48190
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47339
48191
|
* @summary List Custom Event Types
|
|
48192
|
+
* @param {string} xStoreID Store ID
|
|
47340
48193
|
* @param {string} authorization Bearer JWT token
|
|
47341
|
-
* @param {number} [storeId] Filter by store ID
|
|
47342
48194
|
* @param {boolean} [isActive] Filter by active status
|
|
47343
48195
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47344
48196
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47351,29 +48203,32 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47351
48203
|
* @param {*} [options] Override http request option.
|
|
47352
48204
|
* @throws {RequiredError}
|
|
47353
48205
|
*/
|
|
47354
|
-
|
|
48206
|
+
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
48207
|
/**
|
|
47356
48208
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47357
48209
|
* @summary Delete Custom Event Type
|
|
48210
|
+
* @param {string} xStoreID Store ID
|
|
47358
48211
|
* @param {string} authorization Bearer JWT token
|
|
47359
48212
|
* @param {number} id Event Type ID
|
|
47360
48213
|
* @param {*} [options] Override http request option.
|
|
47361
48214
|
* @throws {RequiredError}
|
|
47362
48215
|
*/
|
|
47363
|
-
|
|
48216
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47364
48217
|
/**
|
|
47365
48218
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47366
48219
|
* @summary Remove Field
|
|
48220
|
+
* @param {string} xStoreID Store ID
|
|
47367
48221
|
* @param {string} authorization Bearer JWT token
|
|
47368
48222
|
* @param {number} id Event Type ID
|
|
47369
48223
|
* @param {number} fid Field ID
|
|
47370
48224
|
* @param {*} [options] Override http request option.
|
|
47371
48225
|
* @throws {RequiredError}
|
|
47372
48226
|
*/
|
|
47373
|
-
|
|
48227
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete: (xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47374
48228
|
/**
|
|
47375
48229
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47376
48230
|
* @summary Update Field
|
|
48231
|
+
* @param {string} xStoreID Store ID
|
|
47377
48232
|
* @param {string} authorization Bearer JWT token
|
|
47378
48233
|
* @param {number} id Event Type ID
|
|
47379
48234
|
* @param {number} fid Field ID
|
|
@@ -47381,64 +48236,70 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47381
48236
|
* @param {*} [options] Override http request option.
|
|
47382
48237
|
* @throws {RequiredError}
|
|
47383
48238
|
*/
|
|
47384
|
-
|
|
48239
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut: (xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47385
48240
|
/**
|
|
47386
48241
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47387
48242
|
* @summary Add Field to Custom Event Type
|
|
48243
|
+
* @param {string} xStoreID Store ID
|
|
47388
48244
|
* @param {string} authorization Bearer JWT token
|
|
47389
48245
|
* @param {number} id Event Type ID
|
|
47390
48246
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47391
48247
|
* @param {*} [options] Override http request option.
|
|
47392
48248
|
* @throws {RequiredError}
|
|
47393
48249
|
*/
|
|
47394
|
-
|
|
48250
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost: (xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47395
48251
|
/**
|
|
47396
48252
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47397
48253
|
* @summary Get Custom Event Type
|
|
48254
|
+
* @param {string} xStoreID Store ID
|
|
47398
48255
|
* @param {string} authorization Bearer JWT token
|
|
47399
48256
|
* @param {number} id Event Type ID
|
|
47400
48257
|
* @param {*} [options] Override http request option.
|
|
47401
48258
|
* @throws {RequiredError}
|
|
47402
48259
|
*/
|
|
47403
|
-
|
|
48260
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47404
48261
|
/**
|
|
47405
48262
|
* Update an existing custom event type. Supports partial updates.
|
|
47406
48263
|
* @summary Update Custom Event Type
|
|
48264
|
+
* @param {string} xStoreID Store ID
|
|
47407
48265
|
* @param {string} authorization Bearer JWT token
|
|
47408
48266
|
* @param {number} id Event Type ID
|
|
47409
48267
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47410
48268
|
* @param {*} [options] Override http request option.
|
|
47411
48269
|
* @throws {RequiredError}
|
|
47412
48270
|
*/
|
|
47413
|
-
|
|
48271
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut: (xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47414
48272
|
/**
|
|
47415
48273
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47416
48274
|
* @summary Get Available Slots
|
|
48275
|
+
* @param {string} xStoreID Store ID
|
|
47417
48276
|
* @param {string} authorization Bearer JWT token
|
|
47418
48277
|
* @param {number} id Event Type ID
|
|
47419
48278
|
* @param {*} [options] Override http request option.
|
|
47420
48279
|
* @throws {RequiredError}
|
|
47421
48280
|
*/
|
|
47422
|
-
|
|
48281
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet: (xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47423
48282
|
/**
|
|
47424
48283
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47425
48284
|
* @summary Validate Event Payload
|
|
48285
|
+
* @param {string} xStoreID Store ID
|
|
47426
48286
|
* @param {string} authorization Bearer JWT token
|
|
47427
48287
|
* @param {number} id Event Type ID
|
|
47428
48288
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47429
48289
|
* @param {*} [options] Override http request option.
|
|
47430
48290
|
* @throws {RequiredError}
|
|
47431
48291
|
*/
|
|
47432
|
-
|
|
48292
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost: (xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47433
48293
|
/**
|
|
47434
48294
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47435
48295
|
* @summary Create Custom Event Type
|
|
48296
|
+
* @param {string} xStoreID Store ID
|
|
47436
48297
|
* @param {string} authorization Bearer JWT token
|
|
47437
48298
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47438
48299
|
* @param {*} [options] Override http request option.
|
|
47439
48300
|
* @throws {RequiredError}
|
|
47440
48301
|
*/
|
|
47441
|
-
|
|
48302
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost: (xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47442
48303
|
};
|
|
47443
48304
|
/**
|
|
47444
48305
|
* CustomEventsApi - functional programming interface
|
|
@@ -47446,10 +48307,10 @@ export declare const CustomEventsApiAxiosParamCreator: (configuration?: Configur
|
|
|
47446
48307
|
*/
|
|
47447
48308
|
export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
47448
48309
|
/**
|
|
47449
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
48310
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47450
48311
|
* @summary List Custom Event Types
|
|
48312
|
+
* @param {string} xStoreID Store ID
|
|
47451
48313
|
* @param {string} authorization Bearer JWT token
|
|
47452
|
-
* @param {number} [storeId] Filter by store ID
|
|
47453
48314
|
* @param {boolean} [isActive] Filter by active status
|
|
47454
48315
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47455
48316
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47462,35 +48323,38 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47462
48323
|
* @param {*} [options] Override http request option.
|
|
47463
48324
|
* @throws {RequiredError}
|
|
47464
48325
|
*/
|
|
47465
|
-
|
|
48326
|
+
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
48327
|
[key: string]: any;
|
|
47467
48328
|
}>>;
|
|
47468
48329
|
/**
|
|
47469
48330
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47470
48331
|
* @summary Delete Custom Event Type
|
|
48332
|
+
* @param {string} xStoreID Store ID
|
|
47471
48333
|
* @param {string} authorization Bearer JWT token
|
|
47472
48334
|
* @param {number} id Event Type ID
|
|
47473
48335
|
* @param {*} [options] Override http request option.
|
|
47474
48336
|
* @throws {RequiredError}
|
|
47475
48337
|
*/
|
|
47476
|
-
|
|
48338
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47477
48339
|
[key: string]: any;
|
|
47478
48340
|
}>>;
|
|
47479
48341
|
/**
|
|
47480
48342
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47481
48343
|
* @summary Remove Field
|
|
48344
|
+
* @param {string} xStoreID Store ID
|
|
47482
48345
|
* @param {string} authorization Bearer JWT token
|
|
47483
48346
|
* @param {number} id Event Type ID
|
|
47484
48347
|
* @param {number} fid Field ID
|
|
47485
48348
|
* @param {*} [options] Override http request option.
|
|
47486
48349
|
* @throws {RequiredError}
|
|
47487
48350
|
*/
|
|
47488
|
-
|
|
48351
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47489
48352
|
[key: string]: any;
|
|
47490
48353
|
}>>;
|
|
47491
48354
|
/**
|
|
47492
48355
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47493
48356
|
* @summary Update Field
|
|
48357
|
+
* @param {string} xStoreID Store ID
|
|
47494
48358
|
* @param {string} authorization Bearer JWT token
|
|
47495
48359
|
* @param {number} id Event Type ID
|
|
47496
48360
|
* @param {number} fid Field ID
|
|
@@ -47498,76 +48362,82 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47498
48362
|
* @param {*} [options] Override http request option.
|
|
47499
48363
|
* @throws {RequiredError}
|
|
47500
48364
|
*/
|
|
47501
|
-
|
|
48365
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47502
48366
|
[key: string]: any;
|
|
47503
48367
|
}>>;
|
|
47504
48368
|
/**
|
|
47505
48369
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47506
48370
|
* @summary Add Field to Custom Event Type
|
|
48371
|
+
* @param {string} xStoreID Store ID
|
|
47507
48372
|
* @param {string} authorization Bearer JWT token
|
|
47508
48373
|
* @param {number} id Event Type ID
|
|
47509
48374
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47510
48375
|
* @param {*} [options] Override http request option.
|
|
47511
48376
|
* @throws {RequiredError}
|
|
47512
48377
|
*/
|
|
47513
|
-
|
|
48378
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47514
48379
|
[key: string]: any;
|
|
47515
48380
|
}>>;
|
|
47516
48381
|
/**
|
|
47517
48382
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47518
48383
|
* @summary Get Custom Event Type
|
|
48384
|
+
* @param {string} xStoreID Store ID
|
|
47519
48385
|
* @param {string} authorization Bearer JWT token
|
|
47520
48386
|
* @param {number} id Event Type ID
|
|
47521
48387
|
* @param {*} [options] Override http request option.
|
|
47522
48388
|
* @throws {RequiredError}
|
|
47523
48389
|
*/
|
|
47524
|
-
|
|
48390
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47525
48391
|
[key: string]: any;
|
|
47526
48392
|
}>>;
|
|
47527
48393
|
/**
|
|
47528
48394
|
* Update an existing custom event type. Supports partial updates.
|
|
47529
48395
|
* @summary Update Custom Event Type
|
|
48396
|
+
* @param {string} xStoreID Store ID
|
|
47530
48397
|
* @param {string} authorization Bearer JWT token
|
|
47531
48398
|
* @param {number} id Event Type ID
|
|
47532
48399
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47533
48400
|
* @param {*} [options] Override http request option.
|
|
47534
48401
|
* @throws {RequiredError}
|
|
47535
48402
|
*/
|
|
47536
|
-
|
|
48403
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47537
48404
|
[key: string]: any;
|
|
47538
48405
|
}>>;
|
|
47539
48406
|
/**
|
|
47540
48407
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47541
48408
|
* @summary Get Available Slots
|
|
48409
|
+
* @param {string} xStoreID Store ID
|
|
47542
48410
|
* @param {string} authorization Bearer JWT token
|
|
47543
48411
|
* @param {number} id Event Type ID
|
|
47544
48412
|
* @param {*} [options] Override http request option.
|
|
47545
48413
|
* @throws {RequiredError}
|
|
47546
48414
|
*/
|
|
47547
|
-
|
|
48415
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47548
48416
|
[key: string]: any;
|
|
47549
48417
|
}>>;
|
|
47550
48418
|
/**
|
|
47551
48419
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47552
48420
|
* @summary Validate Event Payload
|
|
48421
|
+
* @param {string} xStoreID Store ID
|
|
47553
48422
|
* @param {string} authorization Bearer JWT token
|
|
47554
48423
|
* @param {number} id Event Type ID
|
|
47555
48424
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47556
48425
|
* @param {*} [options] Override http request option.
|
|
47557
48426
|
* @throws {RequiredError}
|
|
47558
48427
|
*/
|
|
47559
|
-
|
|
48428
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47560
48429
|
[key: string]: any;
|
|
47561
48430
|
}>>;
|
|
47562
48431
|
/**
|
|
47563
48432
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47564
48433
|
* @summary Create Custom Event Type
|
|
48434
|
+
* @param {string} xStoreID Store ID
|
|
47565
48435
|
* @param {string} authorization Bearer JWT token
|
|
47566
48436
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47567
48437
|
* @param {*} [options] Override http request option.
|
|
47568
48438
|
* @throws {RequiredError}
|
|
47569
48439
|
*/
|
|
47570
|
-
|
|
48440
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
47571
48441
|
[key: string]: any;
|
|
47572
48442
|
}>>;
|
|
47573
48443
|
};
|
|
@@ -47577,10 +48447,10 @@ export declare const CustomEventsApiFp: (configuration?: Configuration) => {
|
|
|
47577
48447
|
*/
|
|
47578
48448
|
export declare const CustomEventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47579
48449
|
/**
|
|
47580
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
48450
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47581
48451
|
* @summary List Custom Event Types
|
|
48452
|
+
* @param {string} xStoreID Store ID
|
|
47582
48453
|
* @param {string} authorization Bearer JWT token
|
|
47583
|
-
* @param {number} [storeId] Filter by store ID
|
|
47584
48454
|
* @param {boolean} [isActive] Filter by active status
|
|
47585
48455
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47586
48456
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47593,35 +48463,38 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47593
48463
|
* @param {*} [options] Override http request option.
|
|
47594
48464
|
* @throws {RequiredError}
|
|
47595
48465
|
*/
|
|
47596
|
-
|
|
48466
|
+
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
48467
|
[key: string]: any;
|
|
47598
48468
|
}>;
|
|
47599
48469
|
/**
|
|
47600
48470
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47601
48471
|
* @summary Delete Custom Event Type
|
|
48472
|
+
* @param {string} xStoreID Store ID
|
|
47602
48473
|
* @param {string} authorization Bearer JWT token
|
|
47603
48474
|
* @param {number} id Event Type ID
|
|
47604
48475
|
* @param {*} [options] Override http request option.
|
|
47605
48476
|
* @throws {RequiredError}
|
|
47606
48477
|
*/
|
|
47607
|
-
|
|
48478
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47608
48479
|
[key: string]: any;
|
|
47609
48480
|
}>;
|
|
47610
48481
|
/**
|
|
47611
48482
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47612
48483
|
* @summary Remove Field
|
|
48484
|
+
* @param {string} xStoreID Store ID
|
|
47613
48485
|
* @param {string} authorization Bearer JWT token
|
|
47614
48486
|
* @param {number} id Event Type ID
|
|
47615
48487
|
* @param {number} fid Field ID
|
|
47616
48488
|
* @param {*} [options] Override http request option.
|
|
47617
48489
|
* @throws {RequiredError}
|
|
47618
48490
|
*/
|
|
47619
|
-
|
|
48491
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47620
48492
|
[key: string]: any;
|
|
47621
48493
|
}>;
|
|
47622
48494
|
/**
|
|
47623
48495
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47624
48496
|
* @summary Update Field
|
|
48497
|
+
* @param {string} xStoreID Store ID
|
|
47625
48498
|
* @param {string} authorization Bearer JWT token
|
|
47626
48499
|
* @param {number} id Event Type ID
|
|
47627
48500
|
* @param {number} fid Field ID
|
|
@@ -47629,76 +48502,82 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47629
48502
|
* @param {*} [options] Override http request option.
|
|
47630
48503
|
* @throws {RequiredError}
|
|
47631
48504
|
*/
|
|
47632
|
-
|
|
48505
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47633
48506
|
[key: string]: any;
|
|
47634
48507
|
}>;
|
|
47635
48508
|
/**
|
|
47636
48509
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47637
48510
|
* @summary Add Field to Custom Event Type
|
|
48511
|
+
* @param {string} xStoreID Store ID
|
|
47638
48512
|
* @param {string} authorization Bearer JWT token
|
|
47639
48513
|
* @param {number} id Event Type ID
|
|
47640
48514
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
47641
48515
|
* @param {*} [options] Override http request option.
|
|
47642
48516
|
* @throws {RequiredError}
|
|
47643
48517
|
*/
|
|
47644
|
-
|
|
48518
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47645
48519
|
[key: string]: any;
|
|
47646
48520
|
}>;
|
|
47647
48521
|
/**
|
|
47648
48522
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47649
48523
|
* @summary Get Custom Event Type
|
|
48524
|
+
* @param {string} xStoreID Store ID
|
|
47650
48525
|
* @param {string} authorization Bearer JWT token
|
|
47651
48526
|
* @param {number} id Event Type ID
|
|
47652
48527
|
* @param {*} [options] Override http request option.
|
|
47653
48528
|
* @throws {RequiredError}
|
|
47654
48529
|
*/
|
|
47655
|
-
|
|
48530
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47656
48531
|
[key: string]: any;
|
|
47657
48532
|
}>;
|
|
47658
48533
|
/**
|
|
47659
48534
|
* Update an existing custom event type. Supports partial updates.
|
|
47660
48535
|
* @summary Update Custom Event Type
|
|
48536
|
+
* @param {string} xStoreID Store ID
|
|
47661
48537
|
* @param {string} authorization Bearer JWT token
|
|
47662
48538
|
* @param {number} id Event Type ID
|
|
47663
48539
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
47664
48540
|
* @param {*} [options] Override http request option.
|
|
47665
48541
|
* @throws {RequiredError}
|
|
47666
48542
|
*/
|
|
47667
|
-
|
|
48543
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47668
48544
|
[key: string]: any;
|
|
47669
48545
|
}>;
|
|
47670
48546
|
/**
|
|
47671
48547
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47672
48548
|
* @summary Get Available Slots
|
|
48549
|
+
* @param {string} xStoreID Store ID
|
|
47673
48550
|
* @param {string} authorization Bearer JWT token
|
|
47674
48551
|
* @param {number} id Event Type ID
|
|
47675
48552
|
* @param {*} [options] Override http request option.
|
|
47676
48553
|
* @throws {RequiredError}
|
|
47677
48554
|
*/
|
|
47678
|
-
|
|
48555
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47679
48556
|
[key: string]: any;
|
|
47680
48557
|
}>;
|
|
47681
48558
|
/**
|
|
47682
48559
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47683
48560
|
* @summary Validate Event Payload
|
|
48561
|
+
* @param {string} xStoreID Store ID
|
|
47684
48562
|
* @param {string} authorization Bearer JWT token
|
|
47685
48563
|
* @param {number} id Event Type ID
|
|
47686
48564
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
47687
48565
|
* @param {*} [options] Override http request option.
|
|
47688
48566
|
* @throws {RequiredError}
|
|
47689
48567
|
*/
|
|
47690
|
-
|
|
48568
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47691
48569
|
[key: string]: any;
|
|
47692
48570
|
}>;
|
|
47693
48571
|
/**
|
|
47694
48572
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47695
48573
|
* @summary Create Custom Event Type
|
|
48574
|
+
* @param {string} xStoreID Store ID
|
|
47696
48575
|
* @param {string} authorization Bearer JWT token
|
|
47697
48576
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47698
48577
|
* @param {*} [options] Override http request option.
|
|
47699
48578
|
* @throws {RequiredError}
|
|
47700
48579
|
*/
|
|
47701
|
-
|
|
48580
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
47702
48581
|
[key: string]: any;
|
|
47703
48582
|
}>;
|
|
47704
48583
|
};
|
|
@@ -47710,10 +48589,10 @@ export declare const CustomEventsApiFactory: (configuration?: Configuration, bas
|
|
|
47710
48589
|
*/
|
|
47711
48590
|
export declare class CustomEventsApi extends BaseAPI {
|
|
47712
48591
|
/**
|
|
47713
|
-
* Retrieve a paginated list of custom event types with optional filtering by
|
|
48592
|
+
* Retrieve a paginated list of custom event types with optional filtering by category and active status.
|
|
47714
48593
|
* @summary List Custom Event Types
|
|
48594
|
+
* @param {string} xStoreID Store ID
|
|
47715
48595
|
* @param {string} authorization Bearer JWT token
|
|
47716
|
-
* @param {number} [storeId] Filter by store ID
|
|
47717
48596
|
* @param {boolean} [isActive] Filter by active status
|
|
47718
48597
|
* @param {string} [category] Filter by category (user_journey, system, business, custom)
|
|
47719
48598
|
* @param {string} [search] Search in event names, display names, and descriptions
|
|
@@ -47727,24 +48606,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47727
48606
|
* @throws {RequiredError}
|
|
47728
48607
|
* @memberof CustomEventsApi
|
|
47729
48608
|
*/
|
|
47730
|
-
|
|
48609
|
+
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
48610
|
[key: string]: any;
|
|
47732
48611
|
}, any, {}>>;
|
|
47733
48612
|
/**
|
|
47734
48613
|
* Permanently delete a custom event type and all its field definitions. This operation cannot be undone.
|
|
47735
48614
|
* @summary Delete Custom Event Type
|
|
48615
|
+
* @param {string} xStoreID Store ID
|
|
47736
48616
|
* @param {string} authorization Bearer JWT token
|
|
47737
48617
|
* @param {number} id Event Type ID
|
|
47738
48618
|
* @param {*} [options] Override http request option.
|
|
47739
48619
|
* @throws {RequiredError}
|
|
47740
48620
|
* @memberof CustomEventsApi
|
|
47741
48621
|
*/
|
|
47742
|
-
|
|
48622
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdDelete(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47743
48623
|
[key: string]: any;
|
|
47744
48624
|
}, any, {}>>;
|
|
47745
48625
|
/**
|
|
47746
48626
|
* Remove a field definition from a custom event type. This operation cannot be undone.
|
|
47747
48627
|
* @summary Remove Field
|
|
48628
|
+
* @param {string} xStoreID Store ID
|
|
47748
48629
|
* @param {string} authorization Bearer JWT token
|
|
47749
48630
|
* @param {number} id Event Type ID
|
|
47750
48631
|
* @param {number} fid Field ID
|
|
@@ -47752,12 +48633,13 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47752
48633
|
* @throws {RequiredError}
|
|
47753
48634
|
* @memberof CustomEventsApi
|
|
47754
48635
|
*/
|
|
47755
|
-
|
|
48636
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete(xStoreID: string, authorization: string, id: number, fid: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47756
48637
|
[key: string]: any;
|
|
47757
48638
|
}, any, {}>>;
|
|
47758
48639
|
/**
|
|
47759
48640
|
* Update an existing field definition. Note: field_slot and field_type cannot be changed after creation.
|
|
47760
48641
|
* @summary Update Field
|
|
48642
|
+
* @param {string} xStoreID Store ID
|
|
47761
48643
|
* @param {string} authorization Bearer JWT token
|
|
47762
48644
|
* @param {number} id Event Type ID
|
|
47763
48645
|
* @param {number} fid Field ID
|
|
@@ -47766,12 +48648,13 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47766
48648
|
* @throws {RequiredError}
|
|
47767
48649
|
* @memberof CustomEventsApi
|
|
47768
48650
|
*/
|
|
47769
|
-
|
|
48651
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut(xStoreID: string, authorization: string, id: number, fid: number, modelsUpdateCustomEventFieldRequest: ModelsUpdateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47770
48652
|
[key: string]: any;
|
|
47771
48653
|
}, any, {}>>;
|
|
47772
48654
|
/**
|
|
47773
48655
|
* Add a new field definition to a custom event type. Fields define the data structure for custom events.
|
|
47774
48656
|
* @summary Add Field to Custom Event Type
|
|
48657
|
+
* @param {string} xStoreID Store ID
|
|
47775
48658
|
* @param {string} authorization Bearer JWT token
|
|
47776
48659
|
* @param {number} id Event Type ID
|
|
47777
48660
|
* @param {ModelsCreateCustomEventFieldRequest} modelsCreateCustomEventFieldRequest Field configuration
|
|
@@ -47779,24 +48662,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47779
48662
|
* @throws {RequiredError}
|
|
47780
48663
|
* @memberof CustomEventsApi
|
|
47781
48664
|
*/
|
|
47782
|
-
|
|
48665
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost(xStoreID: string, authorization: string, id: number, modelsCreateCustomEventFieldRequest: ModelsCreateCustomEventFieldRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47783
48666
|
[key: string]: any;
|
|
47784
48667
|
}, any, {}>>;
|
|
47785
48668
|
/**
|
|
47786
48669
|
* Retrieve a specific custom event type by its ID, including all field definitions.
|
|
47787
48670
|
* @summary Get Custom Event Type
|
|
48671
|
+
* @param {string} xStoreID Store ID
|
|
47788
48672
|
* @param {string} authorization Bearer JWT token
|
|
47789
48673
|
* @param {number} id Event Type ID
|
|
47790
48674
|
* @param {*} [options] Override http request option.
|
|
47791
48675
|
* @throws {RequiredError}
|
|
47792
48676
|
* @memberof CustomEventsApi
|
|
47793
48677
|
*/
|
|
47794
|
-
|
|
48678
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47795
48679
|
[key: string]: any;
|
|
47796
48680
|
}, any, {}>>;
|
|
47797
48681
|
/**
|
|
47798
48682
|
* Update an existing custom event type. Supports partial updates.
|
|
47799
48683
|
* @summary Update Custom Event Type
|
|
48684
|
+
* @param {string} xStoreID Store ID
|
|
47800
48685
|
* @param {string} authorization Bearer JWT token
|
|
47801
48686
|
* @param {number} id Event Type ID
|
|
47802
48687
|
* @param {ModelsUpdateCustomEventTypeRequest} modelsUpdateCustomEventTypeRequest Updated event type configuration
|
|
@@ -47804,24 +48689,26 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47804
48689
|
* @throws {RequiredError}
|
|
47805
48690
|
* @memberof CustomEventsApi
|
|
47806
48691
|
*/
|
|
47807
|
-
|
|
48692
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdPut(xStoreID: string, authorization: string, id: number, modelsUpdateCustomEventTypeRequest: ModelsUpdateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47808
48693
|
[key: string]: any;
|
|
47809
48694
|
}, any, {}>>;
|
|
47810
48695
|
/**
|
|
47811
48696
|
* Get available slot numbers for string and numeric fields. String fields use slots 1-25, numeric fields use slots 1-15.
|
|
47812
48697
|
* @summary Get Available Slots
|
|
48698
|
+
* @param {string} xStoreID Store ID
|
|
47813
48699
|
* @param {string} authorization Bearer JWT token
|
|
47814
48700
|
* @param {number} id Event Type ID
|
|
47815
48701
|
* @param {*} [options] Override http request option.
|
|
47816
48702
|
* @throws {RequiredError}
|
|
47817
48703
|
* @memberof CustomEventsApi
|
|
47818
48704
|
*/
|
|
47819
|
-
|
|
48705
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet(xStoreID: string, authorization: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47820
48706
|
[key: string]: any;
|
|
47821
48707
|
}, any, {}>>;
|
|
47822
48708
|
/**
|
|
47823
48709
|
* Validate an event payload against the custom event type schema. Returns validation errors if the payload doesn\'t match the schema.
|
|
47824
48710
|
* @summary Validate Event Payload
|
|
48711
|
+
* @param {string} xStoreID Store ID
|
|
47825
48712
|
* @param {string} authorization Bearer JWT token
|
|
47826
48713
|
* @param {number} id Event Type ID
|
|
47827
48714
|
* @param {ModelsValidatePayloadRequest} modelsValidatePayloadRequest Payload to validate
|
|
@@ -47829,19 +48716,20 @@ export declare class CustomEventsApi extends BaseAPI {
|
|
|
47829
48716
|
* @throws {RequiredError}
|
|
47830
48717
|
* @memberof CustomEventsApi
|
|
47831
48718
|
*/
|
|
47832
|
-
|
|
48719
|
+
adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost(xStoreID: string, authorization: string, id: number, modelsValidatePayloadRequest: ModelsValidatePayloadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47833
48720
|
[key: string]: any;
|
|
47834
48721
|
}, any, {}>>;
|
|
47835
48722
|
/**
|
|
47836
48723
|
* Create a new custom event type for your organization. Custom event types define the schema for tracking custom business events.
|
|
47837
48724
|
* @summary Create Custom Event Type
|
|
48725
|
+
* @param {string} xStoreID Store ID
|
|
47838
48726
|
* @param {string} authorization Bearer JWT token
|
|
47839
48727
|
* @param {ModelsCreateCustomEventTypeRequest} modelsCreateCustomEventTypeRequest Event type configuration
|
|
47840
48728
|
* @param {*} [options] Override http request option.
|
|
47841
48729
|
* @throws {RequiredError}
|
|
47842
48730
|
* @memberof CustomEventsApi
|
|
47843
48731
|
*/
|
|
47844
|
-
|
|
48732
|
+
adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID: string, authorization: string, modelsCreateCustomEventTypeRequest: ModelsCreateCustomEventTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
47845
48733
|
[key: string]: any;
|
|
47846
48734
|
}, any, {}>>;
|
|
47847
48735
|
}
|
|
@@ -48849,27 +49737,27 @@ export declare const DocumentationApiAxiosParamCreator: (configuration?: Configu
|
|
|
48849
49737
|
*/
|
|
48850
49738
|
v1DocsRecreateCollectionPost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48851
49739
|
/**
|
|
48852
|
-
*
|
|
49740
|
+
* 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
49741
|
* @summary Scrape and index documentation
|
|
48854
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49742
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
48855
49743
|
* @param {*} [options] Override http request option.
|
|
48856
49744
|
* @throws {RequiredError}
|
|
48857
49745
|
*/
|
|
48858
49746
|
v1DocsScrapePost: (xDocsAPIKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48859
49747
|
/**
|
|
48860
|
-
*
|
|
49748
|
+
* 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
49749
|
* @summary Search documentation
|
|
48862
49750
|
* @param {string} query Search query
|
|
48863
|
-
* @param {number} [limit]
|
|
49751
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
48864
49752
|
* @param {*} [options] Override http request option.
|
|
48865
49753
|
* @throws {RequiredError}
|
|
48866
49754
|
*/
|
|
48867
49755
|
v1DocsSearchPost: (query: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48868
49756
|
/**
|
|
48869
|
-
*
|
|
48870
|
-
* @summary Get search suggestions
|
|
48871
|
-
* @param {string} query
|
|
48872
|
-
* @param {number} [limit]
|
|
49757
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49758
|
+
* @summary Get doc search suggestions
|
|
49759
|
+
* @param {string} query Partial search query
|
|
49760
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
48873
49761
|
* @param {*} [options] Override http request option.
|
|
48874
49762
|
* @throws {RequiredError}
|
|
48875
49763
|
*/
|
|
@@ -48932,9 +49820,9 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48932
49820
|
[key: string]: any;
|
|
48933
49821
|
}>>;
|
|
48934
49822
|
/**
|
|
48935
|
-
*
|
|
49823
|
+
* 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
49824
|
* @summary Scrape and index documentation
|
|
48937
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49825
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
48938
49826
|
* @param {*} [options] Override http request option.
|
|
48939
49827
|
* @throws {RequiredError}
|
|
48940
49828
|
*/
|
|
@@ -48942,10 +49830,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48942
49830
|
[key: string]: any;
|
|
48943
49831
|
}>>;
|
|
48944
49832
|
/**
|
|
48945
|
-
*
|
|
49833
|
+
* 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
49834
|
* @summary Search documentation
|
|
48947
49835
|
* @param {string} query Search query
|
|
48948
|
-
* @param {number} [limit]
|
|
49836
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
48949
49837
|
* @param {*} [options] Override http request option.
|
|
48950
49838
|
* @throws {RequiredError}
|
|
48951
49839
|
*/
|
|
@@ -48953,10 +49841,10 @@ export declare const DocumentationApiFp: (configuration?: Configuration) => {
|
|
|
48953
49841
|
[key: string]: any;
|
|
48954
49842
|
}>>;
|
|
48955
49843
|
/**
|
|
48956
|
-
*
|
|
48957
|
-
* @summary Get search suggestions
|
|
48958
|
-
* @param {string} query
|
|
48959
|
-
* @param {number} [limit]
|
|
49844
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49845
|
+
* @summary Get doc search suggestions
|
|
49846
|
+
* @param {string} query Partial search query
|
|
49847
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
48960
49848
|
* @param {*} [options] Override http request option.
|
|
48961
49849
|
* @throws {RequiredError}
|
|
48962
49850
|
*/
|
|
@@ -49023,9 +49911,9 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49023
49911
|
[key: string]: any;
|
|
49024
49912
|
}>;
|
|
49025
49913
|
/**
|
|
49026
|
-
*
|
|
49914
|
+
* 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
49915
|
* @summary Scrape and index documentation
|
|
49028
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
49916
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
49029
49917
|
* @param {*} [options] Override http request option.
|
|
49030
49918
|
* @throws {RequiredError}
|
|
49031
49919
|
*/
|
|
@@ -49033,10 +49921,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49033
49921
|
[key: string]: any;
|
|
49034
49922
|
}>;
|
|
49035
49923
|
/**
|
|
49036
|
-
*
|
|
49924
|
+
* 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
49925
|
* @summary Search documentation
|
|
49038
49926
|
* @param {string} query Search query
|
|
49039
|
-
* @param {number} [limit]
|
|
49927
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
49040
49928
|
* @param {*} [options] Override http request option.
|
|
49041
49929
|
* @throws {RequiredError}
|
|
49042
49930
|
*/
|
|
@@ -49044,10 +49932,10 @@ export declare const DocumentationApiFactory: (configuration?: Configuration, ba
|
|
|
49044
49932
|
[key: string]: any;
|
|
49045
49933
|
}>;
|
|
49046
49934
|
/**
|
|
49047
|
-
*
|
|
49048
|
-
* @summary Get search suggestions
|
|
49049
|
-
* @param {string} query
|
|
49050
|
-
* @param {number} [limit]
|
|
49935
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
49936
|
+
* @summary Get doc search suggestions
|
|
49937
|
+
* @param {string} query Partial search query
|
|
49938
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
49051
49939
|
* @param {*} [options] Override http request option.
|
|
49052
49940
|
* @throws {RequiredError}
|
|
49053
49941
|
*/
|
|
@@ -49120,9 +50008,9 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49120
50008
|
[key: string]: any;
|
|
49121
50009
|
}, any, {}>>;
|
|
49122
50010
|
/**
|
|
49123
|
-
*
|
|
50011
|
+
* 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
50012
|
* @summary Scrape and index documentation
|
|
49125
|
-
* @param {string} xDocsAPIKey Documentation API
|
|
50013
|
+
* @param {string} xDocsAPIKey Documentation API key (from dashboard)
|
|
49126
50014
|
* @param {*} [options] Override http request option.
|
|
49127
50015
|
* @throws {RequiredError}
|
|
49128
50016
|
* @memberof DocumentationApi
|
|
@@ -49131,10 +50019,10 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49131
50019
|
[key: string]: any;
|
|
49132
50020
|
}, any, {}>>;
|
|
49133
50021
|
/**
|
|
49134
|
-
*
|
|
50022
|
+
* 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
50023
|
* @summary Search documentation
|
|
49136
50024
|
* @param {string} query Search query
|
|
49137
|
-
* @param {number} [limit]
|
|
50025
|
+
* @param {number} [limit] Max results (default: 10, max: 100)
|
|
49138
50026
|
* @param {*} [options] Override http request option.
|
|
49139
50027
|
* @throws {RequiredError}
|
|
49140
50028
|
* @memberof DocumentationApi
|
|
@@ -49143,10 +50031,10 @@ export declare class DocumentationApi extends BaseAPI {
|
|
|
49143
50031
|
[key: string]: any;
|
|
49144
50032
|
}, any, {}>>;
|
|
49145
50033
|
/**
|
|
49146
|
-
*
|
|
49147
|
-
* @summary Get search suggestions
|
|
49148
|
-
* @param {string} query
|
|
49149
|
-
* @param {number} [limit]
|
|
50034
|
+
* Autocomplete suggestions for documentation search. No authentication required. Use for dropdown/typeahead UIs. Empty query returns no suggestions.
|
|
50035
|
+
* @summary Get doc search suggestions
|
|
50036
|
+
* @param {string} query Partial search query
|
|
50037
|
+
* @param {number} [limit] Max suggestions (default: 6, max: 20)
|
|
49150
50038
|
* @param {*} [options] Override http request option.
|
|
49151
50039
|
* @throws {RequiredError}
|
|
49152
50040
|
* @memberof DocumentationApi
|
|
@@ -55363,56 +56251,56 @@ export declare class PluralsDeclensionsApi extends BaseAPI {
|
|
|
55363
56251
|
*/
|
|
55364
56252
|
export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
55365
56253
|
/**
|
|
55366
|
-
*
|
|
55367
|
-
* @summary Get
|
|
55368
|
-
* @param {string} xStoreid Store ID
|
|
55369
|
-
* @param {string} xStoresecret Store
|
|
56254
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
56255
|
+
* @summary Get suggestions configuration
|
|
56256
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56257
|
+
* @param {string} xStoresecret Store read secret
|
|
55370
56258
|
* @param {*} [options] Override http request option.
|
|
55371
56259
|
* @throws {RequiredError}
|
|
55372
56260
|
*/
|
|
55373
56261
|
v1SuggestionsConfigGet: (xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55374
56262
|
/**
|
|
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
|
|
56263
|
+
* 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.
|
|
56264
|
+
* @summary Get query suggestions (GET)
|
|
56265
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56266
|
+
* @param {string} xStoresecret Store read secret
|
|
56267
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56268
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55381
56269
|
* @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
|
|
56270
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
56271
|
+
* @param {string} [q] Alias for query
|
|
56272
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
56273
|
+
* @param {number} [page] Page for pagination
|
|
56274
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
56275
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
56276
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
56277
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
56278
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
56279
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
56280
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
56281
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
56282
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
56283
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
56284
|
+
* @param {number} [minPopularity] Min popularity
|
|
56285
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
56286
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
56287
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
56288
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
56289
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
56290
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55403
56291
|
* @param {*} [options] Override http request option.
|
|
55404
56292
|
* @throws {RequiredError}
|
|
55405
56293
|
*/
|
|
55406
56294
|
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
56295
|
/**
|
|
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
|
|
56296
|
+
* 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.
|
|
56297
|
+
* @summary Get query suggestions (POST)
|
|
56298
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56299
|
+
* @param {string} xStoresecret Store read secret
|
|
56300
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56301
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55414
56302
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55415
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
56303
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55416
56304
|
* @param {*} [options] Override http request option.
|
|
55417
56305
|
* @throws {RequiredError}
|
|
55418
56306
|
*/
|
|
@@ -55424,56 +56312,56 @@ export declare const QuerySuggestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
55424
56312
|
*/
|
|
55425
56313
|
export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
55426
56314
|
/**
|
|
55427
|
-
*
|
|
55428
|
-
* @summary Get
|
|
55429
|
-
* @param {string} xStoreid Store ID
|
|
55430
|
-
* @param {string} xStoresecret Store
|
|
56315
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
56316
|
+
* @summary Get suggestions configuration
|
|
56317
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56318
|
+
* @param {string} xStoresecret Store read secret
|
|
55431
56319
|
* @param {*} [options] Override http request option.
|
|
55432
56320
|
* @throws {RequiredError}
|
|
55433
56321
|
*/
|
|
55434
56322
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SuggestionsConfigGet200Response>>;
|
|
55435
56323
|
/**
|
|
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
|
|
56324
|
+
* 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.
|
|
56325
|
+
* @summary Get query suggestions (GET)
|
|
56326
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56327
|
+
* @param {string} xStoresecret Store read secret
|
|
56328
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56329
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55442
56330
|
* @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
|
|
56331
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
56332
|
+
* @param {string} [q] Alias for query
|
|
56333
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
56334
|
+
* @param {number} [page] Page for pagination
|
|
56335
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
56336
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
56337
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
56338
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
56339
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
56340
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
56341
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
56342
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
56343
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
56344
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
56345
|
+
* @param {number} [minPopularity] Min popularity
|
|
56346
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
56347
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
56348
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
56349
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
56350
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
56351
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55464
56352
|
* @param {*} [options] Override http request option.
|
|
55465
56353
|
* @throws {RequiredError}
|
|
55466
56354
|
*/
|
|
55467
56355
|
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
56356
|
/**
|
|
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
|
|
56357
|
+
* 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.
|
|
56358
|
+
* @summary Get query suggestions (POST)
|
|
56359
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56360
|
+
* @param {string} xStoresecret Store read secret
|
|
56361
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56362
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55475
56363
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55476
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
56364
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55477
56365
|
* @param {*} [options] Override http request option.
|
|
55478
56366
|
* @throws {RequiredError}
|
|
55479
56367
|
*/
|
|
@@ -55485,56 +56373,56 @@ export declare const QuerySuggestionsApiFp: (configuration?: Configuration) => {
|
|
|
55485
56373
|
*/
|
|
55486
56374
|
export declare const QuerySuggestionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
55487
56375
|
/**
|
|
55488
|
-
*
|
|
55489
|
-
* @summary Get
|
|
55490
|
-
* @param {string} xStoreid Store ID
|
|
55491
|
-
* @param {string} xStoresecret Store
|
|
56376
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
56377
|
+
* @summary Get suggestions configuration
|
|
56378
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56379
|
+
* @param {string} xStoresecret Store read secret
|
|
55492
56380
|
* @param {*} [options] Override http request option.
|
|
55493
56381
|
* @throws {RequiredError}
|
|
55494
56382
|
*/
|
|
55495
56383
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<V1SuggestionsConfigGet200Response>;
|
|
55496
56384
|
/**
|
|
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
|
|
56385
|
+
* 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.
|
|
56386
|
+
* @summary Get query suggestions (GET)
|
|
56387
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56388
|
+
* @param {string} xStoresecret Store read secret
|
|
56389
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56390
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55503
56391
|
* @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
|
|
56392
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
56393
|
+
* @param {string} [q] Alias for query
|
|
56394
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
56395
|
+
* @param {number} [page] Page for pagination
|
|
56396
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
56397
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
56398
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
56399
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
56400
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
56401
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
56402
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
56403
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
56404
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
56405
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
56406
|
+
* @param {number} [minPopularity] Min popularity
|
|
56407
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
56408
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
56409
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
56410
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
56411
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
56412
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55525
56413
|
* @param {*} [options] Override http request option.
|
|
55526
56414
|
* @throws {RequiredError}
|
|
55527
56415
|
*/
|
|
55528
56416
|
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
56417
|
/**
|
|
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
|
|
56418
|
+
* 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.
|
|
56419
|
+
* @summary Get query suggestions (POST)
|
|
56420
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56421
|
+
* @param {string} xStoresecret Store read secret
|
|
56422
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56423
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55536
56424
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55537
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
56425
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55538
56426
|
* @param {*} [options] Override http request option.
|
|
55539
56427
|
* @throws {RequiredError}
|
|
55540
56428
|
*/
|
|
@@ -55548,58 +56436,58 @@ export declare const QuerySuggestionsApiFactory: (configuration?: Configuration,
|
|
|
55548
56436
|
*/
|
|
55549
56437
|
export declare class QuerySuggestionsApi extends BaseAPI {
|
|
55550
56438
|
/**
|
|
55551
|
-
*
|
|
55552
|
-
* @summary Get
|
|
55553
|
-
* @param {string} xStoreid Store ID
|
|
55554
|
-
* @param {string} xStoresecret Store
|
|
56439
|
+
* Returns limits, supported time ranges, and default values for the query suggestions API. **Auth:** `x-storeid` and `x-storesecret`.
|
|
56440
|
+
* @summary Get suggestions configuration
|
|
56441
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56442
|
+
* @param {string} xStoresecret Store read secret
|
|
55555
56443
|
* @param {*} [options] Override http request option.
|
|
55556
56444
|
* @throws {RequiredError}
|
|
55557
56445
|
* @memberof QuerySuggestionsApi
|
|
55558
56446
|
*/
|
|
55559
56447
|
v1SuggestionsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SuggestionsConfigGet200Response, any, {}>>;
|
|
55560
56448
|
/**
|
|
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
|
|
56449
|
+
* 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.
|
|
56450
|
+
* @summary Get query suggestions (GET)
|
|
56451
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56452
|
+
* @param {string} xStoresecret Store read secret
|
|
56453
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56454
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55567
56455
|
* @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
|
|
56456
|
+
* @param {string} [query] Partial query (use \'query\' or \'q\')
|
|
56457
|
+
* @param {string} [q] Alias for query
|
|
56458
|
+
* @param {number} [hitsPerPage] Suggestions to return
|
|
56459
|
+
* @param {number} [page] Page for pagination
|
|
56460
|
+
* @param {string} [analyticsTags] Comma-separated tags to filter
|
|
56461
|
+
* @param {V1SuggestionsQueriesGetTagsMatchModeEnum} [tagsMatchMode] Match mode for tags
|
|
56462
|
+
* @param {boolean} [includeCategories] Include category in suggestions
|
|
56463
|
+
* @param {boolean} [includeFacets] Include facet info
|
|
56464
|
+
* @param {boolean} [includeDropdownRecommendations] Include dropdown recommendations
|
|
56465
|
+
* @param {boolean} [includeDropdownProductList] Include product list in dropdown
|
|
56466
|
+
* @param {boolean} [includeFilteredTabs] Include filtered tabs
|
|
56467
|
+
* @param {boolean} [includeEmptyQueryRecommendations] Popular suggestions when query empty
|
|
56468
|
+
* @param {number} [maxCategories] Max categories per suggestion
|
|
56469
|
+
* @param {number} [maxFacets] Max facets per suggestion
|
|
56470
|
+
* @param {number} [minPopularity] Min popularity
|
|
56471
|
+
* @param {V1SuggestionsQueriesGetTimeRangeEnum} [timeRange] Data time range
|
|
56472
|
+
* @param {boolean} [disableTypoTolerance] Disable fuzzy matching
|
|
56473
|
+
* @param {string} [filteredTabs] URL-encoded JSON array of tab configs
|
|
56474
|
+
* @param {string} [userId] User ID (fallback if header not set)
|
|
56475
|
+
* @param {string} [anonId] Anonymous ID (fallback)
|
|
56476
|
+
* @param {string} [sessionId] Session ID (fallback)
|
|
55589
56477
|
* @param {*} [options] Override http request option.
|
|
55590
56478
|
* @throws {RequiredError}
|
|
55591
56479
|
* @memberof QuerySuggestionsApi
|
|
55592
56480
|
*/
|
|
55593
56481
|
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
56482
|
/**
|
|
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
|
|
56483
|
+
* 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.
|
|
56484
|
+
* @summary Get query suggestions (POST)
|
|
56485
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
56486
|
+
* @param {string} xStoresecret Store read secret
|
|
56487
|
+
* @param {string} [xUserId] User ID for personalization
|
|
56488
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
55601
56489
|
* @param {string} [xSessionId] Session ID for personalization
|
|
55602
|
-
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest]
|
|
56490
|
+
* @param {QuerySuggestionsServiceQuerySuggestionsRequest} [querySuggestionsServiceQuerySuggestionsRequest] Request (query, hitsPerPage, analytics_tags, filtered_tabs, etc.)
|
|
55603
56491
|
* @param {*} [options] Override http request option.
|
|
55604
56492
|
* @throws {RequiredError}
|
|
55605
56493
|
* @memberof QuerySuggestionsApi
|
|
@@ -58138,34 +59026,34 @@ export declare class RolesApi extends BaseAPI {
|
|
|
58138
59026
|
*/
|
|
58139
59027
|
export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58140
59028
|
/**
|
|
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
|
|
59029
|
+
* 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.
|
|
59030
|
+
* @summary Bulk index documents
|
|
59031
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59032
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59033
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59034
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58147
59035
|
* @param {*} [options] Override http request option.
|
|
58148
59036
|
* @throws {RequiredError}
|
|
58149
59037
|
*/
|
|
58150
59038
|
apiV1StoresXStoreIDDocumentsBulkPost: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58151
59039
|
/**
|
|
58152
|
-
*
|
|
58153
|
-
* @summary Delete a document
|
|
58154
|
-
* @param {string} xStoreid Store ID
|
|
58155
|
-
* @param {string} xStoreWriteSecret Store
|
|
58156
|
-
* @param {string} xStoreID
|
|
59040
|
+
* 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.
|
|
59041
|
+
* @summary Delete a document
|
|
59042
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59043
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59044
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58157
59045
|
* @param {string} documentID Document ID to delete
|
|
58158
59046
|
* @param {*} [options] Override http request option.
|
|
58159
59047
|
* @throws {RequiredError}
|
|
58160
59048
|
*/
|
|
58161
59049
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58162
59050
|
/**
|
|
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
|
|
59051
|
+
* 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.
|
|
59052
|
+
* @summary Index a single document
|
|
59053
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59054
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59055
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59056
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58169
59057
|
* @param {*} [options] Override http request option.
|
|
58170
59058
|
* @throws {RequiredError}
|
|
58171
59059
|
*/
|
|
@@ -58177,34 +59065,34 @@ export declare const SDKDocumentsApiAxiosParamCreator: (configuration?: Configur
|
|
|
58177
59065
|
*/
|
|
58178
59066
|
export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
58179
59067
|
/**
|
|
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
|
|
59068
|
+
* 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.
|
|
59069
|
+
* @summary Bulk index documents
|
|
59070
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59071
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59072
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59073
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58186
59074
|
* @param {*} [options] Override http request option.
|
|
58187
59075
|
* @throws {RequiredError}
|
|
58188
59076
|
*/
|
|
58189
59077
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesBulkDocumentResponseWrapper>>;
|
|
58190
59078
|
/**
|
|
58191
|
-
*
|
|
58192
|
-
* @summary Delete a document
|
|
58193
|
-
* @param {string} xStoreid Store ID
|
|
58194
|
-
* @param {string} xStoreWriteSecret Store
|
|
58195
|
-
* @param {string} xStoreID
|
|
59079
|
+
* 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.
|
|
59080
|
+
* @summary Delete a document
|
|
59081
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59082
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59083
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58196
59084
|
* @param {string} documentID Document ID to delete
|
|
58197
59085
|
* @param {*} [options] Override http request option.
|
|
58198
59086
|
* @throws {RequiredError}
|
|
58199
59087
|
*/
|
|
58200
59088
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesDocumentResponseWrapper>>;
|
|
58201
59089
|
/**
|
|
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
|
|
59090
|
+
* 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.
|
|
59091
|
+
* @summary Index a single document
|
|
59092
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59093
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59094
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59095
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58208
59096
|
* @param {*} [options] Override http request option.
|
|
58209
59097
|
* @throws {RequiredError}
|
|
58210
59098
|
*/
|
|
@@ -58216,34 +59104,34 @@ export declare const SDKDocumentsApiFp: (configuration?: Configuration) => {
|
|
|
58216
59104
|
*/
|
|
58217
59105
|
export declare const SDKDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58218
59106
|
/**
|
|
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
|
|
59107
|
+
* 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.
|
|
59108
|
+
* @summary Bulk index documents
|
|
59109
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59110
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59111
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59112
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58225
59113
|
* @param {*} [options] Override http request option.
|
|
58226
59114
|
* @throws {RequiredError}
|
|
58227
59115
|
*/
|
|
58228
59116
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesBulkDocumentResponseWrapper>;
|
|
58229
59117
|
/**
|
|
58230
|
-
*
|
|
58231
|
-
* @summary Delete a document
|
|
58232
|
-
* @param {string} xStoreid Store ID
|
|
58233
|
-
* @param {string} xStoreWriteSecret Store
|
|
58234
|
-
* @param {string} xStoreID
|
|
59118
|
+
* 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.
|
|
59119
|
+
* @summary Delete a document
|
|
59120
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59121
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59122
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58235
59123
|
* @param {string} documentID Document ID to delete
|
|
58236
59124
|
* @param {*} [options] Override http request option.
|
|
58237
59125
|
* @throws {RequiredError}
|
|
58238
59126
|
*/
|
|
58239
59127
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesDocumentResponseWrapper>;
|
|
58240
59128
|
/**
|
|
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
|
|
59129
|
+
* 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.
|
|
59130
|
+
* @summary Index a single document
|
|
59131
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59132
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59133
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59134
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58247
59135
|
* @param {*} [options] Override http request option.
|
|
58248
59136
|
* @throws {RequiredError}
|
|
58249
59137
|
*/
|
|
@@ -58257,23 +59145,23 @@ export declare const SDKDocumentsApiFactory: (configuration?: Configuration, bas
|
|
|
58257
59145
|
*/
|
|
58258
59146
|
export declare class SDKDocumentsApi extends BaseAPI {
|
|
58259
59147
|
/**
|
|
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
|
|
59148
|
+
* 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.
|
|
59149
|
+
* @summary Bulk index documents
|
|
59150
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59151
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59152
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59153
|
+
* @param {DataTypesBulkDocumentRequest} dataTypesBulkDocumentRequest List of operations
|
|
58266
59154
|
* @param {*} [options] Override http request option.
|
|
58267
59155
|
* @throws {RequiredError}
|
|
58268
59156
|
* @memberof SDKDocumentsApi
|
|
58269
59157
|
*/
|
|
58270
59158
|
apiV1StoresXStoreIDDocumentsBulkPost(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesBulkDocumentRequest: DataTypesBulkDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesBulkDocumentResponseWrapper, any, {}>>;
|
|
58271
59159
|
/**
|
|
58272
|
-
*
|
|
58273
|
-
* @summary Delete a document
|
|
58274
|
-
* @param {string} xStoreid Store ID
|
|
58275
|
-
* @param {string} xStoreWriteSecret Store
|
|
58276
|
-
* @param {string} xStoreID
|
|
59160
|
+
* 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.
|
|
59161
|
+
* @summary Delete a document
|
|
59162
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59163
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59164
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58277
59165
|
* @param {string} documentID Document ID to delete
|
|
58278
59166
|
* @param {*} [options] Override http request option.
|
|
58279
59167
|
* @throws {RequiredError}
|
|
@@ -58281,12 +59169,12 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
58281
59169
|
*/
|
|
58282
59170
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, documentID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesDocumentResponseWrapper, any, {}>>;
|
|
58283
59171
|
/**
|
|
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
|
|
59172
|
+
* 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.
|
|
59173
|
+
* @summary Index a single document
|
|
59174
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59175
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59176
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59177
|
+
* @param {DataTypesDocumentRequest} dataTypesDocumentRequest Document fields to index
|
|
58290
59178
|
* @param {*} [options] Override http request option.
|
|
58291
59179
|
* @throws {RequiredError}
|
|
58292
59180
|
* @memberof SDKDocumentsApi
|
|
@@ -58299,22 +59187,22 @@ export declare class SDKDocumentsApi extends BaseAPI {
|
|
|
58299
59187
|
*/
|
|
58300
59188
|
export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58301
59189
|
/**
|
|
58302
|
-
*
|
|
58303
|
-
* @summary Get
|
|
58304
|
-
* @param {string} xStoreid Store ID
|
|
58305
|
-
* @param {string} xStoresecret Store
|
|
58306
|
-
* @param {string} xStoreID
|
|
59190
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59191
|
+
* @summary Get query suggestions configuration
|
|
59192
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59193
|
+
* @param {string} xStoresecret Store read secret
|
|
59194
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58307
59195
|
* @param {*} [options] Override http request option.
|
|
58308
59196
|
* @throws {RequiredError}
|
|
58309
59197
|
*/
|
|
58310
59198
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58311
59199
|
/**
|
|
58312
|
-
*
|
|
58313
|
-
* @summary Update
|
|
58314
|
-
* @param {string} xStoreid Store ID
|
|
58315
|
-
* @param {string} xStoreWriteSecret Store
|
|
58316
|
-
* @param {string} xStoreID
|
|
58317
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
59200
|
+
* 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.
|
|
59201
|
+
* @summary Update query suggestions configuration
|
|
59202
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59203
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59204
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59205
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58318
59206
|
* @param {*} [options] Override http request option.
|
|
58319
59207
|
* @throws {RequiredError}
|
|
58320
59208
|
*/
|
|
@@ -58326,22 +59214,22 @@ export declare const SDKQuerySuggestionsConfigApiAxiosParamCreator: (configurati
|
|
|
58326
59214
|
*/
|
|
58327
59215
|
export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configuration) => {
|
|
58328
59216
|
/**
|
|
58329
|
-
*
|
|
58330
|
-
* @summary Get
|
|
58331
|
-
* @param {string} xStoreid Store ID
|
|
58332
|
-
* @param {string} xStoresecret Store
|
|
58333
|
-
* @param {string} xStoreID
|
|
59217
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59218
|
+
* @summary Get query suggestions configuration
|
|
59219
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59220
|
+
* @param {string} xStoresecret Store read secret
|
|
59221
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58334
59222
|
* @param {*} [options] Override http request option.
|
|
58335
59223
|
* @throws {RequiredError}
|
|
58336
59224
|
*/
|
|
58337
59225
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>>;
|
|
58338
59226
|
/**
|
|
58339
|
-
*
|
|
58340
|
-
* @summary Update
|
|
58341
|
-
* @param {string} xStoreid Store ID
|
|
58342
|
-
* @param {string} xStoreWriteSecret Store
|
|
58343
|
-
* @param {string} xStoreID
|
|
58344
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
59227
|
+
* 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.
|
|
59228
|
+
* @summary Update query suggestions configuration
|
|
59229
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59230
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59231
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59232
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58345
59233
|
* @param {*} [options] Override http request option.
|
|
58346
59234
|
* @throws {RequiredError}
|
|
58347
59235
|
*/
|
|
@@ -58353,22 +59241,22 @@ export declare const SDKQuerySuggestionsConfigApiFp: (configuration?: Configurat
|
|
|
58353
59241
|
*/
|
|
58354
59242
|
export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58355
59243
|
/**
|
|
58356
|
-
*
|
|
58357
|
-
* @summary Get
|
|
58358
|
-
* @param {string} xStoreid Store ID
|
|
58359
|
-
* @param {string} xStoresecret Store
|
|
58360
|
-
* @param {string} xStoreID
|
|
59244
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59245
|
+
* @summary Get query suggestions configuration
|
|
59246
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59247
|
+
* @param {string} xStoresecret Store read secret
|
|
59248
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58361
59249
|
* @param {*} [options] Override http request option.
|
|
58362
59250
|
* @throws {RequiredError}
|
|
58363
59251
|
*/
|
|
58364
59252
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySuggestionsServiceQuerySuggestionsAPIResponse>;
|
|
58365
59253
|
/**
|
|
58366
|
-
*
|
|
58367
|
-
* @summary Update
|
|
58368
|
-
* @param {string} xStoreid Store ID
|
|
58369
|
-
* @param {string} xStoreWriteSecret Store
|
|
58370
|
-
* @param {string} xStoreID
|
|
58371
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
59254
|
+
* 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.
|
|
59255
|
+
* @summary Update query suggestions configuration
|
|
59256
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59257
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59258
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59259
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58372
59260
|
* @param {*} [options] Override http request option.
|
|
58373
59261
|
* @throws {RequiredError}
|
|
58374
59262
|
*/
|
|
@@ -58382,23 +59270,23 @@ export declare const SDKQuerySuggestionsConfigApiFactory: (configuration?: Confi
|
|
|
58382
59270
|
*/
|
|
58383
59271
|
export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
|
|
58384
59272
|
/**
|
|
58385
|
-
*
|
|
58386
|
-
* @summary Get
|
|
58387
|
-
* @param {string} xStoreid Store ID
|
|
58388
|
-
* @param {string} xStoresecret Store
|
|
58389
|
-
* @param {string} xStoreID
|
|
59273
|
+
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59274
|
+
* @summary Get query suggestions configuration
|
|
59275
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59276
|
+
* @param {string} xStoresecret Store read secret
|
|
59277
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58390
59278
|
* @param {*} [options] Override http request option.
|
|
58391
59279
|
* @throws {RequiredError}
|
|
58392
59280
|
* @memberof SDKQuerySuggestionsConfigApi
|
|
58393
59281
|
*/
|
|
58394
59282
|
apiV1StoresXStoreIDQuerySuggestionsConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuerySuggestionsServiceQuerySuggestionsAPIResponse, any, {}>>;
|
|
58395
59283
|
/**
|
|
58396
|
-
*
|
|
58397
|
-
* @summary Update
|
|
58398
|
-
* @param {string} xStoreid Store ID
|
|
58399
|
-
* @param {string} xStoreWriteSecret Store
|
|
58400
|
-
* @param {string} xStoreID
|
|
58401
|
-
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest
|
|
59284
|
+
* 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.
|
|
59285
|
+
* @summary Update query suggestions configuration
|
|
59286
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59287
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59288
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59289
|
+
* @param {QuerySuggestionsServiceUpdateSuggestionConfigRequest} querySuggestionsServiceUpdateSuggestionConfigRequest Fields to update (partial)
|
|
58402
59290
|
* @param {*} [options] Override http request option.
|
|
58403
59291
|
* @throws {RequiredError}
|
|
58404
59292
|
* @memberof SDKQuerySuggestionsConfigApi
|
|
@@ -58411,32 +59299,32 @@ export declare class SDKQuerySuggestionsConfigApi extends BaseAPI {
|
|
|
58411
59299
|
*/
|
|
58412
59300
|
export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58413
59301
|
/**
|
|
58414
|
-
*
|
|
58415
|
-
* @summary Clear
|
|
58416
|
-
* @param {string} xStoreid Store ID
|
|
58417
|
-
* @param {string} xStoreWriteSecret Store
|
|
58418
|
-
* @param {string} xStoreID
|
|
59302
|
+
* 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.
|
|
59303
|
+
* @summary Clear all documents
|
|
59304
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59305
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59306
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58419
59307
|
* @param {*} [options] Override http request option.
|
|
58420
59308
|
* @throws {RequiredError}
|
|
58421
59309
|
*/
|
|
58422
59310
|
apiV1StoresXStoreIDDocumentsDelete: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58423
59311
|
/**
|
|
58424
|
-
*
|
|
58425
|
-
* @summary Get
|
|
58426
|
-
* @param {string} xStoreid Store ID
|
|
58427
|
-
* @param {string} xStoresecret Store
|
|
58428
|
-
* @param {string} xStoreID
|
|
59312
|
+
* 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.
|
|
59313
|
+
* @summary Get index schema
|
|
59314
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59315
|
+
* @param {string} xStoresecret Store read secret
|
|
59316
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58429
59317
|
* @param {*} [options] Override http request option.
|
|
58430
59318
|
* @throws {RequiredError}
|
|
58431
59319
|
*/
|
|
58432
59320
|
apiV1StoresXStoreIDSchemaGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58433
59321
|
/**
|
|
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
|
|
59322
|
+
* 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.
|
|
59323
|
+
* @summary Create or update index schema
|
|
59324
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59325
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59326
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59327
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58440
59328
|
* @param {*} [options] Override http request option.
|
|
58441
59329
|
* @throws {RequiredError}
|
|
58442
59330
|
*/
|
|
@@ -58448,32 +59336,32 @@ export declare const SDKSchemaApiAxiosParamCreator: (configuration?: Configurati
|
|
|
58448
59336
|
*/
|
|
58449
59337
|
export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
58450
59338
|
/**
|
|
58451
|
-
*
|
|
58452
|
-
* @summary Clear
|
|
58453
|
-
* @param {string} xStoreid Store ID
|
|
58454
|
-
* @param {string} xStoreWriteSecret Store
|
|
58455
|
-
* @param {string} xStoreID
|
|
59339
|
+
* 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.
|
|
59340
|
+
* @summary Clear all documents
|
|
59341
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59342
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59343
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58456
59344
|
* @param {*} [options] Override http request option.
|
|
58457
59345
|
* @throws {RequiredError}
|
|
58458
59346
|
*/
|
|
58459
59347
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesClearDocumentsResponseWrapper>>;
|
|
58460
59348
|
/**
|
|
58461
|
-
*
|
|
58462
|
-
* @summary Get
|
|
58463
|
-
* @param {string} xStoreid Store ID
|
|
58464
|
-
* @param {string} xStoresecret Store
|
|
58465
|
-
* @param {string} xStoreID
|
|
59349
|
+
* 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.
|
|
59350
|
+
* @summary Get index schema
|
|
59351
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59352
|
+
* @param {string} xStoresecret Store read secret
|
|
59353
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58466
59354
|
* @param {*} [options] Override http request option.
|
|
58467
59355
|
* @throws {RequiredError}
|
|
58468
59356
|
*/
|
|
58469
59357
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaResponseWrapper>>;
|
|
58470
59358
|
/**
|
|
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
|
|
59359
|
+
* 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.
|
|
59360
|
+
* @summary Create or update index schema
|
|
59361
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59362
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59363
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59364
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58477
59365
|
* @param {*} [options] Override http request option.
|
|
58478
59366
|
* @throws {RequiredError}
|
|
58479
59367
|
*/
|
|
@@ -58485,32 +59373,32 @@ export declare const SDKSchemaApiFp: (configuration?: Configuration) => {
|
|
|
58485
59373
|
*/
|
|
58486
59374
|
export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58487
59375
|
/**
|
|
58488
|
-
*
|
|
58489
|
-
* @summary Clear
|
|
58490
|
-
* @param {string} xStoreid Store ID
|
|
58491
|
-
* @param {string} xStoreWriteSecret Store
|
|
58492
|
-
* @param {string} xStoreID
|
|
59376
|
+
* 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.
|
|
59377
|
+
* @summary Clear all documents
|
|
59378
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59379
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59380
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58493
59381
|
* @param {*} [options] Override http request option.
|
|
58494
59382
|
* @throws {RequiredError}
|
|
58495
59383
|
*/
|
|
58496
59384
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesClearDocumentsResponseWrapper>;
|
|
58497
59385
|
/**
|
|
58498
|
-
*
|
|
58499
|
-
* @summary Get
|
|
58500
|
-
* @param {string} xStoreid Store ID
|
|
58501
|
-
* @param {string} xStoresecret Store
|
|
58502
|
-
* @param {string} xStoreID
|
|
59386
|
+
* 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.
|
|
59387
|
+
* @summary Get index schema
|
|
59388
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59389
|
+
* @param {string} xStoresecret Store read secret
|
|
59390
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58503
59391
|
* @param {*} [options] Override http request option.
|
|
58504
59392
|
* @throws {RequiredError}
|
|
58505
59393
|
*/
|
|
58506
59394
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaResponseWrapper>;
|
|
58507
59395
|
/**
|
|
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
|
|
59396
|
+
* 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.
|
|
59397
|
+
* @summary Create or update index schema
|
|
59398
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59399
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59400
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59401
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58514
59402
|
* @param {*} [options] Override http request option.
|
|
58515
59403
|
* @throws {RequiredError}
|
|
58516
59404
|
*/
|
|
@@ -58524,34 +59412,34 @@ export declare const SDKSchemaApiFactory: (configuration?: Configuration, basePa
|
|
|
58524
59412
|
*/
|
|
58525
59413
|
export declare class SDKSchemaApi extends BaseAPI {
|
|
58526
59414
|
/**
|
|
58527
|
-
*
|
|
58528
|
-
* @summary Clear
|
|
58529
|
-
* @param {string} xStoreid Store ID
|
|
58530
|
-
* @param {string} xStoreWriteSecret Store
|
|
58531
|
-
* @param {string} xStoreID
|
|
59415
|
+
* 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.
|
|
59416
|
+
* @summary Clear all documents
|
|
59417
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59418
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59419
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58532
59420
|
* @param {*} [options] Override http request option.
|
|
58533
59421
|
* @throws {RequiredError}
|
|
58534
59422
|
* @memberof SDKSchemaApi
|
|
58535
59423
|
*/
|
|
58536
59424
|
apiV1StoresXStoreIDDocumentsDelete(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesClearDocumentsResponseWrapper, any, {}>>;
|
|
58537
59425
|
/**
|
|
58538
|
-
*
|
|
58539
|
-
* @summary Get
|
|
58540
|
-
* @param {string} xStoreid Store ID
|
|
58541
|
-
* @param {string} xStoresecret Store
|
|
58542
|
-
* @param {string} xStoreID
|
|
59426
|
+
* 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.
|
|
59427
|
+
* @summary Get index schema
|
|
59428
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59429
|
+
* @param {string} xStoresecret Store read secret
|
|
59430
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58543
59431
|
* @param {*} [options] Override http request option.
|
|
58544
59432
|
* @throws {RequiredError}
|
|
58545
59433
|
* @memberof SDKSchemaApi
|
|
58546
59434
|
*/
|
|
58547
59435
|
apiV1StoresXStoreIDSchemaGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaResponseWrapper, any, {}>>;
|
|
58548
59436
|
/**
|
|
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
|
|
59437
|
+
* 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.
|
|
59438
|
+
* @summary Create or update index schema
|
|
59439
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59440
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59441
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59442
|
+
* @param {DataTypesCollectionSchemaRequest} dataTypesCollectionSchemaRequest Schema definition and mode
|
|
58555
59443
|
* @param {*} [options] Override http request option.
|
|
58556
59444
|
* @throws {RequiredError}
|
|
58557
59445
|
* @memberof SDKSchemaApi
|
|
@@ -58564,32 +59452,32 @@ export declare class SDKSchemaApi extends BaseAPI {
|
|
|
58564
59452
|
*/
|
|
58565
59453
|
export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58566
59454
|
/**
|
|
58567
|
-
*
|
|
58568
|
-
* @summary Get
|
|
58569
|
-
* @param {string} xStoreid Store ID
|
|
58570
|
-
* @param {string} xStoresecret Store
|
|
58571
|
-
* @param {string} xStoreID
|
|
59455
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59456
|
+
* @summary Get store configuration
|
|
59457
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59458
|
+
* @param {string} xStoresecret Store read secret
|
|
59459
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58572
59460
|
* @param {*} [options] Override http request option.
|
|
58573
59461
|
* @throws {RequiredError}
|
|
58574
59462
|
*/
|
|
58575
59463
|
apiV1StoresXStoreIDConfigGet: (xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58576
59464
|
/**
|
|
58577
|
-
*
|
|
58578
|
-
* @summary Update
|
|
58579
|
-
* @param {string} xStoreid Store ID
|
|
58580
|
-
* @param {string} xStoreWriteSecret Store
|
|
58581
|
-
* @param {string} xStoreID
|
|
58582
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
59465
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59466
|
+
* @summary Update store configuration
|
|
59467
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59468
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59469
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59470
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58583
59471
|
* @param {*} [options] Override http request option.
|
|
58584
59472
|
* @throws {RequiredError}
|
|
58585
59473
|
*/
|
|
58586
59474
|
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58587
59475
|
/**
|
|
58588
|
-
*
|
|
58589
|
-
* @summary Get
|
|
58590
|
-
* @param {string} xStoreid Store ID
|
|
58591
|
-
* @param {string} xStoresecret Store
|
|
58592
|
-
* @param {string} xStoreID
|
|
59476
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59477
|
+
* @summary Get store config schema
|
|
59478
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59479
|
+
* @param {string} xStoresecret Store read secret
|
|
59480
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58593
59481
|
* @param {*} [options] Override http request option.
|
|
58594
59482
|
* @throws {RequiredError}
|
|
58595
59483
|
*/
|
|
@@ -58601,32 +59489,32 @@ export declare const SDKStoreConfigApiAxiosParamCreator: (configuration?: Config
|
|
|
58601
59489
|
*/
|
|
58602
59490
|
export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
|
|
58603
59491
|
/**
|
|
58604
|
-
*
|
|
58605
|
-
* @summary Get
|
|
58606
|
-
* @param {string} xStoreid Store ID
|
|
58607
|
-
* @param {string} xStoresecret Store
|
|
58608
|
-
* @param {string} xStoreID
|
|
59492
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59493
|
+
* @summary Get store configuration
|
|
59494
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59495
|
+
* @param {string} xStoresecret Store read secret
|
|
59496
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58609
59497
|
* @param {*} [options] Override http request option.
|
|
58610
59498
|
* @throws {RequiredError}
|
|
58611
59499
|
*/
|
|
58612
59500
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>>;
|
|
58613
59501
|
/**
|
|
58614
|
-
*
|
|
58615
|
-
* @summary Update
|
|
58616
|
-
* @param {string} xStoreid Store ID
|
|
58617
|
-
* @param {string} xStoreWriteSecret Store
|
|
58618
|
-
* @param {string} xStoreID
|
|
58619
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
59502
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59503
|
+
* @summary Update store configuration
|
|
59504
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59505
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59506
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59507
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58620
59508
|
* @param {*} [options] Override http request option.
|
|
58621
59509
|
* @throws {RequiredError}
|
|
58622
59510
|
*/
|
|
58623
59511
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
58624
59512
|
/**
|
|
58625
|
-
*
|
|
58626
|
-
* @summary Get
|
|
58627
|
-
* @param {string} xStoreid Store ID
|
|
58628
|
-
* @param {string} xStoresecret Store
|
|
58629
|
-
* @param {string} xStoreID
|
|
59513
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59514
|
+
* @summary Get store config schema
|
|
59515
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59516
|
+
* @param {string} xStoresecret Store read secret
|
|
59517
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58630
59518
|
* @param {*} [options] Override http request option.
|
|
58631
59519
|
* @throws {RequiredError}
|
|
58632
59520
|
*/
|
|
@@ -58638,32 +59526,32 @@ export declare const SDKStoreConfigApiFp: (configuration?: Configuration) => {
|
|
|
58638
59526
|
*/
|
|
58639
59527
|
export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58640
59528
|
/**
|
|
58641
|
-
*
|
|
58642
|
-
* @summary Get
|
|
58643
|
-
* @param {string} xStoreid Store ID
|
|
58644
|
-
* @param {string} xStoresecret Store
|
|
58645
|
-
* @param {string} xStoreID
|
|
59529
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59530
|
+
* @summary Get store configuration
|
|
59531
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59532
|
+
* @param {string} xStoresecret Store read secret
|
|
59533
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58646
59534
|
* @param {*} [options] Override http request option.
|
|
58647
59535
|
* @throws {RequiredError}
|
|
58648
59536
|
*/
|
|
58649
59537
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse>;
|
|
58650
59538
|
/**
|
|
58651
|
-
*
|
|
58652
|
-
* @summary Update
|
|
58653
|
-
* @param {string} xStoreid Store ID
|
|
58654
|
-
* @param {string} xStoreWriteSecret Store
|
|
58655
|
-
* @param {string} xStoreID
|
|
58656
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
59539
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59540
|
+
* @summary Update store configuration
|
|
59541
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59542
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59543
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59544
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58657
59545
|
* @param {*} [options] Override http request option.
|
|
58658
59546
|
* @throws {RequiredError}
|
|
58659
59547
|
*/
|
|
58660
59548
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
58661
59549
|
/**
|
|
58662
|
-
*
|
|
58663
|
-
* @summary Get
|
|
58664
|
-
* @param {string} xStoreid Store ID
|
|
58665
|
-
* @param {string} xStoresecret Store
|
|
58666
|
-
* @param {string} xStoreID
|
|
59550
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59551
|
+
* @summary Get store config schema
|
|
59552
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59553
|
+
* @param {string} xStoresecret Store read secret
|
|
59554
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58667
59555
|
* @param {*} [options] Override http request option.
|
|
58668
59556
|
* @throws {RequiredError}
|
|
58669
59557
|
*/
|
|
@@ -58677,34 +59565,34 @@ export declare const SDKStoreConfigApiFactory: (configuration?: Configuration, b
|
|
|
58677
59565
|
*/
|
|
58678
59566
|
export declare class SDKStoreConfigApi extends BaseAPI {
|
|
58679
59567
|
/**
|
|
58680
|
-
*
|
|
58681
|
-
* @summary Get
|
|
58682
|
-
* @param {string} xStoreid Store ID
|
|
58683
|
-
* @param {string} xStoresecret Store
|
|
58684
|
-
* @param {string} xStoreID
|
|
59568
|
+
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59569
|
+
* @summary Get store configuration
|
|
59570
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59571
|
+
* @param {string} xStoresecret Store read secret
|
|
59572
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58685
59573
|
* @param {*} [options] Override http request option.
|
|
58686
59574
|
* @throws {RequiredError}
|
|
58687
59575
|
* @memberof SDKStoreConfigApi
|
|
58688
59576
|
*/
|
|
58689
59577
|
apiV1StoresXStoreIDConfigGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreConfigWithOnboardingResponse, any, {}>>;
|
|
58690
59578
|
/**
|
|
58691
|
-
*
|
|
58692
|
-
* @summary Update
|
|
58693
|
-
* @param {string} xStoreid Store ID
|
|
58694
|
-
* @param {string} xStoreWriteSecret Store
|
|
58695
|
-
* @param {string} xStoreID
|
|
58696
|
-
* @param {DataTypesIndexConfig} dataTypesIndexConfig
|
|
59579
|
+
* Update search and store settings. Partial updates supported. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59580
|
+
* @summary Update store configuration
|
|
59581
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59582
|
+
* @param {string} xStoreWriteSecret Store write secret
|
|
59583
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
59584
|
+
* @param {DataTypesIndexConfig} dataTypesIndexConfig Fields to update (partial)
|
|
58697
59585
|
* @param {*} [options] Override http request option.
|
|
58698
59586
|
* @throws {RequiredError}
|
|
58699
59587
|
* @memberof SDKStoreConfigApi
|
|
58700
59588
|
*/
|
|
58701
59589
|
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesIndexConfig: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
58702
59590
|
/**
|
|
58703
|
-
*
|
|
58704
|
-
* @summary Get
|
|
58705
|
-
* @param {string} xStoreid Store ID
|
|
58706
|
-
* @param {string} xStoresecret Store
|
|
58707
|
-
* @param {string} xStoreID
|
|
59591
|
+
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59592
|
+
* @summary Get store config schema
|
|
59593
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59594
|
+
* @param {string} xStoresecret Store read secret
|
|
59595
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58708
59596
|
* @param {*} [options] Override http request option.
|
|
58709
59597
|
* @throws {RequiredError}
|
|
58710
59598
|
* @memberof SDKStoreConfigApi
|
|
@@ -58780,11 +59668,11 @@ export declare class SDKStoreCreationApi extends BaseAPI {
|
|
|
58780
59668
|
*/
|
|
58781
59669
|
export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
58782
59670
|
/**
|
|
58783
|
-
*
|
|
58784
|
-
* @summary Get
|
|
58785
|
-
* @param {string} xStoreid Store ID
|
|
58786
|
-
* @param {string} xStoresecret Store
|
|
58787
|
-
* @param {string} xStoreID
|
|
59671
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59672
|
+
* @summary Get store info
|
|
59673
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59674
|
+
* @param {string} xStoresecret Store read secret
|
|
59675
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58788
59676
|
* @param {*} [options] Override http request option.
|
|
58789
59677
|
* @throws {RequiredError}
|
|
58790
59678
|
*/
|
|
@@ -58796,11 +59684,11 @@ export declare const SDKStoreInfoApiAxiosParamCreator: (configuration?: Configur
|
|
|
58796
59684
|
*/
|
|
58797
59685
|
export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
|
|
58798
59686
|
/**
|
|
58799
|
-
*
|
|
58800
|
-
* @summary Get
|
|
58801
|
-
* @param {string} xStoreid Store ID
|
|
58802
|
-
* @param {string} xStoresecret Store
|
|
58803
|
-
* @param {string} xStoreID
|
|
59687
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59688
|
+
* @summary Get store info
|
|
59689
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59690
|
+
* @param {string} xStoresecret Store read secret
|
|
59691
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58804
59692
|
* @param {*} [options] Override http request option.
|
|
58805
59693
|
* @throws {RequiredError}
|
|
58806
59694
|
*/
|
|
@@ -58812,11 +59700,11 @@ export declare const SDKStoreInfoApiFp: (configuration?: Configuration) => {
|
|
|
58812
59700
|
*/
|
|
58813
59701
|
export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
58814
59702
|
/**
|
|
58815
|
-
*
|
|
58816
|
-
* @summary Get
|
|
58817
|
-
* @param {string} xStoreid Store ID
|
|
58818
|
-
* @param {string} xStoresecret Store
|
|
58819
|
-
* @param {string} xStoreID
|
|
59703
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59704
|
+
* @summary Get store info
|
|
59705
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59706
|
+
* @param {string} xStoresecret Store read secret
|
|
59707
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58820
59708
|
* @param {*} [options] Override http request option.
|
|
58821
59709
|
* @throws {RequiredError}
|
|
58822
59710
|
*/
|
|
@@ -58830,11 +59718,11 @@ export declare const SDKStoreInfoApiFactory: (configuration?: Configuration, bas
|
|
|
58830
59718
|
*/
|
|
58831
59719
|
export declare class SDKStoreInfoApi extends BaseAPI {
|
|
58832
59720
|
/**
|
|
58833
|
-
*
|
|
58834
|
-
* @summary Get
|
|
58835
|
-
* @param {string} xStoreid Store ID
|
|
58836
|
-
* @param {string} xStoresecret Store
|
|
58837
|
-
* @param {string} xStoreID
|
|
59721
|
+
* Returns basic store details (name, location, status). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
59722
|
+
* @summary Get store info
|
|
59723
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59724
|
+
* @param {string} xStoresecret Store read secret
|
|
59725
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
58838
59726
|
* @param {*} [options] Override http request option.
|
|
58839
59727
|
* @throws {RequiredError}
|
|
58840
59728
|
* @memberof SDKStoreInfoApi
|
|
@@ -58899,13 +59787,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58899
59787
|
*/
|
|
58900
59788
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58901
59789
|
/**
|
|
58902
|
-
*
|
|
58903
|
-
* @summary
|
|
58904
|
-
* @param {string} xStoreid Store ID
|
|
58905
|
-
* @param {string} xStoresecret Store
|
|
59790
|
+
* 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.
|
|
59791
|
+
* @summary Search (GET)
|
|
59792
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59793
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
58906
59794
|
* @param {string} q Search query
|
|
58907
59795
|
* @param {string} [xUserId] User ID for personalization
|
|
58908
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59796
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
58909
59797
|
* @param {string} [xSessionId] Session ID for personalization
|
|
58910
59798
|
* @param {number} [page] Page number (default: 1)
|
|
58911
59799
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -58949,13 +59837,13 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58949
59837
|
*/
|
|
58950
59838
|
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
59839
|
/**
|
|
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
|
|
59840
|
+
* 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.
|
|
59841
|
+
* @summary Search (POST)
|
|
59842
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59843
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59844
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59845
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59846
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
58959
59847
|
* @param {string} [xSessionId] Session ID for personalization
|
|
58960
59848
|
* @param {*} [options] Override http request option.
|
|
58961
59849
|
* @throws {RequiredError}
|
|
@@ -59020,13 +59908,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
59020
59908
|
*/
|
|
59021
59909
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
59022
59910
|
/**
|
|
59023
|
-
*
|
|
59024
|
-
* @summary
|
|
59025
|
-
* @param {string} xStoreid Store ID
|
|
59026
|
-
* @param {string} xStoresecret Store
|
|
59911
|
+
* 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.
|
|
59912
|
+
* @summary Search (GET)
|
|
59913
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59914
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59027
59915
|
* @param {string} q Search query
|
|
59028
59916
|
* @param {string} [xUserId] User ID for personalization
|
|
59029
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
59917
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59030
59918
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59031
59919
|
* @param {number} [page] Page number (default: 1)
|
|
59032
59920
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59070,13 +59958,13 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
59070
59958
|
*/
|
|
59071
59959
|
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
59960
|
/**
|
|
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
|
|
59961
|
+
* 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.
|
|
59962
|
+
* @summary Search (POST)
|
|
59963
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
59964
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59965
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
59966
|
+
* @param {string} [xUserId] User ID for personalization
|
|
59967
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59080
59968
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59081
59969
|
* @param {*} [options] Override http request option.
|
|
59082
59970
|
* @throws {RequiredError}
|
|
@@ -59141,13 +60029,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
59141
60029
|
*/
|
|
59142
60030
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
59143
60031
|
/**
|
|
59144
|
-
*
|
|
59145
|
-
* @summary
|
|
59146
|
-
* @param {string} xStoreid Store ID
|
|
59147
|
-
* @param {string} xStoresecret Store
|
|
60032
|
+
* 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.
|
|
60033
|
+
* @summary Search (GET)
|
|
60034
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60035
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59148
60036
|
* @param {string} q Search query
|
|
59149
60037
|
* @param {string} [xUserId] User ID for personalization
|
|
59150
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
60038
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59151
60039
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59152
60040
|
* @param {number} [page] Page number (default: 1)
|
|
59153
60041
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59191,13 +60079,13 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
59191
60079
|
*/
|
|
59192
60080
|
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
60081
|
/**
|
|
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
|
|
60082
|
+
* 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.
|
|
60083
|
+
* @summary Search (POST)
|
|
60084
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60085
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
60086
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
60087
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60088
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59201
60089
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59202
60090
|
* @param {*} [options] Override http request option.
|
|
59203
60091
|
* @throws {RequiredError}
|
|
@@ -59270,13 +60158,13 @@ export declare class SearchApi extends BaseAPI {
|
|
|
59270
60158
|
*/
|
|
59271
60159
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
59272
60160
|
/**
|
|
59273
|
-
*
|
|
59274
|
-
* @summary
|
|
59275
|
-
* @param {string} xStoreid Store ID
|
|
59276
|
-
* @param {string} xStoresecret Store
|
|
60161
|
+
* 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.
|
|
60162
|
+
* @summary Search (GET)
|
|
60163
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60164
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
59277
60165
|
* @param {string} q Search query
|
|
59278
60166
|
* @param {string} [xUserId] User ID for personalization
|
|
59279
|
-
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
60167
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59280
60168
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59281
60169
|
* @param {number} [page] Page number (default: 1)
|
|
59282
60170
|
* @param {number} [perPage] Items per page (default: 10)
|
|
@@ -59321,13 +60209,13 @@ export declare class SearchApi extends BaseAPI {
|
|
|
59321
60209
|
*/
|
|
59322
60210
|
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
60211
|
/**
|
|
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
|
|
60212
|
+
* 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.
|
|
60213
|
+
* @summary Search (POST)
|
|
60214
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
60215
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
60216
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search query, filters, pagination, and options
|
|
60217
|
+
* @param {string} [xUserId] User ID for personalization
|
|
60218
|
+
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
59331
60219
|
* @param {string} [xSessionId] Session ID for personalization
|
|
59332
60220
|
* @param {*} [options] Override http request option.
|
|
59333
60221
|
* @throws {RequiredError}
|
|
@@ -63033,71 +63921,72 @@ export declare const UserProfilesApiAxiosParamCreator: (configuration?: Configur
|
|
|
63033
63921
|
/**
|
|
63034
63922
|
* Returns the user profile for an authenticated user token
|
|
63035
63923
|
* @summary Get User Profile by Auth Token
|
|
63924
|
+
* @param {string} xStoreID Store ID
|
|
63036
63925
|
* @param {string} authToken Authenticated user token
|
|
63037
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63038
63926
|
* @param {*} [options] Override http request option.
|
|
63039
63927
|
* @throws {RequiredError}
|
|
63040
63928
|
*/
|
|
63041
|
-
|
|
63929
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet: (xStoreID: string, authToken: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63042
63930
|
/**
|
|
63043
63931
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63044
63932
|
* @summary Merge User Profiles
|
|
63933
|
+
* @param {string} xStoreID Store ID
|
|
63045
63934
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63046
63935
|
* @param {*} [options] Override http request option.
|
|
63047
63936
|
* @throws {RequiredError}
|
|
63048
63937
|
*/
|
|
63049
|
-
|
|
63938
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost: (xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63050
63939
|
/**
|
|
63051
63940
|
* Returns paginated events for a user with optional filtering
|
|
63052
63941
|
* @summary Get User Events
|
|
63942
|
+
* @param {string} xStoreID Store ID
|
|
63053
63943
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63054
63944
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63055
63945
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63056
63946
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63057
63947
|
* @param {number} [page] Page number (default 1)
|
|
63058
63948
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63059
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63060
63949
|
* @param {*} [options] Override http request option.
|
|
63061
63950
|
* @throws {RequiredError}
|
|
63062
63951
|
*/
|
|
63063
|
-
|
|
63952
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet: (xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63064
63953
|
/**
|
|
63065
63954
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63066
63955
|
* @summary Get User Profile
|
|
63956
|
+
* @param {string} xStoreID Store ID
|
|
63067
63957
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63068
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63069
63958
|
* @param {*} [options] Override http request option.
|
|
63070
63959
|
* @throws {RequiredError}
|
|
63071
63960
|
*/
|
|
63072
|
-
|
|
63961
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63073
63962
|
/**
|
|
63074
63963
|
* Returns all data needed for personalizing the user experience
|
|
63075
63964
|
* @summary Get Personalization Context
|
|
63965
|
+
* @param {string} xStoreID Store ID
|
|
63076
63966
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63077
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63078
63967
|
* @param {*} [options] Override http request option.
|
|
63079
63968
|
* @throws {RequiredError}
|
|
63080
63969
|
*/
|
|
63081
|
-
|
|
63970
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63082
63971
|
/**
|
|
63083
63972
|
* Returns the segments a user belongs to based on their behavior
|
|
63084
63973
|
* @summary Get User Segments
|
|
63974
|
+
* @param {string} xStoreID Store ID
|
|
63085
63975
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63086
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63087
63976
|
* @param {*} [options] Override http request option.
|
|
63088
63977
|
* @throws {RequiredError}
|
|
63089
63978
|
*/
|
|
63090
|
-
|
|
63979
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet: (xStoreID: string, userKey: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63091
63980
|
/**
|
|
63092
63981
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63093
63982
|
* @summary Get Similar Users
|
|
63983
|
+
* @param {string} xStoreID Store ID
|
|
63094
63984
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63095
63985
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63096
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63097
63986
|
* @param {*} [options] Override http request option.
|
|
63098
63987
|
* @throws {RequiredError}
|
|
63099
63988
|
*/
|
|
63100
|
-
|
|
63989
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet: (xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63101
63990
|
};
|
|
63102
63991
|
/**
|
|
63103
63992
|
* UserProfilesApi - functional programming interface
|
|
@@ -63107,71 +63996,72 @@ export declare const UserProfilesApiFp: (configuration?: Configuration) => {
|
|
|
63107
63996
|
/**
|
|
63108
63997
|
* Returns the user profile for an authenticated user token
|
|
63109
63998
|
* @summary Get User Profile by Auth Token
|
|
63999
|
+
* @param {string} xStoreID Store ID
|
|
63110
64000
|
* @param {string} authToken Authenticated user token
|
|
63111
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63112
64001
|
* @param {*} [options] Override http request option.
|
|
63113
64002
|
* @throws {RequiredError}
|
|
63114
64003
|
*/
|
|
63115
|
-
|
|
64004
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
|
|
63116
64005
|
/**
|
|
63117
64006
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63118
64007
|
* @summary Merge User Profiles
|
|
64008
|
+
* @param {string} xStoreID Store ID
|
|
63119
64009
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63120
64010
|
* @param {*} [options] Override http request option.
|
|
63121
64011
|
* @throws {RequiredError}
|
|
63122
64012
|
*/
|
|
63123
|
-
|
|
64013
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>>;
|
|
63124
64014
|
/**
|
|
63125
64015
|
* Returns paginated events for a user with optional filtering
|
|
63126
64016
|
* @summary Get User Events
|
|
64017
|
+
* @param {string} xStoreID Store ID
|
|
63127
64018
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63128
64019
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63129
64020
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63130
64021
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63131
64022
|
* @param {number} [page] Page number (default 1)
|
|
63132
64023
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63133
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63134
64024
|
* @param {*} [options] Override http request option.
|
|
63135
64025
|
* @throws {RequiredError}
|
|
63136
64026
|
*/
|
|
63137
|
-
|
|
64027
|
+
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
64028
|
/**
|
|
63139
64029
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63140
64030
|
* @summary Get User Profile
|
|
64031
|
+
* @param {string} xStoreID Store ID
|
|
63141
64032
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63142
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63143
64033
|
* @param {*} [options] Override http request option.
|
|
63144
64034
|
* @throws {RequiredError}
|
|
63145
64035
|
*/
|
|
63146
|
-
|
|
64036
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsUserProfile>>;
|
|
63147
64037
|
/**
|
|
63148
64038
|
* Returns all data needed for personalizing the user experience
|
|
63149
64039
|
* @summary Get Personalization Context
|
|
64040
|
+
* @param {string} xStoreID Store ID
|
|
63150
64041
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63151
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63152
64042
|
* @param {*} [options] Override http request option.
|
|
63153
64043
|
* @throws {RequiredError}
|
|
63154
64044
|
*/
|
|
63155
|
-
|
|
64045
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>>;
|
|
63156
64046
|
/**
|
|
63157
64047
|
* Returns the segments a user belongs to based on their behavior
|
|
63158
64048
|
* @summary Get User Segments
|
|
64049
|
+
* @param {string} xStoreID Store ID
|
|
63159
64050
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63160
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63161
64051
|
* @param {*} [options] Override http request option.
|
|
63162
64052
|
* @throws {RequiredError}
|
|
63163
64053
|
*/
|
|
63164
|
-
|
|
64054
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayString>>;
|
|
63165
64055
|
/**
|
|
63166
64056
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63167
64057
|
* @summary Get Similar Users
|
|
64058
|
+
* @param {string} xStoreID Store ID
|
|
63168
64059
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63169
64060
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63170
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63171
64061
|
* @param {*} [options] Override http request option.
|
|
63172
64062
|
* @throws {RequiredError}
|
|
63173
64063
|
*/
|
|
63174
|
-
|
|
64064
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>>;
|
|
63175
64065
|
};
|
|
63176
64066
|
/**
|
|
63177
64067
|
* UserProfilesApi - factory interface
|
|
@@ -63181,71 +64071,72 @@ export declare const UserProfilesApiFactory: (configuration?: Configuration, bas
|
|
|
63181
64071
|
/**
|
|
63182
64072
|
* Returns the user profile for an authenticated user token
|
|
63183
64073
|
* @summary Get User Profile by Auth Token
|
|
64074
|
+
* @param {string} xStoreID Store ID
|
|
63184
64075
|
* @param {string} authToken Authenticated user token
|
|
63185
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63186
64076
|
* @param {*} [options] Override http request option.
|
|
63187
64077
|
* @throws {RequiredError}
|
|
63188
64078
|
*/
|
|
63189
|
-
|
|
64079
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
|
|
63190
64080
|
/**
|
|
63191
64081
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63192
64082
|
* @summary Merge User Profiles
|
|
64083
|
+
* @param {string} xStoreID Store ID
|
|
63193
64084
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63194
64085
|
* @param {*} [options] Override http request option.
|
|
63195
64086
|
* @throws {RequiredError}
|
|
63196
64087
|
*/
|
|
63197
|
-
|
|
64088
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsMergeProfilesResponse>;
|
|
63198
64089
|
/**
|
|
63199
64090
|
* Returns paginated events for a user with optional filtering
|
|
63200
64091
|
* @summary Get User Events
|
|
64092
|
+
* @param {string} xStoreID Store ID
|
|
63201
64093
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63202
64094
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63203
64095
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63204
64096
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63205
64097
|
* @param {number} [page] Page number (default 1)
|
|
63206
64098
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63207
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63208
64099
|
* @param {*} [options] Override http request option.
|
|
63209
64100
|
* @throws {RequiredError}
|
|
63210
64101
|
*/
|
|
63211
|
-
|
|
64102
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet(xStoreID: string, userKey: string, eventTypes?: Array<string>, startDate?: string, endDate?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserEventsResponse>;
|
|
63212
64103
|
/**
|
|
63213
64104
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63214
64105
|
* @summary Get User Profile
|
|
64106
|
+
* @param {string} xStoreID Store ID
|
|
63215
64107
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63216
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63217
64108
|
* @param {*} [options] Override http request option.
|
|
63218
64109
|
* @throws {RequiredError}
|
|
63219
64110
|
*/
|
|
63220
|
-
|
|
64111
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsUserProfile>;
|
|
63221
64112
|
/**
|
|
63222
64113
|
* Returns all data needed for personalizing the user experience
|
|
63223
64114
|
* @summary Get Personalization Context
|
|
64115
|
+
* @param {string} xStoreID Store ID
|
|
63224
64116
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63225
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63226
64117
|
* @param {*} [options] Override http request option.
|
|
63227
64118
|
* @throws {RequiredError}
|
|
63228
64119
|
*/
|
|
63229
|
-
|
|
64120
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseModelsPersonalizationContext>;
|
|
63230
64121
|
/**
|
|
63231
64122
|
* Returns the segments a user belongs to based on their behavior
|
|
63232
64123
|
* @summary Get User Segments
|
|
64124
|
+
* @param {string} xStoreID Store ID
|
|
63233
64125
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63234
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63235
64126
|
* @param {*} [options] Override http request option.
|
|
63236
64127
|
* @throws {RequiredError}
|
|
63237
64128
|
*/
|
|
63238
|
-
|
|
64129
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayString>;
|
|
63239
64130
|
/**
|
|
63240
64131
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63241
64132
|
* @summary Get Similar Users
|
|
64133
|
+
* @param {string} xStoreID Store ID
|
|
63242
64134
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63243
64135
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63244
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63245
64136
|
* @param {*} [options] Override http request option.
|
|
63246
64137
|
* @throws {RequiredError}
|
|
63247
64138
|
*/
|
|
63248
|
-
|
|
64139
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayModelsSimilarUser>;
|
|
63249
64140
|
};
|
|
63250
64141
|
/**
|
|
63251
64142
|
* UserProfilesApi - object-oriented interface
|
|
@@ -63257,78 +64148,79 @@ export declare class UserProfilesApi extends BaseAPI {
|
|
|
63257
64148
|
/**
|
|
63258
64149
|
* Returns the user profile for an authenticated user token
|
|
63259
64150
|
* @summary Get User Profile by Auth Token
|
|
64151
|
+
* @param {string} xStoreID Store ID
|
|
63260
64152
|
* @param {string} authToken Authenticated user token
|
|
63261
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63262
64153
|
* @param {*} [options] Override http request option.
|
|
63263
64154
|
* @throws {RequiredError}
|
|
63264
64155
|
* @memberof UserProfilesApi
|
|
63265
64156
|
*/
|
|
63266
|
-
|
|
64157
|
+
adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet(xStoreID: string, authToken: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
|
|
63267
64158
|
/**
|
|
63268
64159
|
* Merges an anonymous user profile into an authenticated user profile
|
|
63269
64160
|
* @summary Merge User Profiles
|
|
64161
|
+
* @param {string} xStoreID Store ID
|
|
63270
64162
|
* @param {AnalyticsMergeProfilesRequestBody} analyticsMergeProfilesRequestBody Merge request
|
|
63271
64163
|
* @param {*} [options] Override http request option.
|
|
63272
64164
|
* @throws {RequiredError}
|
|
63273
64165
|
* @memberof UserProfilesApi
|
|
63274
64166
|
*/
|
|
63275
|
-
|
|
64167
|
+
adminAnalyticsStoreXStoreIDProfilesMergePost(xStoreID: string, analyticsMergeProfilesRequestBody: AnalyticsMergeProfilesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsMergeProfilesResponse, any, {}>>;
|
|
63276
64168
|
/**
|
|
63277
64169
|
* Returns paginated events for a user with optional filtering
|
|
63278
64170
|
* @summary Get User Events
|
|
64171
|
+
* @param {string} xStoreID Store ID
|
|
63279
64172
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63280
64173
|
* @param {Array<string>} [eventTypes] Filter by event types (search, click, conversion, view, recommendation)
|
|
63281
64174
|
* @param {string} [startDate] Start date (YYYY-MM-DD)
|
|
63282
64175
|
* @param {string} [endDate] End date (YYYY-MM-DD)
|
|
63283
64176
|
* @param {number} [page] Page number (default 1)
|
|
63284
64177
|
* @param {number} [pageSize] Page size (default 50, max 500)
|
|
63285
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63286
64178
|
* @param {*} [options] Override http request option.
|
|
63287
64179
|
* @throws {RequiredError}
|
|
63288
64180
|
* @memberof UserProfilesApi
|
|
63289
64181
|
*/
|
|
63290
|
-
|
|
64182
|
+
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
64183
|
/**
|
|
63292
64184
|
* Returns the user profile with computed traits, affinities, and recent activity
|
|
63293
64185
|
* @summary Get User Profile
|
|
64186
|
+
* @param {string} xStoreID Store ID
|
|
63294
64187
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63295
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63296
64188
|
* @param {*} [options] Override http request option.
|
|
63297
64189
|
* @throws {RequiredError}
|
|
63298
64190
|
* @memberof UserProfilesApi
|
|
63299
64191
|
*/
|
|
63300
|
-
|
|
64192
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsUserProfile, any, {}>>;
|
|
63301
64193
|
/**
|
|
63302
64194
|
* Returns all data needed for personalizing the user experience
|
|
63303
64195
|
* @summary Get Personalization Context
|
|
64196
|
+
* @param {string} xStoreID Store ID
|
|
63304
64197
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63305
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63306
64198
|
* @param {*} [options] Override http request option.
|
|
63307
64199
|
* @throws {RequiredError}
|
|
63308
64200
|
* @memberof UserProfilesApi
|
|
63309
64201
|
*/
|
|
63310
|
-
|
|
64202
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseModelsPersonalizationContext, any, {}>>;
|
|
63311
64203
|
/**
|
|
63312
64204
|
* Returns the segments a user belongs to based on their behavior
|
|
63313
64205
|
* @summary Get User Segments
|
|
64206
|
+
* @param {string} xStoreID Store ID
|
|
63314
64207
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63315
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63316
64208
|
* @param {*} [options] Override http request option.
|
|
63317
64209
|
* @throws {RequiredError}
|
|
63318
64210
|
* @memberof UserProfilesApi
|
|
63319
64211
|
*/
|
|
63320
|
-
|
|
64212
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet(xStoreID: string, userKey: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayString, any, {}>>;
|
|
63321
64213
|
/**
|
|
63322
64214
|
* Returns users with similar behavior patterns for lookalike targeting
|
|
63323
64215
|
* @summary Get Similar Users
|
|
64216
|
+
* @param {string} xStoreID Store ID
|
|
63324
64217
|
* @param {string} userKey User key (user_id or anonymous_id)
|
|
63325
64218
|
* @param {number} [limit] Number of similar users to return (default 10, max 100)
|
|
63326
|
-
* @param {string} [xstoreid] Store ID filter
|
|
63327
64219
|
* @param {*} [options] Override http request option.
|
|
63328
64220
|
* @throws {RequiredError}
|
|
63329
64221
|
* @memberof UserProfilesApi
|
|
63330
64222
|
*/
|
|
63331
|
-
|
|
64223
|
+
adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet(xStoreID: string, userKey: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayModelsSimilarUser, any, {}>>;
|
|
63332
64224
|
}
|
|
63333
64225
|
/**
|
|
63334
64226
|
* WebhooksApi - axios parameter creator
|