@seekora-ai/admin-api 1.1.57 → 1.1.59
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 +26 -18
- package/api.ts +1054 -467
- package/dist/api.d.ts +583 -226
- package/dist/api.js +581 -159
- package/dist/esm/api.d.ts +583 -226
- package/dist/esm/api.js +574 -152
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.59.tgz +0 -0
- package/seekora-ai-admin-api-1.1.57.tgz +0 -0
package/api.ts
CHANGED
|
@@ -23,6 +23,178 @@ import type { RequestArgs } from './base';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
|
|
25
25
|
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface AdminAnalyticsOrgGeoGet200Response
|
|
30
|
+
*/
|
|
31
|
+
export interface AdminAnalyticsOrgGeoGet200Response {
|
|
32
|
+
/**
|
|
33
|
+
* Comparison metadata when in compare mode
|
|
34
|
+
* @type {AnalyticsComparisonMeta}
|
|
35
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
36
|
+
*/
|
|
37
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {Array<AnalyticsGeoAnalytic>}
|
|
41
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
42
|
+
*/
|
|
43
|
+
'data'?: Array<AnalyticsGeoAnalytic>;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
48
|
+
*/
|
|
49
|
+
'error'?: string;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
54
|
+
*/
|
|
55
|
+
'status'?: string;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
60
|
+
*/
|
|
61
|
+
'timestamp'?: string;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof AdminAnalyticsOrgGeoGet200Response
|
|
66
|
+
*/
|
|
67
|
+
'total'?: number;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @export
|
|
72
|
+
* @interface AdminAnalyticsOrgKpiGet200Response
|
|
73
|
+
*/
|
|
74
|
+
export interface AdminAnalyticsOrgKpiGet200Response {
|
|
75
|
+
/**
|
|
76
|
+
* Comparison metadata when in compare mode
|
|
77
|
+
* @type {AnalyticsComparisonMeta}
|
|
78
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
79
|
+
*/
|
|
80
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @type {AnalyticsExtendedKPIResponse}
|
|
84
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
85
|
+
*/
|
|
86
|
+
'data'?: AnalyticsExtendedKPIResponse;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {string}
|
|
90
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
91
|
+
*/
|
|
92
|
+
'error'?: string;
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @type {string}
|
|
96
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
97
|
+
*/
|
|
98
|
+
'status'?: string;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @type {string}
|
|
102
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
103
|
+
*/
|
|
104
|
+
'timestamp'?: string;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {number}
|
|
108
|
+
* @memberof AdminAnalyticsOrgKpiGet200Response
|
|
109
|
+
*/
|
|
110
|
+
'total'?: number;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @export
|
|
115
|
+
* @interface AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
116
|
+
*/
|
|
117
|
+
export interface AdminAnalyticsOrgKpiRealtimeGet200Response {
|
|
118
|
+
/**
|
|
119
|
+
* Comparison metadata when in compare mode
|
|
120
|
+
* @type {AnalyticsComparisonMeta}
|
|
121
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
122
|
+
*/
|
|
123
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @type {AnalyticsKPIMetrics}
|
|
127
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
128
|
+
*/
|
|
129
|
+
'data'?: AnalyticsKPIMetrics;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
134
|
+
*/
|
|
135
|
+
'error'?: string;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
140
|
+
*/
|
|
141
|
+
'status'?: string;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @type {string}
|
|
145
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
146
|
+
*/
|
|
147
|
+
'timestamp'?: string;
|
|
148
|
+
/**
|
|
149
|
+
*
|
|
150
|
+
* @type {number}
|
|
151
|
+
* @memberof AdminAnalyticsOrgKpiRealtimeGet200Response
|
|
152
|
+
*/
|
|
153
|
+
'total'?: number;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @export
|
|
158
|
+
* @interface AdminAnalyticsOrgQueriesGet200Response
|
|
159
|
+
*/
|
|
160
|
+
export interface AdminAnalyticsOrgQueriesGet200Response {
|
|
161
|
+
/**
|
|
162
|
+
* Comparison metadata when in compare mode
|
|
163
|
+
* @type {AnalyticsComparisonMeta}
|
|
164
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
165
|
+
*/
|
|
166
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {Array<AnalyticsQueryAnalytic>}
|
|
170
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
171
|
+
*/
|
|
172
|
+
'data'?: Array<AnalyticsQueryAnalytic>;
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
177
|
+
*/
|
|
178
|
+
'error'?: string;
|
|
179
|
+
/**
|
|
180
|
+
*
|
|
181
|
+
* @type {string}
|
|
182
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
183
|
+
*/
|
|
184
|
+
'status'?: string;
|
|
185
|
+
/**
|
|
186
|
+
*
|
|
187
|
+
* @type {string}
|
|
188
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
189
|
+
*/
|
|
190
|
+
'timestamp'?: string;
|
|
191
|
+
/**
|
|
192
|
+
*
|
|
193
|
+
* @type {number}
|
|
194
|
+
* @memberof AdminAnalyticsOrgQueriesGet200Response
|
|
195
|
+
*/
|
|
196
|
+
'total'?: number;
|
|
197
|
+
}
|
|
26
198
|
/**
|
|
27
199
|
*
|
|
28
200
|
* @export
|
|
@@ -539,49 +711,6 @@ export interface AdminAnalyticsStoreXStoreIDItemsTrendsGet200Response {
|
|
|
539
711
|
*/
|
|
540
712
|
'total'?: number;
|
|
541
713
|
}
|
|
542
|
-
/**
|
|
543
|
-
*
|
|
544
|
-
* @export
|
|
545
|
-
* @interface AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
546
|
-
*/
|
|
547
|
-
export interface AdminAnalyticsStoreXStoreIDKpiGet200Response {
|
|
548
|
-
/**
|
|
549
|
-
* Comparison metadata when in compare mode
|
|
550
|
-
* @type {AnalyticsComparisonMeta}
|
|
551
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
552
|
-
*/
|
|
553
|
-
'comparison'?: AnalyticsComparisonMeta;
|
|
554
|
-
/**
|
|
555
|
-
*
|
|
556
|
-
* @type {AnalyticsExtendedKPIResponse}
|
|
557
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
558
|
-
*/
|
|
559
|
-
'data'?: AnalyticsExtendedKPIResponse;
|
|
560
|
-
/**
|
|
561
|
-
*
|
|
562
|
-
* @type {string}
|
|
563
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
564
|
-
*/
|
|
565
|
-
'error'?: string;
|
|
566
|
-
/**
|
|
567
|
-
*
|
|
568
|
-
* @type {string}
|
|
569
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
570
|
-
*/
|
|
571
|
-
'status'?: string;
|
|
572
|
-
/**
|
|
573
|
-
*
|
|
574
|
-
* @type {string}
|
|
575
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
576
|
-
*/
|
|
577
|
-
'timestamp'?: string;
|
|
578
|
-
/**
|
|
579
|
-
*
|
|
580
|
-
* @type {number}
|
|
581
|
-
* @memberof AdminAnalyticsStoreXStoreIDKpiGet200Response
|
|
582
|
-
*/
|
|
583
|
-
'total'?: number;
|
|
584
|
-
}
|
|
585
714
|
/**
|
|
586
715
|
*
|
|
587
716
|
* @export
|
|
@@ -757,40 +886,140 @@ export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
|
757
886
|
/**
|
|
758
887
|
*
|
|
759
888
|
* @export
|
|
760
|
-
* @interface
|
|
889
|
+
* @interface AdminPaymentGatewayVerifyInvoicePostRequest
|
|
761
890
|
*/
|
|
762
|
-
export interface
|
|
891
|
+
export interface AdminPaymentGatewayVerifyInvoicePostRequest {
|
|
763
892
|
/**
|
|
764
893
|
*
|
|
765
|
-
* @type {
|
|
766
|
-
* @memberof
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof AdminPaymentGatewayVerifyInvoicePostRequest
|
|
767
896
|
*/
|
|
768
|
-
'
|
|
897
|
+
'gateway_order_id'?: string;
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
*
|
|
901
|
+
* @export
|
|
902
|
+
* @interface AdminV1FeatureLimitsCheckGet200Response
|
|
903
|
+
*/
|
|
904
|
+
export interface AdminV1FeatureLimitsCheckGet200Response {
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @type {DataTypesFeatureCheckResult}
|
|
908
|
+
* @memberof AdminV1FeatureLimitsCheckGet200Response
|
|
909
|
+
*/
|
|
910
|
+
'data'?: DataTypesFeatureCheckResult;
|
|
769
911
|
/**
|
|
770
912
|
*
|
|
771
913
|
* @type {string}
|
|
772
|
-
* @memberof
|
|
914
|
+
* @memberof AdminV1FeatureLimitsCheckGet200Response
|
|
773
915
|
*/
|
|
774
916
|
'message'?: string;
|
|
775
917
|
/**
|
|
776
918
|
*
|
|
777
919
|
* @type {number}
|
|
778
|
-
* @memberof
|
|
920
|
+
* @memberof AdminV1FeatureLimitsCheckGet200Response
|
|
779
921
|
*/
|
|
780
922
|
'status'?: number;
|
|
781
923
|
}
|
|
782
924
|
/**
|
|
783
925
|
*
|
|
784
926
|
* @export
|
|
785
|
-
* @interface
|
|
927
|
+
* @interface AdminV1FeatureLimitsHistoryGet200Response
|
|
786
928
|
*/
|
|
787
|
-
export interface
|
|
929
|
+
export interface AdminV1FeatureLimitsHistoryGet200Response {
|
|
930
|
+
/**
|
|
931
|
+
*
|
|
932
|
+
* @type {Array<DataTypesFeatureUsageHistory>}
|
|
933
|
+
* @memberof AdminV1FeatureLimitsHistoryGet200Response
|
|
934
|
+
*/
|
|
935
|
+
'data'?: Array<DataTypesFeatureUsageHistory>;
|
|
788
936
|
/**
|
|
789
937
|
*
|
|
790
938
|
* @type {string}
|
|
791
|
-
* @memberof
|
|
939
|
+
* @memberof AdminV1FeatureLimitsHistoryGet200Response
|
|
792
940
|
*/
|
|
793
|
-
'
|
|
941
|
+
'message'?: string;
|
|
942
|
+
/**
|
|
943
|
+
*
|
|
944
|
+
* @type {number}
|
|
945
|
+
* @memberof AdminV1FeatureLimitsHistoryGet200Response
|
|
946
|
+
*/
|
|
947
|
+
'status'?: number;
|
|
948
|
+
}
|
|
949
|
+
/**
|
|
950
|
+
*
|
|
951
|
+
* @export
|
|
952
|
+
* @interface AdminV1FeatureLimitsPlanGet200Response
|
|
953
|
+
*/
|
|
954
|
+
export interface AdminV1FeatureLimitsPlanGet200Response {
|
|
955
|
+
/**
|
|
956
|
+
*
|
|
957
|
+
* @type {DataTypesPlanFeatures}
|
|
958
|
+
* @memberof AdminV1FeatureLimitsPlanGet200Response
|
|
959
|
+
*/
|
|
960
|
+
'data'?: DataTypesPlanFeatures;
|
|
961
|
+
/**
|
|
962
|
+
*
|
|
963
|
+
* @type {string}
|
|
964
|
+
* @memberof AdminV1FeatureLimitsPlanGet200Response
|
|
965
|
+
*/
|
|
966
|
+
'message'?: string;
|
|
967
|
+
/**
|
|
968
|
+
*
|
|
969
|
+
* @type {number}
|
|
970
|
+
* @memberof AdminV1FeatureLimitsPlanGet200Response
|
|
971
|
+
*/
|
|
972
|
+
'status'?: number;
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
*
|
|
976
|
+
* @export
|
|
977
|
+
* @interface AdminV1FeatureLimitsUsageGet200Response
|
|
978
|
+
*/
|
|
979
|
+
export interface AdminV1FeatureLimitsUsageGet200Response {
|
|
980
|
+
/**
|
|
981
|
+
*
|
|
982
|
+
* @type {Array<DataTypesFeatureUsageStats>}
|
|
983
|
+
* @memberof AdminV1FeatureLimitsUsageGet200Response
|
|
984
|
+
*/
|
|
985
|
+
'data'?: Array<DataTypesFeatureUsageStats>;
|
|
986
|
+
/**
|
|
987
|
+
*
|
|
988
|
+
* @type {string}
|
|
989
|
+
* @memberof AdminV1FeatureLimitsUsageGet200Response
|
|
990
|
+
*/
|
|
991
|
+
'message'?: string;
|
|
992
|
+
/**
|
|
993
|
+
*
|
|
994
|
+
* @type {number}
|
|
995
|
+
* @memberof AdminV1FeatureLimitsUsageGet200Response
|
|
996
|
+
*/
|
|
997
|
+
'status'?: number;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
* @export
|
|
1002
|
+
* @interface AdminV1FeatureLimitsViolationsGet200Response
|
|
1003
|
+
*/
|
|
1004
|
+
export interface AdminV1FeatureLimitsViolationsGet200Response {
|
|
1005
|
+
/**
|
|
1006
|
+
*
|
|
1007
|
+
* @type {Array<DataTypesFeatureLimitViolation>}
|
|
1008
|
+
* @memberof AdminV1FeatureLimitsViolationsGet200Response
|
|
1009
|
+
*/
|
|
1010
|
+
'data'?: Array<DataTypesFeatureLimitViolation>;
|
|
1011
|
+
/**
|
|
1012
|
+
*
|
|
1013
|
+
* @type {string}
|
|
1014
|
+
* @memberof AdminV1FeatureLimitsViolationsGet200Response
|
|
1015
|
+
*/
|
|
1016
|
+
'message'?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
*
|
|
1019
|
+
* @type {number}
|
|
1020
|
+
* @memberof AdminV1FeatureLimitsViolationsGet200Response
|
|
1021
|
+
*/
|
|
1022
|
+
'status'?: number;
|
|
794
1023
|
}
|
|
795
1024
|
/**
|
|
796
1025
|
*
|
|
@@ -24392,106 +24621,6 @@ export interface FeatureLimitServiceLimitStatus {
|
|
|
24392
24621
|
*/
|
|
24393
24622
|
'plan_name'?: string;
|
|
24394
24623
|
}
|
|
24395
|
-
/**
|
|
24396
|
-
*
|
|
24397
|
-
* @export
|
|
24398
|
-
* @interface FeatureLimitsCheckGet200Response
|
|
24399
|
-
*/
|
|
24400
|
-
export interface FeatureLimitsCheckGet200Response {
|
|
24401
|
-
/**
|
|
24402
|
-
*
|
|
24403
|
-
* @type {DataTypesFeatureCheckResult}
|
|
24404
|
-
* @memberof FeatureLimitsCheckGet200Response
|
|
24405
|
-
*/
|
|
24406
|
-
'data'?: DataTypesFeatureCheckResult;
|
|
24407
|
-
/**
|
|
24408
|
-
*
|
|
24409
|
-
* @type {string}
|
|
24410
|
-
* @memberof FeatureLimitsCheckGet200Response
|
|
24411
|
-
*/
|
|
24412
|
-
'message'?: string;
|
|
24413
|
-
/**
|
|
24414
|
-
*
|
|
24415
|
-
* @type {number}
|
|
24416
|
-
* @memberof FeatureLimitsCheckGet200Response
|
|
24417
|
-
*/
|
|
24418
|
-
'status'?: number;
|
|
24419
|
-
}
|
|
24420
|
-
/**
|
|
24421
|
-
*
|
|
24422
|
-
* @export
|
|
24423
|
-
* @interface FeatureLimitsHistoryGet200Response
|
|
24424
|
-
*/
|
|
24425
|
-
export interface FeatureLimitsHistoryGet200Response {
|
|
24426
|
-
/**
|
|
24427
|
-
*
|
|
24428
|
-
* @type {Array<DataTypesFeatureUsageHistory>}
|
|
24429
|
-
* @memberof FeatureLimitsHistoryGet200Response
|
|
24430
|
-
*/
|
|
24431
|
-
'data'?: Array<DataTypesFeatureUsageHistory>;
|
|
24432
|
-
/**
|
|
24433
|
-
*
|
|
24434
|
-
* @type {string}
|
|
24435
|
-
* @memberof FeatureLimitsHistoryGet200Response
|
|
24436
|
-
*/
|
|
24437
|
-
'message'?: string;
|
|
24438
|
-
/**
|
|
24439
|
-
*
|
|
24440
|
-
* @type {number}
|
|
24441
|
-
* @memberof FeatureLimitsHistoryGet200Response
|
|
24442
|
-
*/
|
|
24443
|
-
'status'?: number;
|
|
24444
|
-
}
|
|
24445
|
-
/**
|
|
24446
|
-
*
|
|
24447
|
-
* @export
|
|
24448
|
-
* @interface FeatureLimitsPlanGet200Response
|
|
24449
|
-
*/
|
|
24450
|
-
export interface FeatureLimitsPlanGet200Response {
|
|
24451
|
-
/**
|
|
24452
|
-
*
|
|
24453
|
-
* @type {DataTypesPlanFeatures}
|
|
24454
|
-
* @memberof FeatureLimitsPlanGet200Response
|
|
24455
|
-
*/
|
|
24456
|
-
'data'?: DataTypesPlanFeatures;
|
|
24457
|
-
/**
|
|
24458
|
-
*
|
|
24459
|
-
* @type {string}
|
|
24460
|
-
* @memberof FeatureLimitsPlanGet200Response
|
|
24461
|
-
*/
|
|
24462
|
-
'message'?: string;
|
|
24463
|
-
/**
|
|
24464
|
-
*
|
|
24465
|
-
* @type {number}
|
|
24466
|
-
* @memberof FeatureLimitsPlanGet200Response
|
|
24467
|
-
*/
|
|
24468
|
-
'status'?: number;
|
|
24469
|
-
}
|
|
24470
|
-
/**
|
|
24471
|
-
*
|
|
24472
|
-
* @export
|
|
24473
|
-
* @interface FeatureLimitsUsageGet200Response
|
|
24474
|
-
*/
|
|
24475
|
-
export interface FeatureLimitsUsageGet200Response {
|
|
24476
|
-
/**
|
|
24477
|
-
*
|
|
24478
|
-
* @type {Array<DataTypesFeatureUsageStats>}
|
|
24479
|
-
* @memberof FeatureLimitsUsageGet200Response
|
|
24480
|
-
*/
|
|
24481
|
-
'data'?: Array<DataTypesFeatureUsageStats>;
|
|
24482
|
-
/**
|
|
24483
|
-
*
|
|
24484
|
-
* @type {string}
|
|
24485
|
-
* @memberof FeatureLimitsUsageGet200Response
|
|
24486
|
-
*/
|
|
24487
|
-
'message'?: string;
|
|
24488
|
-
/**
|
|
24489
|
-
*
|
|
24490
|
-
* @type {number}
|
|
24491
|
-
* @memberof FeatureLimitsUsageGet200Response
|
|
24492
|
-
*/
|
|
24493
|
-
'status'?: number;
|
|
24494
|
-
}
|
|
24495
24624
|
/**
|
|
24496
24625
|
*
|
|
24497
24626
|
* @export
|
|
@@ -29672,17 +29801,16 @@ export class AdminNotificationsApi extends BaseAPI {
|
|
|
29672
29801
|
export const AnalyticsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
29673
29802
|
return {
|
|
29674
29803
|
/**
|
|
29675
|
-
* Retrieve analytics
|
|
29676
|
-
* @summary Get Analytics
|
|
29677
|
-
* @param {string}
|
|
29804
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
29805
|
+
* @summary Get Organization Geographic Analytics
|
|
29806
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
29807
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
29808
|
+
* @param {number} [limit] Maximum number of results
|
|
29678
29809
|
* @param {*} [options] Override http request option.
|
|
29679
29810
|
* @throws {RequiredError}
|
|
29680
29811
|
*/
|
|
29681
|
-
|
|
29682
|
-
|
|
29683
|
-
assertParamExists('adminAnalyticsStoreXStoreIDConfigGet', 'xStoreID', xStoreID)
|
|
29684
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/config`
|
|
29685
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
29812
|
+
adminAnalyticsOrgGeoGet: async (startTime?: string, endTime?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29813
|
+
const localVarPath = `/admin/analytics/org/geo`;
|
|
29686
29814
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29687
29815
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29688
29816
|
let baseOptions;
|
|
@@ -29697,54 +29825,23 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29697
29825
|
// authentication BearerAuth required
|
|
29698
29826
|
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
29699
29827
|
|
|
29700
|
-
|
|
29701
|
-
|
|
29702
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
29703
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
29704
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
29705
|
-
|
|
29706
|
-
return {
|
|
29707
|
-
url: toPathString(localVarUrlObj),
|
|
29708
|
-
options: localVarRequestOptions,
|
|
29709
|
-
};
|
|
29710
|
-
},
|
|
29711
|
-
/**
|
|
29712
|
-
* Execute a custom ClickHouse query for advanced analytics with parameterized queries
|
|
29713
|
-
* @summary Execute Custom Analytics Query
|
|
29714
|
-
* @param {string} xStoreID Store ID
|
|
29715
|
-
* @param {AnalyticsCustomQueryRequest} analyticsCustomQueryRequest Custom query request
|
|
29716
|
-
* @param {*} [options] Override http request option.
|
|
29717
|
-
* @throws {RequiredError}
|
|
29718
|
-
*/
|
|
29719
|
-
adminAnalyticsStoreXStoreIDCustomPost: async (xStoreID: string, analyticsCustomQueryRequest: AnalyticsCustomQueryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29720
|
-
// verify required parameter 'xStoreID' is not null or undefined
|
|
29721
|
-
assertParamExists('adminAnalyticsStoreXStoreIDCustomPost', 'xStoreID', xStoreID)
|
|
29722
|
-
// verify required parameter 'analyticsCustomQueryRequest' is not null or undefined
|
|
29723
|
-
assertParamExists('adminAnalyticsStoreXStoreIDCustomPost', 'analyticsCustomQueryRequest', analyticsCustomQueryRequest)
|
|
29724
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/custom`
|
|
29725
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
29726
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29727
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29728
|
-
let baseOptions;
|
|
29729
|
-
if (configuration) {
|
|
29730
|
-
baseOptions = configuration.baseOptions;
|
|
29828
|
+
if (startTime !== undefined) {
|
|
29829
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
29731
29830
|
}
|
|
29732
29831
|
|
|
29733
|
-
|
|
29734
|
-
|
|
29735
|
-
|
|
29832
|
+
if (endTime !== undefined) {
|
|
29833
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
29834
|
+
}
|
|
29736
29835
|
|
|
29737
|
-
|
|
29738
|
-
|
|
29836
|
+
if (limit !== undefined) {
|
|
29837
|
+
localVarQueryParameter['limit'] = limit;
|
|
29838
|
+
}
|
|
29739
29839
|
|
|
29740
29840
|
|
|
29741
29841
|
|
|
29742
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
29743
|
-
|
|
29744
29842
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
29745
29843
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
29746
29844
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
29747
|
-
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomQueryRequest, localVarRequestOptions, configuration)
|
|
29748
29845
|
|
|
29749
29846
|
return {
|
|
29750
29847
|
url: toPathString(localVarUrlObj),
|
|
@@ -29752,27 +29849,19 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29752
29849
|
};
|
|
29753
29850
|
},
|
|
29754
29851
|
/**
|
|
29755
|
-
* Retrieve
|
|
29756
|
-
* @summary Get
|
|
29757
|
-
* @param {string} xStoreID Store ID
|
|
29852
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
29853
|
+
* @summary Get Organization KPI Analytics
|
|
29758
29854
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
29759
29855
|
* @param {string} [endTime] End time in RFC3339 format
|
|
29760
|
-
* @param {
|
|
29761
|
-
* @param {
|
|
29762
|
-
* @param {
|
|
29763
|
-
* @param {
|
|
29764
|
-
* @param {number} [pageSize] Number of results per page
|
|
29765
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum} [sortBy] Field to sort by
|
|
29766
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum} [sortOrder] Sort direction
|
|
29767
|
-
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
29856
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
29857
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
29858
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
29859
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
29768
29860
|
* @param {*} [options] Override http request option.
|
|
29769
29861
|
* @throws {RequiredError}
|
|
29770
29862
|
*/
|
|
29771
|
-
|
|
29772
|
-
|
|
29773
|
-
assertParamExists('adminAnalyticsStoreXStoreIDFiltersCombinationsGet', 'xStoreID', xStoreID)
|
|
29774
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/filters/combinations`
|
|
29775
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
29863
|
+
adminAnalyticsOrgKpiGet: async (startTime?: string, endTime?: string, granularity?: AdminAnalyticsOrgKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsOrgKpiGetTagsMatchModeEnum, compareMode?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29864
|
+
const localVarPath = `/admin/analytics/org/kpi`;
|
|
29776
29865
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29777
29866
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29778
29867
|
let baseOptions;
|
|
@@ -29795,36 +29884,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29795
29884
|
localVarQueryParameter['end_time'] = endTime;
|
|
29796
29885
|
}
|
|
29797
29886
|
|
|
29798
|
-
if (
|
|
29799
|
-
localVarQueryParameter['
|
|
29800
|
-
}
|
|
29801
|
-
|
|
29802
|
-
if (limit !== undefined) {
|
|
29803
|
-
localVarQueryParameter['limit'] = limit;
|
|
29804
|
-
}
|
|
29805
|
-
|
|
29806
|
-
if (offset !== undefined) {
|
|
29807
|
-
localVarQueryParameter['offset'] = offset;
|
|
29808
|
-
}
|
|
29809
|
-
|
|
29810
|
-
if (page !== undefined) {
|
|
29811
|
-
localVarQueryParameter['page'] = page;
|
|
29812
|
-
}
|
|
29813
|
-
|
|
29814
|
-
if (pageSize !== undefined) {
|
|
29815
|
-
localVarQueryParameter['page_size'] = pageSize;
|
|
29887
|
+
if (granularity !== undefined) {
|
|
29888
|
+
localVarQueryParameter['granularity'] = granularity;
|
|
29816
29889
|
}
|
|
29817
29890
|
|
|
29818
|
-
if (
|
|
29819
|
-
localVarQueryParameter['
|
|
29891
|
+
if (analyticsTags !== undefined) {
|
|
29892
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
29820
29893
|
}
|
|
29821
29894
|
|
|
29822
|
-
if (
|
|
29823
|
-
localVarQueryParameter['
|
|
29895
|
+
if (tagsMatchMode !== undefined) {
|
|
29896
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
29824
29897
|
}
|
|
29825
29898
|
|
|
29826
|
-
if (
|
|
29827
|
-
localVarQueryParameter['
|
|
29899
|
+
if (compareMode !== undefined) {
|
|
29900
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
29828
29901
|
}
|
|
29829
29902
|
|
|
29830
29903
|
|
|
@@ -29839,26 +29912,13 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29839
29912
|
};
|
|
29840
29913
|
},
|
|
29841
29914
|
/**
|
|
29842
|
-
*
|
|
29843
|
-
* @summary Get
|
|
29844
|
-
* @param {string} xStoreID Store ID
|
|
29845
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
29846
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
29847
|
-
* @param {number} [limit] Maximum number of results to return (legacy - use page_size instead)
|
|
29848
|
-
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
29849
|
-
* @param {number} [page] Page number for pagination
|
|
29850
|
-
* @param {number} [pageSize] Number of results per page
|
|
29851
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum} [sortBy] Field to sort by
|
|
29852
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum} [sortOrder] Sort direction
|
|
29853
|
-
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
29915
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
29916
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
29854
29917
|
* @param {*} [options] Override http request option.
|
|
29855
29918
|
* @throws {RequiredError}
|
|
29856
29919
|
*/
|
|
29857
|
-
|
|
29858
|
-
|
|
29859
|
-
assertParamExists('adminAnalyticsStoreXStoreIDFiltersEffectivenessGet', 'xStoreID', xStoreID)
|
|
29860
|
-
const localVarPath = `/admin/analytics/store/{xStoreID}/filters/effectiveness`
|
|
29861
|
-
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
29920
|
+
adminAnalyticsOrgKpiRealtimeGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29921
|
+
const localVarPath = `/admin/analytics/org/kpi/realtime`;
|
|
29862
29922
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29863
29923
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29864
29924
|
let baseOptions;
|
|
@@ -29873,42 +29933,6 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29873
29933
|
// authentication BearerAuth required
|
|
29874
29934
|
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
29875
29935
|
|
|
29876
|
-
if (startTime !== undefined) {
|
|
29877
|
-
localVarQueryParameter['start_time'] = startTime;
|
|
29878
|
-
}
|
|
29879
|
-
|
|
29880
|
-
if (endTime !== undefined) {
|
|
29881
|
-
localVarQueryParameter['end_time'] = endTime;
|
|
29882
|
-
}
|
|
29883
|
-
|
|
29884
|
-
if (limit !== undefined) {
|
|
29885
|
-
localVarQueryParameter['limit'] = limit;
|
|
29886
|
-
}
|
|
29887
|
-
|
|
29888
|
-
if (offset !== undefined) {
|
|
29889
|
-
localVarQueryParameter['offset'] = offset;
|
|
29890
|
-
}
|
|
29891
|
-
|
|
29892
|
-
if (page !== undefined) {
|
|
29893
|
-
localVarQueryParameter['page'] = page;
|
|
29894
|
-
}
|
|
29895
|
-
|
|
29896
|
-
if (pageSize !== undefined) {
|
|
29897
|
-
localVarQueryParameter['page_size'] = pageSize;
|
|
29898
|
-
}
|
|
29899
|
-
|
|
29900
|
-
if (sortBy !== undefined) {
|
|
29901
|
-
localVarQueryParameter['sort_by'] = sortBy;
|
|
29902
|
-
}
|
|
29903
|
-
|
|
29904
|
-
if (sortOrder !== undefined) {
|
|
29905
|
-
localVarQueryParameter['sort_order'] = sortOrder;
|
|
29906
|
-
}
|
|
29907
|
-
|
|
29908
|
-
if (sort !== undefined) {
|
|
29909
|
-
localVarQueryParameter['sort'] = sort;
|
|
29910
|
-
}
|
|
29911
|
-
|
|
29912
29936
|
|
|
29913
29937
|
|
|
29914
29938
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -29921,30 +29945,337 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
29921
29945
|
};
|
|
29922
29946
|
},
|
|
29923
29947
|
/**
|
|
29924
|
-
* Retrieve
|
|
29925
|
-
* @summary Get
|
|
29926
|
-
* @param {string} xStoreID Store ID
|
|
29948
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
29949
|
+
* @summary Get Organization Query Analytics
|
|
29927
29950
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
29928
29951
|
* @param {string} [endTime] End time in RFC3339 format
|
|
29929
|
-
* @param {
|
|
29930
|
-
* @param {
|
|
29931
|
-
* @param {
|
|
29932
|
-
* @param {boolean} [includeEffectiveness] Include filter effectiveness analysis
|
|
29933
|
-
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
29934
|
-
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
29935
|
-
* @param {number} [page] Page number for pagination
|
|
29936
|
-
* @param {number} [pageSize] Number of results per page
|
|
29937
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum} [sortBy] Field to sort by
|
|
29938
|
-
* @param {AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum} [sortOrder] Sort direction
|
|
29939
|
-
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
29952
|
+
* @param {number} [limit] Maximum number of results
|
|
29953
|
+
* @param {number} [offset] Offset for pagination
|
|
29954
|
+
* @param {string} [orderBy] Column to order by
|
|
29940
29955
|
* @param {*} [options] Override http request option.
|
|
29941
29956
|
* @throws {RequiredError}
|
|
29942
29957
|
*/
|
|
29943
|
-
|
|
29944
|
-
|
|
29945
|
-
|
|
29946
|
-
const
|
|
29947
|
-
|
|
29958
|
+
adminAnalyticsOrgQueriesGet: async (startTime?: string, endTime?: string, limit?: number, offset?: number, orderBy?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
29959
|
+
const localVarPath = `/admin/analytics/org/queries`;
|
|
29960
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29961
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29962
|
+
let baseOptions;
|
|
29963
|
+
if (configuration) {
|
|
29964
|
+
baseOptions = configuration.baseOptions;
|
|
29965
|
+
}
|
|
29966
|
+
|
|
29967
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
29968
|
+
const localVarHeaderParameter = {} as any;
|
|
29969
|
+
const localVarQueryParameter = {} as any;
|
|
29970
|
+
|
|
29971
|
+
// authentication BearerAuth required
|
|
29972
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
29973
|
+
|
|
29974
|
+
if (startTime !== undefined) {
|
|
29975
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
29976
|
+
}
|
|
29977
|
+
|
|
29978
|
+
if (endTime !== undefined) {
|
|
29979
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
29980
|
+
}
|
|
29981
|
+
|
|
29982
|
+
if (limit !== undefined) {
|
|
29983
|
+
localVarQueryParameter['limit'] = limit;
|
|
29984
|
+
}
|
|
29985
|
+
|
|
29986
|
+
if (offset !== undefined) {
|
|
29987
|
+
localVarQueryParameter['offset'] = offset;
|
|
29988
|
+
}
|
|
29989
|
+
|
|
29990
|
+
if (orderBy !== undefined) {
|
|
29991
|
+
localVarQueryParameter['order_by'] = orderBy;
|
|
29992
|
+
}
|
|
29993
|
+
|
|
29994
|
+
|
|
29995
|
+
|
|
29996
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
29997
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
29998
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
29999
|
+
|
|
30000
|
+
return {
|
|
30001
|
+
url: toPathString(localVarUrlObj),
|
|
30002
|
+
options: localVarRequestOptions,
|
|
30003
|
+
};
|
|
30004
|
+
},
|
|
30005
|
+
/**
|
|
30006
|
+
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
30007
|
+
* @summary Get Analytics Configuration
|
|
30008
|
+
* @param {string} xStoreID Store ID
|
|
30009
|
+
* @param {*} [options] Override http request option.
|
|
30010
|
+
* @throws {RequiredError}
|
|
30011
|
+
*/
|
|
30012
|
+
adminAnalyticsStoreXStoreIDConfigGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30013
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
30014
|
+
assertParamExists('adminAnalyticsStoreXStoreIDConfigGet', 'xStoreID', xStoreID)
|
|
30015
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/config`
|
|
30016
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
30017
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30018
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30019
|
+
let baseOptions;
|
|
30020
|
+
if (configuration) {
|
|
30021
|
+
baseOptions = configuration.baseOptions;
|
|
30022
|
+
}
|
|
30023
|
+
|
|
30024
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
30025
|
+
const localVarHeaderParameter = {} as any;
|
|
30026
|
+
const localVarQueryParameter = {} as any;
|
|
30027
|
+
|
|
30028
|
+
// authentication BearerAuth required
|
|
30029
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
30030
|
+
|
|
30031
|
+
|
|
30032
|
+
|
|
30033
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30035
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
30036
|
+
|
|
30037
|
+
return {
|
|
30038
|
+
url: toPathString(localVarUrlObj),
|
|
30039
|
+
options: localVarRequestOptions,
|
|
30040
|
+
};
|
|
30041
|
+
},
|
|
30042
|
+
/**
|
|
30043
|
+
* Execute a custom ClickHouse query for advanced analytics with parameterized queries
|
|
30044
|
+
* @summary Execute Custom Analytics Query
|
|
30045
|
+
* @param {string} xStoreID Store ID
|
|
30046
|
+
* @param {AnalyticsCustomQueryRequest} analyticsCustomQueryRequest Custom query request
|
|
30047
|
+
* @param {*} [options] Override http request option.
|
|
30048
|
+
* @throws {RequiredError}
|
|
30049
|
+
*/
|
|
30050
|
+
adminAnalyticsStoreXStoreIDCustomPost: async (xStoreID: string, analyticsCustomQueryRequest: AnalyticsCustomQueryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30051
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
30052
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomPost', 'xStoreID', xStoreID)
|
|
30053
|
+
// verify required parameter 'analyticsCustomQueryRequest' is not null or undefined
|
|
30054
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomPost', 'analyticsCustomQueryRequest', analyticsCustomQueryRequest)
|
|
30055
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom`
|
|
30056
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
30057
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30058
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30059
|
+
let baseOptions;
|
|
30060
|
+
if (configuration) {
|
|
30061
|
+
baseOptions = configuration.baseOptions;
|
|
30062
|
+
}
|
|
30063
|
+
|
|
30064
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
30065
|
+
const localVarHeaderParameter = {} as any;
|
|
30066
|
+
const localVarQueryParameter = {} as any;
|
|
30067
|
+
|
|
30068
|
+
// authentication BearerAuth required
|
|
30069
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
30070
|
+
|
|
30071
|
+
|
|
30072
|
+
|
|
30073
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
30074
|
+
|
|
30075
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30076
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30077
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
30078
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomQueryRequest, localVarRequestOptions, configuration)
|
|
30079
|
+
|
|
30080
|
+
return {
|
|
30081
|
+
url: toPathString(localVarUrlObj),
|
|
30082
|
+
options: localVarRequestOptions,
|
|
30083
|
+
};
|
|
30084
|
+
},
|
|
30085
|
+
/**
|
|
30086
|
+
* Retrieve popular filter combinations and their effectiveness metrics
|
|
30087
|
+
* @summary Get Filter Combinations
|
|
30088
|
+
* @param {string} xStoreID Store ID
|
|
30089
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
30090
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
30091
|
+
* @param {number} [minUsage] Minimum usage count for combinations
|
|
30092
|
+
* @param {number} [limit] Maximum number of combinations to return (legacy - use page_size instead)
|
|
30093
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
30094
|
+
* @param {number} [page] Page number for pagination
|
|
30095
|
+
* @param {number} [pageSize] Number of results per page
|
|
30096
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum} [sortBy] Field to sort by
|
|
30097
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum} [sortOrder] Sort direction
|
|
30098
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
30099
|
+
* @param {*} [options] Override http request option.
|
|
30100
|
+
* @throws {RequiredError}
|
|
30101
|
+
*/
|
|
30102
|
+
adminAnalyticsStoreXStoreIDFiltersCombinationsGet: async (xStoreID: string, startTime?: string, endTime?: string, minUsage?: number, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30103
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
30104
|
+
assertParamExists('adminAnalyticsStoreXStoreIDFiltersCombinationsGet', 'xStoreID', xStoreID)
|
|
30105
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/filters/combinations`
|
|
30106
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
30107
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30108
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30109
|
+
let baseOptions;
|
|
30110
|
+
if (configuration) {
|
|
30111
|
+
baseOptions = configuration.baseOptions;
|
|
30112
|
+
}
|
|
30113
|
+
|
|
30114
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
30115
|
+
const localVarHeaderParameter = {} as any;
|
|
30116
|
+
const localVarQueryParameter = {} as any;
|
|
30117
|
+
|
|
30118
|
+
// authentication BearerAuth required
|
|
30119
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
30120
|
+
|
|
30121
|
+
if (startTime !== undefined) {
|
|
30122
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
30123
|
+
}
|
|
30124
|
+
|
|
30125
|
+
if (endTime !== undefined) {
|
|
30126
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
30127
|
+
}
|
|
30128
|
+
|
|
30129
|
+
if (minUsage !== undefined) {
|
|
30130
|
+
localVarQueryParameter['min_usage'] = minUsage;
|
|
30131
|
+
}
|
|
30132
|
+
|
|
30133
|
+
if (limit !== undefined) {
|
|
30134
|
+
localVarQueryParameter['limit'] = limit;
|
|
30135
|
+
}
|
|
30136
|
+
|
|
30137
|
+
if (offset !== undefined) {
|
|
30138
|
+
localVarQueryParameter['offset'] = offset;
|
|
30139
|
+
}
|
|
30140
|
+
|
|
30141
|
+
if (page !== undefined) {
|
|
30142
|
+
localVarQueryParameter['page'] = page;
|
|
30143
|
+
}
|
|
30144
|
+
|
|
30145
|
+
if (pageSize !== undefined) {
|
|
30146
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
30147
|
+
}
|
|
30148
|
+
|
|
30149
|
+
if (sortBy !== undefined) {
|
|
30150
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
30151
|
+
}
|
|
30152
|
+
|
|
30153
|
+
if (sortOrder !== undefined) {
|
|
30154
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
30155
|
+
}
|
|
30156
|
+
|
|
30157
|
+
if (sort !== undefined) {
|
|
30158
|
+
localVarQueryParameter['sort'] = sort;
|
|
30159
|
+
}
|
|
30160
|
+
|
|
30161
|
+
|
|
30162
|
+
|
|
30163
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30164
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30165
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
30166
|
+
|
|
30167
|
+
return {
|
|
30168
|
+
url: toPathString(localVarUrlObj),
|
|
30169
|
+
options: localVarRequestOptions,
|
|
30170
|
+
};
|
|
30171
|
+
},
|
|
30172
|
+
/**
|
|
30173
|
+
* Analyze filter effectiveness by comparing search results with and without filters
|
|
30174
|
+
* @summary Get Filter Effectiveness
|
|
30175
|
+
* @param {string} xStoreID Store ID
|
|
30176
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
30177
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
30178
|
+
* @param {number} [limit] Maximum number of results to return (legacy - use page_size instead)
|
|
30179
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
30180
|
+
* @param {number} [page] Page number for pagination
|
|
30181
|
+
* @param {number} [pageSize] Number of results per page
|
|
30182
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum} [sortBy] Field to sort by
|
|
30183
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum} [sortOrder] Sort direction
|
|
30184
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
30185
|
+
* @param {*} [options] Override http request option.
|
|
30186
|
+
* @throws {RequiredError}
|
|
30187
|
+
*/
|
|
30188
|
+
adminAnalyticsStoreXStoreIDFiltersEffectivenessGet: async (xStoreID: string, startTime?: string, endTime?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30189
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
30190
|
+
assertParamExists('adminAnalyticsStoreXStoreIDFiltersEffectivenessGet', 'xStoreID', xStoreID)
|
|
30191
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/filters/effectiveness`
|
|
30192
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
30193
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30194
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30195
|
+
let baseOptions;
|
|
30196
|
+
if (configuration) {
|
|
30197
|
+
baseOptions = configuration.baseOptions;
|
|
30198
|
+
}
|
|
30199
|
+
|
|
30200
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
30201
|
+
const localVarHeaderParameter = {} as any;
|
|
30202
|
+
const localVarQueryParameter = {} as any;
|
|
30203
|
+
|
|
30204
|
+
// authentication BearerAuth required
|
|
30205
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
30206
|
+
|
|
30207
|
+
if (startTime !== undefined) {
|
|
30208
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
30209
|
+
}
|
|
30210
|
+
|
|
30211
|
+
if (endTime !== undefined) {
|
|
30212
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
30213
|
+
}
|
|
30214
|
+
|
|
30215
|
+
if (limit !== undefined) {
|
|
30216
|
+
localVarQueryParameter['limit'] = limit;
|
|
30217
|
+
}
|
|
30218
|
+
|
|
30219
|
+
if (offset !== undefined) {
|
|
30220
|
+
localVarQueryParameter['offset'] = offset;
|
|
30221
|
+
}
|
|
30222
|
+
|
|
30223
|
+
if (page !== undefined) {
|
|
30224
|
+
localVarQueryParameter['page'] = page;
|
|
30225
|
+
}
|
|
30226
|
+
|
|
30227
|
+
if (pageSize !== undefined) {
|
|
30228
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
30229
|
+
}
|
|
30230
|
+
|
|
30231
|
+
if (sortBy !== undefined) {
|
|
30232
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
30233
|
+
}
|
|
30234
|
+
|
|
30235
|
+
if (sortOrder !== undefined) {
|
|
30236
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
30237
|
+
}
|
|
30238
|
+
|
|
30239
|
+
if (sort !== undefined) {
|
|
30240
|
+
localVarQueryParameter['sort'] = sort;
|
|
30241
|
+
}
|
|
30242
|
+
|
|
30243
|
+
|
|
30244
|
+
|
|
30245
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30246
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30247
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
30248
|
+
|
|
30249
|
+
return {
|
|
30250
|
+
url: toPathString(localVarUrlObj),
|
|
30251
|
+
options: localVarRequestOptions,
|
|
30252
|
+
};
|
|
30253
|
+
},
|
|
30254
|
+
/**
|
|
30255
|
+
* Retrieve comprehensive filter usage statistics including popular filters, combinations, and effectiveness metrics
|
|
30256
|
+
* @summary Get Filter Analytics
|
|
30257
|
+
* @param {string} xStoreID Store ID
|
|
30258
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
30259
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
30260
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum} [granularity] Time granularity
|
|
30261
|
+
* @param {string} [filterKey] Filter by specific filter key
|
|
30262
|
+
* @param {boolean} [includeCombinations] Include filter combinations analysis
|
|
30263
|
+
* @param {boolean} [includeEffectiveness] Include filter effectiveness analysis
|
|
30264
|
+
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
30265
|
+
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
30266
|
+
* @param {number} [page] Page number for pagination
|
|
30267
|
+
* @param {number} [pageSize] Number of results per page
|
|
30268
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum} [sortBy] Field to sort by
|
|
30269
|
+
* @param {AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum} [sortOrder] Sort direction
|
|
30270
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
30271
|
+
* @param {*} [options] Override http request option.
|
|
30272
|
+
* @throws {RequiredError}
|
|
30273
|
+
*/
|
|
30274
|
+
adminAnalyticsStoreXStoreIDFiltersGet: async (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum, filterKey?: string, includeCombinations?: boolean, includeEffectiveness?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30275
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
30276
|
+
assertParamExists('adminAnalyticsStoreXStoreIDFiltersGet', 'xStoreID', xStoreID)
|
|
30277
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/filters`
|
|
30278
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
29948
30279
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
29949
30280
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
29950
30281
|
let baseOptions;
|
|
@@ -31828,6 +32159,68 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
31828
32159
|
export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
31829
32160
|
const localVarAxiosParamCreator = AnalyticsApiAxiosParamCreator(configuration)
|
|
31830
32161
|
return {
|
|
32162
|
+
/**
|
|
32163
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
32164
|
+
* @summary Get Organization Geographic Analytics
|
|
32165
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32166
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32167
|
+
* @param {number} [limit] Maximum number of results
|
|
32168
|
+
* @param {*} [options] Override http request option.
|
|
32169
|
+
* @throws {RequiredError}
|
|
32170
|
+
*/
|
|
32171
|
+
async adminAnalyticsOrgGeoGet(startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsOrgGeoGet200Response>> {
|
|
32172
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsOrgGeoGet(startTime, endTime, limit, options);
|
|
32173
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
32174
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsOrgGeoGet']?.[localVarOperationServerIndex]?.url;
|
|
32175
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
32176
|
+
},
|
|
32177
|
+
/**
|
|
32178
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
32179
|
+
* @summary Get Organization KPI Analytics
|
|
32180
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32181
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32182
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
32183
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
32184
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32185
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
32186
|
+
* @param {*} [options] Override http request option.
|
|
32187
|
+
* @throws {RequiredError}
|
|
32188
|
+
*/
|
|
32189
|
+
async adminAnalyticsOrgKpiGet(startTime?: string, endTime?: string, granularity?: AdminAnalyticsOrgKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsOrgKpiGetTagsMatchModeEnum, compareMode?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsOrgKpiGet200Response>> {
|
|
32190
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options);
|
|
32191
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
32192
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsOrgKpiGet']?.[localVarOperationServerIndex]?.url;
|
|
32193
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
32194
|
+
},
|
|
32195
|
+
/**
|
|
32196
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
32197
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
32198
|
+
* @param {*} [options] Override http request option.
|
|
32199
|
+
* @throws {RequiredError}
|
|
32200
|
+
*/
|
|
32201
|
+
async adminAnalyticsOrgKpiRealtimeGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsOrgKpiRealtimeGet200Response>> {
|
|
32202
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsOrgKpiRealtimeGet(options);
|
|
32203
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
32204
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsOrgKpiRealtimeGet']?.[localVarOperationServerIndex]?.url;
|
|
32205
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
32206
|
+
},
|
|
32207
|
+
/**
|
|
32208
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
32209
|
+
* @summary Get Organization Query Analytics
|
|
32210
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32211
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32212
|
+
* @param {number} [limit] Maximum number of results
|
|
32213
|
+
* @param {number} [offset] Offset for pagination
|
|
32214
|
+
* @param {string} [orderBy] Column to order by
|
|
32215
|
+
* @param {*} [options] Override http request option.
|
|
32216
|
+
* @throws {RequiredError}
|
|
32217
|
+
*/
|
|
32218
|
+
async adminAnalyticsOrgQueriesGet(startTime?: string, endTime?: string, limit?: number, offset?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsOrgQueriesGet200Response>> {
|
|
32219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options);
|
|
32220
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
32221
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsOrgQueriesGet']?.[localVarOperationServerIndex]?.url;
|
|
32222
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
32223
|
+
},
|
|
31831
32224
|
/**
|
|
31832
32225
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
31833
32226
|
* @summary Get Analytics Configuration
|
|
@@ -32068,7 +32461,7 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
32068
32461
|
* @param {*} [options] Override http request option.
|
|
32069
32462
|
* @throws {RequiredError}
|
|
32070
32463
|
*/
|
|
32071
|
-
async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
32464
|
+
async adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsOrgKpiGet200Response>> {
|
|
32072
32465
|
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options);
|
|
32073
32466
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
32074
32467
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDKpiGet']?.[localVarOperationServerIndex]?.url;
|
|
@@ -32386,6 +32779,56 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
32386
32779
|
export const AnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
32387
32780
|
const localVarFp = AnalyticsApiFp(configuration)
|
|
32388
32781
|
return {
|
|
32782
|
+
/**
|
|
32783
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
32784
|
+
* @summary Get Organization Geographic Analytics
|
|
32785
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32786
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32787
|
+
* @param {number} [limit] Maximum number of results
|
|
32788
|
+
* @param {*} [options] Override http request option.
|
|
32789
|
+
* @throws {RequiredError}
|
|
32790
|
+
*/
|
|
32791
|
+
adminAnalyticsOrgGeoGet(startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsOrgGeoGet200Response> {
|
|
32792
|
+
return localVarFp.adminAnalyticsOrgGeoGet(startTime, endTime, limit, options).then((request) => request(axios, basePath));
|
|
32793
|
+
},
|
|
32794
|
+
/**
|
|
32795
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
32796
|
+
* @summary Get Organization KPI Analytics
|
|
32797
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32798
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32799
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
32800
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
32801
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
32802
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
32803
|
+
* @param {*} [options] Override http request option.
|
|
32804
|
+
* @throws {RequiredError}
|
|
32805
|
+
*/
|
|
32806
|
+
adminAnalyticsOrgKpiGet(startTime?: string, endTime?: string, granularity?: AdminAnalyticsOrgKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsOrgKpiGetTagsMatchModeEnum, compareMode?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsOrgKpiGet200Response> {
|
|
32807
|
+
return localVarFp.adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options).then((request) => request(axios, basePath));
|
|
32808
|
+
},
|
|
32809
|
+
/**
|
|
32810
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
32811
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
32812
|
+
* @param {*} [options] Override http request option.
|
|
32813
|
+
* @throws {RequiredError}
|
|
32814
|
+
*/
|
|
32815
|
+
adminAnalyticsOrgKpiRealtimeGet(options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsOrgKpiRealtimeGet200Response> {
|
|
32816
|
+
return localVarFp.adminAnalyticsOrgKpiRealtimeGet(options).then((request) => request(axios, basePath));
|
|
32817
|
+
},
|
|
32818
|
+
/**
|
|
32819
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
32820
|
+
* @summary Get Organization Query Analytics
|
|
32821
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
32822
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
32823
|
+
* @param {number} [limit] Maximum number of results
|
|
32824
|
+
* @param {number} [offset] Offset for pagination
|
|
32825
|
+
* @param {string} [orderBy] Column to order by
|
|
32826
|
+
* @param {*} [options] Override http request option.
|
|
32827
|
+
* @throws {RequiredError}
|
|
32828
|
+
*/
|
|
32829
|
+
adminAnalyticsOrgQueriesGet(startTime?: string, endTime?: string, limit?: number, offset?: number, orderBy?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsOrgQueriesGet200Response> {
|
|
32830
|
+
return localVarFp.adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options).then((request) => request(axios, basePath));
|
|
32831
|
+
},
|
|
32389
32832
|
/**
|
|
32390
32833
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
32391
32834
|
* @summary Get Analytics Configuration
|
|
@@ -32599,7 +33042,7 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
32599
33042
|
* @param {*} [options] Override http request option.
|
|
32600
33043
|
* @throws {RequiredError}
|
|
32601
33044
|
*/
|
|
32602
|
-
adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
33045
|
+
adminAnalyticsStoreXStoreIDKpiGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsOrgKpiGet200Response> {
|
|
32603
33046
|
return localVarFp.adminAnalyticsStoreXStoreIDKpiGet(xStoreID, startTime, endTime, granularity, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
32604
33047
|
},
|
|
32605
33048
|
/**
|
|
@@ -32881,6 +33324,64 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
32881
33324
|
* @extends {BaseAPI}
|
|
32882
33325
|
*/
|
|
32883
33326
|
export class AnalyticsApi extends BaseAPI {
|
|
33327
|
+
/**
|
|
33328
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
33329
|
+
* @summary Get Organization Geographic Analytics
|
|
33330
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33331
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33332
|
+
* @param {number} [limit] Maximum number of results
|
|
33333
|
+
* @param {*} [options] Override http request option.
|
|
33334
|
+
* @throws {RequiredError}
|
|
33335
|
+
* @memberof AnalyticsApi
|
|
33336
|
+
*/
|
|
33337
|
+
public adminAnalyticsOrgGeoGet(startTime?: string, endTime?: string, limit?: number, options?: RawAxiosRequestConfig) {
|
|
33338
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgGeoGet(startTime, endTime, limit, options).then((request) => request(this.axios, this.basePath));
|
|
33339
|
+
}
|
|
33340
|
+
|
|
33341
|
+
/**
|
|
33342
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
33343
|
+
* @summary Get Organization KPI Analytics
|
|
33344
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33345
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33346
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
33347
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
33348
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
33349
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
33350
|
+
* @param {*} [options] Override http request option.
|
|
33351
|
+
* @throws {RequiredError}
|
|
33352
|
+
* @memberof AnalyticsApi
|
|
33353
|
+
*/
|
|
33354
|
+
public adminAnalyticsOrgKpiGet(startTime?: string, endTime?: string, granularity?: AdminAnalyticsOrgKpiGetGranularityEnum, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsOrgKpiGetTagsMatchModeEnum, compareMode?: boolean, options?: RawAxiosRequestConfig) {
|
|
33355
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options).then((request) => request(this.axios, this.basePath));
|
|
33356
|
+
}
|
|
33357
|
+
|
|
33358
|
+
/**
|
|
33359
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
33360
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
33361
|
+
* @param {*} [options] Override http request option.
|
|
33362
|
+
* @throws {RequiredError}
|
|
33363
|
+
* @memberof AnalyticsApi
|
|
33364
|
+
*/
|
|
33365
|
+
public adminAnalyticsOrgKpiRealtimeGet(options?: RawAxiosRequestConfig) {
|
|
33366
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgKpiRealtimeGet(options).then((request) => request(this.axios, this.basePath));
|
|
33367
|
+
}
|
|
33368
|
+
|
|
33369
|
+
/**
|
|
33370
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
33371
|
+
* @summary Get Organization Query Analytics
|
|
33372
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
33373
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
33374
|
+
* @param {number} [limit] Maximum number of results
|
|
33375
|
+
* @param {number} [offset] Offset for pagination
|
|
33376
|
+
* @param {string} [orderBy] Column to order by
|
|
33377
|
+
* @param {*} [options] Override http request option.
|
|
33378
|
+
* @throws {RequiredError}
|
|
33379
|
+
* @memberof AnalyticsApi
|
|
33380
|
+
*/
|
|
33381
|
+
public adminAnalyticsOrgQueriesGet(startTime?: string, endTime?: string, limit?: number, offset?: number, orderBy?: string, options?: RawAxiosRequestConfig) {
|
|
33382
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options).then((request) => request(this.axios, this.basePath));
|
|
33383
|
+
}
|
|
33384
|
+
|
|
32884
33385
|
/**
|
|
32885
33386
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
32886
33387
|
* @summary Get Analytics Configuration
|
|
@@ -33409,6 +33910,27 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
33409
33910
|
}
|
|
33410
33911
|
}
|
|
33411
33912
|
|
|
33913
|
+
/**
|
|
33914
|
+
* @export
|
|
33915
|
+
*/
|
|
33916
|
+
export const AdminAnalyticsOrgKpiGetGranularityEnum = {
|
|
33917
|
+
Minute: 'minute',
|
|
33918
|
+
_5minute: '5minute',
|
|
33919
|
+
_15minute: '15minute',
|
|
33920
|
+
Hour: 'hour',
|
|
33921
|
+
Day: 'day',
|
|
33922
|
+
Week: 'week',
|
|
33923
|
+
Month: 'month'
|
|
33924
|
+
} as const;
|
|
33925
|
+
export type AdminAnalyticsOrgKpiGetGranularityEnum = typeof AdminAnalyticsOrgKpiGetGranularityEnum[keyof typeof AdminAnalyticsOrgKpiGetGranularityEnum];
|
|
33926
|
+
/**
|
|
33927
|
+
* @export
|
|
33928
|
+
*/
|
|
33929
|
+
export const AdminAnalyticsOrgKpiGetTagsMatchModeEnum = {
|
|
33930
|
+
Any: 'any',
|
|
33931
|
+
All: 'all'
|
|
33932
|
+
} as const;
|
|
33933
|
+
export type AdminAnalyticsOrgKpiGetTagsMatchModeEnum = typeof AdminAnalyticsOrgKpiGetTagsMatchModeEnum[keyof typeof AdminAnalyticsOrgKpiGetTagsMatchModeEnum];
|
|
33412
33934
|
/**
|
|
33413
33935
|
* @export
|
|
33414
33936
|
*/
|
|
@@ -43666,15 +44188,17 @@ export class ExternalAPINotificationsApi extends BaseAPI {
|
|
|
43666
44188
|
export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
43667
44189
|
return {
|
|
43668
44190
|
/**
|
|
43669
|
-
*
|
|
43670
|
-
* @summary
|
|
43671
|
-
* @param {string}
|
|
43672
|
-
* @param {number} [
|
|
44191
|
+
* Checks if a specific feature is within limits without incrementing usage
|
|
44192
|
+
* @summary Check if a feature can be used
|
|
44193
|
+
* @param {string} featureName Feature name to check
|
|
44194
|
+
* @param {number} [amount] Amount to check (default: 1)
|
|
43673
44195
|
* @param {*} [options] Override http request option.
|
|
43674
44196
|
* @throws {RequiredError}
|
|
43675
44197
|
*/
|
|
43676
|
-
|
|
43677
|
-
|
|
44198
|
+
adminV1FeatureLimitsCheckGet: async (featureName: string, amount?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44199
|
+
// verify required parameter 'featureName' is not null or undefined
|
|
44200
|
+
assertParamExists('adminV1FeatureLimitsCheckGet', 'featureName', featureName)
|
|
44201
|
+
const localVarPath = `/admin/v1/feature-limits/check`;
|
|
43678
44202
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43679
44203
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43680
44204
|
let baseOptions;
|
|
@@ -43693,8 +44217,8 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43693
44217
|
localVarQueryParameter['feature_name'] = featureName;
|
|
43694
44218
|
}
|
|
43695
44219
|
|
|
43696
|
-
if (
|
|
43697
|
-
localVarQueryParameter['
|
|
44220
|
+
if (amount !== undefined) {
|
|
44221
|
+
localVarQueryParameter['amount'] = amount;
|
|
43698
44222
|
}
|
|
43699
44223
|
|
|
43700
44224
|
|
|
@@ -43709,17 +44233,15 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43709
44233
|
};
|
|
43710
44234
|
},
|
|
43711
44235
|
/**
|
|
43712
|
-
*
|
|
43713
|
-
* @summary
|
|
43714
|
-
* @param {string} featureName
|
|
43715
|
-
* @param {number} [
|
|
44236
|
+
* Retrieves historical feature usage events for the organization
|
|
44237
|
+
* @summary Get feature usage history
|
|
44238
|
+
* @param {string} [featureName] Filter by feature name
|
|
44239
|
+
* @param {number} [limit] Number of records to return (default: 100)
|
|
43716
44240
|
* @param {*} [options] Override http request option.
|
|
43717
44241
|
* @throws {RequiredError}
|
|
43718
44242
|
*/
|
|
43719
|
-
|
|
43720
|
-
|
|
43721
|
-
assertParamExists('featureLimitsCheckGet', 'featureName', featureName)
|
|
43722
|
-
const localVarPath = `/feature-limits/check`;
|
|
44243
|
+
adminV1FeatureLimitsHistoryGet: async (featureName?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44244
|
+
const localVarPath = `/admin/v1/feature-limits/history`;
|
|
43723
44245
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43724
44246
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43725
44247
|
let baseOptions;
|
|
@@ -43738,8 +44260,8 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43738
44260
|
localVarQueryParameter['feature_name'] = featureName;
|
|
43739
44261
|
}
|
|
43740
44262
|
|
|
43741
|
-
if (
|
|
43742
|
-
localVarQueryParameter['
|
|
44263
|
+
if (limit !== undefined) {
|
|
44264
|
+
localVarQueryParameter['limit'] = limit;
|
|
43743
44265
|
}
|
|
43744
44266
|
|
|
43745
44267
|
|
|
@@ -43754,15 +44276,13 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43754
44276
|
};
|
|
43755
44277
|
},
|
|
43756
44278
|
/**
|
|
43757
|
-
* Retrieves
|
|
43758
|
-
* @summary Get
|
|
43759
|
-
* @param {string} [featureName] Filter by feature name
|
|
43760
|
-
* @param {number} [limit] Number of records to return (default: 100)
|
|
44279
|
+
* Retrieves the organization\'s current plan with all feature limits
|
|
44280
|
+
* @summary Get organization plan features
|
|
43761
44281
|
* @param {*} [options] Override http request option.
|
|
43762
44282
|
* @throws {RequiredError}
|
|
43763
44283
|
*/
|
|
43764
|
-
|
|
43765
|
-
const localVarPath = `/feature-limits/
|
|
44284
|
+
adminV1FeatureLimitsPlanGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44285
|
+
const localVarPath = `/admin/v1/feature-limits/plan`;
|
|
43766
44286
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43767
44287
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43768
44288
|
let baseOptions;
|
|
@@ -43777,14 +44297,6 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43777
44297
|
// authentication BearerAuth required
|
|
43778
44298
|
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
43779
44299
|
|
|
43780
|
-
if (featureName !== undefined) {
|
|
43781
|
-
localVarQueryParameter['feature_name'] = featureName;
|
|
43782
|
-
}
|
|
43783
|
-
|
|
43784
|
-
if (limit !== undefined) {
|
|
43785
|
-
localVarQueryParameter['limit'] = limit;
|
|
43786
|
-
}
|
|
43787
|
-
|
|
43788
44300
|
|
|
43789
44301
|
|
|
43790
44302
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -43797,13 +44309,13 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43797
44309
|
};
|
|
43798
44310
|
},
|
|
43799
44311
|
/**
|
|
43800
|
-
*
|
|
43801
|
-
* @summary Get
|
|
44312
|
+
* Returns plan details and feature availability map for UI rendering
|
|
44313
|
+
* @summary Get plan information for frontend
|
|
43802
44314
|
* @param {*} [options] Override http request option.
|
|
43803
44315
|
* @throws {RequiredError}
|
|
43804
44316
|
*/
|
|
43805
|
-
|
|
43806
|
-
const localVarPath = `/feature-limits/plan`;
|
|
44317
|
+
adminV1FeatureLimitsPlanInfoGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44318
|
+
const localVarPath = `/admin/v1/feature-limits/plan/info`;
|
|
43807
44319
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43808
44320
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43809
44321
|
let baseOptions;
|
|
@@ -43830,13 +44342,13 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43830
44342
|
};
|
|
43831
44343
|
},
|
|
43832
44344
|
/**
|
|
43833
|
-
* Returns plan
|
|
43834
|
-
* @summary Get plan information
|
|
44345
|
+
* Returns plan information and feature availability map for the current user
|
|
44346
|
+
* @summary Get user plan information
|
|
43835
44347
|
* @param {*} [options] Override http request option.
|
|
43836
44348
|
* @throws {RequiredError}
|
|
43837
44349
|
*/
|
|
43838
|
-
|
|
43839
|
-
const localVarPath = `/feature-limits/plan/info`;
|
|
44350
|
+
adminV1FeatureLimitsPlanUserInfoGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44351
|
+
const localVarPath = `/admin/v1/feature-limits/plan/user-info`;
|
|
43840
44352
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43841
44353
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43842
44354
|
let baseOptions;
|
|
@@ -43868,8 +44380,8 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43868
44380
|
* @param {*} [options] Override http request option.
|
|
43869
44381
|
* @throws {RequiredError}
|
|
43870
44382
|
*/
|
|
43871
|
-
|
|
43872
|
-
const localVarPath = `/feature-limits/status`;
|
|
44383
|
+
adminV1FeatureLimitsStatusGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44384
|
+
const localVarPath = `/admin/v1/feature-limits/status`;
|
|
43873
44385
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43874
44386
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43875
44387
|
let baseOptions;
|
|
@@ -43901,8 +44413,8 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43901
44413
|
* @param {*} [options] Override http request option.
|
|
43902
44414
|
* @throws {RequiredError}
|
|
43903
44415
|
*/
|
|
43904
|
-
|
|
43905
|
-
const localVarPath = `/feature-limits/usage`;
|
|
44416
|
+
adminV1FeatureLimitsUsageGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44417
|
+
const localVarPath = `/admin/v1/feature-limits/usage`;
|
|
43906
44418
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43907
44419
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43908
44420
|
let baseOptions;
|
|
@@ -43919,6 +44431,49 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43919
44431
|
|
|
43920
44432
|
|
|
43921
44433
|
|
|
44434
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
44435
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
44436
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
44437
|
+
|
|
44438
|
+
return {
|
|
44439
|
+
url: toPathString(localVarUrlObj),
|
|
44440
|
+
options: localVarRequestOptions,
|
|
44441
|
+
};
|
|
44442
|
+
},
|
|
44443
|
+
/**
|
|
44444
|
+
* Retrieves log of feature limit violations for monitoring
|
|
44445
|
+
* @summary Get feature limit violations
|
|
44446
|
+
* @param {string} [featureName] Filter by feature name
|
|
44447
|
+
* @param {number} [limit] Number of records to return (default: 50)
|
|
44448
|
+
* @param {*} [options] Override http request option.
|
|
44449
|
+
* @throws {RequiredError}
|
|
44450
|
+
*/
|
|
44451
|
+
adminV1FeatureLimitsViolationsGet: async (featureName?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44452
|
+
const localVarPath = `/admin/v1/feature-limits/violations`;
|
|
44453
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44454
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44455
|
+
let baseOptions;
|
|
44456
|
+
if (configuration) {
|
|
44457
|
+
baseOptions = configuration.baseOptions;
|
|
44458
|
+
}
|
|
44459
|
+
|
|
44460
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
44461
|
+
const localVarHeaderParameter = {} as any;
|
|
44462
|
+
const localVarQueryParameter = {} as any;
|
|
44463
|
+
|
|
44464
|
+
// authentication BearerAuth required
|
|
44465
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
44466
|
+
|
|
44467
|
+
if (featureName !== undefined) {
|
|
44468
|
+
localVarQueryParameter['feature_name'] = featureName;
|
|
44469
|
+
}
|
|
44470
|
+
|
|
44471
|
+
if (limit !== undefined) {
|
|
44472
|
+
localVarQueryParameter['limit'] = limit;
|
|
44473
|
+
}
|
|
44474
|
+
|
|
44475
|
+
|
|
44476
|
+
|
|
43922
44477
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43923
44478
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43924
44479
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -43938,20 +44493,6 @@ export const FeatureLimitsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
43938
44493
|
export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
43939
44494
|
const localVarAxiosParamCreator = FeatureLimitsApiAxiosParamCreator(configuration)
|
|
43940
44495
|
return {
|
|
43941
|
-
/**
|
|
43942
|
-
* Retrieves log of feature limit violations for monitoring
|
|
43943
|
-
* @summary Get feature limit violations
|
|
43944
|
-
* @param {string} [featureName] Filter by feature name
|
|
43945
|
-
* @param {number} [limit] Number of records to return (default: 50)
|
|
43946
|
-
* @param {*} [options] Override http request option.
|
|
43947
|
-
* @throws {RequiredError}
|
|
43948
|
-
*/
|
|
43949
|
-
async adminFeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminFeatureLimitsViolationsGet200Response>> {
|
|
43950
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminFeatureLimitsViolationsGet(featureName, limit, options);
|
|
43951
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43952
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminFeatureLimitsViolationsGet']?.[localVarOperationServerIndex]?.url;
|
|
43953
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43954
|
-
},
|
|
43955
44496
|
/**
|
|
43956
44497
|
* Checks if a specific feature is within limits without incrementing usage
|
|
43957
44498
|
* @summary Check if a feature can be used
|
|
@@ -43960,10 +44501,10 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
43960
44501
|
* @param {*} [options] Override http request option.
|
|
43961
44502
|
* @throws {RequiredError}
|
|
43962
44503
|
*/
|
|
43963
|
-
async
|
|
43964
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44504
|
+
async adminV1FeatureLimitsCheckGet(featureName: string, amount?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1FeatureLimitsCheckGet200Response>> {
|
|
44505
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsCheckGet(featureName, amount, options);
|
|
43965
44506
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43966
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44507
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsCheckGet']?.[localVarOperationServerIndex]?.url;
|
|
43967
44508
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43968
44509
|
},
|
|
43969
44510
|
/**
|
|
@@ -43974,10 +44515,10 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
43974
44515
|
* @param {*} [options] Override http request option.
|
|
43975
44516
|
* @throws {RequiredError}
|
|
43976
44517
|
*/
|
|
43977
|
-
async
|
|
43978
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44518
|
+
async adminV1FeatureLimitsHistoryGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1FeatureLimitsHistoryGet200Response>> {
|
|
44519
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsHistoryGet(featureName, limit, options);
|
|
43979
44520
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43980
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44521
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsHistoryGet']?.[localVarOperationServerIndex]?.url;
|
|
43981
44522
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43982
44523
|
},
|
|
43983
44524
|
/**
|
|
@@ -43986,10 +44527,10 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
43986
44527
|
* @param {*} [options] Override http request option.
|
|
43987
44528
|
* @throws {RequiredError}
|
|
43988
44529
|
*/
|
|
43989
|
-
async
|
|
43990
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44530
|
+
async adminV1FeatureLimitsPlanGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1FeatureLimitsPlanGet200Response>> {
|
|
44531
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsPlanGet(options);
|
|
43991
44532
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43992
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44533
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsPlanGet']?.[localVarOperationServerIndex]?.url;
|
|
43993
44534
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43994
44535
|
},
|
|
43995
44536
|
/**
|
|
@@ -43998,10 +44539,22 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
43998
44539
|
* @param {*} [options] Override http request option.
|
|
43999
44540
|
* @throws {RequiredError}
|
|
44000
44541
|
*/
|
|
44001
|
-
async
|
|
44002
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44542
|
+
async adminV1FeatureLimitsPlanInfoGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
|
|
44543
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsPlanInfoGet(options);
|
|
44003
44544
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44004
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44545
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsPlanInfoGet']?.[localVarOperationServerIndex]?.url;
|
|
44546
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44547
|
+
},
|
|
44548
|
+
/**
|
|
44549
|
+
* Returns plan information and feature availability map for the current user
|
|
44550
|
+
* @summary Get user plan information
|
|
44551
|
+
* @param {*} [options] Override http request option.
|
|
44552
|
+
* @throws {RequiredError}
|
|
44553
|
+
*/
|
|
44554
|
+
async adminV1FeatureLimitsPlanUserInfoGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
|
|
44555
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsPlanUserInfoGet(options);
|
|
44556
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44557
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsPlanUserInfoGet']?.[localVarOperationServerIndex]?.url;
|
|
44005
44558
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44006
44559
|
},
|
|
44007
44560
|
/**
|
|
@@ -44010,10 +44563,10 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
44010
44563
|
* @param {*} [options] Override http request option.
|
|
44011
44564
|
* @throws {RequiredError}
|
|
44012
44565
|
*/
|
|
44013
|
-
async
|
|
44014
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44566
|
+
async adminV1FeatureLimitsStatusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseFeatureLimitServiceLimitStatus>> {
|
|
44567
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsStatusGet(options);
|
|
44015
44568
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44016
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44569
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsStatusGet']?.[localVarOperationServerIndex]?.url;
|
|
44017
44570
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44018
44571
|
},
|
|
44019
44572
|
/**
|
|
@@ -44022,10 +44575,24 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
44022
44575
|
* @param {*} [options] Override http request option.
|
|
44023
44576
|
* @throws {RequiredError}
|
|
44024
44577
|
*/
|
|
44025
|
-
async
|
|
44026
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44578
|
+
async adminV1FeatureLimitsUsageGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1FeatureLimitsUsageGet200Response>> {
|
|
44579
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsUsageGet(options);
|
|
44027
44580
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44028
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.
|
|
44581
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsUsageGet']?.[localVarOperationServerIndex]?.url;
|
|
44582
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44583
|
+
},
|
|
44584
|
+
/**
|
|
44585
|
+
* Retrieves log of feature limit violations for monitoring
|
|
44586
|
+
* @summary Get feature limit violations
|
|
44587
|
+
* @param {string} [featureName] Filter by feature name
|
|
44588
|
+
* @param {number} [limit] Number of records to return (default: 50)
|
|
44589
|
+
* @param {*} [options] Override http request option.
|
|
44590
|
+
* @throws {RequiredError}
|
|
44591
|
+
*/
|
|
44592
|
+
async adminV1FeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminV1FeatureLimitsViolationsGet200Response>> {
|
|
44593
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsViolationsGet(featureName, limit, options);
|
|
44594
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44595
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsApi.adminV1FeatureLimitsViolationsGet']?.[localVarOperationServerIndex]?.url;
|
|
44029
44596
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44030
44597
|
},
|
|
44031
44598
|
}
|
|
@@ -44038,17 +44605,6 @@ export const FeatureLimitsApiFp = function(configuration?: Configuration) {
|
|
|
44038
44605
|
export const FeatureLimitsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
44039
44606
|
const localVarFp = FeatureLimitsApiFp(configuration)
|
|
44040
44607
|
return {
|
|
44041
|
-
/**
|
|
44042
|
-
* Retrieves log of feature limit violations for monitoring
|
|
44043
|
-
* @summary Get feature limit violations
|
|
44044
|
-
* @param {string} [featureName] Filter by feature name
|
|
44045
|
-
* @param {number} [limit] Number of records to return (default: 50)
|
|
44046
|
-
* @param {*} [options] Override http request option.
|
|
44047
|
-
* @throws {RequiredError}
|
|
44048
|
-
*/
|
|
44049
|
-
adminFeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminFeatureLimitsViolationsGet200Response> {
|
|
44050
|
-
return localVarFp.adminFeatureLimitsViolationsGet(featureName, limit, options).then((request) => request(axios, basePath));
|
|
44051
|
-
},
|
|
44052
44608
|
/**
|
|
44053
44609
|
* Checks if a specific feature is within limits without incrementing usage
|
|
44054
44610
|
* @summary Check if a feature can be used
|
|
@@ -44057,8 +44613,8 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44057
44613
|
* @param {*} [options] Override http request option.
|
|
44058
44614
|
* @throws {RequiredError}
|
|
44059
44615
|
*/
|
|
44060
|
-
|
|
44061
|
-
return localVarFp.
|
|
44616
|
+
adminV1FeatureLimitsCheckGet(featureName: string, amount?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1FeatureLimitsCheckGet200Response> {
|
|
44617
|
+
return localVarFp.adminV1FeatureLimitsCheckGet(featureName, amount, options).then((request) => request(axios, basePath));
|
|
44062
44618
|
},
|
|
44063
44619
|
/**
|
|
44064
44620
|
* Retrieves historical feature usage events for the organization
|
|
@@ -44068,8 +44624,8 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44068
44624
|
* @param {*} [options] Override http request option.
|
|
44069
44625
|
* @throws {RequiredError}
|
|
44070
44626
|
*/
|
|
44071
|
-
|
|
44072
|
-
return localVarFp.
|
|
44627
|
+
adminV1FeatureLimitsHistoryGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1FeatureLimitsHistoryGet200Response> {
|
|
44628
|
+
return localVarFp.adminV1FeatureLimitsHistoryGet(featureName, limit, options).then((request) => request(axios, basePath));
|
|
44073
44629
|
},
|
|
44074
44630
|
/**
|
|
44075
44631
|
* Retrieves the organization\'s current plan with all feature limits
|
|
@@ -44077,8 +44633,8 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44077
44633
|
* @param {*} [options] Override http request option.
|
|
44078
44634
|
* @throws {RequiredError}
|
|
44079
44635
|
*/
|
|
44080
|
-
|
|
44081
|
-
return localVarFp.
|
|
44636
|
+
adminV1FeatureLimitsPlanGet(options?: RawAxiosRequestConfig): AxiosPromise<AdminV1FeatureLimitsPlanGet200Response> {
|
|
44637
|
+
return localVarFp.adminV1FeatureLimitsPlanGet(options).then((request) => request(axios, basePath));
|
|
44082
44638
|
},
|
|
44083
44639
|
/**
|
|
44084
44640
|
* Returns plan details and feature availability map for UI rendering
|
|
@@ -44086,8 +44642,17 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44086
44642
|
* @param {*} [options] Override http request option.
|
|
44087
44643
|
* @throws {RequiredError}
|
|
44088
44644
|
*/
|
|
44089
|
-
|
|
44090
|
-
return localVarFp.
|
|
44645
|
+
adminV1FeatureLimitsPlanInfoGet(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
|
|
44646
|
+
return localVarFp.adminV1FeatureLimitsPlanInfoGet(options).then((request) => request(axios, basePath));
|
|
44647
|
+
},
|
|
44648
|
+
/**
|
|
44649
|
+
* Returns plan information and feature availability map for the current user
|
|
44650
|
+
* @summary Get user plan information
|
|
44651
|
+
* @param {*} [options] Override http request option.
|
|
44652
|
+
* @throws {RequiredError}
|
|
44653
|
+
*/
|
|
44654
|
+
adminV1FeatureLimitsPlanUserInfoGet(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
|
|
44655
|
+
return localVarFp.adminV1FeatureLimitsPlanUserInfoGet(options).then((request) => request(axios, basePath));
|
|
44091
44656
|
},
|
|
44092
44657
|
/**
|
|
44093
44658
|
* Retrieves comprehensive real-time limit status for the organization including all features, credits, and API calls
|
|
@@ -44095,8 +44660,8 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44095
44660
|
* @param {*} [options] Override http request option.
|
|
44096
44661
|
* @throws {RequiredError}
|
|
44097
44662
|
*/
|
|
44098
|
-
|
|
44099
|
-
return localVarFp.
|
|
44663
|
+
adminV1FeatureLimitsStatusGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseFeatureLimitServiceLimitStatus> {
|
|
44664
|
+
return localVarFp.adminV1FeatureLimitsStatusGet(options).then((request) => request(axios, basePath));
|
|
44100
44665
|
},
|
|
44101
44666
|
/**
|
|
44102
44667
|
* Retrieves current feature usage statistics for the organization
|
|
@@ -44104,8 +44669,19 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44104
44669
|
* @param {*} [options] Override http request option.
|
|
44105
44670
|
* @throws {RequiredError}
|
|
44106
44671
|
*/
|
|
44107
|
-
|
|
44108
|
-
return localVarFp.
|
|
44672
|
+
adminV1FeatureLimitsUsageGet(options?: RawAxiosRequestConfig): AxiosPromise<AdminV1FeatureLimitsUsageGet200Response> {
|
|
44673
|
+
return localVarFp.adminV1FeatureLimitsUsageGet(options).then((request) => request(axios, basePath));
|
|
44674
|
+
},
|
|
44675
|
+
/**
|
|
44676
|
+
* Retrieves log of feature limit violations for monitoring
|
|
44677
|
+
* @summary Get feature limit violations
|
|
44678
|
+
* @param {string} [featureName] Filter by feature name
|
|
44679
|
+
* @param {number} [limit] Number of records to return (default: 50)
|
|
44680
|
+
* @param {*} [options] Override http request option.
|
|
44681
|
+
* @throws {RequiredError}
|
|
44682
|
+
*/
|
|
44683
|
+
adminV1FeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminV1FeatureLimitsViolationsGet200Response> {
|
|
44684
|
+
return localVarFp.adminV1FeatureLimitsViolationsGet(featureName, limit, options).then((request) => request(axios, basePath));
|
|
44109
44685
|
},
|
|
44110
44686
|
};
|
|
44111
44687
|
};
|
|
@@ -44117,19 +44693,6 @@ export const FeatureLimitsApiFactory = function (configuration?: Configuration,
|
|
|
44117
44693
|
* @extends {BaseAPI}
|
|
44118
44694
|
*/
|
|
44119
44695
|
export class FeatureLimitsApi extends BaseAPI {
|
|
44120
|
-
/**
|
|
44121
|
-
* Retrieves log of feature limit violations for monitoring
|
|
44122
|
-
* @summary Get feature limit violations
|
|
44123
|
-
* @param {string} [featureName] Filter by feature name
|
|
44124
|
-
* @param {number} [limit] Number of records to return (default: 50)
|
|
44125
|
-
* @param {*} [options] Override http request option.
|
|
44126
|
-
* @throws {RequiredError}
|
|
44127
|
-
* @memberof FeatureLimitsApi
|
|
44128
|
-
*/
|
|
44129
|
-
public adminFeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig) {
|
|
44130
|
-
return FeatureLimitsApiFp(this.configuration).adminFeatureLimitsViolationsGet(featureName, limit, options).then((request) => request(this.axios, this.basePath));
|
|
44131
|
-
}
|
|
44132
|
-
|
|
44133
44696
|
/**
|
|
44134
44697
|
* Checks if a specific feature is within limits without incrementing usage
|
|
44135
44698
|
* @summary Check if a feature can be used
|
|
@@ -44139,8 +44702,8 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44139
44702
|
* @throws {RequiredError}
|
|
44140
44703
|
* @memberof FeatureLimitsApi
|
|
44141
44704
|
*/
|
|
44142
|
-
public
|
|
44143
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44705
|
+
public adminV1FeatureLimitsCheckGet(featureName: string, amount?: number, options?: RawAxiosRequestConfig) {
|
|
44706
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsCheckGet(featureName, amount, options).then((request) => request(this.axios, this.basePath));
|
|
44144
44707
|
}
|
|
44145
44708
|
|
|
44146
44709
|
/**
|
|
@@ -44152,8 +44715,8 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44152
44715
|
* @throws {RequiredError}
|
|
44153
44716
|
* @memberof FeatureLimitsApi
|
|
44154
44717
|
*/
|
|
44155
|
-
public
|
|
44156
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44718
|
+
public adminV1FeatureLimitsHistoryGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig) {
|
|
44719
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsHistoryGet(featureName, limit, options).then((request) => request(this.axios, this.basePath));
|
|
44157
44720
|
}
|
|
44158
44721
|
|
|
44159
44722
|
/**
|
|
@@ -44163,8 +44726,8 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44163
44726
|
* @throws {RequiredError}
|
|
44164
44727
|
* @memberof FeatureLimitsApi
|
|
44165
44728
|
*/
|
|
44166
|
-
public
|
|
44167
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44729
|
+
public adminV1FeatureLimitsPlanGet(options?: RawAxiosRequestConfig) {
|
|
44730
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsPlanGet(options).then((request) => request(this.axios, this.basePath));
|
|
44168
44731
|
}
|
|
44169
44732
|
|
|
44170
44733
|
/**
|
|
@@ -44174,8 +44737,19 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44174
44737
|
* @throws {RequiredError}
|
|
44175
44738
|
* @memberof FeatureLimitsApi
|
|
44176
44739
|
*/
|
|
44177
|
-
public
|
|
44178
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44740
|
+
public adminV1FeatureLimitsPlanInfoGet(options?: RawAxiosRequestConfig) {
|
|
44741
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsPlanInfoGet(options).then((request) => request(this.axios, this.basePath));
|
|
44742
|
+
}
|
|
44743
|
+
|
|
44744
|
+
/**
|
|
44745
|
+
* Returns plan information and feature availability map for the current user
|
|
44746
|
+
* @summary Get user plan information
|
|
44747
|
+
* @param {*} [options] Override http request option.
|
|
44748
|
+
* @throws {RequiredError}
|
|
44749
|
+
* @memberof FeatureLimitsApi
|
|
44750
|
+
*/
|
|
44751
|
+
public adminV1FeatureLimitsPlanUserInfoGet(options?: RawAxiosRequestConfig) {
|
|
44752
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsPlanUserInfoGet(options).then((request) => request(this.axios, this.basePath));
|
|
44179
44753
|
}
|
|
44180
44754
|
|
|
44181
44755
|
/**
|
|
@@ -44185,8 +44759,8 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44185
44759
|
* @throws {RequiredError}
|
|
44186
44760
|
* @memberof FeatureLimitsApi
|
|
44187
44761
|
*/
|
|
44188
|
-
public
|
|
44189
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44762
|
+
public adminV1FeatureLimitsStatusGet(options?: RawAxiosRequestConfig) {
|
|
44763
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsStatusGet(options).then((request) => request(this.axios, this.basePath));
|
|
44190
44764
|
}
|
|
44191
44765
|
|
|
44192
44766
|
/**
|
|
@@ -44196,8 +44770,21 @@ export class FeatureLimitsApi extends BaseAPI {
|
|
|
44196
44770
|
* @throws {RequiredError}
|
|
44197
44771
|
* @memberof FeatureLimitsApi
|
|
44198
44772
|
*/
|
|
44199
|
-
public
|
|
44200
|
-
return FeatureLimitsApiFp(this.configuration).
|
|
44773
|
+
public adminV1FeatureLimitsUsageGet(options?: RawAxiosRequestConfig) {
|
|
44774
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsUsageGet(options).then((request) => request(this.axios, this.basePath));
|
|
44775
|
+
}
|
|
44776
|
+
|
|
44777
|
+
/**
|
|
44778
|
+
* Retrieves log of feature limit violations for monitoring
|
|
44779
|
+
* @summary Get feature limit violations
|
|
44780
|
+
* @param {string} [featureName] Filter by feature name
|
|
44781
|
+
* @param {number} [limit] Number of records to return (default: 50)
|
|
44782
|
+
* @param {*} [options] Override http request option.
|
|
44783
|
+
* @throws {RequiredError}
|
|
44784
|
+
* @memberof FeatureLimitsApi
|
|
44785
|
+
*/
|
|
44786
|
+
public adminV1FeatureLimitsViolationsGet(featureName?: string, limit?: number, options?: RawAxiosRequestConfig) {
|
|
44787
|
+
return FeatureLimitsApiFp(this.configuration).adminV1FeatureLimitsViolationsGet(featureName, limit, options).then((request) => request(this.axios, this.basePath));
|
|
44201
44788
|
}
|
|
44202
44789
|
}
|
|
44203
44790
|
|
|
@@ -44215,8 +44802,8 @@ export const FeatureLimitsAdminApiAxiosParamCreator = function (configuration?:
|
|
|
44215
44802
|
* @param {*} [options] Override http request option.
|
|
44216
44803
|
* @throws {RequiredError}
|
|
44217
44804
|
*/
|
|
44218
|
-
|
|
44219
|
-
const localVarPath = `/admin/feature-limits/cache/invalidate`;
|
|
44805
|
+
adminV1FeatureLimitsCacheInvalidatePost: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44806
|
+
const localVarPath = `/admin/v1/feature-limits/cache/invalidate`;
|
|
44220
44807
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44221
44808
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44222
44809
|
let baseOptions;
|
|
@@ -44249,8 +44836,8 @@ export const FeatureLimitsAdminApiAxiosParamCreator = function (configuration?:
|
|
|
44249
44836
|
* @param {*} [options] Override http request option.
|
|
44250
44837
|
* @throws {RequiredError}
|
|
44251
44838
|
*/
|
|
44252
|
-
|
|
44253
|
-
const localVarPath = `/admin/feature-limits/metrics/sync`;
|
|
44839
|
+
adminV1FeatureLimitsMetricsSyncPost: async (force?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44840
|
+
const localVarPath = `/admin/v1/feature-limits/metrics/sync`;
|
|
44254
44841
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44255
44842
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44256
44843
|
let baseOptions;
|
|
@@ -44287,10 +44874,10 @@ export const FeatureLimitsAdminApiAxiosParamCreator = function (configuration?:
|
|
|
44287
44874
|
* @param {*} [options] Override http request option.
|
|
44288
44875
|
* @throws {RequiredError}
|
|
44289
44876
|
*/
|
|
44290
|
-
|
|
44877
|
+
adminV1FeatureLimitsResetPost: async (featureName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44291
44878
|
// verify required parameter 'featureName' is not null or undefined
|
|
44292
|
-
assertParamExists('
|
|
44293
|
-
const localVarPath = `/admin/feature-limits/reset`;
|
|
44879
|
+
assertParamExists('adminV1FeatureLimitsResetPost', 'featureName', featureName)
|
|
44880
|
+
const localVarPath = `/admin/v1/feature-limits/reset`;
|
|
44294
44881
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
44295
44882
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44296
44883
|
let baseOptions;
|
|
@@ -44336,10 +44923,10 @@ export const FeatureLimitsAdminApiFp = function(configuration?: Configuration) {
|
|
|
44336
44923
|
* @param {*} [options] Override http request option.
|
|
44337
44924
|
* @throws {RequiredError}
|
|
44338
44925
|
*/
|
|
44339
|
-
async
|
|
44340
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44926
|
+
async adminV1FeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
44927
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsCacheInvalidatePost(options);
|
|
44341
44928
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44342
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.
|
|
44929
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.adminV1FeatureLimitsCacheInvalidatePost']?.[localVarOperationServerIndex]?.url;
|
|
44343
44930
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44344
44931
|
},
|
|
44345
44932
|
/**
|
|
@@ -44349,10 +44936,10 @@ export const FeatureLimitsAdminApiFp = function(configuration?: Configuration) {
|
|
|
44349
44936
|
* @param {*} [options] Override http request option.
|
|
44350
44937
|
* @throws {RequiredError}
|
|
44351
44938
|
*/
|
|
44352
|
-
async
|
|
44353
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44939
|
+
async adminV1FeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
44940
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsMetricsSyncPost(force, options);
|
|
44354
44941
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44355
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.
|
|
44942
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.adminV1FeatureLimitsMetricsSyncPost']?.[localVarOperationServerIndex]?.url;
|
|
44356
44943
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44357
44944
|
},
|
|
44358
44945
|
/**
|
|
@@ -44362,10 +44949,10 @@ export const FeatureLimitsAdminApiFp = function(configuration?: Configuration) {
|
|
|
44362
44949
|
* @param {*} [options] Override http request option.
|
|
44363
44950
|
* @throws {RequiredError}
|
|
44364
44951
|
*/
|
|
44365
|
-
async
|
|
44366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
44952
|
+
async adminV1FeatureLimitsResetPost(featureName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
44953
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1FeatureLimitsResetPost(featureName, options);
|
|
44367
44954
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
44368
|
-
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.
|
|
44955
|
+
const localVarOperationServerBasePath = operationServerMap['FeatureLimitsAdminApi.adminV1FeatureLimitsResetPost']?.[localVarOperationServerIndex]?.url;
|
|
44369
44956
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
44370
44957
|
},
|
|
44371
44958
|
}
|
|
@@ -44384,8 +44971,8 @@ export const FeatureLimitsAdminApiFactory = function (configuration?: Configurat
|
|
|
44384
44971
|
* @param {*} [options] Override http request option.
|
|
44385
44972
|
* @throws {RequiredError}
|
|
44386
44973
|
*/
|
|
44387
|
-
|
|
44388
|
-
return localVarFp.
|
|
44974
|
+
adminV1FeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
44975
|
+
return localVarFp.adminV1FeatureLimitsCacheInvalidatePost(options).then((request) => request(axios, basePath));
|
|
44389
44976
|
},
|
|
44390
44977
|
/**
|
|
44391
44978
|
* Recalculates and syncs all metrics for the organization from source tables to database and Redis. For increment-based metrics (api_calls, analytics_events), only syncs if Redis is empty unless force=true
|
|
@@ -44394,8 +44981,8 @@ export const FeatureLimitsAdminApiFactory = function (configuration?: Configurat
|
|
|
44394
44981
|
* @param {*} [options] Override http request option.
|
|
44395
44982
|
* @throws {RequiredError}
|
|
44396
44983
|
*/
|
|
44397
|
-
|
|
44398
|
-
return localVarFp.
|
|
44984
|
+
adminV1FeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
44985
|
+
return localVarFp.adminV1FeatureLimitsMetricsSyncPost(force, options).then((request) => request(axios, basePath));
|
|
44399
44986
|
},
|
|
44400
44987
|
/**
|
|
44401
44988
|
* Resets usage counter for a specific feature (admin only)
|
|
@@ -44404,8 +44991,8 @@ export const FeatureLimitsAdminApiFactory = function (configuration?: Configurat
|
|
|
44404
44991
|
* @param {*} [options] Override http request option.
|
|
44405
44992
|
* @throws {RequiredError}
|
|
44406
44993
|
*/
|
|
44407
|
-
|
|
44408
|
-
return localVarFp.
|
|
44994
|
+
adminV1FeatureLimitsResetPost(featureName: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
44995
|
+
return localVarFp.adminV1FeatureLimitsResetPost(featureName, options).then((request) => request(axios, basePath));
|
|
44409
44996
|
},
|
|
44410
44997
|
};
|
|
44411
44998
|
};
|
|
@@ -44424,8 +45011,8 @@ export class FeatureLimitsAdminApi extends BaseAPI {
|
|
|
44424
45011
|
* @throws {RequiredError}
|
|
44425
45012
|
* @memberof FeatureLimitsAdminApi
|
|
44426
45013
|
*/
|
|
44427
|
-
public
|
|
44428
|
-
return FeatureLimitsAdminApiFp(this.configuration).
|
|
45014
|
+
public adminV1FeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig) {
|
|
45015
|
+
return FeatureLimitsAdminApiFp(this.configuration).adminV1FeatureLimitsCacheInvalidatePost(options).then((request) => request(this.axios, this.basePath));
|
|
44429
45016
|
}
|
|
44430
45017
|
|
|
44431
45018
|
/**
|
|
@@ -44436,8 +45023,8 @@ export class FeatureLimitsAdminApi extends BaseAPI {
|
|
|
44436
45023
|
* @throws {RequiredError}
|
|
44437
45024
|
* @memberof FeatureLimitsAdminApi
|
|
44438
45025
|
*/
|
|
44439
|
-
public
|
|
44440
|
-
return FeatureLimitsAdminApiFp(this.configuration).
|
|
45026
|
+
public adminV1FeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig) {
|
|
45027
|
+
return FeatureLimitsAdminApiFp(this.configuration).adminV1FeatureLimitsMetricsSyncPost(force, options).then((request) => request(this.axios, this.basePath));
|
|
44441
45028
|
}
|
|
44442
45029
|
|
|
44443
45030
|
/**
|
|
@@ -44448,8 +45035,8 @@ export class FeatureLimitsAdminApi extends BaseAPI {
|
|
|
44448
45035
|
* @throws {RequiredError}
|
|
44449
45036
|
* @memberof FeatureLimitsAdminApi
|
|
44450
45037
|
*/
|
|
44451
|
-
public
|
|
44452
|
-
return FeatureLimitsAdminApiFp(this.configuration).
|
|
45038
|
+
public adminV1FeatureLimitsResetPost(featureName: string, options?: RawAxiosRequestConfig) {
|
|
45039
|
+
return FeatureLimitsAdminApiFp(this.configuration).adminV1FeatureLimitsResetPost(featureName, options).then((request) => request(this.axios, this.basePath));
|
|
44453
45040
|
}
|
|
44454
45041
|
}
|
|
44455
45042
|
|