@seekora-ai/admin-api 1.0.62 → 1.0.64
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/.openapi-generator/VERSION +1 -1
- package/README.md +24 -3
- package/api.ts +1426 -40
- package/common.ts +4 -4
- package/dist/api.d.ts +1186 -94
- package/dist/api.js +554 -17
- package/dist/esm/api.d.ts +1186 -94
- package/dist/esm/api.js +549 -12
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.64.tgz +0 -0
- package/seekora-ai-admin-api-1.0.62.tgz +0 -0
package/api.ts
CHANGED
|
@@ -754,6 +754,135 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
754
754
|
*/
|
|
755
755
|
'total'?: number;
|
|
756
756
|
}
|
|
757
|
+
/**
|
|
758
|
+
*
|
|
759
|
+
* @export
|
|
760
|
+
* @interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
761
|
+
*/
|
|
762
|
+
export interface AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response {
|
|
763
|
+
/**
|
|
764
|
+
* Comparison metadata when in compare mode
|
|
765
|
+
* @type {AnalyticsComparisonMeta}
|
|
766
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
767
|
+
*/
|
|
768
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @type {Array<AnalyticsQuerySuggestionRecord>}
|
|
772
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
773
|
+
*/
|
|
774
|
+
'data'?: Array<AnalyticsQuerySuggestionRecord>;
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @type {string}
|
|
778
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
779
|
+
*/
|
|
780
|
+
'error'?: string;
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {string}
|
|
784
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
785
|
+
*/
|
|
786
|
+
'status'?: string;
|
|
787
|
+
/**
|
|
788
|
+
*
|
|
789
|
+
* @type {string}
|
|
790
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
791
|
+
*/
|
|
792
|
+
'timestamp'?: string;
|
|
793
|
+
/**
|
|
794
|
+
*
|
|
795
|
+
* @type {number}
|
|
796
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response
|
|
797
|
+
*/
|
|
798
|
+
'total'?: number;
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @export
|
|
803
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
804
|
+
*/
|
|
805
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response {
|
|
806
|
+
/**
|
|
807
|
+
* Comparison metadata when in compare mode
|
|
808
|
+
* @type {AnalyticsComparisonMeta}
|
|
809
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
810
|
+
*/
|
|
811
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
815
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
816
|
+
*/
|
|
817
|
+
'data'?: Array<AnalyticsBannedExpression>;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {string}
|
|
821
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
822
|
+
*/
|
|
823
|
+
'error'?: string;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
828
|
+
*/
|
|
829
|
+
'status'?: string;
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
834
|
+
*/
|
|
835
|
+
'timestamp'?: string;
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {number}
|
|
839
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response
|
|
840
|
+
*/
|
|
841
|
+
'total'?: number;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
*
|
|
845
|
+
* @export
|
|
846
|
+
* @interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
847
|
+
*/
|
|
848
|
+
export interface AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response {
|
|
849
|
+
/**
|
|
850
|
+
* Comparison metadata when in compare mode
|
|
851
|
+
* @type {AnalyticsComparisonMeta}
|
|
852
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
853
|
+
*/
|
|
854
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
855
|
+
/**
|
|
856
|
+
*
|
|
857
|
+
* @type {AnalyticsBannedExpression}
|
|
858
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
859
|
+
*/
|
|
860
|
+
'data'?: AnalyticsBannedExpression;
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @type {string}
|
|
864
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
865
|
+
*/
|
|
866
|
+
'error'?: string;
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @type {string}
|
|
870
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
871
|
+
*/
|
|
872
|
+
'status'?: string;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {string}
|
|
876
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
877
|
+
*/
|
|
878
|
+
'timestamp'?: string;
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @type {number}
|
|
882
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response
|
|
883
|
+
*/
|
|
884
|
+
'total'?: number;
|
|
885
|
+
}
|
|
757
886
|
/**
|
|
758
887
|
*
|
|
759
888
|
* @export
|
|
@@ -843,86 +972,129 @@ export interface AdminV1QuerySuggestionsXStoreIDConfigGet200Response {
|
|
|
843
972
|
/**
|
|
844
973
|
*
|
|
845
974
|
* @export
|
|
846
|
-
* @interface
|
|
975
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
847
976
|
*/
|
|
848
|
-
export interface
|
|
977
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response {
|
|
849
978
|
/**
|
|
850
979
|
* Comparison metadata when in compare mode
|
|
851
980
|
* @type {AnalyticsComparisonMeta}
|
|
852
|
-
* @memberof
|
|
981
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
853
982
|
*/
|
|
854
983
|
'comparison'?: AnalyticsComparisonMeta;
|
|
855
984
|
/**
|
|
856
985
|
*
|
|
857
|
-
* @type {
|
|
858
|
-
* @memberof
|
|
986
|
+
* @type {Array<AnalyticsEnhancedCategorySuggestion>}
|
|
987
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
859
988
|
*/
|
|
860
|
-
'data'?:
|
|
989
|
+
'data'?: Array<AnalyticsEnhancedCategorySuggestion>;
|
|
861
990
|
/**
|
|
862
991
|
*
|
|
863
992
|
* @type {string}
|
|
864
|
-
* @memberof
|
|
993
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
865
994
|
*/
|
|
866
995
|
'error'?: string;
|
|
867
996
|
/**
|
|
868
997
|
*
|
|
869
998
|
* @type {string}
|
|
870
|
-
* @memberof
|
|
999
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
871
1000
|
*/
|
|
872
1001
|
'status'?: string;
|
|
873
1002
|
/**
|
|
874
1003
|
*
|
|
875
1004
|
* @type {string}
|
|
876
|
-
* @memberof
|
|
1005
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
877
1006
|
*/
|
|
878
1007
|
'timestamp'?: string;
|
|
879
1008
|
/**
|
|
880
1009
|
*
|
|
881
1010
|
* @type {number}
|
|
882
|
-
* @memberof
|
|
1011
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response
|
|
883
1012
|
*/
|
|
884
1013
|
'total'?: number;
|
|
885
1014
|
}
|
|
886
1015
|
/**
|
|
887
1016
|
*
|
|
888
1017
|
* @export
|
|
889
|
-
* @interface
|
|
1018
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
890
1019
|
*/
|
|
891
|
-
export interface
|
|
1020
|
+
export interface AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response {
|
|
892
1021
|
/**
|
|
893
1022
|
* Comparison metadata when in compare mode
|
|
894
1023
|
* @type {AnalyticsComparisonMeta}
|
|
895
|
-
* @memberof
|
|
1024
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
896
1025
|
*/
|
|
897
1026
|
'comparison'?: AnalyticsComparisonMeta;
|
|
898
1027
|
/**
|
|
899
1028
|
*
|
|
900
|
-
* @type {Array<
|
|
901
|
-
* @memberof
|
|
1029
|
+
* @type {Array<AnalyticsFacetSuggestion>}
|
|
1030
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
902
1031
|
*/
|
|
903
|
-
'data'?: Array<
|
|
1032
|
+
'data'?: Array<AnalyticsFacetSuggestion>;
|
|
1033
|
+
/**
|
|
1034
|
+
*
|
|
1035
|
+
* @type {string}
|
|
1036
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1037
|
+
*/
|
|
1038
|
+
'error'?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
*
|
|
1041
|
+
* @type {string}
|
|
1042
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1043
|
+
*/
|
|
1044
|
+
'status'?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
*
|
|
1047
|
+
* @type {string}
|
|
1048
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1049
|
+
*/
|
|
1050
|
+
'timestamp'?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
*
|
|
1053
|
+
* @type {number}
|
|
1054
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response
|
|
1055
|
+
*/
|
|
1056
|
+
'total'?: number;
|
|
1057
|
+
}
|
|
1058
|
+
/**
|
|
1059
|
+
*
|
|
1060
|
+
* @export
|
|
1061
|
+
* @interface AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1062
|
+
*/
|
|
1063
|
+
export interface AdminV1QuerySuggestionsXStoreIDGet200Response {
|
|
1064
|
+
/**
|
|
1065
|
+
* Comparison metadata when in compare mode
|
|
1066
|
+
* @type {AnalyticsComparisonMeta}
|
|
1067
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1068
|
+
*/
|
|
1069
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
1070
|
+
/**
|
|
1071
|
+
*
|
|
1072
|
+
* @type {AnalyticsQuerySuggestionManagementResponse}
|
|
1073
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
1074
|
+
*/
|
|
1075
|
+
'data'?: AnalyticsQuerySuggestionManagementResponse;
|
|
904
1076
|
/**
|
|
905
1077
|
*
|
|
906
1078
|
* @type {string}
|
|
907
|
-
* @memberof
|
|
1079
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
908
1080
|
*/
|
|
909
1081
|
'error'?: string;
|
|
910
1082
|
/**
|
|
911
1083
|
*
|
|
912
1084
|
* @type {string}
|
|
913
|
-
* @memberof
|
|
1085
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
914
1086
|
*/
|
|
915
1087
|
'status'?: string;
|
|
916
1088
|
/**
|
|
917
1089
|
*
|
|
918
1090
|
* @type {string}
|
|
919
|
-
* @memberof
|
|
1091
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
920
1092
|
*/
|
|
921
1093
|
'timestamp'?: string;
|
|
922
1094
|
/**
|
|
923
1095
|
*
|
|
924
1096
|
* @type {number}
|
|
925
|
-
* @memberof
|
|
1097
|
+
* @memberof AdminV1QuerySuggestionsXStoreIDGet200Response
|
|
926
1098
|
*/
|
|
927
1099
|
'total'?: number;
|
|
928
1100
|
}
|
|
@@ -1288,6 +1460,74 @@ export interface AnalyticsArrayPositionAnalytic {
|
|
|
1288
1460
|
*/
|
|
1289
1461
|
'usage_count'?: number;
|
|
1290
1462
|
}
|
|
1463
|
+
/**
|
|
1464
|
+
*
|
|
1465
|
+
* @export
|
|
1466
|
+
* @interface AnalyticsBannedExpression
|
|
1467
|
+
*/
|
|
1468
|
+
export interface AnalyticsBannedExpression {
|
|
1469
|
+
/**
|
|
1470
|
+
* When this ban was created
|
|
1471
|
+
* @type {string}
|
|
1472
|
+
* @memberof AnalyticsBannedExpression
|
|
1473
|
+
*/
|
|
1474
|
+
'created_at'?: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* Optional description
|
|
1477
|
+
* @type {string}
|
|
1478
|
+
* @memberof AnalyticsBannedExpression
|
|
1479
|
+
*/
|
|
1480
|
+
'description'?: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Whether this ban is active
|
|
1483
|
+
* @type {boolean}
|
|
1484
|
+
* @memberof AnalyticsBannedExpression
|
|
1485
|
+
*/
|
|
1486
|
+
'enabled'?: boolean;
|
|
1487
|
+
/**
|
|
1488
|
+
* The expression to ban
|
|
1489
|
+
* @type {string}
|
|
1490
|
+
* @memberof AnalyticsBannedExpression
|
|
1491
|
+
*/
|
|
1492
|
+
'expression'?: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* Unique identifier for the banned expression
|
|
1495
|
+
* @type {string}
|
|
1496
|
+
* @memberof AnalyticsBannedExpression
|
|
1497
|
+
*/
|
|
1498
|
+
'id'?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* How to match the expression
|
|
1501
|
+
* @type {AnalyticsBannedMatchType}
|
|
1502
|
+
* @memberof AnalyticsBannedExpression
|
|
1503
|
+
*/
|
|
1504
|
+
'match_type'?: AnalyticsBannedMatchType;
|
|
1505
|
+
/**
|
|
1506
|
+
* When this ban was last updated
|
|
1507
|
+
* @type {string}
|
|
1508
|
+
* @memberof AnalyticsBannedExpression
|
|
1509
|
+
*/
|
|
1510
|
+
'updated_at'?: string;
|
|
1511
|
+
}
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
*
|
|
1516
|
+
* @export
|
|
1517
|
+
* @enum {string}
|
|
1518
|
+
*/
|
|
1519
|
+
|
|
1520
|
+
export const AnalyticsBannedMatchType = {
|
|
1521
|
+
BannedMatchIs: 'is',
|
|
1522
|
+
BannedMatchContains: 'contains',
|
|
1523
|
+
BannedMatchStartsWith: 'startsWith',
|
|
1524
|
+
BannedMatchEndsWith: 'endsWith',
|
|
1525
|
+
BannedMatchCustom: 'custom'
|
|
1526
|
+
} as const;
|
|
1527
|
+
|
|
1528
|
+
export type AnalyticsBannedMatchType = typeof AnalyticsBannedMatchType[keyof typeof AnalyticsBannedMatchType];
|
|
1529
|
+
|
|
1530
|
+
|
|
1291
1531
|
/**
|
|
1292
1532
|
*
|
|
1293
1533
|
* @export
|
|
@@ -1399,6 +1639,68 @@ export interface AnalyticsCachedSuggestionResponse {
|
|
|
1399
1639
|
*/
|
|
1400
1640
|
'suggestions'?: Array<AnalyticsCachedSuggestion>;
|
|
1401
1641
|
}
|
|
1642
|
+
/**
|
|
1643
|
+
*
|
|
1644
|
+
* @export
|
|
1645
|
+
* @interface AnalyticsCategoryAttributeConfig
|
|
1646
|
+
*/
|
|
1647
|
+
export interface AnalyticsCategoryAttributeConfig {
|
|
1648
|
+
/**
|
|
1649
|
+
* The attribute name (e.g., \"category\", \"brand\") - REQUIRED
|
|
1650
|
+
* @type {string}
|
|
1651
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1652
|
+
*/
|
|
1653
|
+
'attribute'?: string;
|
|
1654
|
+
/**
|
|
1655
|
+
* Optional description (default: auto-generated)
|
|
1656
|
+
* @type {string}
|
|
1657
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1658
|
+
*/
|
|
1659
|
+
'description'?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Whether this attribute is enabled (default: true)
|
|
1662
|
+
* @type {boolean}
|
|
1663
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1664
|
+
*/
|
|
1665
|
+
'enabled'?: boolean;
|
|
1666
|
+
/**
|
|
1667
|
+
* Maximum number of categories to show for this attribute - REQUIRED
|
|
1668
|
+
* @type {number}
|
|
1669
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1670
|
+
*/
|
|
1671
|
+
'max_count'?: number;
|
|
1672
|
+
/**
|
|
1673
|
+
* Priority order (lower number = higher priority) (default: auto-assigned)
|
|
1674
|
+
* @type {number}
|
|
1675
|
+
* @memberof AnalyticsCategoryAttributeConfig
|
|
1676
|
+
*/
|
|
1677
|
+
'priority'?: number;
|
|
1678
|
+
}
|
|
1679
|
+
/**
|
|
1680
|
+
*
|
|
1681
|
+
* @export
|
|
1682
|
+
* @interface AnalyticsCategoryWithCount
|
|
1683
|
+
*/
|
|
1684
|
+
export interface AnalyticsCategoryWithCount {
|
|
1685
|
+
/**
|
|
1686
|
+
*
|
|
1687
|
+
* @type {number}
|
|
1688
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1689
|
+
*/
|
|
1690
|
+
'count'?: number;
|
|
1691
|
+
/**
|
|
1692
|
+
* \"exact_matches\" or \"analytics\"
|
|
1693
|
+
* @type {string}
|
|
1694
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1695
|
+
*/
|
|
1696
|
+
'type'?: string;
|
|
1697
|
+
/**
|
|
1698
|
+
*
|
|
1699
|
+
* @type {string}
|
|
1700
|
+
* @memberof AnalyticsCategoryWithCount
|
|
1701
|
+
*/
|
|
1702
|
+
'value'?: string;
|
|
1703
|
+
}
|
|
1402
1704
|
/**
|
|
1403
1705
|
*
|
|
1404
1706
|
* @export
|
|
@@ -1560,6 +1862,37 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1560
1862
|
*/
|
|
1561
1863
|
'suggestion_ids': Array<string>;
|
|
1562
1864
|
}
|
|
1865
|
+
/**
|
|
1866
|
+
*
|
|
1867
|
+
* @export
|
|
1868
|
+
* @interface AnalyticsEnhancedCategorySuggestion
|
|
1869
|
+
*/
|
|
1870
|
+
export interface AnalyticsEnhancedCategorySuggestion {
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @type {Array<AnalyticsCategoryWithCount>}
|
|
1874
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1875
|
+
*/
|
|
1876
|
+
'categories'?: Array<AnalyticsCategoryWithCount>;
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {{ [key: string]: any; }}
|
|
1880
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1881
|
+
*/
|
|
1882
|
+
'metadata'?: { [key: string]: any; };
|
|
1883
|
+
/**
|
|
1884
|
+
*
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1887
|
+
*/
|
|
1888
|
+
'popularity'?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
*
|
|
1891
|
+
* @type {string}
|
|
1892
|
+
* @memberof AnalyticsEnhancedCategorySuggestion
|
|
1893
|
+
*/
|
|
1894
|
+
'query'?: string;
|
|
1895
|
+
}
|
|
1563
1896
|
/**
|
|
1564
1897
|
*
|
|
1565
1898
|
* @export
|
|
@@ -1567,11 +1900,41 @@ export interface AnalyticsDeleteManualSuggestionsRequest {
|
|
|
1567
1900
|
*/
|
|
1568
1901
|
export interface AnalyticsEnrichedItemResultWithWidget {
|
|
1569
1902
|
/**
|
|
1570
|
-
*
|
|
1571
|
-
* @type {
|
|
1903
|
+
*
|
|
1904
|
+
* @type {number}
|
|
1572
1905
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1573
1906
|
*/
|
|
1574
|
-
'
|
|
1907
|
+
'avg_position'?: number;
|
|
1908
|
+
/**
|
|
1909
|
+
*
|
|
1910
|
+
* @type {number}
|
|
1911
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1912
|
+
*/
|
|
1913
|
+
'avg_score'?: number;
|
|
1914
|
+
/**
|
|
1915
|
+
* Calculated metrics
|
|
1916
|
+
* @type {number}
|
|
1917
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1918
|
+
*/
|
|
1919
|
+
'click_through_rate'?: number;
|
|
1920
|
+
/**
|
|
1921
|
+
* Future click and conversion metrics
|
|
1922
|
+
* @type {number}
|
|
1923
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1924
|
+
*/
|
|
1925
|
+
'clicks'?: number;
|
|
1926
|
+
/**
|
|
1927
|
+
*
|
|
1928
|
+
* @type {number}
|
|
1929
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1930
|
+
*/
|
|
1931
|
+
'conversion_rate'?: number;
|
|
1932
|
+
/**
|
|
1933
|
+
*
|
|
1934
|
+
* @type {number}
|
|
1935
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1936
|
+
*/
|
|
1937
|
+
'conversions'?: number;
|
|
1575
1938
|
/**
|
|
1576
1939
|
* Document data from Typesense index
|
|
1577
1940
|
* @type {{ [key: string]: any; }}
|
|
@@ -1584,6 +1947,84 @@ export interface AnalyticsEnrichedItemResultWithWidget {
|
|
|
1584
1947
|
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1585
1948
|
*/
|
|
1586
1949
|
'document_fetch_error'?: string;
|
|
1950
|
+
/**
|
|
1951
|
+
*
|
|
1952
|
+
* @type {number}
|
|
1953
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1954
|
+
*/
|
|
1955
|
+
'impressions'?: number;
|
|
1956
|
+
/**
|
|
1957
|
+
*
|
|
1958
|
+
* @type {string}
|
|
1959
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1960
|
+
*/
|
|
1961
|
+
'item_id'?: string;
|
|
1962
|
+
/**
|
|
1963
|
+
*
|
|
1964
|
+
* @type {string}
|
|
1965
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1966
|
+
*/
|
|
1967
|
+
'item_name'?: string;
|
|
1968
|
+
/**
|
|
1969
|
+
*
|
|
1970
|
+
* @type {number}
|
|
1971
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1972
|
+
*/
|
|
1973
|
+
'revenue'?: number;
|
|
1974
|
+
/**
|
|
1975
|
+
*
|
|
1976
|
+
* @type {number}
|
|
1977
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1978
|
+
*/
|
|
1979
|
+
'revenue_per_item'?: number;
|
|
1980
|
+
/**
|
|
1981
|
+
*
|
|
1982
|
+
* @type {number}
|
|
1983
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1984
|
+
*/
|
|
1985
|
+
'top_10_impressions'?: number;
|
|
1986
|
+
/**
|
|
1987
|
+
*
|
|
1988
|
+
* @type {number}
|
|
1989
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1990
|
+
*/
|
|
1991
|
+
'top_3_impression_rate'?: number;
|
|
1992
|
+
/**
|
|
1993
|
+
*
|
|
1994
|
+
* @type {number}
|
|
1995
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
1996
|
+
*/
|
|
1997
|
+
'top_3_impressions'?: number;
|
|
1998
|
+
/**
|
|
1999
|
+
*
|
|
2000
|
+
* @type {number}
|
|
2001
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2002
|
+
*/
|
|
2003
|
+
'unique_filters'?: number;
|
|
2004
|
+
/**
|
|
2005
|
+
*
|
|
2006
|
+
* @type {number}
|
|
2007
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2008
|
+
*/
|
|
2009
|
+
'unique_queries'?: number;
|
|
2010
|
+
/**
|
|
2011
|
+
*
|
|
2012
|
+
* @type {number}
|
|
2013
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2014
|
+
*/
|
|
2015
|
+
'unique_searches'?: number;
|
|
2016
|
+
/**
|
|
2017
|
+
*
|
|
2018
|
+
* @type {number}
|
|
2019
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2020
|
+
*/
|
|
2021
|
+
'unique_sorts'?: number;
|
|
2022
|
+
/**
|
|
2023
|
+
*
|
|
2024
|
+
* @type {number}
|
|
2025
|
+
* @memberof AnalyticsEnrichedItemResultWithWidget
|
|
2026
|
+
*/
|
|
2027
|
+
'unique_users'?: number;
|
|
1587
2028
|
/**
|
|
1588
2029
|
* Widget display data for UI presentation
|
|
1589
2030
|
* @type {AnalyticsWidgetData}
|
|
@@ -1657,6 +2098,12 @@ export interface AnalyticsExtendedKPIResponse {
|
|
|
1657
2098
|
* @memberof AnalyticsExtendedKPIResponse
|
|
1658
2099
|
*/
|
|
1659
2100
|
'summary'?: any;
|
|
2101
|
+
/**
|
|
2102
|
+
*
|
|
2103
|
+
* @type {string}
|
|
2104
|
+
* @memberof AnalyticsExtendedKPIResponse
|
|
2105
|
+
*/
|
|
2106
|
+
'target_currency'?: string;
|
|
1660
2107
|
/**
|
|
1661
2108
|
*
|
|
1662
2109
|
* @type {string}
|
|
@@ -1683,6 +2130,37 @@ export interface AnalyticsFacetMatch {
|
|
|
1683
2130
|
*/
|
|
1684
2131
|
'value'?: string;
|
|
1685
2132
|
}
|
|
2133
|
+
/**
|
|
2134
|
+
*
|
|
2135
|
+
* @export
|
|
2136
|
+
* @interface AnalyticsFacetSuggestion
|
|
2137
|
+
*/
|
|
2138
|
+
export interface AnalyticsFacetSuggestion {
|
|
2139
|
+
/**
|
|
2140
|
+
*
|
|
2141
|
+
* @type {number}
|
|
2142
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2143
|
+
*/
|
|
2144
|
+
'count'?: number;
|
|
2145
|
+
/**
|
|
2146
|
+
* e.g., {\"brand\": \"Nike\", \"color\": \"red\"}
|
|
2147
|
+
* @type {{ [key: string]: string; }}
|
|
2148
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2149
|
+
*/
|
|
2150
|
+
'facet_combination'?: { [key: string]: string; };
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @type {number}
|
|
2154
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2155
|
+
*/
|
|
2156
|
+
'popularity'?: number;
|
|
2157
|
+
/**
|
|
2158
|
+
*
|
|
2159
|
+
* @type {string}
|
|
2160
|
+
* @memberof AnalyticsFacetSuggestion
|
|
2161
|
+
*/
|
|
2162
|
+
'query'?: string;
|
|
2163
|
+
}
|
|
1686
2164
|
/**
|
|
1687
2165
|
*
|
|
1688
2166
|
* @export
|
|
@@ -2361,6 +2839,18 @@ export interface AnalyticsGeoAnalytic {
|
|
|
2361
2839
|
* @memberof AnalyticsGeoAnalytic
|
|
2362
2840
|
*/
|
|
2363
2841
|
'revenue'?: number;
|
|
2842
|
+
/**
|
|
2843
|
+
*
|
|
2844
|
+
* @type {{ [key: string]: number; }}
|
|
2845
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2846
|
+
*/
|
|
2847
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
2848
|
+
/**
|
|
2849
|
+
*
|
|
2850
|
+
* @type {string}
|
|
2851
|
+
* @memberof AnalyticsGeoAnalytic
|
|
2852
|
+
*/
|
|
2853
|
+
'revenue_currency'?: string;
|
|
2364
2854
|
/**
|
|
2365
2855
|
*
|
|
2366
2856
|
* @type {number}
|
|
@@ -2703,6 +3193,12 @@ export interface AnalyticsGeoResponse {
|
|
|
2703
3193
|
* @memberof AnalyticsGeoResponse
|
|
2704
3194
|
*/
|
|
2705
3195
|
'start_time'?: string;
|
|
3196
|
+
/**
|
|
3197
|
+
*
|
|
3198
|
+
* @type {string}
|
|
3199
|
+
* @memberof AnalyticsGeoResponse
|
|
3200
|
+
*/
|
|
3201
|
+
'target_currency'?: string;
|
|
2706
3202
|
/**
|
|
2707
3203
|
*
|
|
2708
3204
|
* @type {number}
|
|
@@ -4180,6 +4676,18 @@ export interface AnalyticsKPIMetrics {
|
|
|
4180
4676
|
* @memberof AnalyticsKPIMetrics
|
|
4181
4677
|
*/
|
|
4182
4678
|
'revenue'?: number;
|
|
4679
|
+
/**
|
|
4680
|
+
*
|
|
4681
|
+
* @type {{ [key: string]: number; }}
|
|
4682
|
+
* @memberof AnalyticsKPIMetrics
|
|
4683
|
+
*/
|
|
4684
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4685
|
+
/**
|
|
4686
|
+
*
|
|
4687
|
+
* @type {string}
|
|
4688
|
+
* @memberof AnalyticsKPIMetrics
|
|
4689
|
+
*/
|
|
4690
|
+
'revenue_currency'?: string;
|
|
4183
4691
|
/**
|
|
4184
4692
|
*
|
|
4185
4693
|
* @type {number}
|
|
@@ -4259,6 +4767,18 @@ export interface AnalyticsKPIPointExtended {
|
|
|
4259
4767
|
* @memberof AnalyticsKPIPointExtended
|
|
4260
4768
|
*/
|
|
4261
4769
|
'revenue'?: number;
|
|
4770
|
+
/**
|
|
4771
|
+
*
|
|
4772
|
+
* @type {{ [key: string]: number; }}
|
|
4773
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4774
|
+
*/
|
|
4775
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4776
|
+
/**
|
|
4777
|
+
*
|
|
4778
|
+
* @type {string}
|
|
4779
|
+
* @memberof AnalyticsKPIPointExtended
|
|
4780
|
+
*/
|
|
4781
|
+
'revenue_currency'?: string;
|
|
4262
4782
|
/**
|
|
4263
4783
|
*
|
|
4264
4784
|
* @type {number}
|
|
@@ -4437,6 +4957,18 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4437
4957
|
* @memberof AnalyticsQueryAnalytic
|
|
4438
4958
|
*/
|
|
4439
4959
|
'revenue'?: number;
|
|
4960
|
+
/**
|
|
4961
|
+
*
|
|
4962
|
+
* @type {{ [key: string]: number; }}
|
|
4963
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4964
|
+
*/
|
|
4965
|
+
'revenue_breakdown'?: { [key: string]: number; };
|
|
4966
|
+
/**
|
|
4967
|
+
*
|
|
4968
|
+
* @type {string}
|
|
4969
|
+
* @memberof AnalyticsQueryAnalytic
|
|
4970
|
+
*/
|
|
4971
|
+
'revenue_currency'?: string;
|
|
4440
4972
|
/**
|
|
4441
4973
|
*
|
|
4442
4974
|
* @type {number}
|
|
@@ -5303,6 +5835,12 @@ export interface AnalyticsQueryResponse {
|
|
|
5303
5835
|
* @memberof AnalyticsQueryResponse
|
|
5304
5836
|
*/
|
|
5305
5837
|
'start_time'?: string;
|
|
5838
|
+
/**
|
|
5839
|
+
*
|
|
5840
|
+
* @type {string}
|
|
5841
|
+
* @memberof AnalyticsQueryResponse
|
|
5842
|
+
*/
|
|
5843
|
+
'target_currency'?: string;
|
|
5306
5844
|
/**
|
|
5307
5845
|
*
|
|
5308
5846
|
* @type {number}
|
|
@@ -5378,11 +5916,29 @@ export interface AnalyticsQuerySuggestion {
|
|
|
5378
5916
|
*/
|
|
5379
5917
|
export interface AnalyticsQuerySuggestionConfig {
|
|
5380
5918
|
/**
|
|
5381
|
-
*
|
|
5919
|
+
* Expressions to exclude from suggestions with matching types
|
|
5920
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
5921
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5922
|
+
*/
|
|
5923
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
5924
|
+
/**
|
|
5925
|
+
* Per-attribute configuration with counts
|
|
5926
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
5927
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5928
|
+
*/
|
|
5929
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
5930
|
+
/**
|
|
5931
|
+
* Attributes to use for category suggestions (legacy)
|
|
5382
5932
|
* @type {Array<string>}
|
|
5383
5933
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5384
5934
|
*/
|
|
5385
5935
|
'category_attributes'?: Array<string>;
|
|
5936
|
+
/**
|
|
5937
|
+
* Whether to include count per attribute
|
|
5938
|
+
* @type {boolean}
|
|
5939
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5940
|
+
*/
|
|
5941
|
+
'category_counts'?: boolean;
|
|
5386
5942
|
/**
|
|
5387
5943
|
* Whether to include category-based suggestions
|
|
5388
5944
|
* @type {boolean}
|
|
@@ -5395,12 +5951,42 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5395
5951
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5396
5952
|
*/
|
|
5397
5953
|
'enable_facet_suggestions'?: boolean;
|
|
5954
|
+
/**
|
|
5955
|
+
* Personalization (boolean flag for now as requested)
|
|
5956
|
+
* @type {boolean}
|
|
5957
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5958
|
+
*/
|
|
5959
|
+
'enable_personalization'?: boolean;
|
|
5960
|
+
/**
|
|
5961
|
+
* Improve relevance using Rules
|
|
5962
|
+
* @type {boolean}
|
|
5963
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5964
|
+
*/
|
|
5965
|
+
'enable_rules'?: boolean;
|
|
5398
5966
|
/**
|
|
5399
5967
|
* Whether query suggestions are enabled for the store
|
|
5400
5968
|
* @type {boolean}
|
|
5401
5969
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5402
5970
|
*/
|
|
5403
5971
|
'enabled'?: boolean;
|
|
5972
|
+
/**
|
|
5973
|
+
* Facet data augmentation
|
|
5974
|
+
* @type {Array<string>}
|
|
5975
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5976
|
+
*/
|
|
5977
|
+
'facet_attributes'?: Array<string>;
|
|
5978
|
+
/**
|
|
5979
|
+
* Maximum number of facet combinations
|
|
5980
|
+
* @type {number}
|
|
5981
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5982
|
+
*/
|
|
5983
|
+
'facet_combination_limit'?: number;
|
|
5984
|
+
/**
|
|
5985
|
+
* Language for duplicate removal (singular/plural)
|
|
5986
|
+
* @type {string}
|
|
5987
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
5988
|
+
*/
|
|
5989
|
+
'language'?: string;
|
|
5404
5990
|
/**
|
|
5405
5991
|
* Maximum number of suggestions to return
|
|
5406
5992
|
* @type {number}
|
|
@@ -5413,18 +5999,54 @@ export interface AnalyticsQuerySuggestionConfig {
|
|
|
5413
5999
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5414
6000
|
*/
|
|
5415
6001
|
'min_popularity'?: number;
|
|
6002
|
+
/**
|
|
6003
|
+
* Minimum search results for suggestions
|
|
6004
|
+
* @type {number}
|
|
6005
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6006
|
+
*/
|
|
6007
|
+
'minimum_hits'?: number;
|
|
6008
|
+
/**
|
|
6009
|
+
* Remove duplicate or unhelpful suggestions (from Algolia documentation)
|
|
6010
|
+
* @type {number}
|
|
6011
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6012
|
+
*/
|
|
6013
|
+
'minimum_letters'?: number;
|
|
6014
|
+
/**
|
|
6015
|
+
* Array of rules for suggestion promotion/hiding
|
|
6016
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6017
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6018
|
+
*/
|
|
6019
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6020
|
+
/**
|
|
6021
|
+
* Query Suggestions with categories - enhanced
|
|
6022
|
+
* @type {number}
|
|
6023
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6024
|
+
*/
|
|
6025
|
+
'show_top_categories'?: number;
|
|
5416
6026
|
/**
|
|
5417
6027
|
* Whether to sync enabled suggestions to Typesense
|
|
5418
6028
|
* @type {boolean}
|
|
5419
6029
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5420
6030
|
*/
|
|
5421
6031
|
'sync_to_typesense'?: boolean;
|
|
6032
|
+
/**
|
|
6033
|
+
* Tokenization method
|
|
6034
|
+
* @type {string}
|
|
6035
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6036
|
+
*/
|
|
6037
|
+
'tokenization'?: string;
|
|
5422
6038
|
/**
|
|
5423
6039
|
* Whether to sync to Typesense
|
|
5424
6040
|
* @type {boolean}
|
|
5425
6041
|
* @memberof AnalyticsQuerySuggestionConfig
|
|
5426
6042
|
*/
|
|
5427
6043
|
'typesense_collection_enabled'?: boolean;
|
|
6044
|
+
/**
|
|
6045
|
+
* Index settings
|
|
6046
|
+
* @type {number}
|
|
6047
|
+
* @memberof AnalyticsQuerySuggestionConfig
|
|
6048
|
+
*/
|
|
6049
|
+
'typo_tolerance'?: number;
|
|
5428
6050
|
/**
|
|
5429
6051
|
* Include auto-generated suggestions
|
|
5430
6052
|
* @type {boolean}
|
|
@@ -5626,6 +6248,75 @@ export interface AnalyticsQuerySuggestionRecord {
|
|
|
5626
6248
|
}
|
|
5627
6249
|
|
|
5628
6250
|
|
|
6251
|
+
/**
|
|
6252
|
+
*
|
|
6253
|
+
* @export
|
|
6254
|
+
* @interface AnalyticsQuerySuggestionRule
|
|
6255
|
+
*/
|
|
6256
|
+
export interface AnalyticsQuerySuggestionRule {
|
|
6257
|
+
/**
|
|
6258
|
+
* Rule actions
|
|
6259
|
+
* @type {Array<AnalyticsRuleAction>}
|
|
6260
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6261
|
+
*/
|
|
6262
|
+
'actions'?: Array<AnalyticsRuleAction>;
|
|
6263
|
+
/**
|
|
6264
|
+
* Rule conditions
|
|
6265
|
+
* @type {Array<AnalyticsRuleCondition>}
|
|
6266
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6267
|
+
*/
|
|
6268
|
+
'conditions'?: Array<AnalyticsRuleCondition>;
|
|
6269
|
+
/**
|
|
6270
|
+
* Rule creation time
|
|
6271
|
+
* @type {string}
|
|
6272
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6273
|
+
*/
|
|
6274
|
+
'created_at'?: string;
|
|
6275
|
+
/**
|
|
6276
|
+
* Rule description
|
|
6277
|
+
* @type {string}
|
|
6278
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6279
|
+
*/
|
|
6280
|
+
'description'?: string;
|
|
6281
|
+
/**
|
|
6282
|
+
* Whether rule is enabled
|
|
6283
|
+
* @type {boolean}
|
|
6284
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6285
|
+
*/
|
|
6286
|
+
'enabled'?: boolean;
|
|
6287
|
+
/**
|
|
6288
|
+
* Unique rule identifier
|
|
6289
|
+
* @type {string}
|
|
6290
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6291
|
+
*/
|
|
6292
|
+
'id'?: string;
|
|
6293
|
+
/**
|
|
6294
|
+
* Rule name
|
|
6295
|
+
* @type {string}
|
|
6296
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6297
|
+
*/
|
|
6298
|
+
'name'?: string;
|
|
6299
|
+
/**
|
|
6300
|
+
* Rule priority (higher = executed first)
|
|
6301
|
+
* @type {number}
|
|
6302
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6303
|
+
*/
|
|
6304
|
+
'priority'?: number;
|
|
6305
|
+
/**
|
|
6306
|
+
* Rule type (promote, hide, redirect, etc.)
|
|
6307
|
+
* @type {AnalyticsRuleType}
|
|
6308
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6309
|
+
*/
|
|
6310
|
+
'type'?: AnalyticsRuleType;
|
|
6311
|
+
/**
|
|
6312
|
+
* Rule last update time
|
|
6313
|
+
* @type {string}
|
|
6314
|
+
* @memberof AnalyticsQuerySuggestionRule
|
|
6315
|
+
*/
|
|
6316
|
+
'updated_at'?: string;
|
|
6317
|
+
}
|
|
6318
|
+
|
|
6319
|
+
|
|
5629
6320
|
/**
|
|
5630
6321
|
*
|
|
5631
6322
|
* @export
|
|
@@ -5905,6 +6596,72 @@ export interface AnalyticsQuerySuggestionsResponse {
|
|
|
5905
6596
|
*/
|
|
5906
6597
|
'userToken'?: string;
|
|
5907
6598
|
}
|
|
6599
|
+
/**
|
|
6600
|
+
*
|
|
6601
|
+
* @export
|
|
6602
|
+
* @interface AnalyticsRuleAction
|
|
6603
|
+
*/
|
|
6604
|
+
export interface AnalyticsRuleAction {
|
|
6605
|
+
/**
|
|
6606
|
+
* Optional message for banner actions
|
|
6607
|
+
* @type {string}
|
|
6608
|
+
* @memberof AnalyticsRuleAction
|
|
6609
|
+
*/
|
|
6610
|
+
'message'?: string;
|
|
6611
|
+
/**
|
|
6612
|
+
* Action type (promote, hide, change_query, show_banner)
|
|
6613
|
+
* @type {string}
|
|
6614
|
+
* @memberof AnalyticsRuleAction
|
|
6615
|
+
*/
|
|
6616
|
+
'type'?: string;
|
|
6617
|
+
/**
|
|
6618
|
+
* Action value
|
|
6619
|
+
* @type {any}
|
|
6620
|
+
* @memberof AnalyticsRuleAction
|
|
6621
|
+
*/
|
|
6622
|
+
'value'?: any;
|
|
6623
|
+
}
|
|
6624
|
+
/**
|
|
6625
|
+
*
|
|
6626
|
+
* @export
|
|
6627
|
+
* @interface AnalyticsRuleCondition
|
|
6628
|
+
*/
|
|
6629
|
+
export interface AnalyticsRuleCondition {
|
|
6630
|
+
/**
|
|
6631
|
+
* Attribute to match (query, category, etc.)
|
|
6632
|
+
* @type {string}
|
|
6633
|
+
* @memberof AnalyticsRuleCondition
|
|
6634
|
+
*/
|
|
6635
|
+
'attribute'?: string;
|
|
6636
|
+
/**
|
|
6637
|
+
* Operator (equals, contains, starts_with, etc.)
|
|
6638
|
+
* @type {string}
|
|
6639
|
+
* @memberof AnalyticsRuleCondition
|
|
6640
|
+
*/
|
|
6641
|
+
'operator'?: string;
|
|
6642
|
+
/**
|
|
6643
|
+
* Value to match against
|
|
6644
|
+
* @type {any}
|
|
6645
|
+
* @memberof AnalyticsRuleCondition
|
|
6646
|
+
*/
|
|
6647
|
+
'value'?: any;
|
|
6648
|
+
}
|
|
6649
|
+
/**
|
|
6650
|
+
*
|
|
6651
|
+
* @export
|
|
6652
|
+
* @enum {string}
|
|
6653
|
+
*/
|
|
6654
|
+
|
|
6655
|
+
export const AnalyticsRuleType = {
|
|
6656
|
+
RuleTypePromote: 'promote',
|
|
6657
|
+
RuleTypeHide: 'hide',
|
|
6658
|
+
RuleTypeRedirect: 'redirect',
|
|
6659
|
+
RuleTypeBanner: 'banner'
|
|
6660
|
+
} as const;
|
|
6661
|
+
|
|
6662
|
+
export type AnalyticsRuleType = typeof AnalyticsRuleType[keyof typeof AnalyticsRuleType];
|
|
6663
|
+
|
|
6664
|
+
|
|
5908
6665
|
/**
|
|
5909
6666
|
*
|
|
5910
6667
|
* @export
|
|
@@ -6011,18 +6768,102 @@ export interface AnalyticsToggleQuerySuggestionsRequest {
|
|
|
6011
6768
|
* @interface AnalyticsUpdateSuggestionConfigRequest
|
|
6012
6769
|
*/
|
|
6013
6770
|
export interface AnalyticsUpdateSuggestionConfigRequest {
|
|
6771
|
+
/**
|
|
6772
|
+
* Banned expressions with matching types
|
|
6773
|
+
* @type {Array<AnalyticsBannedExpression>}
|
|
6774
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6775
|
+
*/
|
|
6776
|
+
'banned_expressions'?: Array<AnalyticsBannedExpression>;
|
|
6777
|
+
/**
|
|
6778
|
+
* Per-attribute configuration with counts
|
|
6779
|
+
* @type {Array<AnalyticsCategoryAttributeConfig>}
|
|
6780
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6781
|
+
*/
|
|
6782
|
+
'category_attribute_configs'?: Array<AnalyticsCategoryAttributeConfig>;
|
|
6783
|
+
/**
|
|
6784
|
+
* Include category counts
|
|
6785
|
+
* @type {boolean}
|
|
6786
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6787
|
+
*/
|
|
6788
|
+
'category_counts'?: boolean;
|
|
6014
6789
|
/**
|
|
6015
6790
|
* Enable/disable facet-based suggestions
|
|
6016
6791
|
* @type {boolean}
|
|
6017
6792
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6018
6793
|
*/
|
|
6019
6794
|
'enable_facet_suggestions'?: boolean;
|
|
6795
|
+
/**
|
|
6796
|
+
* Enable personalization
|
|
6797
|
+
* @type {boolean}
|
|
6798
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6799
|
+
*/
|
|
6800
|
+
'enable_personalization'?: boolean;
|
|
6801
|
+
/**
|
|
6802
|
+
* Enable rules
|
|
6803
|
+
* @type {boolean}
|
|
6804
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6805
|
+
*/
|
|
6806
|
+
'enable_rules'?: boolean;
|
|
6020
6807
|
/**
|
|
6021
6808
|
* Enable/disable query suggestions for the store
|
|
6022
6809
|
* @type {boolean}
|
|
6023
6810
|
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6024
6811
|
*/
|
|
6025
6812
|
'enabled'?: boolean;
|
|
6813
|
+
/**
|
|
6814
|
+
* Facet attributes
|
|
6815
|
+
* @type {Array<string>}
|
|
6816
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6817
|
+
*/
|
|
6818
|
+
'facet_attributes'?: Array<string>;
|
|
6819
|
+
/**
|
|
6820
|
+
* Facet combination limit
|
|
6821
|
+
* @type {number}
|
|
6822
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6823
|
+
*/
|
|
6824
|
+
'facet_combination_limit'?: number;
|
|
6825
|
+
/**
|
|
6826
|
+
* Language for duplicate removal
|
|
6827
|
+
* @type {string}
|
|
6828
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6829
|
+
*/
|
|
6830
|
+
'language'?: string;
|
|
6831
|
+
/**
|
|
6832
|
+
* Minimum hits for suggestions
|
|
6833
|
+
* @type {number}
|
|
6834
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6835
|
+
*/
|
|
6836
|
+
'minimum_hits'?: number;
|
|
6837
|
+
/**
|
|
6838
|
+
* New fields from Algolia documentation
|
|
6839
|
+
* @type {number}
|
|
6840
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6841
|
+
*/
|
|
6842
|
+
'minimum_letters'?: number;
|
|
6843
|
+
/**
|
|
6844
|
+
* Rules array
|
|
6845
|
+
* @type {Array<AnalyticsQuerySuggestionRule>}
|
|
6846
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6847
|
+
*/
|
|
6848
|
+
'rules'?: Array<AnalyticsQuerySuggestionRule>;
|
|
6849
|
+
/**
|
|
6850
|
+
* Number of top categories (legacy)
|
|
6851
|
+
* @type {number}
|
|
6852
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6853
|
+
*/
|
|
6854
|
+
'show_top_categories'?: number;
|
|
6855
|
+
/**
|
|
6856
|
+
* Tokenization method
|
|
6857
|
+
* @type {string}
|
|
6858
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6859
|
+
*/
|
|
6860
|
+
'tokenization'?: string;
|
|
6861
|
+
/**
|
|
6862
|
+
* Typo tolerance
|
|
6863
|
+
* @type {number}
|
|
6864
|
+
* @memberof AnalyticsUpdateSuggestionConfigRequest
|
|
6865
|
+
*/
|
|
6866
|
+
'typo_tolerance'?: number;
|
|
6026
6867
|
/**
|
|
6027
6868
|
* Enable/disable auto-generated suggestions
|
|
6028
6869
|
* @type {boolean}
|
|
@@ -19475,11 +20316,11 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
19475
20316
|
};
|
|
19476
20317
|
},
|
|
19477
20318
|
/**
|
|
19478
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
20319
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
19479
20320
|
* @summary Get Analytics Tags
|
|
19480
20321
|
* @param {string} xStoreID Store ID
|
|
19481
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
19482
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
20322
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
20323
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
19483
20324
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
19484
20325
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
19485
20326
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -20098,11 +20939,11 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
20098
20939
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20099
20940
|
},
|
|
20100
20941
|
/**
|
|
20101
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
20942
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
20102
20943
|
* @summary Get Analytics Tags
|
|
20103
20944
|
* @param {string} xStoreID Store ID
|
|
20104
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
20105
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
20945
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
20946
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
20106
20947
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
20107
20948
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
20108
20949
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -20543,11 +21384,11 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
20543
21384
|
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
20544
21385
|
},
|
|
20545
21386
|
/**
|
|
20546
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
21387
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
20547
21388
|
* @summary Get Analytics Tags
|
|
20548
21389
|
* @param {string} xStoreID Store ID
|
|
20549
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
20550
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21390
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
21391
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
20551
21392
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
20552
21393
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
20553
21394
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -21014,11 +21855,11 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
21014
21855
|
}
|
|
21015
21856
|
|
|
21016
21857
|
/**
|
|
21017
|
-
* Retrieve analytics tags usage data and filtering capabilities
|
|
21858
|
+
* Retrieve analytics tags usage data and filtering capabilities. If no start_time/end_time is specified, returns all tags from the last 2 years.
|
|
21018
21859
|
* @summary Get Analytics Tags
|
|
21019
21860
|
* @param {string} xStoreID Store ID
|
|
21020
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
21021
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21861
|
+
* @param {string} [startTime] Start time in RFC3339 format. If not specified, returns all tags from 2 years ago
|
|
21862
|
+
* @param {string} [endTime] End time in RFC3339 format. If not specified, returns all tags until now
|
|
21022
21863
|
* @param {string} [search] Search term for tag keys and values (case-insensitive partial match)
|
|
21023
21864
|
* @param {string} [tagKey] Filter by specific tag key (exact match)
|
|
21024
21865
|
* @param {string} [tagValue] Filter by specific tag value (exact match)
|
|
@@ -34019,6 +34860,217 @@ export const QuerySuggestionsManagementApiAxiosParamCreator = function (configur
|
|
|
34019
34860
|
options: localVarRequestOptions,
|
|
34020
34861
|
};
|
|
34021
34862
|
},
|
|
34863
|
+
/**
|
|
34864
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
34865
|
+
* @summary Apply Suggestion Filters
|
|
34866
|
+
* @param {string} xStoreID Store ID
|
|
34867
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
34868
|
+
* @param {*} [options] Override http request option.
|
|
34869
|
+
* @throws {RequiredError}
|
|
34870
|
+
*/
|
|
34871
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost: async (xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34872
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
34873
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDApplyFiltersPost', 'xStoreID', xStoreID)
|
|
34874
|
+
// verify required parameter 'analyticsQuerySuggestionRecord' is not null or undefined
|
|
34875
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDApplyFiltersPost', 'analyticsQuerySuggestionRecord', analyticsQuerySuggestionRecord)
|
|
34876
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/apply-filters`
|
|
34877
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
34878
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34879
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34880
|
+
let baseOptions;
|
|
34881
|
+
if (configuration) {
|
|
34882
|
+
baseOptions = configuration.baseOptions;
|
|
34883
|
+
}
|
|
34884
|
+
|
|
34885
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
34886
|
+
const localVarHeaderParameter = {} as any;
|
|
34887
|
+
const localVarQueryParameter = {} as any;
|
|
34888
|
+
|
|
34889
|
+
// authentication BearerAuth required
|
|
34890
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
34891
|
+
|
|
34892
|
+
|
|
34893
|
+
|
|
34894
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34895
|
+
|
|
34896
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34897
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34898
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34899
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsQuerySuggestionRecord, localVarRequestOptions, configuration)
|
|
34900
|
+
|
|
34901
|
+
return {
|
|
34902
|
+
url: toPathString(localVarUrlObj),
|
|
34903
|
+
options: localVarRequestOptions,
|
|
34904
|
+
};
|
|
34905
|
+
},
|
|
34906
|
+
/**
|
|
34907
|
+
* Delete a banned expression
|
|
34908
|
+
* @summary Delete Banned Expression
|
|
34909
|
+
* @param {string} xStoreID Store ID
|
|
34910
|
+
* @param {string} expressionID Banned Expression ID
|
|
34911
|
+
* @param {*} [options] Override http request option.
|
|
34912
|
+
* @throws {RequiredError}
|
|
34913
|
+
*/
|
|
34914
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete: async (xStoreID: string, expressionID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34915
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
34916
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete', 'xStoreID', xStoreID)
|
|
34917
|
+
// verify required parameter 'expressionID' is not null or undefined
|
|
34918
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete', 'expressionID', expressionID)
|
|
34919
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions/{expressionID}`
|
|
34920
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
34921
|
+
.replace(`{${"expressionID"}}`, encodeURIComponent(String(expressionID)));
|
|
34922
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34923
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34924
|
+
let baseOptions;
|
|
34925
|
+
if (configuration) {
|
|
34926
|
+
baseOptions = configuration.baseOptions;
|
|
34927
|
+
}
|
|
34928
|
+
|
|
34929
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
34930
|
+
const localVarHeaderParameter = {} as any;
|
|
34931
|
+
const localVarQueryParameter = {} as any;
|
|
34932
|
+
|
|
34933
|
+
// authentication BearerAuth required
|
|
34934
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
34935
|
+
|
|
34936
|
+
|
|
34937
|
+
|
|
34938
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34939
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34940
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34941
|
+
|
|
34942
|
+
return {
|
|
34943
|
+
url: toPathString(localVarUrlObj),
|
|
34944
|
+
options: localVarRequestOptions,
|
|
34945
|
+
};
|
|
34946
|
+
},
|
|
34947
|
+
/**
|
|
34948
|
+
* Update an existing banned expression
|
|
34949
|
+
* @summary Update Banned Expression
|
|
34950
|
+
* @param {string} xStoreID Store ID
|
|
34951
|
+
* @param {string} expressionID Banned Expression ID
|
|
34952
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
34953
|
+
* @param {*} [options] Override http request option.
|
|
34954
|
+
* @throws {RequiredError}
|
|
34955
|
+
*/
|
|
34956
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut: async (xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34957
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
34958
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'xStoreID', xStoreID)
|
|
34959
|
+
// verify required parameter 'expressionID' is not null or undefined
|
|
34960
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'expressionID', expressionID)
|
|
34961
|
+
// verify required parameter 'analyticsBannedExpression' is not null or undefined
|
|
34962
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut', 'analyticsBannedExpression', analyticsBannedExpression)
|
|
34963
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions/{expressionID}`
|
|
34964
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
34965
|
+
.replace(`{${"expressionID"}}`, encodeURIComponent(String(expressionID)));
|
|
34966
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34967
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34968
|
+
let baseOptions;
|
|
34969
|
+
if (configuration) {
|
|
34970
|
+
baseOptions = configuration.baseOptions;
|
|
34971
|
+
}
|
|
34972
|
+
|
|
34973
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34974
|
+
const localVarHeaderParameter = {} as any;
|
|
34975
|
+
const localVarQueryParameter = {} as any;
|
|
34976
|
+
|
|
34977
|
+
// authentication BearerAuth required
|
|
34978
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
34979
|
+
|
|
34980
|
+
|
|
34981
|
+
|
|
34982
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34983
|
+
|
|
34984
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34985
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34986
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34987
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsBannedExpression, localVarRequestOptions, configuration)
|
|
34988
|
+
|
|
34989
|
+
return {
|
|
34990
|
+
url: toPathString(localVarUrlObj),
|
|
34991
|
+
options: localVarRequestOptions,
|
|
34992
|
+
};
|
|
34993
|
+
},
|
|
34994
|
+
/**
|
|
34995
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
34996
|
+
* @summary Get Banned Expressions
|
|
34997
|
+
* @param {string} xStoreID Store ID
|
|
34998
|
+
* @param {*} [options] Override http request option.
|
|
34999
|
+
* @throws {RequiredError}
|
|
35000
|
+
*/
|
|
35001
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35002
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35003
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsGet', 'xStoreID', xStoreID)
|
|
35004
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions`
|
|
35005
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35006
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35007
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35008
|
+
let baseOptions;
|
|
35009
|
+
if (configuration) {
|
|
35010
|
+
baseOptions = configuration.baseOptions;
|
|
35011
|
+
}
|
|
35012
|
+
|
|
35013
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35014
|
+
const localVarHeaderParameter = {} as any;
|
|
35015
|
+
const localVarQueryParameter = {} as any;
|
|
35016
|
+
|
|
35017
|
+
// authentication BearerAuth required
|
|
35018
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35019
|
+
|
|
35020
|
+
|
|
35021
|
+
|
|
35022
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35023
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35024
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35025
|
+
|
|
35026
|
+
return {
|
|
35027
|
+
url: toPathString(localVarUrlObj),
|
|
35028
|
+
options: localVarRequestOptions,
|
|
35029
|
+
};
|
|
35030
|
+
},
|
|
35031
|
+
/**
|
|
35032
|
+
* Create a new banned expression with specified matching type
|
|
35033
|
+
* @summary Create Banned Expression
|
|
35034
|
+
* @param {string} xStoreID Store ID
|
|
35035
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
35036
|
+
* @param {*} [options] Override http request option.
|
|
35037
|
+
* @throws {RequiredError}
|
|
35038
|
+
*/
|
|
35039
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost: async (xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35040
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35041
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsPost', 'xStoreID', xStoreID)
|
|
35042
|
+
// verify required parameter 'analyticsBannedExpression' is not null or undefined
|
|
35043
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDBannedExpressionsPost', 'analyticsBannedExpression', analyticsBannedExpression)
|
|
35044
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/banned-expressions`
|
|
35045
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35046
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35047
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35048
|
+
let baseOptions;
|
|
35049
|
+
if (configuration) {
|
|
35050
|
+
baseOptions = configuration.baseOptions;
|
|
35051
|
+
}
|
|
35052
|
+
|
|
35053
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35054
|
+
const localVarHeaderParameter = {} as any;
|
|
35055
|
+
const localVarQueryParameter = {} as any;
|
|
35056
|
+
|
|
35057
|
+
// authentication BearerAuth required
|
|
35058
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35059
|
+
|
|
35060
|
+
|
|
35061
|
+
|
|
35062
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35063
|
+
|
|
35064
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35065
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35066
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35067
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsBannedExpression, localVarRequestOptions, configuration)
|
|
35068
|
+
|
|
35069
|
+
return {
|
|
35070
|
+
url: toPathString(localVarUrlObj),
|
|
35071
|
+
options: localVarRequestOptions,
|
|
35072
|
+
};
|
|
35073
|
+
},
|
|
34022
35074
|
/**
|
|
34023
35075
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
34024
35076
|
* @summary Bulk Update Suggestions
|
|
@@ -34194,6 +35246,80 @@ export const QuerySuggestionsManagementApiAxiosParamCreator = function (configur
|
|
|
34194
35246
|
options: localVarRequestOptions,
|
|
34195
35247
|
};
|
|
34196
35248
|
},
|
|
35249
|
+
/**
|
|
35250
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
35251
|
+
* @summary Generate Enhanced Category Suggestions
|
|
35252
|
+
* @param {string} xStoreID Store ID
|
|
35253
|
+
* @param {*} [options] Override http request option.
|
|
35254
|
+
* @throws {RequiredError}
|
|
35255
|
+
*/
|
|
35256
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35257
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35258
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost', 'xStoreID', xStoreID)
|
|
35259
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/generate-categories`
|
|
35260
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35261
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35262
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35263
|
+
let baseOptions;
|
|
35264
|
+
if (configuration) {
|
|
35265
|
+
baseOptions = configuration.baseOptions;
|
|
35266
|
+
}
|
|
35267
|
+
|
|
35268
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35269
|
+
const localVarHeaderParameter = {} as any;
|
|
35270
|
+
const localVarQueryParameter = {} as any;
|
|
35271
|
+
|
|
35272
|
+
// authentication BearerAuth required
|
|
35273
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35274
|
+
|
|
35275
|
+
|
|
35276
|
+
|
|
35277
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35278
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35279
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35280
|
+
|
|
35281
|
+
return {
|
|
35282
|
+
url: toPathString(localVarUrlObj),
|
|
35283
|
+
options: localVarRequestOptions,
|
|
35284
|
+
};
|
|
35285
|
+
},
|
|
35286
|
+
/**
|
|
35287
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
35288
|
+
* @summary Generate Facet-Based Suggestions
|
|
35289
|
+
* @param {string} xStoreID Store ID
|
|
35290
|
+
* @param {*} [options] Override http request option.
|
|
35291
|
+
* @throws {RequiredError}
|
|
35292
|
+
*/
|
|
35293
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35294
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
35295
|
+
assertParamExists('adminV1QuerySuggestionsXStoreIDGenerateFacetsPost', 'xStoreID', xStoreID)
|
|
35296
|
+
const localVarPath = `/admin/v1/query-suggestions/{xStoreID}/generate-facets`
|
|
35297
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
35298
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35299
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35300
|
+
let baseOptions;
|
|
35301
|
+
if (configuration) {
|
|
35302
|
+
baseOptions = configuration.baseOptions;
|
|
35303
|
+
}
|
|
35304
|
+
|
|
35305
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35306
|
+
const localVarHeaderParameter = {} as any;
|
|
35307
|
+
const localVarQueryParameter = {} as any;
|
|
35308
|
+
|
|
35309
|
+
// authentication BearerAuth required
|
|
35310
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
35311
|
+
|
|
35312
|
+
|
|
35313
|
+
|
|
35314
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35315
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35316
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35317
|
+
|
|
35318
|
+
return {
|
|
35319
|
+
url: toPathString(localVarUrlObj),
|
|
35320
|
+
options: localVarRequestOptions,
|
|
35321
|
+
};
|
|
35322
|
+
},
|
|
34197
35323
|
/**
|
|
34198
35324
|
* Retrieve query suggestions with filtering and pagination for management
|
|
34199
35325
|
* @summary Get Query Suggestions
|
|
@@ -34981,6 +36107,76 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
34981
36107
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsMigrateAllPost']?.[localVarOperationServerIndex]?.url;
|
|
34982
36108
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34983
36109
|
},
|
|
36110
|
+
/**
|
|
36111
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
36112
|
+
* @summary Apply Suggestion Filters
|
|
36113
|
+
* @param {string} xStoreID Store ID
|
|
36114
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
36115
|
+
* @param {*} [options] Override http request option.
|
|
36116
|
+
* @throws {RequiredError}
|
|
36117
|
+
*/
|
|
36118
|
+
async adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
36119
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options);
|
|
36120
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36121
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDApplyFiltersPost']?.[localVarOperationServerIndex]?.url;
|
|
36122
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36123
|
+
},
|
|
36124
|
+
/**
|
|
36125
|
+
* Delete a banned expression
|
|
36126
|
+
* @summary Delete Banned Expression
|
|
36127
|
+
* @param {string} xStoreID Store ID
|
|
36128
|
+
* @param {string} expressionID Banned Expression ID
|
|
36129
|
+
* @param {*} [options] Override http request option.
|
|
36130
|
+
* @throws {RequiredError}
|
|
36131
|
+
*/
|
|
36132
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsAnalyticsAPIResponse>> {
|
|
36133
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options);
|
|
36134
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36135
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete']?.[localVarOperationServerIndex]?.url;
|
|
36136
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36137
|
+
},
|
|
36138
|
+
/**
|
|
36139
|
+
* Update an existing banned expression
|
|
36140
|
+
* @summary Update Banned Expression
|
|
36141
|
+
* @param {string} xStoreID Store ID
|
|
36142
|
+
* @param {string} expressionID Banned Expression ID
|
|
36143
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
36144
|
+
* @param {*} [options] Override http request option.
|
|
36145
|
+
* @throws {RequiredError}
|
|
36146
|
+
*/
|
|
36147
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>> {
|
|
36148
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options);
|
|
36149
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36150
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut']?.[localVarOperationServerIndex]?.url;
|
|
36151
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36152
|
+
},
|
|
36153
|
+
/**
|
|
36154
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
36155
|
+
* @summary Get Banned Expressions
|
|
36156
|
+
* @param {string} xStoreID Store ID
|
|
36157
|
+
* @param {*} [options] Override http request option.
|
|
36158
|
+
* @throws {RequiredError}
|
|
36159
|
+
*/
|
|
36160
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response>> {
|
|
36161
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options);
|
|
36162
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36163
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet']?.[localVarOperationServerIndex]?.url;
|
|
36164
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36165
|
+
},
|
|
36166
|
+
/**
|
|
36167
|
+
* Create a new banned expression with specified matching type
|
|
36168
|
+
* @summary Create Banned Expression
|
|
36169
|
+
* @param {string} xStoreID Store ID
|
|
36170
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
36171
|
+
* @param {*} [options] Override http request option.
|
|
36172
|
+
* @throws {RequiredError}
|
|
36173
|
+
*/
|
|
36174
|
+
async adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response>> {
|
|
36175
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options);
|
|
36176
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36177
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost']?.[localVarOperationServerIndex]?.url;
|
|
36178
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36179
|
+
},
|
|
34984
36180
|
/**
|
|
34985
36181
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
34986
36182
|
* @summary Bulk Update Suggestions
|
|
@@ -35038,6 +36234,32 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35038
36234
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDConfigPut']?.[localVarOperationServerIndex]?.url;
|
|
35039
36235
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35040
36236
|
},
|
|
36237
|
+
/**
|
|
36238
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
36239
|
+
* @summary Generate Enhanced Category Suggestions
|
|
36240
|
+
* @param {string} xStoreID Store ID
|
|
36241
|
+
* @param {*} [options] Override http request option.
|
|
36242
|
+
* @throws {RequiredError}
|
|
36243
|
+
*/
|
|
36244
|
+
async adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response>> {
|
|
36245
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options);
|
|
36246
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36247
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost']?.[localVarOperationServerIndex]?.url;
|
|
36248
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36249
|
+
},
|
|
36250
|
+
/**
|
|
36251
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
36252
|
+
* @summary Generate Facet-Based Suggestions
|
|
36253
|
+
* @param {string} xStoreID Store ID
|
|
36254
|
+
* @param {*} [options] Override http request option.
|
|
36255
|
+
* @throws {RequiredError}
|
|
36256
|
+
*/
|
|
36257
|
+
async adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response>> {
|
|
36258
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options);
|
|
36259
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36260
|
+
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost']?.[localVarOperationServerIndex]?.url;
|
|
36261
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36262
|
+
},
|
|
35041
36263
|
/**
|
|
35042
36264
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35043
36265
|
* @summary Get Query Suggestions
|
|
@@ -35066,7 +36288,7 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35066
36288
|
* @param {*} [options] Override http request option.
|
|
35067
36289
|
* @throws {RequiredError}
|
|
35068
36290
|
*/
|
|
35069
|
-
async adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
36291
|
+
async adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
35070
36292
|
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDImportPost(xStoreID, analyticsImportQuerySuggestionsRequest, options);
|
|
35071
36293
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35072
36294
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDImportPost']?.[localVarOperationServerIndex]?.url;
|
|
@@ -35137,7 +36359,7 @@ export const QuerySuggestionsManagementApiFp = function(configuration?: Configur
|
|
|
35137
36359
|
* @param {*} [options] Override http request option.
|
|
35138
36360
|
* @throws {RequiredError}
|
|
35139
36361
|
*/
|
|
35140
|
-
async adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
36362
|
+
async adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response>> {
|
|
35141
36363
|
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID, analyticsPromoteSuggestionsRequest, options);
|
|
35142
36364
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35143
36365
|
const localVarOperationServerBasePath = operationServerMap['QuerySuggestionsManagementApi.adminV1QuerySuggestionsXStoreIDPromotePost']?.[localVarOperationServerIndex]?.url;
|
|
@@ -35306,6 +36528,61 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35306
36528
|
adminV1QuerySuggestionsMigrateAllPost(daysBack?: number, minPopularity?: number, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
35307
36529
|
return localVarFp.adminV1QuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(axios, basePath));
|
|
35308
36530
|
},
|
|
36531
|
+
/**
|
|
36532
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
36533
|
+
* @summary Apply Suggestion Filters
|
|
36534
|
+
* @param {string} xStoreID Store ID
|
|
36535
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
36536
|
+
* @param {*} [options] Override http request option.
|
|
36537
|
+
* @throws {RequiredError}
|
|
36538
|
+
*/
|
|
36539
|
+
adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
36540
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options).then((request) => request(axios, basePath));
|
|
36541
|
+
},
|
|
36542
|
+
/**
|
|
36543
|
+
* Delete a banned expression
|
|
36544
|
+
* @summary Delete Banned Expression
|
|
36545
|
+
* @param {string} xStoreID Store ID
|
|
36546
|
+
* @param {string} expressionID Banned Expression ID
|
|
36547
|
+
* @param {*} [options] Override http request option.
|
|
36548
|
+
* @throws {RequiredError}
|
|
36549
|
+
*/
|
|
36550
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsAnalyticsAPIResponse> {
|
|
36551
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options).then((request) => request(axios, basePath));
|
|
36552
|
+
},
|
|
36553
|
+
/**
|
|
36554
|
+
* Update an existing banned expression
|
|
36555
|
+
* @summary Update Banned Expression
|
|
36556
|
+
* @param {string} xStoreID Store ID
|
|
36557
|
+
* @param {string} expressionID Banned Expression ID
|
|
36558
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
36559
|
+
* @param {*} [options] Override http request option.
|
|
36560
|
+
* @throws {RequiredError}
|
|
36561
|
+
*/
|
|
36562
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response> {
|
|
36563
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options).then((request) => request(axios, basePath));
|
|
36564
|
+
},
|
|
36565
|
+
/**
|
|
36566
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
36567
|
+
* @summary Get Banned Expressions
|
|
36568
|
+
* @param {string} xStoreID Store ID
|
|
36569
|
+
* @param {*} [options] Override http request option.
|
|
36570
|
+
* @throws {RequiredError}
|
|
36571
|
+
*/
|
|
36572
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsGet200Response> {
|
|
36573
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
36574
|
+
},
|
|
36575
|
+
/**
|
|
36576
|
+
* Create a new banned expression with specified matching type
|
|
36577
|
+
* @summary Create Banned Expression
|
|
36578
|
+
* @param {string} xStoreID Store ID
|
|
36579
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
36580
|
+
* @param {*} [options] Override http request option.
|
|
36581
|
+
* @throws {RequiredError}
|
|
36582
|
+
*/
|
|
36583
|
+
adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDBannedExpressionsPost201Response> {
|
|
36584
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options).then((request) => request(axios, basePath));
|
|
36585
|
+
},
|
|
35309
36586
|
/**
|
|
35310
36587
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
35311
36588
|
* @summary Bulk Update Suggestions
|
|
@@ -35351,6 +36628,26 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35351
36628
|
adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID: string, analyticsUpdateSuggestionConfigRequest: AnalyticsUpdateSuggestionConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDConfigGet200Response> {
|
|
35352
36629
|
return localVarFp.adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID, analyticsUpdateSuggestionConfigRequest, options).then((request) => request(axios, basePath));
|
|
35353
36630
|
},
|
|
36631
|
+
/**
|
|
36632
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
36633
|
+
* @summary Generate Enhanced Category Suggestions
|
|
36634
|
+
* @param {string} xStoreID Store ID
|
|
36635
|
+
* @param {*} [options] Override http request option.
|
|
36636
|
+
* @throws {RequiredError}
|
|
36637
|
+
*/
|
|
36638
|
+
adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateCategoriesPost200Response> {
|
|
36639
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
36640
|
+
},
|
|
36641
|
+
/**
|
|
36642
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
36643
|
+
* @summary Generate Facet-Based Suggestions
|
|
36644
|
+
* @param {string} xStoreID Store ID
|
|
36645
|
+
* @param {*} [options] Override http request option.
|
|
36646
|
+
* @throws {RequiredError}
|
|
36647
|
+
*/
|
|
36648
|
+
adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDGenerateFacetsPost200Response> {
|
|
36649
|
+
return localVarFp.adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options).then((request) => request(axios, basePath));
|
|
36650
|
+
},
|
|
35354
36651
|
/**
|
|
35355
36652
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35356
36653
|
* @summary Get Query Suggestions
|
|
@@ -35376,7 +36673,7 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35376
36673
|
* @param {*} [options] Override http request option.
|
|
35377
36674
|
* @throws {RequiredError}
|
|
35378
36675
|
*/
|
|
35379
|
-
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
36676
|
+
adminV1QuerySuggestionsXStoreIDImportPost(xStoreID: string, analyticsImportQuerySuggestionsRequest: AnalyticsImportQuerySuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
35380
36677
|
return localVarFp.adminV1QuerySuggestionsXStoreIDImportPost(xStoreID, analyticsImportQuerySuggestionsRequest, options).then((request) => request(axios, basePath));
|
|
35381
36678
|
},
|
|
35382
36679
|
/**
|
|
@@ -35432,7 +36729,7 @@ export const QuerySuggestionsManagementApiFactory = function (configuration?: Co
|
|
|
35432
36729
|
* @param {*} [options] Override http request option.
|
|
35433
36730
|
* @throws {RequiredError}
|
|
35434
36731
|
*/
|
|
35435
|
-
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
36732
|
+
adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID: string, analyticsPromoteSuggestionsRequest: AnalyticsPromoteSuggestionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1QuerySuggestionsXStoreIDApplyFiltersPost200Response> {
|
|
35436
36733
|
return localVarFp.adminV1QuerySuggestionsXStoreIDPromotePost(xStoreID, analyticsPromoteSuggestionsRequest, options).then((request) => request(axios, basePath));
|
|
35437
36734
|
},
|
|
35438
36735
|
/**
|
|
@@ -35570,6 +36867,71 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
35570
36867
|
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsMigrateAllPost(daysBack, minPopularity, options).then((request) => request(this.axios, this.basePath));
|
|
35571
36868
|
}
|
|
35572
36869
|
|
|
36870
|
+
/**
|
|
36871
|
+
* Apply filters to remove duplicate or unhelpful suggestions based on configuration
|
|
36872
|
+
* @summary Apply Suggestion Filters
|
|
36873
|
+
* @param {string} xStoreID Store ID
|
|
36874
|
+
* @param {Array<AnalyticsQuerySuggestionRecord>} analyticsQuerySuggestionRecord Array of suggestions to filter
|
|
36875
|
+
* @param {*} [options] Override http request option.
|
|
36876
|
+
* @throws {RequiredError}
|
|
36877
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36878
|
+
*/
|
|
36879
|
+
public adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID: string, analyticsQuerySuggestionRecord: Array<AnalyticsQuerySuggestionRecord>, options?: RawAxiosRequestConfig) {
|
|
36880
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDApplyFiltersPost(xStoreID, analyticsQuerySuggestionRecord, options).then((request) => request(this.axios, this.basePath));
|
|
36881
|
+
}
|
|
36882
|
+
|
|
36883
|
+
/**
|
|
36884
|
+
* Delete a banned expression
|
|
36885
|
+
* @summary Delete Banned Expression
|
|
36886
|
+
* @param {string} xStoreID Store ID
|
|
36887
|
+
* @param {string} expressionID Banned Expression ID
|
|
36888
|
+
* @param {*} [options] Override http request option.
|
|
36889
|
+
* @throws {RequiredError}
|
|
36890
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36891
|
+
*/
|
|
36892
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID: string, expressionID: string, options?: RawAxiosRequestConfig) {
|
|
36893
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete(xStoreID, expressionID, options).then((request) => request(this.axios, this.basePath));
|
|
36894
|
+
}
|
|
36895
|
+
|
|
36896
|
+
/**
|
|
36897
|
+
* Update an existing banned expression
|
|
36898
|
+
* @summary Update Banned Expression
|
|
36899
|
+
* @param {string} xStoreID Store ID
|
|
36900
|
+
* @param {string} expressionID Banned Expression ID
|
|
36901
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Updated banned expression
|
|
36902
|
+
* @param {*} [options] Override http request option.
|
|
36903
|
+
* @throws {RequiredError}
|
|
36904
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36905
|
+
*/
|
|
36906
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID: string, expressionID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) {
|
|
36907
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDPut(xStoreID, expressionID, analyticsBannedExpression, options).then((request) => request(this.axios, this.basePath));
|
|
36908
|
+
}
|
|
36909
|
+
|
|
36910
|
+
/**
|
|
36911
|
+
* Retrieve all banned expressions for a store with their matching types
|
|
36912
|
+
* @summary Get Banned Expressions
|
|
36913
|
+
* @param {string} xStoreID Store ID
|
|
36914
|
+
* @param {*} [options] Override http request option.
|
|
36915
|
+
* @throws {RequiredError}
|
|
36916
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36917
|
+
*/
|
|
36918
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
36919
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
36920
|
+
}
|
|
36921
|
+
|
|
36922
|
+
/**
|
|
36923
|
+
* Create a new banned expression with specified matching type
|
|
36924
|
+
* @summary Create Banned Expression
|
|
36925
|
+
* @param {string} xStoreID Store ID
|
|
36926
|
+
* @param {AnalyticsBannedExpression} analyticsBannedExpression Banned expression to create
|
|
36927
|
+
* @param {*} [options] Override http request option.
|
|
36928
|
+
* @throws {RequiredError}
|
|
36929
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36930
|
+
*/
|
|
36931
|
+
public adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID: string, analyticsBannedExpression: AnalyticsBannedExpression, options?: RawAxiosRequestConfig) {
|
|
36932
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDBannedExpressionsPost(xStoreID, analyticsBannedExpression, options).then((request) => request(this.axios, this.basePath));
|
|
36933
|
+
}
|
|
36934
|
+
|
|
35573
36935
|
/**
|
|
35574
36936
|
* Perform bulk operations on multiple suggestions (enable, disable, delete, update priority)
|
|
35575
36937
|
* @summary Bulk Update Suggestions
|
|
@@ -35623,6 +36985,30 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
35623
36985
|
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDConfigPut(xStoreID, analyticsUpdateSuggestionConfigRequest, options).then((request) => request(this.axios, this.basePath));
|
|
35624
36986
|
}
|
|
35625
36987
|
|
|
36988
|
+
/**
|
|
36989
|
+
* Generate query suggestions with category counts and enhanced data structure
|
|
36990
|
+
* @summary Generate Enhanced Category Suggestions
|
|
36991
|
+
* @param {string} xStoreID Store ID
|
|
36992
|
+
* @param {*} [options] Override http request option.
|
|
36993
|
+
* @throws {RequiredError}
|
|
36994
|
+
* @memberof QuerySuggestionsManagementApi
|
|
36995
|
+
*/
|
|
36996
|
+
public adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
36997
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDGenerateCategoriesPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
36998
|
+
}
|
|
36999
|
+
|
|
37000
|
+
/**
|
|
37001
|
+
* Generate query suggestions based on facet combinations from search analytics data
|
|
37002
|
+
* @summary Generate Facet-Based Suggestions
|
|
37003
|
+
* @param {string} xStoreID Store ID
|
|
37004
|
+
* @param {*} [options] Override http request option.
|
|
37005
|
+
* @throws {RequiredError}
|
|
37006
|
+
* @memberof QuerySuggestionsManagementApi
|
|
37007
|
+
*/
|
|
37008
|
+
public adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID: string, options?: RawAxiosRequestConfig) {
|
|
37009
|
+
return QuerySuggestionsManagementApiFp(this.configuration).adminV1QuerySuggestionsXStoreIDGenerateFacetsPost(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
37010
|
+
}
|
|
37011
|
+
|
|
35626
37012
|
/**
|
|
35627
37013
|
* Retrieve query suggestions with filtering and pagination for management
|
|
35628
37014
|
* @summary Get Query Suggestions
|