@seekora-ai/admin-api 1.1.14 → 1.1.16
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 +46 -2
- package/api.ts +2479 -0
- package/dist/api.d.ts +1926 -0
- package/dist/api.js +986 -13
- package/dist/esm/api.d.ts +1926 -0
- package/dist/esm/api.js +981 -8
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.16.tgz +0 -0
- package/seekora-ai-admin-api-1.1.14.tgz +0 -0
package/api.ts
CHANGED
|
@@ -711,6 +711,49 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
711
711
|
*/
|
|
712
712
|
'total'?: number;
|
|
713
713
|
}
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @export
|
|
717
|
+
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
718
|
+
*/
|
|
719
|
+
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
720
|
+
/**
|
|
721
|
+
* Comparison metadata when in compare mode
|
|
722
|
+
* @type {AnalyticsComparisonMeta}
|
|
723
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
724
|
+
*/
|
|
725
|
+
'comparison'?: AnalyticsComparisonMeta;
|
|
726
|
+
/**
|
|
727
|
+
*
|
|
728
|
+
* @type {AnalyticsQueryInsights}
|
|
729
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
730
|
+
*/
|
|
731
|
+
'data'?: AnalyticsQueryInsights;
|
|
732
|
+
/**
|
|
733
|
+
*
|
|
734
|
+
* @type {string}
|
|
735
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
736
|
+
*/
|
|
737
|
+
'error'?: string;
|
|
738
|
+
/**
|
|
739
|
+
*
|
|
740
|
+
* @type {string}
|
|
741
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
742
|
+
*/
|
|
743
|
+
'status'?: string;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
748
|
+
*/
|
|
749
|
+
'timestamp'?: string;
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @type {number}
|
|
753
|
+
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
754
|
+
*/
|
|
755
|
+
'total'?: number;
|
|
756
|
+
}
|
|
714
757
|
/**
|
|
715
758
|
*
|
|
716
759
|
* @export
|
|
@@ -1424,6 +1467,153 @@ export interface AnalyticsAnalyticsAPIResponse {
|
|
|
1424
1467
|
*/
|
|
1425
1468
|
'total'?: number;
|
|
1426
1469
|
}
|
|
1470
|
+
/**
|
|
1471
|
+
*
|
|
1472
|
+
* @export
|
|
1473
|
+
* @interface AnalyticsArrayElementAnalytic
|
|
1474
|
+
*/
|
|
1475
|
+
export interface AnalyticsArrayElementAnalytic {
|
|
1476
|
+
/**
|
|
1477
|
+
* Position in array (0-based)
|
|
1478
|
+
* @type {number}
|
|
1479
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1480
|
+
*/
|
|
1481
|
+
'array_index'?: number;
|
|
1482
|
+
/**
|
|
1483
|
+
* Total array size
|
|
1484
|
+
* @type {number}
|
|
1485
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1486
|
+
*/
|
|
1487
|
+
'array_length'?: number;
|
|
1488
|
+
/**
|
|
1489
|
+
* Average results when this element is used
|
|
1490
|
+
* @type {number}
|
|
1491
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1492
|
+
*/
|
|
1493
|
+
'avg_results_count'?: number;
|
|
1494
|
+
/**
|
|
1495
|
+
* e.g., \"tags\"
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1498
|
+
*/
|
|
1499
|
+
'filter_key'?: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* e.g., \"fashion\"
|
|
1502
|
+
* @type {string}
|
|
1503
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1504
|
+
*/
|
|
1505
|
+
'filter_value'?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* \"array\", \"object\", \"string\"
|
|
1508
|
+
* @type {string}
|
|
1509
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1510
|
+
*/
|
|
1511
|
+
'original_type'?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* How often this element appears at this position
|
|
1514
|
+
* @type {number}
|
|
1515
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1516
|
+
*/
|
|
1517
|
+
'position_popularity'?: number;
|
|
1518
|
+
/**
|
|
1519
|
+
* Percentage with results > 0
|
|
1520
|
+
* @type {number}
|
|
1521
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1522
|
+
*/
|
|
1523
|
+
'success_rate'?: number;
|
|
1524
|
+
/**
|
|
1525
|
+
* Unique searches using this element
|
|
1526
|
+
* @type {number}
|
|
1527
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1528
|
+
*/
|
|
1529
|
+
'unique_searches'?: number;
|
|
1530
|
+
/**
|
|
1531
|
+
* How many times this element was used
|
|
1532
|
+
* @type {number}
|
|
1533
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1534
|
+
*/
|
|
1535
|
+
'usage_count'?: number;
|
|
1536
|
+
/**
|
|
1537
|
+
* \"array_element\", \"object_key\", etc.
|
|
1538
|
+
* @type {string}
|
|
1539
|
+
* @memberof AnalyticsArrayElementAnalytic
|
|
1540
|
+
*/
|
|
1541
|
+
'value_type'?: string;
|
|
1542
|
+
}
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
* @export
|
|
1546
|
+
* @interface AnalyticsArrayFilterStats
|
|
1547
|
+
*/
|
|
1548
|
+
export interface AnalyticsArrayFilterStats {
|
|
1549
|
+
/**
|
|
1550
|
+
* Average array size
|
|
1551
|
+
* @type {number}
|
|
1552
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1553
|
+
*/
|
|
1554
|
+
'avg_array_length'?: number;
|
|
1555
|
+
/**
|
|
1556
|
+
* Largest array seen
|
|
1557
|
+
* @type {number}
|
|
1558
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1559
|
+
*/
|
|
1560
|
+
'max_array_length'?: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* Top values across all arrays
|
|
1563
|
+
* @type {Array<string>}
|
|
1564
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1565
|
+
*/
|
|
1566
|
+
'most_popular_values'?: Array<string>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Usage by array position
|
|
1569
|
+
* @type {Array<AnalyticsArrayPositionAnalytic>}
|
|
1570
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1571
|
+
*/
|
|
1572
|
+
'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Total times arrays were used for this filter
|
|
1575
|
+
* @type {number}
|
|
1576
|
+
* @memberof AnalyticsArrayFilterStats
|
|
1577
|
+
*/
|
|
1578
|
+
'total_array_usage'?: number;
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @export
|
|
1583
|
+
* @interface AnalyticsArrayPositionAnalytic
|
|
1584
|
+
*/
|
|
1585
|
+
export interface AnalyticsArrayPositionAnalytic {
|
|
1586
|
+
/**
|
|
1587
|
+
* Most popular value at this position
|
|
1588
|
+
* @type {string}
|
|
1589
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1590
|
+
*/
|
|
1591
|
+
'popular_value'?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* 0-based array position
|
|
1594
|
+
* @type {number}
|
|
1595
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1596
|
+
*/
|
|
1597
|
+
'position'?: number;
|
|
1598
|
+
/**
|
|
1599
|
+
* Success rate for searches with values at this position
|
|
1600
|
+
* @type {number}
|
|
1601
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1602
|
+
*/
|
|
1603
|
+
'success_rate'?: number;
|
|
1604
|
+
/**
|
|
1605
|
+
* Unique values at this position
|
|
1606
|
+
* @type {number}
|
|
1607
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1608
|
+
*/
|
|
1609
|
+
'unique_values'?: number;
|
|
1610
|
+
/**
|
|
1611
|
+
* Times this position was used
|
|
1612
|
+
* @type {number}
|
|
1613
|
+
* @memberof AnalyticsArrayPositionAnalytic
|
|
1614
|
+
*/
|
|
1615
|
+
'usage_count'?: number;
|
|
1616
|
+
}
|
|
1427
1617
|
/**
|
|
1428
1618
|
*
|
|
1429
1619
|
* @export
|
|
@@ -1678,6 +1868,43 @@ export interface AnalyticsCategoryWithCount {
|
|
|
1678
1868
|
*/
|
|
1679
1869
|
'value'?: string;
|
|
1680
1870
|
}
|
|
1871
|
+
/**
|
|
1872
|
+
*
|
|
1873
|
+
* @export
|
|
1874
|
+
* @interface AnalyticsClickPositionBucket
|
|
1875
|
+
*/
|
|
1876
|
+
export interface AnalyticsClickPositionBucket {
|
|
1877
|
+
/**
|
|
1878
|
+
*
|
|
1879
|
+
* @type {number}
|
|
1880
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1881
|
+
*/
|
|
1882
|
+
'click_rate'?: number;
|
|
1883
|
+
/**
|
|
1884
|
+
*
|
|
1885
|
+
* @type {number}
|
|
1886
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1887
|
+
*/
|
|
1888
|
+
'clicks'?: number;
|
|
1889
|
+
/**
|
|
1890
|
+
*
|
|
1891
|
+
* @type {number}
|
|
1892
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1893
|
+
*/
|
|
1894
|
+
'impressions'?: number;
|
|
1895
|
+
/**
|
|
1896
|
+
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
1897
|
+
* @type {string}
|
|
1898
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1899
|
+
*/
|
|
1900
|
+
'position_range'?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* percentage of total clicks for this query
|
|
1903
|
+
* @type {number}
|
|
1904
|
+
* @memberof AnalyticsClickPositionBucket
|
|
1905
|
+
*/
|
|
1906
|
+
'share'?: number;
|
|
1907
|
+
}
|
|
1681
1908
|
/**
|
|
1682
1909
|
*
|
|
1683
1910
|
* @export
|
|
@@ -2316,6 +2543,43 @@ export interface AnalyticsFilterEffectivenessCategory {
|
|
|
2316
2543
|
*/
|
|
2317
2544
|
'unique_searches'?: number;
|
|
2318
2545
|
}
|
|
2546
|
+
/**
|
|
2547
|
+
*
|
|
2548
|
+
* @export
|
|
2549
|
+
* @interface AnalyticsFilterEffectivenessMetrics
|
|
2550
|
+
*/
|
|
2551
|
+
export interface AnalyticsFilterEffectivenessMetrics {
|
|
2552
|
+
/**
|
|
2553
|
+
*
|
|
2554
|
+
* @type {number}
|
|
2555
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2556
|
+
*/
|
|
2557
|
+
'avg_results_count'?: number;
|
|
2558
|
+
/**
|
|
2559
|
+
*
|
|
2560
|
+
* @type {number}
|
|
2561
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2562
|
+
*/
|
|
2563
|
+
'click_through_rate'?: number;
|
|
2564
|
+
/**
|
|
2565
|
+
*
|
|
2566
|
+
* @type {number}
|
|
2567
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2568
|
+
*/
|
|
2569
|
+
'conversion_rate'?: number;
|
|
2570
|
+
/**
|
|
2571
|
+
*
|
|
2572
|
+
* @type {number}
|
|
2573
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2574
|
+
*/
|
|
2575
|
+
'search_count'?: number;
|
|
2576
|
+
/**
|
|
2577
|
+
* percentage with results > 0
|
|
2578
|
+
* @type {number}
|
|
2579
|
+
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2580
|
+
*/
|
|
2581
|
+
'success_rate'?: number;
|
|
2582
|
+
}
|
|
2319
2583
|
/**
|
|
2320
2584
|
*
|
|
2321
2585
|
* @export
|
|
@@ -2359,6 +2623,37 @@ export interface AnalyticsFilterEffectivenessSummary {
|
|
|
2359
2623
|
*/
|
|
2360
2624
|
'total_searches'?: number;
|
|
2361
2625
|
}
|
|
2626
|
+
/**
|
|
2627
|
+
*
|
|
2628
|
+
* @export
|
|
2629
|
+
* @interface AnalyticsFilterImprovementMetrics
|
|
2630
|
+
*/
|
|
2631
|
+
export interface AnalyticsFilterImprovementMetrics {
|
|
2632
|
+
/**
|
|
2633
|
+
* percentage points
|
|
2634
|
+
* @type {number}
|
|
2635
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2636
|
+
*/
|
|
2637
|
+
'conversion_improvement'?: number;
|
|
2638
|
+
/**
|
|
2639
|
+
* percentage points
|
|
2640
|
+
* @type {number}
|
|
2641
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2642
|
+
*/
|
|
2643
|
+
'ctr_improvement'?: number;
|
|
2644
|
+
/**
|
|
2645
|
+
* percentage
|
|
2646
|
+
* @type {number}
|
|
2647
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2648
|
+
*/
|
|
2649
|
+
'results_count_improvement'?: number;
|
|
2650
|
+
/**
|
|
2651
|
+
* percentage points
|
|
2652
|
+
* @type {number}
|
|
2653
|
+
* @memberof AnalyticsFilterImprovementMetrics
|
|
2654
|
+
*/
|
|
2655
|
+
'success_rate_improvement'?: number;
|
|
2656
|
+
}
|
|
2362
2657
|
/**
|
|
2363
2658
|
*
|
|
2364
2659
|
* @export
|
|
@@ -2584,6 +2879,73 @@ export interface AnalyticsFilterValueStatistic {
|
|
|
2584
2879
|
*/
|
|
2585
2880
|
'value_type'?: string;
|
|
2586
2881
|
}
|
|
2882
|
+
/**
|
|
2883
|
+
*
|
|
2884
|
+
* @export
|
|
2885
|
+
* @interface AnalyticsFilterValueUsage
|
|
2886
|
+
*/
|
|
2887
|
+
export interface AnalyticsFilterValueUsage {
|
|
2888
|
+
/**
|
|
2889
|
+
* Position in array (if applicable)
|
|
2890
|
+
* @type {number}
|
|
2891
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2892
|
+
*/
|
|
2893
|
+
'array_index'?: number;
|
|
2894
|
+
/**
|
|
2895
|
+
* Total array size (if applicable)
|
|
2896
|
+
* @type {number}
|
|
2897
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2898
|
+
*/
|
|
2899
|
+
'array_length'?: number;
|
|
2900
|
+
/**
|
|
2901
|
+
*
|
|
2902
|
+
* @type {number}
|
|
2903
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2904
|
+
*/
|
|
2905
|
+
'avg_results_count'?: number;
|
|
2906
|
+
/**
|
|
2907
|
+
* \"array\", \"object\", \"string\"
|
|
2908
|
+
* @type {string}
|
|
2909
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2910
|
+
*/
|
|
2911
|
+
'original_type'?: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Percentage of total usage for this filter key
|
|
2914
|
+
* @type {number}
|
|
2915
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2916
|
+
*/
|
|
2917
|
+
'share_of_filter_key'?: number;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {number}
|
|
2921
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2922
|
+
*/
|
|
2923
|
+
'success_rate'?: number;
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {number}
|
|
2927
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2928
|
+
*/
|
|
2929
|
+
'unique_searches'?: number;
|
|
2930
|
+
/**
|
|
2931
|
+
*
|
|
2932
|
+
* @type {number}
|
|
2933
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2934
|
+
*/
|
|
2935
|
+
'usage_count'?: number;
|
|
2936
|
+
/**
|
|
2937
|
+
*
|
|
2938
|
+
* @type {string}
|
|
2939
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2940
|
+
*/
|
|
2941
|
+
'value'?: string;
|
|
2942
|
+
/**
|
|
2943
|
+
* \"array_element\", \"object_key\", \"string\", etc.
|
|
2944
|
+
* @type {string}
|
|
2945
|
+
* @memberof AnalyticsFilterValueUsage
|
|
2946
|
+
*/
|
|
2947
|
+
'value_type'?: string;
|
|
2948
|
+
}
|
|
2587
2949
|
/**
|
|
2588
2950
|
*
|
|
2589
2951
|
* @export
|
|
@@ -4744,6 +5106,446 @@ export interface AnalyticsQueryAnalytic {
|
|
|
4744
5106
|
*/
|
|
4745
5107
|
'unique_users'?: number;
|
|
4746
5108
|
}
|
|
5109
|
+
/**
|
|
5110
|
+
*
|
|
5111
|
+
* @export
|
|
5112
|
+
* @interface AnalyticsQueryFilterAnalytics
|
|
5113
|
+
*/
|
|
5114
|
+
export interface AnalyticsQueryFilterAnalytics {
|
|
5115
|
+
/**
|
|
5116
|
+
* NEW: Individual array element insights
|
|
5117
|
+
* @type {Array<AnalyticsArrayElementAnalytic>}
|
|
5118
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5119
|
+
*/
|
|
5120
|
+
'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
|
|
5121
|
+
/**
|
|
5122
|
+
*
|
|
5123
|
+
* @type {number}
|
|
5124
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5125
|
+
*/
|
|
5126
|
+
'avg_filters_per_search'?: number;
|
|
5127
|
+
/**
|
|
5128
|
+
*
|
|
5129
|
+
* @type {Array<AnalyticsQueryFilterCombination>}
|
|
5130
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5131
|
+
*/
|
|
5132
|
+
'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
|
|
5133
|
+
/**
|
|
5134
|
+
*
|
|
5135
|
+
* @type {AnalyticsQueryFilterEffectiveness}
|
|
5136
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5137
|
+
*/
|
|
5138
|
+
'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
|
|
5139
|
+
/**
|
|
5140
|
+
*
|
|
5141
|
+
* @type {Array<AnalyticsQueryFilterTrend>}
|
|
5142
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5143
|
+
*/
|
|
5144
|
+
'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
|
|
5145
|
+
/**
|
|
5146
|
+
*
|
|
5147
|
+
* @type {number}
|
|
5148
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5149
|
+
*/
|
|
5150
|
+
'filter_usage_rate'?: number;
|
|
5151
|
+
/**
|
|
5152
|
+
* NEW: Enhanced filter usage with array data (removed omitempty to always show field)
|
|
5153
|
+
* @type {Array<AnalyticsQueryFilterUsage>}
|
|
5154
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5155
|
+
*/
|
|
5156
|
+
'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
|
|
5157
|
+
/**
|
|
5158
|
+
*
|
|
5159
|
+
* @type {number}
|
|
5160
|
+
* @memberof AnalyticsQueryFilterAnalytics
|
|
5161
|
+
*/
|
|
5162
|
+
'total_searches_with_filters'?: number;
|
|
5163
|
+
}
|
|
5164
|
+
/**
|
|
5165
|
+
*
|
|
5166
|
+
* @export
|
|
5167
|
+
* @interface AnalyticsQueryFilterCombination
|
|
5168
|
+
*/
|
|
5169
|
+
export interface AnalyticsQueryFilterCombination {
|
|
5170
|
+
/**
|
|
5171
|
+
*
|
|
5172
|
+
* @type {number}
|
|
5173
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5174
|
+
*/
|
|
5175
|
+
'avg_results_count'?: number;
|
|
5176
|
+
/**
|
|
5177
|
+
*
|
|
5178
|
+
* @type {Array<string>}
|
|
5179
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5180
|
+
*/
|
|
5181
|
+
'filters'?: Array<string>;
|
|
5182
|
+
/**
|
|
5183
|
+
* percentage of filtered searches
|
|
5184
|
+
* @type {number}
|
|
5185
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5186
|
+
*/
|
|
5187
|
+
'share'?: number;
|
|
5188
|
+
/**
|
|
5189
|
+
*
|
|
5190
|
+
* @type {number}
|
|
5191
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5192
|
+
*/
|
|
5193
|
+
'success_rate'?: number;
|
|
5194
|
+
/**
|
|
5195
|
+
*
|
|
5196
|
+
* @type {number}
|
|
5197
|
+
* @memberof AnalyticsQueryFilterCombination
|
|
5198
|
+
*/
|
|
5199
|
+
'usage_count'?: number;
|
|
5200
|
+
}
|
|
5201
|
+
/**
|
|
5202
|
+
*
|
|
5203
|
+
* @export
|
|
5204
|
+
* @interface AnalyticsQueryFilterEffectiveness
|
|
5205
|
+
*/
|
|
5206
|
+
export interface AnalyticsQueryFilterEffectiveness {
|
|
5207
|
+
/**
|
|
5208
|
+
*
|
|
5209
|
+
* @type {AnalyticsFilterImprovementMetrics}
|
|
5210
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5211
|
+
*/
|
|
5212
|
+
'improvement'?: AnalyticsFilterImprovementMetrics;
|
|
5213
|
+
/**
|
|
5214
|
+
*
|
|
5215
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5216
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5217
|
+
*/
|
|
5218
|
+
'with_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5219
|
+
/**
|
|
5220
|
+
*
|
|
5221
|
+
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5222
|
+
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5223
|
+
*/
|
|
5224
|
+
'without_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5225
|
+
}
|
|
5226
|
+
/**
|
|
5227
|
+
*
|
|
5228
|
+
* @export
|
|
5229
|
+
* @interface AnalyticsQueryFilterTrend
|
|
5230
|
+
*/
|
|
5231
|
+
export interface AnalyticsQueryFilterTrend {
|
|
5232
|
+
/**
|
|
5233
|
+
*
|
|
5234
|
+
* @type {string}
|
|
5235
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5236
|
+
*/
|
|
5237
|
+
'filter_key'?: string;
|
|
5238
|
+
/**
|
|
5239
|
+
*
|
|
5240
|
+
* @type {number}
|
|
5241
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5242
|
+
*/
|
|
5243
|
+
'growth_rate'?: number;
|
|
5244
|
+
/**
|
|
5245
|
+
* \"increasing\", \"decreasing\", \"stable\"
|
|
5246
|
+
* @type {string}
|
|
5247
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5248
|
+
*/
|
|
5249
|
+
'trend'?: string;
|
|
5250
|
+
/**
|
|
5251
|
+
*
|
|
5252
|
+
* @type {Array<AnalyticsTimeSeriesPoint>}
|
|
5253
|
+
* @memberof AnalyticsQueryFilterTrend
|
|
5254
|
+
*/
|
|
5255
|
+
'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
|
|
5256
|
+
}
|
|
5257
|
+
/**
|
|
5258
|
+
*
|
|
5259
|
+
* @export
|
|
5260
|
+
* @interface AnalyticsQueryFilterUsage
|
|
5261
|
+
*/
|
|
5262
|
+
export interface AnalyticsQueryFilterUsage {
|
|
5263
|
+
/**
|
|
5264
|
+
* Stats specific to array-type filters
|
|
5265
|
+
* @type {AnalyticsArrayFilterStats}
|
|
5266
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5267
|
+
*/
|
|
5268
|
+
'array_stats'?: AnalyticsArrayFilterStats;
|
|
5269
|
+
/**
|
|
5270
|
+
*
|
|
5271
|
+
* @type {number}
|
|
5272
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5273
|
+
*/
|
|
5274
|
+
'effectiveness_score'?: number;
|
|
5275
|
+
/**
|
|
5276
|
+
*
|
|
5277
|
+
* @type {string}
|
|
5278
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5279
|
+
*/
|
|
5280
|
+
'filter_key'?: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* Individual values with array explosion data
|
|
5283
|
+
* @type {Array<AnalyticsFilterValueUsage>}
|
|
5284
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5285
|
+
*/
|
|
5286
|
+
'filter_values'?: Array<AnalyticsFilterValueUsage>;
|
|
5287
|
+
/**
|
|
5288
|
+
* Total times this filter key was used
|
|
5289
|
+
* @type {number}
|
|
5290
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5291
|
+
*/
|
|
5292
|
+
'total_usage'?: number;
|
|
5293
|
+
/**
|
|
5294
|
+
* Unique searches using this filter
|
|
5295
|
+
* @type {number}
|
|
5296
|
+
* @memberof AnalyticsQueryFilterUsage
|
|
5297
|
+
*/
|
|
5298
|
+
'unique_searches'?: number;
|
|
5299
|
+
}
|
|
5300
|
+
/**
|
|
5301
|
+
*
|
|
5302
|
+
* @export
|
|
5303
|
+
* @interface AnalyticsQueryGeoAnalytic
|
|
5304
|
+
*/
|
|
5305
|
+
export interface AnalyticsQueryGeoAnalytic {
|
|
5306
|
+
/**
|
|
5307
|
+
*
|
|
5308
|
+
* @type {string}
|
|
5309
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5310
|
+
*/
|
|
5311
|
+
'city'?: string;
|
|
5312
|
+
/**
|
|
5313
|
+
* Clicks / Results Shown
|
|
5314
|
+
* @type {number}
|
|
5315
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5316
|
+
*/
|
|
5317
|
+
'click_through_rate'?: number;
|
|
5318
|
+
/**
|
|
5319
|
+
* Count of result-click events
|
|
5320
|
+
* @type {number}
|
|
5321
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5322
|
+
*/
|
|
5323
|
+
'clicks'?: number;
|
|
5324
|
+
/**
|
|
5325
|
+
* Conversions / Clicks (CVR)
|
|
5326
|
+
* @type {number}
|
|
5327
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5328
|
+
*/
|
|
5329
|
+
'conversion_rate'?: number;
|
|
5330
|
+
/**
|
|
5331
|
+
* Conversions / Searches
|
|
5332
|
+
* @type {number}
|
|
5333
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5334
|
+
*/
|
|
5335
|
+
'conversion_rate_per_search'?: number;
|
|
5336
|
+
/**
|
|
5337
|
+
* Post-click conversions attributed to search
|
|
5338
|
+
* @type {number}
|
|
5339
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5340
|
+
*/
|
|
5341
|
+
'conversions'?: number;
|
|
5342
|
+
/**
|
|
5343
|
+
*
|
|
5344
|
+
* @type {string}
|
|
5345
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5346
|
+
*/
|
|
5347
|
+
'country'?: string;
|
|
5348
|
+
/**
|
|
5349
|
+
*
|
|
5350
|
+
* @type {string}
|
|
5351
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5352
|
+
*/
|
|
5353
|
+
'country_code'?: string;
|
|
5354
|
+
/**
|
|
5355
|
+
* Searches with results but zero clicks / Results Shown
|
|
5356
|
+
* @type {number}
|
|
5357
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5358
|
+
*/
|
|
5359
|
+
'no_click_rate'?: number;
|
|
5360
|
+
/**
|
|
5361
|
+
* No-result searches / Searches
|
|
5362
|
+
* @type {number}
|
|
5363
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5364
|
+
*/
|
|
5365
|
+
'no_result_rate'?: number;
|
|
5366
|
+
/**
|
|
5367
|
+
*
|
|
5368
|
+
* @type {string}
|
|
5369
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5370
|
+
*/
|
|
5371
|
+
'region'?: string;
|
|
5372
|
+
/**
|
|
5373
|
+
* Count of searches that returned ≥1 result
|
|
5374
|
+
* @type {number}
|
|
5375
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5376
|
+
*/
|
|
5377
|
+
'results_shown'?: number;
|
|
5378
|
+
/**
|
|
5379
|
+
* Sum of attributed revenue
|
|
5380
|
+
* @type {number}
|
|
5381
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5382
|
+
*/
|
|
5383
|
+
'revenue'?: number;
|
|
5384
|
+
/**
|
|
5385
|
+
* Count of search events
|
|
5386
|
+
* @type {number}
|
|
5387
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5388
|
+
*/
|
|
5389
|
+
'searches'?: number;
|
|
5390
|
+
/**
|
|
5391
|
+
* percentage of total searches for this query
|
|
5392
|
+
* @type {number}
|
|
5393
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5394
|
+
*/
|
|
5395
|
+
'share'?: number;
|
|
5396
|
+
/**
|
|
5397
|
+
* Unique users
|
|
5398
|
+
* @type {number}
|
|
5399
|
+
* @memberof AnalyticsQueryGeoAnalytic
|
|
5400
|
+
*/
|
|
5401
|
+
'unique_users'?: number;
|
|
5402
|
+
}
|
|
5403
|
+
/**
|
|
5404
|
+
*
|
|
5405
|
+
* @export
|
|
5406
|
+
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
5407
|
+
*/
|
|
5408
|
+
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
5412
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5413
|
+
*/
|
|
5414
|
+
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
5415
|
+
/**
|
|
5416
|
+
*
|
|
5417
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5418
|
+
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5419
|
+
*/
|
|
5420
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5421
|
+
}
|
|
5422
|
+
/**
|
|
5423
|
+
*
|
|
5424
|
+
* @export
|
|
5425
|
+
* @interface AnalyticsQueryInsights
|
|
5426
|
+
*/
|
|
5427
|
+
export interface AnalyticsQueryInsights {
|
|
5428
|
+
/**
|
|
5429
|
+
* Average rank position of clicked results (renamed for clarity)
|
|
5430
|
+
* @type {number}
|
|
5431
|
+
* @memberof AnalyticsQueryInsights
|
|
5432
|
+
*/
|
|
5433
|
+
'avg_click_position'?: number;
|
|
5434
|
+
/**
|
|
5435
|
+
* Average rank of the top result shown per search
|
|
5436
|
+
* @type {number}
|
|
5437
|
+
* @memberof AnalyticsQueryInsights
|
|
5438
|
+
*/
|
|
5439
|
+
'avg_result_rank'?: number;
|
|
5440
|
+
/**
|
|
5441
|
+
*
|
|
5442
|
+
* @type {Array<AnalyticsClickPositionBucket>}
|
|
5443
|
+
* @memberof AnalyticsQueryInsights
|
|
5444
|
+
*/
|
|
5445
|
+
'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
|
|
5446
|
+
/**
|
|
5447
|
+
* Clicks / Results Shown
|
|
5448
|
+
* @type {number}
|
|
5449
|
+
* @memberof AnalyticsQueryInsights
|
|
5450
|
+
*/
|
|
5451
|
+
'click_through_rate'?: number;
|
|
5452
|
+
/**
|
|
5453
|
+
* Conversions / Clicks (CVR)
|
|
5454
|
+
* @type {number}
|
|
5455
|
+
* @memberof AnalyticsQueryInsights
|
|
5456
|
+
*/
|
|
5457
|
+
'conversion_rate'?: number;
|
|
5458
|
+
/**
|
|
5459
|
+
* Conversions / Searches
|
|
5460
|
+
* @type {number}
|
|
5461
|
+
* @memberof AnalyticsQueryInsights
|
|
5462
|
+
*/
|
|
5463
|
+
'conversion_rate_per_search'?: number;
|
|
5464
|
+
/**
|
|
5465
|
+
* Enhanced filter analytics
|
|
5466
|
+
* @type {AnalyticsQueryFilterAnalytics}
|
|
5467
|
+
* @memberof AnalyticsQueryInsights
|
|
5468
|
+
*/
|
|
5469
|
+
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
5470
|
+
/**
|
|
5471
|
+
*
|
|
5472
|
+
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
5473
|
+
* @memberof AnalyticsQueryInsights
|
|
5474
|
+
*/
|
|
5475
|
+
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
5476
|
+
/**
|
|
5477
|
+
*
|
|
5478
|
+
* @type {string}
|
|
5479
|
+
* @memberof AnalyticsQueryInsights
|
|
5480
|
+
*/
|
|
5481
|
+
'last_searched'?: string;
|
|
5482
|
+
/**
|
|
5483
|
+
* Searches with results but zero clicks / Results Shown
|
|
5484
|
+
* @type {number}
|
|
5485
|
+
* @memberof AnalyticsQueryInsights
|
|
5486
|
+
*/
|
|
5487
|
+
'no_click_rate'?: number;
|
|
5488
|
+
/**
|
|
5489
|
+
* No-result searches / Searches
|
|
5490
|
+
* @type {number}
|
|
5491
|
+
* @memberof AnalyticsQueryInsights
|
|
5492
|
+
*/
|
|
5493
|
+
'no_results_rate'?: number;
|
|
5494
|
+
/**
|
|
5495
|
+
*
|
|
5496
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
5497
|
+
* @memberof AnalyticsQueryInsights
|
|
5498
|
+
*/
|
|
5499
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
5500
|
+
/**
|
|
5501
|
+
*
|
|
5502
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
5503
|
+
* @memberof AnalyticsQueryInsights
|
|
5504
|
+
*/
|
|
5505
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
5506
|
+
/**
|
|
5507
|
+
*
|
|
5508
|
+
* @type {string}
|
|
5509
|
+
* @memberof AnalyticsQueryInsights
|
|
5510
|
+
*/
|
|
5511
|
+
'query'?: string;
|
|
5512
|
+
/**
|
|
5513
|
+
* Searches that returned ≥1 result
|
|
5514
|
+
* @type {number}
|
|
5515
|
+
* @memberof AnalyticsQueryInsights
|
|
5516
|
+
*/
|
|
5517
|
+
'results_shown'?: number;
|
|
5518
|
+
/**
|
|
5519
|
+
* Count of result-click events
|
|
5520
|
+
* @type {number}
|
|
5521
|
+
* @memberof AnalyticsQueryInsights
|
|
5522
|
+
*/
|
|
5523
|
+
'total_clicks'?: number;
|
|
5524
|
+
/**
|
|
5525
|
+
* Count of conversions
|
|
5526
|
+
* @type {number}
|
|
5527
|
+
* @memberof AnalyticsQueryInsights
|
|
5528
|
+
*/
|
|
5529
|
+
'total_conversions'?: number;
|
|
5530
|
+
/**
|
|
5531
|
+
* Sum of attributed revenue
|
|
5532
|
+
* @type {number}
|
|
5533
|
+
* @memberof AnalyticsQueryInsights
|
|
5534
|
+
*/
|
|
5535
|
+
'total_revenue'?: number;
|
|
5536
|
+
/**
|
|
5537
|
+
*
|
|
5538
|
+
* @type {number}
|
|
5539
|
+
* @memberof AnalyticsQueryInsights
|
|
5540
|
+
*/
|
|
5541
|
+
'total_searches'?: number;
|
|
5542
|
+
/**
|
|
5543
|
+
*
|
|
5544
|
+
* @type {number}
|
|
5545
|
+
* @memberof AnalyticsQueryInsights
|
|
5546
|
+
*/
|
|
5547
|
+
'unique_users'?: number;
|
|
5548
|
+
}
|
|
4747
5549
|
/**
|
|
4748
5550
|
*
|
|
4749
5551
|
* @export
|
|
@@ -4841,6 +5643,250 @@ export interface AnalyticsQueryPerformanceAnalytics {
|
|
|
4841
5643
|
*/
|
|
4842
5644
|
'unique_users'?: number;
|
|
4843
5645
|
}
|
|
5646
|
+
/**
|
|
5647
|
+
*
|
|
5648
|
+
* @export
|
|
5649
|
+
* @interface AnalyticsQueryPopularFilter
|
|
5650
|
+
*/
|
|
5651
|
+
export interface AnalyticsQueryPopularFilter {
|
|
5652
|
+
/**
|
|
5653
|
+
* Clicks / Results Shown
|
|
5654
|
+
* @type {number}
|
|
5655
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5656
|
+
*/
|
|
5657
|
+
'click_through_rate'?: number;
|
|
5658
|
+
/**
|
|
5659
|
+
* Count of result-click events
|
|
5660
|
+
* @type {number}
|
|
5661
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5662
|
+
*/
|
|
5663
|
+
'clicks'?: number;
|
|
5664
|
+
/**
|
|
5665
|
+
* Conversions / Clicks (CVR)
|
|
5666
|
+
* @type {number}
|
|
5667
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5668
|
+
*/
|
|
5669
|
+
'conversion_rate'?: number;
|
|
5670
|
+
/**
|
|
5671
|
+
* Conversions / Searches
|
|
5672
|
+
* @type {number}
|
|
5673
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5674
|
+
*/
|
|
5675
|
+
'conversion_rate_per_search'?: number;
|
|
5676
|
+
/**
|
|
5677
|
+
* Post-click conversions attributed to search
|
|
5678
|
+
* @type {number}
|
|
5679
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5680
|
+
*/
|
|
5681
|
+
'conversions'?: number;
|
|
5682
|
+
/**
|
|
5683
|
+
*
|
|
5684
|
+
* @type {string}
|
|
5685
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5686
|
+
*/
|
|
5687
|
+
'filter_key'?: string;
|
|
5688
|
+
/**
|
|
5689
|
+
*
|
|
5690
|
+
* @type {string}
|
|
5691
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5692
|
+
*/
|
|
5693
|
+
'filter_value'?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
* Searches with results but zero clicks / Results Shown
|
|
5696
|
+
* @type {number}
|
|
5697
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5698
|
+
*/
|
|
5699
|
+
'no_click_rate'?: number;
|
|
5700
|
+
/**
|
|
5701
|
+
* No-result searches / Searches
|
|
5702
|
+
* @type {number}
|
|
5703
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5704
|
+
*/
|
|
5705
|
+
'no_result_rate'?: number;
|
|
5706
|
+
/**
|
|
5707
|
+
* Count of searches that returned ≥1 result
|
|
5708
|
+
* @type {number}
|
|
5709
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5710
|
+
*/
|
|
5711
|
+
'results_shown'?: number;
|
|
5712
|
+
/**
|
|
5713
|
+
* Sum of attributed revenue
|
|
5714
|
+
* @type {number}
|
|
5715
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5716
|
+
*/
|
|
5717
|
+
'revenue'?: number;
|
|
5718
|
+
/**
|
|
5719
|
+
* Count of search events with this filter
|
|
5720
|
+
* @type {number}
|
|
5721
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5722
|
+
*/
|
|
5723
|
+
'searches'?: number;
|
|
5724
|
+
/**
|
|
5725
|
+
* percentage of searches with this filter
|
|
5726
|
+
* @type {number}
|
|
5727
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5728
|
+
*/
|
|
5729
|
+
'share'?: number;
|
|
5730
|
+
/**
|
|
5731
|
+
* Number of times this filter was used
|
|
5732
|
+
* @type {number}
|
|
5733
|
+
* @memberof AnalyticsQueryPopularFilter
|
|
5734
|
+
*/
|
|
5735
|
+
'usage_count'?: number;
|
|
5736
|
+
}
|
|
5737
|
+
/**
|
|
5738
|
+
*
|
|
5739
|
+
* @export
|
|
5740
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
5741
|
+
*/
|
|
5742
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
5743
|
+
/**
|
|
5744
|
+
*
|
|
5745
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
5746
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5747
|
+
*/
|
|
5748
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
5749
|
+
/**
|
|
5750
|
+
*
|
|
5751
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5752
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5753
|
+
*/
|
|
5754
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5755
|
+
}
|
|
5756
|
+
/**
|
|
5757
|
+
*
|
|
5758
|
+
* @export
|
|
5759
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
5760
|
+
*/
|
|
5761
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
5762
|
+
/**
|
|
5763
|
+
* Average rank position of clicked results
|
|
5764
|
+
* @type {number}
|
|
5765
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5766
|
+
*/
|
|
5767
|
+
'avg_click_rank'?: number;
|
|
5768
|
+
/**
|
|
5769
|
+
* Same as AvgResultRank (backward compatibility)
|
|
5770
|
+
* @type {number}
|
|
5771
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5772
|
+
*/
|
|
5773
|
+
'avg_position'?: number;
|
|
5774
|
+
/**
|
|
5775
|
+
* Average rank of the top result shown per search
|
|
5776
|
+
* @type {number}
|
|
5777
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5778
|
+
*/
|
|
5779
|
+
'avg_result_rank'?: number;
|
|
5780
|
+
/**
|
|
5781
|
+
* Clicks / Results Shown
|
|
5782
|
+
* @type {number}
|
|
5783
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5784
|
+
*/
|
|
5785
|
+
'click_through_rate'?: number;
|
|
5786
|
+
/**
|
|
5787
|
+
* Count of result-click events
|
|
5788
|
+
* @type {number}
|
|
5789
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5790
|
+
*/
|
|
5791
|
+
'clicks'?: number;
|
|
5792
|
+
/**
|
|
5793
|
+
* Conversions / Clicks (CVR)
|
|
5794
|
+
* @type {number}
|
|
5795
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5796
|
+
*/
|
|
5797
|
+
'conversion_rate'?: number;
|
|
5798
|
+
/**
|
|
5799
|
+
* Conversions / Searches
|
|
5800
|
+
* @type {number}
|
|
5801
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5802
|
+
*/
|
|
5803
|
+
'conversion_rate_per_search'?: number;
|
|
5804
|
+
/**
|
|
5805
|
+
* Post-click conversions attributed to search
|
|
5806
|
+
* @type {number}
|
|
5807
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5808
|
+
*/
|
|
5809
|
+
'conversions'?: number;
|
|
5810
|
+
/**
|
|
5811
|
+
* Count of times item was shown
|
|
5812
|
+
* @type {number}
|
|
5813
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5814
|
+
*/
|
|
5815
|
+
'impressions'?: number;
|
|
5816
|
+
/**
|
|
5817
|
+
*
|
|
5818
|
+
* @type {string}
|
|
5819
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5820
|
+
*/
|
|
5821
|
+
'item_id'?: string;
|
|
5822
|
+
/**
|
|
5823
|
+
*
|
|
5824
|
+
* @type {string}
|
|
5825
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5826
|
+
*/
|
|
5827
|
+
'item_name'?: string;
|
|
5828
|
+
/**
|
|
5829
|
+
* Searches with results but zero clicks / Results Shown
|
|
5830
|
+
* @type {number}
|
|
5831
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5832
|
+
*/
|
|
5833
|
+
'no_click_rate'?: number;
|
|
5834
|
+
/**
|
|
5835
|
+
* No-result searches / Searches
|
|
5836
|
+
* @type {number}
|
|
5837
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5838
|
+
*/
|
|
5839
|
+
'no_result_rate'?: number;
|
|
5840
|
+
/**
|
|
5841
|
+
* Count of searches that returned ≥1 result
|
|
5842
|
+
* @type {number}
|
|
5843
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5844
|
+
*/
|
|
5845
|
+
'results_shown'?: number;
|
|
5846
|
+
/**
|
|
5847
|
+
* Sum of attributed revenue
|
|
5848
|
+
* @type {number}
|
|
5849
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5850
|
+
*/
|
|
5851
|
+
'revenue'?: number;
|
|
5852
|
+
/**
|
|
5853
|
+
* Count of search events
|
|
5854
|
+
* @type {number}
|
|
5855
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5856
|
+
*/
|
|
5857
|
+
'searches'?: number;
|
|
5858
|
+
/**
|
|
5859
|
+
* percentage of total impressions for this query
|
|
5860
|
+
* @type {number}
|
|
5861
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5862
|
+
*/
|
|
5863
|
+
'share'?: number;
|
|
5864
|
+
/**
|
|
5865
|
+
* Widget display fields
|
|
5866
|
+
* @type {AnalyticsWidgetData}
|
|
5867
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5868
|
+
*/
|
|
5869
|
+
'widget'?: AnalyticsWidgetData;
|
|
5870
|
+
}
|
|
5871
|
+
/**
|
|
5872
|
+
*
|
|
5873
|
+
* @export
|
|
5874
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
5875
|
+
*/
|
|
5876
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
5877
|
+
/**
|
|
5878
|
+
*
|
|
5879
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
5880
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
5881
|
+
*/
|
|
5882
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
5883
|
+
/**
|
|
5884
|
+
*
|
|
5885
|
+
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5886
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
5887
|
+
*/
|
|
5888
|
+
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5889
|
+
}
|
|
4844
5890
|
/**
|
|
4845
5891
|
*
|
|
4846
5892
|
* @export
|
|
@@ -11674,6 +12720,31 @@ export interface DataTypesLimitResponse {
|
|
|
11674
12720
|
*/
|
|
11675
12721
|
'status'?: number;
|
|
11676
12722
|
}
|
|
12723
|
+
/**
|
|
12724
|
+
*
|
|
12725
|
+
* @export
|
|
12726
|
+
* @interface DataTypesLimitsListResponse
|
|
12727
|
+
*/
|
|
12728
|
+
export interface DataTypesLimitsListResponse {
|
|
12729
|
+
/**
|
|
12730
|
+
*
|
|
12731
|
+
* @type {Array<DataTypesLimit>}
|
|
12732
|
+
* @memberof DataTypesLimitsListResponse
|
|
12733
|
+
*/
|
|
12734
|
+
'data'?: Array<DataTypesLimit>;
|
|
12735
|
+
/**
|
|
12736
|
+
*
|
|
12737
|
+
* @type {string}
|
|
12738
|
+
* @memberof DataTypesLimitsListResponse
|
|
12739
|
+
*/
|
|
12740
|
+
'message'?: string;
|
|
12741
|
+
/**
|
|
12742
|
+
*
|
|
12743
|
+
* @type {number}
|
|
12744
|
+
* @memberof DataTypesLimitsListResponse
|
|
12745
|
+
*/
|
|
12746
|
+
'status'?: number;
|
|
12747
|
+
}
|
|
11677
12748
|
/**
|
|
11678
12749
|
*
|
|
11679
12750
|
* @export
|
|
@@ -12503,6 +13574,31 @@ export interface DataTypesNewsLetterRequestResponse {
|
|
|
12503
13574
|
*/
|
|
12504
13575
|
'status'?: number;
|
|
12505
13576
|
}
|
|
13577
|
+
/**
|
|
13578
|
+
*
|
|
13579
|
+
* @export
|
|
13580
|
+
* @interface DataTypesNewsLetterRequestsListResponse
|
|
13581
|
+
*/
|
|
13582
|
+
export interface DataTypesNewsLetterRequestsListResponse {
|
|
13583
|
+
/**
|
|
13584
|
+
*
|
|
13585
|
+
* @type {Array<DataTypesNewsLetterRequest>}
|
|
13586
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13587
|
+
*/
|
|
13588
|
+
'data'?: Array<DataTypesNewsLetterRequest>;
|
|
13589
|
+
/**
|
|
13590
|
+
*
|
|
13591
|
+
* @type {string}
|
|
13592
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13593
|
+
*/
|
|
13594
|
+
'message'?: string;
|
|
13595
|
+
/**
|
|
13596
|
+
*
|
|
13597
|
+
* @type {number}
|
|
13598
|
+
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13599
|
+
*/
|
|
13600
|
+
'status'?: number;
|
|
13601
|
+
}
|
|
12506
13602
|
/**
|
|
12507
13603
|
*
|
|
12508
13604
|
* @export
|
|
@@ -12541,6 +13637,105 @@ export interface DataTypesOTPPayload {
|
|
|
12541
13637
|
*/
|
|
12542
13638
|
'otp'?: string;
|
|
12543
13639
|
}
|
|
13640
|
+
/**
|
|
13641
|
+
*
|
|
13642
|
+
* @export
|
|
13643
|
+
* @interface DataTypesOfficialSearchResponse
|
|
13644
|
+
*/
|
|
13645
|
+
export interface DataTypesOfficialSearchResponse {
|
|
13646
|
+
/**
|
|
13647
|
+
*
|
|
13648
|
+
* @type {any}
|
|
13649
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13650
|
+
*/
|
|
13651
|
+
'facets'?: any;
|
|
13652
|
+
/**
|
|
13653
|
+
*
|
|
13654
|
+
* @type {number}
|
|
13655
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13656
|
+
*/
|
|
13657
|
+
'page'?: number;
|
|
13658
|
+
/**
|
|
13659
|
+
*
|
|
13660
|
+
* @type {number}
|
|
13661
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13662
|
+
*/
|
|
13663
|
+
'per_page'?: number;
|
|
13664
|
+
/**
|
|
13665
|
+
*
|
|
13666
|
+
* @type {Array<DataTypesOfficialSearchResult>}
|
|
13667
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13668
|
+
*/
|
|
13669
|
+
'results'?: Array<DataTypesOfficialSearchResult>;
|
|
13670
|
+
/**
|
|
13671
|
+
*
|
|
13672
|
+
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
13673
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13674
|
+
*/
|
|
13675
|
+
'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
|
|
13676
|
+
/**
|
|
13677
|
+
*
|
|
13678
|
+
* @type {number}
|
|
13679
|
+
* @memberof DataTypesOfficialSearchResponse
|
|
13680
|
+
*/
|
|
13681
|
+
'total_results'?: number;
|
|
13682
|
+
}
|
|
13683
|
+
/**
|
|
13684
|
+
*
|
|
13685
|
+
* @export
|
|
13686
|
+
* @interface DataTypesOfficialSearchResponseWrapper
|
|
13687
|
+
*/
|
|
13688
|
+
export interface DataTypesOfficialSearchResponseWrapper {
|
|
13689
|
+
/**
|
|
13690
|
+
*
|
|
13691
|
+
* @type {DataTypesOfficialSearchResponse}
|
|
13692
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13693
|
+
*/
|
|
13694
|
+
'data'?: DataTypesOfficialSearchResponse;
|
|
13695
|
+
/**
|
|
13696
|
+
*
|
|
13697
|
+
* @type {string}
|
|
13698
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13699
|
+
*/
|
|
13700
|
+
'message'?: string;
|
|
13701
|
+
/**
|
|
13702
|
+
*
|
|
13703
|
+
* @type {number}
|
|
13704
|
+
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13705
|
+
*/
|
|
13706
|
+
'status'?: number;
|
|
13707
|
+
}
|
|
13708
|
+
/**
|
|
13709
|
+
*
|
|
13710
|
+
* @export
|
|
13711
|
+
* @interface DataTypesOfficialSearchResult
|
|
13712
|
+
*/
|
|
13713
|
+
export interface DataTypesOfficialSearchResult {
|
|
13714
|
+
/**
|
|
13715
|
+
*
|
|
13716
|
+
* @type {{ [key: string]: any; }}
|
|
13717
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13718
|
+
*/
|
|
13719
|
+
'document'?: { [key: string]: any; };
|
|
13720
|
+
/**
|
|
13721
|
+
*
|
|
13722
|
+
* @type {{ [key: string]: any; }}
|
|
13723
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13724
|
+
*/
|
|
13725
|
+
'highlight'?: { [key: string]: any; };
|
|
13726
|
+
/**
|
|
13727
|
+
*
|
|
13728
|
+
* @type {string}
|
|
13729
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13730
|
+
*/
|
|
13731
|
+
'id'?: string;
|
|
13732
|
+
/**
|
|
13733
|
+
*
|
|
13734
|
+
* @type {number}
|
|
13735
|
+
* @memberof DataTypesOfficialSearchResult
|
|
13736
|
+
*/
|
|
13737
|
+
'score'?: number;
|
|
13738
|
+
}
|
|
12544
13739
|
/**
|
|
12545
13740
|
*
|
|
12546
13741
|
* @export
|
|
@@ -13548,6 +14743,31 @@ export interface DataTypesOrganizationTaxDetails {
|
|
|
13548
14743
|
*/
|
|
13549
14744
|
'tax_settings'?: { [key: string]: any; };
|
|
13550
14745
|
}
|
|
14746
|
+
/**
|
|
14747
|
+
*
|
|
14748
|
+
* @export
|
|
14749
|
+
* @interface DataTypesOrganizationsListResponse
|
|
14750
|
+
*/
|
|
14751
|
+
export interface DataTypesOrganizationsListResponse {
|
|
14752
|
+
/**
|
|
14753
|
+
*
|
|
14754
|
+
* @type {Array<DataTypesOrganization>}
|
|
14755
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14756
|
+
*/
|
|
14757
|
+
'data'?: Array<DataTypesOrganization>;
|
|
14758
|
+
/**
|
|
14759
|
+
*
|
|
14760
|
+
* @type {string}
|
|
14761
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14762
|
+
*/
|
|
14763
|
+
'message'?: string;
|
|
14764
|
+
/**
|
|
14765
|
+
*
|
|
14766
|
+
* @type {number}
|
|
14767
|
+
* @memberof DataTypesOrganizationsListResponse
|
|
14768
|
+
*/
|
|
14769
|
+
'status'?: number;
|
|
14770
|
+
}
|
|
13551
14771
|
/**
|
|
13552
14772
|
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
13553
14773
|
* @export
|
|
@@ -14050,6 +15270,31 @@ export interface DataTypesPaymentStatusPollResponse {
|
|
|
14050
15270
|
*/
|
|
14051
15271
|
'updated_at'?: string;
|
|
14052
15272
|
}
|
|
15273
|
+
/**
|
|
15274
|
+
*
|
|
15275
|
+
* @export
|
|
15276
|
+
* @interface DataTypesPaymentsListResponse
|
|
15277
|
+
*/
|
|
15278
|
+
export interface DataTypesPaymentsListResponse {
|
|
15279
|
+
/**
|
|
15280
|
+
*
|
|
15281
|
+
* @type {Array<DataTypesPayment>}
|
|
15282
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15283
|
+
*/
|
|
15284
|
+
'data'?: Array<DataTypesPayment>;
|
|
15285
|
+
/**
|
|
15286
|
+
*
|
|
15287
|
+
* @type {string}
|
|
15288
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15289
|
+
*/
|
|
15290
|
+
'message'?: string;
|
|
15291
|
+
/**
|
|
15292
|
+
*
|
|
15293
|
+
* @type {number}
|
|
15294
|
+
* @memberof DataTypesPaymentsListResponse
|
|
15295
|
+
*/
|
|
15296
|
+
'status'?: number;
|
|
15297
|
+
}
|
|
14053
15298
|
/**
|
|
14054
15299
|
*
|
|
14055
15300
|
* @export
|
|
@@ -14167,6 +15412,31 @@ export interface DataTypesPlanResponse {
|
|
|
14167
15412
|
*/
|
|
14168
15413
|
'status'?: number;
|
|
14169
15414
|
}
|
|
15415
|
+
/**
|
|
15416
|
+
*
|
|
15417
|
+
* @export
|
|
15418
|
+
* @interface DataTypesPlansListResponse
|
|
15419
|
+
*/
|
|
15420
|
+
export interface DataTypesPlansListResponse {
|
|
15421
|
+
/**
|
|
15422
|
+
*
|
|
15423
|
+
* @type {Array<DataTypesPlan>}
|
|
15424
|
+
* @memberof DataTypesPlansListResponse
|
|
15425
|
+
*/
|
|
15426
|
+
'data'?: Array<DataTypesPlan>;
|
|
15427
|
+
/**
|
|
15428
|
+
*
|
|
15429
|
+
* @type {string}
|
|
15430
|
+
* @memberof DataTypesPlansListResponse
|
|
15431
|
+
*/
|
|
15432
|
+
'message'?: string;
|
|
15433
|
+
/**
|
|
15434
|
+
*
|
|
15435
|
+
* @type {number}
|
|
15436
|
+
* @memberof DataTypesPlansListResponse
|
|
15437
|
+
*/
|
|
15438
|
+
'status'?: number;
|
|
15439
|
+
}
|
|
14170
15440
|
/**
|
|
14171
15441
|
*
|
|
14172
15442
|
* @export
|
|
@@ -14483,6 +15753,91 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
14483
15753
|
*/
|
|
14484
15754
|
'status'?: number;
|
|
14485
15755
|
}
|
|
15756
|
+
/**
|
|
15757
|
+
*
|
|
15758
|
+
* @export
|
|
15759
|
+
* @interface DataTypesPublicSearchRequest
|
|
15760
|
+
*/
|
|
15761
|
+
export interface DataTypesPublicSearchRequest {
|
|
15762
|
+
/**
|
|
15763
|
+
*
|
|
15764
|
+
* @type {Array<string>}
|
|
15765
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15766
|
+
*/
|
|
15767
|
+
'analytics_tags'?: Array<string>;
|
|
15768
|
+
/**
|
|
15769
|
+
*
|
|
15770
|
+
* @type {string}
|
|
15771
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15772
|
+
*/
|
|
15773
|
+
'facet_by'?: string;
|
|
15774
|
+
/**
|
|
15775
|
+
*
|
|
15776
|
+
* @type {string}
|
|
15777
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15778
|
+
*/
|
|
15779
|
+
'filter'?: string;
|
|
15780
|
+
/**
|
|
15781
|
+
*
|
|
15782
|
+
* @type {boolean}
|
|
15783
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15784
|
+
*/
|
|
15785
|
+
'include_suggestions'?: boolean;
|
|
15786
|
+
/**
|
|
15787
|
+
*
|
|
15788
|
+
* @type {number}
|
|
15789
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15790
|
+
*/
|
|
15791
|
+
'max_facet_values'?: number;
|
|
15792
|
+
/**
|
|
15793
|
+
*
|
|
15794
|
+
* @type {number}
|
|
15795
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15796
|
+
*/
|
|
15797
|
+
'page'?: number;
|
|
15798
|
+
/**
|
|
15799
|
+
*
|
|
15800
|
+
* @type {number}
|
|
15801
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15802
|
+
*/
|
|
15803
|
+
'per_page'?: number;
|
|
15804
|
+
/**
|
|
15805
|
+
*
|
|
15806
|
+
* @type {string}
|
|
15807
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15808
|
+
*/
|
|
15809
|
+
'q': string;
|
|
15810
|
+
/**
|
|
15811
|
+
*
|
|
15812
|
+
* @type {string}
|
|
15813
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15814
|
+
*/
|
|
15815
|
+
'sort'?: string;
|
|
15816
|
+
/**
|
|
15817
|
+
* IDs of stopword sets to use
|
|
15818
|
+
* @type {Array<string>}
|
|
15819
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15820
|
+
*/
|
|
15821
|
+
'stopword_sets'?: Array<string>;
|
|
15822
|
+
/**
|
|
15823
|
+
*
|
|
15824
|
+
* @type {number}
|
|
15825
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15826
|
+
*/
|
|
15827
|
+
'suggestions_limit'?: number;
|
|
15828
|
+
/**
|
|
15829
|
+
* IDs of synonym sets to use
|
|
15830
|
+
* @type {Array<string>}
|
|
15831
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15832
|
+
*/
|
|
15833
|
+
'synonym_sets'?: Array<string>;
|
|
15834
|
+
/**
|
|
15835
|
+
* If true, returns only display fields instead of full document (used in public API only)
|
|
15836
|
+
* @type {boolean}
|
|
15837
|
+
* @memberof DataTypesPublicSearchRequest
|
|
15838
|
+
*/
|
|
15839
|
+
'widget_mode'?: boolean;
|
|
15840
|
+
}
|
|
14486
15841
|
/**
|
|
14487
15842
|
*
|
|
14488
15843
|
* @export
|
|
@@ -15497,6 +16852,31 @@ export interface DataTypesRoleRightsListResponse {
|
|
|
15497
16852
|
*/
|
|
15498
16853
|
'status'?: number;
|
|
15499
16854
|
}
|
|
16855
|
+
/**
|
|
16856
|
+
*
|
|
16857
|
+
* @export
|
|
16858
|
+
* @interface DataTypesRolesListResponse
|
|
16859
|
+
*/
|
|
16860
|
+
export interface DataTypesRolesListResponse {
|
|
16861
|
+
/**
|
|
16862
|
+
*
|
|
16863
|
+
* @type {Array<DataTypesRole>}
|
|
16864
|
+
* @memberof DataTypesRolesListResponse
|
|
16865
|
+
*/
|
|
16866
|
+
'data'?: Array<DataTypesRole>;
|
|
16867
|
+
/**
|
|
16868
|
+
*
|
|
16869
|
+
* @type {string}
|
|
16870
|
+
* @memberof DataTypesRolesListResponse
|
|
16871
|
+
*/
|
|
16872
|
+
'message'?: string;
|
|
16873
|
+
/**
|
|
16874
|
+
*
|
|
16875
|
+
* @type {number}
|
|
16876
|
+
* @memberof DataTypesRolesListResponse
|
|
16877
|
+
*/
|
|
16878
|
+
'status'?: number;
|
|
16879
|
+
}
|
|
15500
16880
|
/**
|
|
15501
16881
|
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
15502
16882
|
* @export
|
|
@@ -16052,6 +17432,31 @@ export interface DataTypesServiceRequestResponse {
|
|
|
16052
17432
|
*/
|
|
16053
17433
|
'status'?: number;
|
|
16054
17434
|
}
|
|
17435
|
+
/**
|
|
17436
|
+
*
|
|
17437
|
+
* @export
|
|
17438
|
+
* @interface DataTypesServiceRequestsListResponse
|
|
17439
|
+
*/
|
|
17440
|
+
export interface DataTypesServiceRequestsListResponse {
|
|
17441
|
+
/**
|
|
17442
|
+
*
|
|
17443
|
+
* @type {Array<DataTypesServiceRequest>}
|
|
17444
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17445
|
+
*/
|
|
17446
|
+
'data'?: Array<DataTypesServiceRequest>;
|
|
17447
|
+
/**
|
|
17448
|
+
*
|
|
17449
|
+
* @type {string}
|
|
17450
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17451
|
+
*/
|
|
17452
|
+
'message'?: string;
|
|
17453
|
+
/**
|
|
17454
|
+
*
|
|
17455
|
+
* @type {number}
|
|
17456
|
+
* @memberof DataTypesServiceRequestsListResponse
|
|
17457
|
+
*/
|
|
17458
|
+
'status'?: number;
|
|
17459
|
+
}
|
|
16055
17460
|
/**
|
|
16056
17461
|
*
|
|
16057
17462
|
* @export
|
|
@@ -16917,6 +18322,31 @@ export interface DataTypesSubscriptionResponse {
|
|
|
16917
18322
|
*/
|
|
16918
18323
|
'status'?: number;
|
|
16919
18324
|
}
|
|
18325
|
+
/**
|
|
18326
|
+
*
|
|
18327
|
+
* @export
|
|
18328
|
+
* @interface DataTypesSubscriptionsListResponse
|
|
18329
|
+
*/
|
|
18330
|
+
export interface DataTypesSubscriptionsListResponse {
|
|
18331
|
+
/**
|
|
18332
|
+
*
|
|
18333
|
+
* @type {Array<DataTypesSubscription>}
|
|
18334
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18335
|
+
*/
|
|
18336
|
+
'data'?: Array<DataTypesSubscription>;
|
|
18337
|
+
/**
|
|
18338
|
+
*
|
|
18339
|
+
* @type {string}
|
|
18340
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18341
|
+
*/
|
|
18342
|
+
'message'?: string;
|
|
18343
|
+
/**
|
|
18344
|
+
*
|
|
18345
|
+
* @type {number}
|
|
18346
|
+
* @memberof DataTypesSubscriptionsListResponse
|
|
18347
|
+
*/
|
|
18348
|
+
'status'?: number;
|
|
18349
|
+
}
|
|
16920
18350
|
/**
|
|
16921
18351
|
*
|
|
16922
18352
|
* @export
|
|
@@ -22678,6 +24108,177 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
22678
24108
|
|
|
22679
24109
|
|
|
22680
24110
|
|
|
24111
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24112
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24113
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24114
|
+
|
|
24115
|
+
return {
|
|
24116
|
+
url: toPathString(localVarUrlObj),
|
|
24117
|
+
options: localVarRequestOptions,
|
|
24118
|
+
};
|
|
24119
|
+
},
|
|
24120
|
+
/**
|
|
24121
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
24122
|
+
* @summary Get Query Insights
|
|
24123
|
+
* @param {string} xStoreID Store ID
|
|
24124
|
+
* @param {string} query Search query to analyze
|
|
24125
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
24126
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
24127
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
24128
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
24129
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
24130
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
24131
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
24132
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
24133
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
24134
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
24135
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
24136
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
24137
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
24138
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
24139
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
24140
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
24141
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
24142
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
24143
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
24144
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
24145
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
24146
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
24147
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
24148
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
24149
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
24150
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
24151
|
+
* @param {*} [options] Override http request option.
|
|
24152
|
+
* @throws {RequiredError}
|
|
24153
|
+
*/
|
|
24154
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24155
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
24156
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
24157
|
+
// verify required parameter 'query' is not null or undefined
|
|
24158
|
+
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'query', query)
|
|
24159
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/{query}/insights`
|
|
24160
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
24161
|
+
.replace(`{${"query"}}`, encodeURIComponent(String(query)));
|
|
24162
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24163
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24164
|
+
let baseOptions;
|
|
24165
|
+
if (configuration) {
|
|
24166
|
+
baseOptions = configuration.baseOptions;
|
|
24167
|
+
}
|
|
24168
|
+
|
|
24169
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24170
|
+
const localVarHeaderParameter = {} as any;
|
|
24171
|
+
const localVarQueryParameter = {} as any;
|
|
24172
|
+
|
|
24173
|
+
// authentication BearerAuth required
|
|
24174
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
24175
|
+
|
|
24176
|
+
if (startTime !== undefined) {
|
|
24177
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
24178
|
+
}
|
|
24179
|
+
|
|
24180
|
+
if (endTime !== undefined) {
|
|
24181
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
24182
|
+
}
|
|
24183
|
+
|
|
24184
|
+
if (analyticsTags !== undefined) {
|
|
24185
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
24186
|
+
}
|
|
24187
|
+
|
|
24188
|
+
if (tagsMatchMode !== undefined) {
|
|
24189
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
24190
|
+
}
|
|
24191
|
+
|
|
24192
|
+
if (tagsExclude !== undefined) {
|
|
24193
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
24194
|
+
}
|
|
24195
|
+
|
|
24196
|
+
if (tagKeyFilter !== undefined) {
|
|
24197
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
24198
|
+
}
|
|
24199
|
+
|
|
24200
|
+
if (tagValueFilter !== undefined) {
|
|
24201
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
24202
|
+
}
|
|
24203
|
+
|
|
24204
|
+
if (search !== undefined) {
|
|
24205
|
+
localVarQueryParameter['search'] = search;
|
|
24206
|
+
}
|
|
24207
|
+
|
|
24208
|
+
if (compareMode !== undefined) {
|
|
24209
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
24210
|
+
}
|
|
24211
|
+
|
|
24212
|
+
if (compareStartTime !== undefined) {
|
|
24213
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
24214
|
+
}
|
|
24215
|
+
|
|
24216
|
+
if (compareEndTime !== undefined) {
|
|
24217
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
24218
|
+
}
|
|
24219
|
+
|
|
24220
|
+
if (compareAnalyticsTags !== undefined) {
|
|
24221
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
24222
|
+
}
|
|
24223
|
+
|
|
24224
|
+
if (compareTagsMatchMode !== undefined) {
|
|
24225
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
24226
|
+
}
|
|
24227
|
+
|
|
24228
|
+
if (compareTagsExclude !== undefined) {
|
|
24229
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
24230
|
+
}
|
|
24231
|
+
|
|
24232
|
+
if (compareTagKeyFilter !== undefined) {
|
|
24233
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
24234
|
+
}
|
|
24235
|
+
|
|
24236
|
+
if (compareTagValueFilter !== undefined) {
|
|
24237
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
24238
|
+
}
|
|
24239
|
+
|
|
24240
|
+
if (resultsPage !== undefined) {
|
|
24241
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
24242
|
+
}
|
|
24243
|
+
|
|
24244
|
+
if (resultsPageSize !== undefined) {
|
|
24245
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
24246
|
+
}
|
|
24247
|
+
|
|
24248
|
+
if (resultsSearch !== undefined) {
|
|
24249
|
+
localVarQueryParameter['results_search'] = resultsSearch;
|
|
24250
|
+
}
|
|
24251
|
+
|
|
24252
|
+
if (filtersPage !== undefined) {
|
|
24253
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
24254
|
+
}
|
|
24255
|
+
|
|
24256
|
+
if (filtersPageSize !== undefined) {
|
|
24257
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
24258
|
+
}
|
|
24259
|
+
|
|
24260
|
+
if (filtersSearch !== undefined) {
|
|
24261
|
+
localVarQueryParameter['filters_search'] = filtersSearch;
|
|
24262
|
+
}
|
|
24263
|
+
|
|
24264
|
+
if (geoPage !== undefined) {
|
|
24265
|
+
localVarQueryParameter['geo_page'] = geoPage;
|
|
24266
|
+
}
|
|
24267
|
+
|
|
24268
|
+
if (geoPageSize !== undefined) {
|
|
24269
|
+
localVarQueryParameter['geo_page_size'] = geoPageSize;
|
|
24270
|
+
}
|
|
24271
|
+
|
|
24272
|
+
if (geoSearch !== undefined) {
|
|
24273
|
+
localVarQueryParameter['geo_search'] = geoSearch;
|
|
24274
|
+
}
|
|
24275
|
+
|
|
24276
|
+
if (includeWidget !== undefined) {
|
|
24277
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
24278
|
+
}
|
|
24279
|
+
|
|
24280
|
+
|
|
24281
|
+
|
|
22681
24282
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22682
24283
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22683
24284
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -23546,6 +25147,46 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
23546
25147
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
23547
25148
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23548
25149
|
},
|
|
25150
|
+
/**
|
|
25151
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
25152
|
+
* @summary Get Query Insights
|
|
25153
|
+
* @param {string} xStoreID Store ID
|
|
25154
|
+
* @param {string} query Search query to analyze
|
|
25155
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
25156
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
25157
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
25158
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
25159
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
25160
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
25161
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
25162
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
25163
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
25164
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
25165
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
25166
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
25167
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
25168
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
25169
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
25170
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
25171
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
25172
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
25173
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
25174
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
25175
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
25176
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
25177
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
25178
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
25179
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
25180
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
25181
|
+
* @param {*} [options] Override http request option.
|
|
25182
|
+
* @throws {RequiredError}
|
|
25183
|
+
*/
|
|
25184
|
+
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
25185
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options);
|
|
25186
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25187
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
25188
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25189
|
+
},
|
|
23549
25190
|
/**
|
|
23550
25191
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
23551
25192
|
* @summary Get Top Results Analytics
|
|
@@ -24008,6 +25649,43 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
24008
25649
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
24009
25650
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
24010
25651
|
},
|
|
25652
|
+
/**
|
|
25653
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
25654
|
+
* @summary Get Query Insights
|
|
25655
|
+
* @param {string} xStoreID Store ID
|
|
25656
|
+
* @param {string} query Search query to analyze
|
|
25657
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
25658
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
25659
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
25660
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
25661
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
25662
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
25663
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
25664
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
25665
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
25666
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
25667
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
25668
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
25669
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
25670
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
25671
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
25672
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
25673
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
25674
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
25675
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
25676
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
25677
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
25678
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
25679
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
25680
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
25681
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
25682
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
25683
|
+
* @param {*} [options] Override http request option.
|
|
25684
|
+
* @throws {RequiredError}
|
|
25685
|
+
*/
|
|
25686
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
25687
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(axios, basePath));
|
|
25688
|
+
},
|
|
24011
25689
|
/**
|
|
24012
25690
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
24013
25691
|
* @summary Get Top Results Analytics
|
|
@@ -24483,6 +26161,45 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
24483
26161
|
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
24484
26162
|
}
|
|
24485
26163
|
|
|
26164
|
+
/**
|
|
26165
|
+
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
26166
|
+
* @summary Get Query Insights
|
|
26167
|
+
* @param {string} xStoreID Store ID
|
|
26168
|
+
* @param {string} query Search query to analyze
|
|
26169
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
26170
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
26171
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
26172
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
26173
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
26174
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
26175
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
26176
|
+
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
26177
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
26178
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
26179
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
26180
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
26181
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
26182
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
26183
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
26184
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
26185
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
26186
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
26187
|
+
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
26188
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
26189
|
+
* @param {number} [filtersPageSize] Number of filters per page
|
|
26190
|
+
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
26191
|
+
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
26192
|
+
* @param {number} [geoPageSize] Number of geo locations per page
|
|
26193
|
+
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
26194
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
26195
|
+
* @param {*} [options] Override http request option.
|
|
26196
|
+
* @throws {RequiredError}
|
|
26197
|
+
* @memberof AnalyticsApi
|
|
26198
|
+
*/
|
|
26199
|
+
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
26200
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, resultsSearch, filtersPage, filtersPageSize, filtersSearch, geoPage, geoPageSize, geoSearch, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
26201
|
+
}
|
|
26202
|
+
|
|
24486
26203
|
/**
|
|
24487
26204
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
24488
26205
|
* @summary Get Top Results Analytics
|
|
@@ -24909,6 +26626,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
24909
26626
|
Desc: 'desc'
|
|
24910
26627
|
} as const;
|
|
24911
26628
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
26629
|
+
/**
|
|
26630
|
+
* @export
|
|
26631
|
+
*/
|
|
26632
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = {
|
|
26633
|
+
Any: 'any',
|
|
26634
|
+
All: 'all'
|
|
26635
|
+
} as const;
|
|
26636
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
26637
|
+
/**
|
|
26638
|
+
* @export
|
|
26639
|
+
*/
|
|
26640
|
+
export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
|
|
26641
|
+
Any: 'any',
|
|
26642
|
+
All: 'all'
|
|
26643
|
+
} as const;
|
|
26644
|
+
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
24912
26645
|
/**
|
|
24913
26646
|
* @export
|
|
24914
26647
|
*/
|
|
@@ -35647,6 +37380,39 @@ export const LimitsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
35647
37380
|
|
|
35648
37381
|
|
|
35649
37382
|
|
|
37383
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37384
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37385
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
37386
|
+
|
|
37387
|
+
return {
|
|
37388
|
+
url: toPathString(localVarUrlObj),
|
|
37389
|
+
options: localVarRequestOptions,
|
|
37390
|
+
};
|
|
37391
|
+
},
|
|
37392
|
+
/**
|
|
37393
|
+
* Fetches list of all limits
|
|
37394
|
+
* @summary Fetches list of all limits
|
|
37395
|
+
* @param {*} [options] Override http request option.
|
|
37396
|
+
* @throws {RequiredError}
|
|
37397
|
+
*/
|
|
37398
|
+
miscLimitsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37399
|
+
const localVarPath = `/misc/limits`;
|
|
37400
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37401
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37402
|
+
let baseOptions;
|
|
37403
|
+
if (configuration) {
|
|
37404
|
+
baseOptions = configuration.baseOptions;
|
|
37405
|
+
}
|
|
37406
|
+
|
|
37407
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
37408
|
+
const localVarHeaderParameter = {} as any;
|
|
37409
|
+
const localVarQueryParameter = {} as any;
|
|
37410
|
+
|
|
37411
|
+
// authentication BearerAuth required
|
|
37412
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
37413
|
+
|
|
37414
|
+
|
|
37415
|
+
|
|
35650
37416
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35651
37417
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35652
37418
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -35799,6 +37565,18 @@ export const LimitsApiFp = function(configuration?: Configuration) {
|
|
|
35799
37565
|
const localVarOperationServerBasePath = operationServerMap['LimitsApi.miscLimitsChangeStatusLimitIDIsActivePut']?.[localVarOperationServerIndex]?.url;
|
|
35800
37566
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35801
37567
|
},
|
|
37568
|
+
/**
|
|
37569
|
+
* Fetches list of all limits
|
|
37570
|
+
* @summary Fetches list of all limits
|
|
37571
|
+
* @param {*} [options] Override http request option.
|
|
37572
|
+
* @throws {RequiredError}
|
|
37573
|
+
*/
|
|
37574
|
+
async miscLimitsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLimitsListResponse>> {
|
|
37575
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscLimitsGet(options);
|
|
37576
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
37577
|
+
const localVarOperationServerBasePath = operationServerMap['LimitsApi.miscLimitsGet']?.[localVarOperationServerIndex]?.url;
|
|
37578
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
37579
|
+
},
|
|
35802
37580
|
/**
|
|
35803
37581
|
* Fetches limit by id
|
|
35804
37582
|
* @summary Fetches limit by id
|
|
@@ -35860,6 +37638,15 @@ export const LimitsApiFactory = function (configuration?: Configuration, basePat
|
|
|
35860
37638
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
35861
37639
|
return localVarFp.miscLimitsChangeStatusLimitIDIsActivePut(limitID, isActive, options).then((request) => request(axios, basePath));
|
|
35862
37640
|
},
|
|
37641
|
+
/**
|
|
37642
|
+
* Fetches list of all limits
|
|
37643
|
+
* @summary Fetches list of all limits
|
|
37644
|
+
* @param {*} [options] Override http request option.
|
|
37645
|
+
* @throws {RequiredError}
|
|
37646
|
+
*/
|
|
37647
|
+
miscLimitsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLimitsListResponse> {
|
|
37648
|
+
return localVarFp.miscLimitsGet(options).then((request) => request(axios, basePath));
|
|
37649
|
+
},
|
|
35863
37650
|
/**
|
|
35864
37651
|
* Fetches limit by id
|
|
35865
37652
|
* @summary Fetches limit by id
|
|
@@ -35914,6 +37701,17 @@ export class LimitsApi extends BaseAPI {
|
|
|
35914
37701
|
return LimitsApiFp(this.configuration).miscLimitsChangeStatusLimitIDIsActivePut(limitID, isActive, options).then((request) => request(this.axios, this.basePath));
|
|
35915
37702
|
}
|
|
35916
37703
|
|
|
37704
|
+
/**
|
|
37705
|
+
* Fetches list of all limits
|
|
37706
|
+
* @summary Fetches list of all limits
|
|
37707
|
+
* @param {*} [options] Override http request option.
|
|
37708
|
+
* @throws {RequiredError}
|
|
37709
|
+
* @memberof LimitsApi
|
|
37710
|
+
*/
|
|
37711
|
+
public miscLimitsGet(options?: RawAxiosRequestConfig) {
|
|
37712
|
+
return LimitsApiFp(this.configuration).miscLimitsGet(options).then((request) => request(this.axios, this.basePath));
|
|
37713
|
+
}
|
|
37714
|
+
|
|
35917
37715
|
/**
|
|
35918
37716
|
* Fetches limit by id
|
|
35919
37717
|
* @summary Fetches limit by id
|
|
@@ -35960,6 +37758,39 @@ export class LimitsApi extends BaseAPI {
|
|
|
35960
37758
|
*/
|
|
35961
37759
|
export const MenusApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35962
37760
|
return {
|
|
37761
|
+
/**
|
|
37762
|
+
* Fetches list of all menus
|
|
37763
|
+
* @summary Fetches list of all menus
|
|
37764
|
+
* @param {*} [options] Override http request option.
|
|
37765
|
+
* @throws {RequiredError}
|
|
37766
|
+
*/
|
|
37767
|
+
miscMenusGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
37768
|
+
const localVarPath = `/misc/menus`;
|
|
37769
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
37770
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
37771
|
+
let baseOptions;
|
|
37772
|
+
if (configuration) {
|
|
37773
|
+
baseOptions = configuration.baseOptions;
|
|
37774
|
+
}
|
|
37775
|
+
|
|
37776
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
37777
|
+
const localVarHeaderParameter = {} as any;
|
|
37778
|
+
const localVarQueryParameter = {} as any;
|
|
37779
|
+
|
|
37780
|
+
// authentication BearerAuth required
|
|
37781
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
37782
|
+
|
|
37783
|
+
|
|
37784
|
+
|
|
37785
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37786
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37787
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
37788
|
+
|
|
37789
|
+
return {
|
|
37790
|
+
url: toPathString(localVarUrlObj),
|
|
37791
|
+
options: localVarRequestOptions,
|
|
37792
|
+
};
|
|
37793
|
+
},
|
|
35963
37794
|
/**
|
|
35964
37795
|
* Deletes a menu from the system by ID.
|
|
35965
37796
|
* @summary Delete a menu
|
|
@@ -36495,6 +38326,18 @@ export const MenusApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
36495
38326
|
export const MenusApiFp = function(configuration?: Configuration) {
|
|
36496
38327
|
const localVarAxiosParamCreator = MenusApiAxiosParamCreator(configuration)
|
|
36497
38328
|
return {
|
|
38329
|
+
/**
|
|
38330
|
+
* Fetches list of all menus
|
|
38331
|
+
* @summary Fetches list of all menus
|
|
38332
|
+
* @param {*} [options] Override http request option.
|
|
38333
|
+
* @throws {RequiredError}
|
|
38334
|
+
*/
|
|
38335
|
+
async miscMenusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMenusListResponse>> {
|
|
38336
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscMenusGet(options);
|
|
38337
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
38338
|
+
const localVarOperationServerBasePath = operationServerMap['MenusApi.miscMenusGet']?.[localVarOperationServerIndex]?.url;
|
|
38339
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
38340
|
+
},
|
|
36498
38341
|
/**
|
|
36499
38342
|
* Deletes a menu from the system by ID.
|
|
36500
38343
|
* @summary Delete a menu
|
|
@@ -36682,6 +38525,15 @@ export const MenusApiFp = function(configuration?: Configuration) {
|
|
|
36682
38525
|
export const MenusApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
36683
38526
|
const localVarFp = MenusApiFp(configuration)
|
|
36684
38527
|
return {
|
|
38528
|
+
/**
|
|
38529
|
+
* Fetches list of all menus
|
|
38530
|
+
* @summary Fetches list of all menus
|
|
38531
|
+
* @param {*} [options] Override http request option.
|
|
38532
|
+
* @throws {RequiredError}
|
|
38533
|
+
*/
|
|
38534
|
+
miscMenusGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMenusListResponse> {
|
|
38535
|
+
return localVarFp.miscMenusGet(options).then((request) => request(axios, basePath));
|
|
38536
|
+
},
|
|
36685
38537
|
/**
|
|
36686
38538
|
* Deletes a menu from the system by ID.
|
|
36687
38539
|
* @summary Delete a menu
|
|
@@ -36830,6 +38682,17 @@ export const MenusApiFactory = function (configuration?: Configuration, basePath
|
|
|
36830
38682
|
* @extends {BaseAPI}
|
|
36831
38683
|
*/
|
|
36832
38684
|
export class MenusApi extends BaseAPI {
|
|
38685
|
+
/**
|
|
38686
|
+
* Fetches list of all menus
|
|
38687
|
+
* @summary Fetches list of all menus
|
|
38688
|
+
* @param {*} [options] Override http request option.
|
|
38689
|
+
* @throws {RequiredError}
|
|
38690
|
+
* @memberof MenusApi
|
|
38691
|
+
*/
|
|
38692
|
+
public miscMenusGet(options?: RawAxiosRequestConfig) {
|
|
38693
|
+
return MenusApiFp(this.configuration).miscMenusGet(options).then((request) => request(this.axios, this.basePath));
|
|
38694
|
+
}
|
|
38695
|
+
|
|
36833
38696
|
/**
|
|
36834
38697
|
* Deletes a menu from the system by ID.
|
|
36835
38698
|
* @summary Delete a menu
|
|
@@ -37866,6 +39729,39 @@ export class MongoDbApi extends BaseAPI {
|
|
|
37866
39729
|
*/
|
|
37867
39730
|
export const NewsLettersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
37868
39731
|
return {
|
|
39732
|
+
/**
|
|
39733
|
+
* Fetches list of all NewsLetterSubscription
|
|
39734
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
39735
|
+
* @param {*} [options] Override http request option.
|
|
39736
|
+
* @throws {RequiredError}
|
|
39737
|
+
*/
|
|
39738
|
+
miscNewsLettersGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
39739
|
+
const localVarPath = `/misc/NewsLetters`;
|
|
39740
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
39741
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
39742
|
+
let baseOptions;
|
|
39743
|
+
if (configuration) {
|
|
39744
|
+
baseOptions = configuration.baseOptions;
|
|
39745
|
+
}
|
|
39746
|
+
|
|
39747
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
39748
|
+
const localVarHeaderParameter = {} as any;
|
|
39749
|
+
const localVarQueryParameter = {} as any;
|
|
39750
|
+
|
|
39751
|
+
// authentication BearerAuth required
|
|
39752
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
39753
|
+
|
|
39754
|
+
|
|
39755
|
+
|
|
39756
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
39757
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
39758
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
39759
|
+
|
|
39760
|
+
return {
|
|
39761
|
+
url: toPathString(localVarUrlObj),
|
|
39762
|
+
options: localVarRequestOptions,
|
|
39763
|
+
};
|
|
39764
|
+
},
|
|
37869
39765
|
/**
|
|
37870
39766
|
* Fetches NewsLetterSubscription by id
|
|
37871
39767
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -38036,6 +39932,18 @@ export const NewsLettersApiAxiosParamCreator = function (configuration?: Configu
|
|
|
38036
39932
|
export const NewsLettersApiFp = function(configuration?: Configuration) {
|
|
38037
39933
|
const localVarAxiosParamCreator = NewsLettersApiAxiosParamCreator(configuration)
|
|
38038
39934
|
return {
|
|
39935
|
+
/**
|
|
39936
|
+
* Fetches list of all NewsLetterSubscription
|
|
39937
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
39938
|
+
* @param {*} [options] Override http request option.
|
|
39939
|
+
* @throws {RequiredError}
|
|
39940
|
+
*/
|
|
39941
|
+
async miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesNewsLetterRequestsListResponse>> {
|
|
39942
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscNewsLettersGet(options);
|
|
39943
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
39944
|
+
const localVarOperationServerBasePath = operationServerMap['NewsLettersApi.miscNewsLettersGet']?.[localVarOperationServerIndex]?.url;
|
|
39945
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
39946
|
+
},
|
|
38039
39947
|
/**
|
|
38040
39948
|
* Fetches NewsLetterSubscription by id
|
|
38041
39949
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -38100,6 +40008,15 @@ export const NewsLettersApiFp = function(configuration?: Configuration) {
|
|
|
38100
40008
|
export const NewsLettersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
38101
40009
|
const localVarFp = NewsLettersApiFp(configuration)
|
|
38102
40010
|
return {
|
|
40011
|
+
/**
|
|
40012
|
+
* Fetches list of all NewsLetterSubscription
|
|
40013
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
40014
|
+
* @param {*} [options] Override http request option.
|
|
40015
|
+
* @throws {RequiredError}
|
|
40016
|
+
*/
|
|
40017
|
+
miscNewsLettersGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesNewsLetterRequestsListResponse> {
|
|
40018
|
+
return localVarFp.miscNewsLettersGet(options).then((request) => request(axios, basePath));
|
|
40019
|
+
},
|
|
38103
40020
|
/**
|
|
38104
40021
|
* Fetches NewsLetterSubscription by id
|
|
38105
40022
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -38152,6 +40069,17 @@ export const NewsLettersApiFactory = function (configuration?: Configuration, ba
|
|
|
38152
40069
|
* @extends {BaseAPI}
|
|
38153
40070
|
*/
|
|
38154
40071
|
export class NewsLettersApi extends BaseAPI {
|
|
40072
|
+
/**
|
|
40073
|
+
* Fetches list of all NewsLetterSubscription
|
|
40074
|
+
* @summary Fetches list of all NewsLetterSubscription
|
|
40075
|
+
* @param {*} [options] Override http request option.
|
|
40076
|
+
* @throws {RequiredError}
|
|
40077
|
+
* @memberof NewsLettersApi
|
|
40078
|
+
*/
|
|
40079
|
+
public miscNewsLettersGet(options?: RawAxiosRequestConfig) {
|
|
40080
|
+
return NewsLettersApiFp(this.configuration).miscNewsLettersGet(options).then((request) => request(this.axios, this.basePath));
|
|
40081
|
+
}
|
|
40082
|
+
|
|
38155
40083
|
/**
|
|
38156
40084
|
* Fetches NewsLetterSubscription by id
|
|
38157
40085
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -38889,6 +40817,39 @@ export class OnboardingApi extends BaseAPI {
|
|
|
38889
40817
|
*/
|
|
38890
40818
|
export const OrganizationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
38891
40819
|
return {
|
|
40820
|
+
/**
|
|
40821
|
+
* Fetches list of all Organizations
|
|
40822
|
+
* @summary Fetches list of all Organizations
|
|
40823
|
+
* @param {*} [options] Override http request option.
|
|
40824
|
+
* @throws {RequiredError}
|
|
40825
|
+
*/
|
|
40826
|
+
adminOrganizationsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40827
|
+
const localVarPath = `/admin/Organizations`;
|
|
40828
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40829
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40830
|
+
let baseOptions;
|
|
40831
|
+
if (configuration) {
|
|
40832
|
+
baseOptions = configuration.baseOptions;
|
|
40833
|
+
}
|
|
40834
|
+
|
|
40835
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40836
|
+
const localVarHeaderParameter = {} as any;
|
|
40837
|
+
const localVarQueryParameter = {} as any;
|
|
40838
|
+
|
|
40839
|
+
// authentication BearerAuth required
|
|
40840
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
40841
|
+
|
|
40842
|
+
|
|
40843
|
+
|
|
40844
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40845
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40846
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40847
|
+
|
|
40848
|
+
return {
|
|
40849
|
+
url: toPathString(localVarUrlObj),
|
|
40850
|
+
options: localVarRequestOptions,
|
|
40851
|
+
};
|
|
40852
|
+
},
|
|
38892
40853
|
/**
|
|
38893
40854
|
* Updates Orgnization information by ID.
|
|
38894
40855
|
* @summary Update an existing Orgnization
|
|
@@ -39059,6 +41020,18 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
39059
41020
|
export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
39060
41021
|
const localVarAxiosParamCreator = OrganizationsApiAxiosParamCreator(configuration)
|
|
39061
41022
|
return {
|
|
41023
|
+
/**
|
|
41024
|
+
* Fetches list of all Organizations
|
|
41025
|
+
* @summary Fetches list of all Organizations
|
|
41026
|
+
* @param {*} [options] Override http request option.
|
|
41027
|
+
* @throws {RequiredError}
|
|
41028
|
+
*/
|
|
41029
|
+
async adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrganizationsListResponse>> {
|
|
41030
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminOrganizationsGet(options);
|
|
41031
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
41032
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.adminOrganizationsGet']?.[localVarOperationServerIndex]?.url;
|
|
41033
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41034
|
+
},
|
|
39062
41035
|
/**
|
|
39063
41036
|
* Updates Orgnization information by ID.
|
|
39064
41037
|
* @summary Update an existing Orgnization
|
|
@@ -39123,6 +41096,15 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
39123
41096
|
export const OrganizationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
39124
41097
|
const localVarFp = OrganizationsApiFp(configuration)
|
|
39125
41098
|
return {
|
|
41099
|
+
/**
|
|
41100
|
+
* Fetches list of all Organizations
|
|
41101
|
+
* @summary Fetches list of all Organizations
|
|
41102
|
+
* @param {*} [options] Override http request option.
|
|
41103
|
+
* @throws {RequiredError}
|
|
41104
|
+
*/
|
|
41105
|
+
adminOrganizationsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrganizationsListResponse> {
|
|
41106
|
+
return localVarFp.adminOrganizationsGet(options).then((request) => request(axios, basePath));
|
|
41107
|
+
},
|
|
39126
41108
|
/**
|
|
39127
41109
|
* Updates Orgnization information by ID.
|
|
39128
41110
|
* @summary Update an existing Orgnization
|
|
@@ -39175,6 +41157,17 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
39175
41157
|
* @extends {BaseAPI}
|
|
39176
41158
|
*/
|
|
39177
41159
|
export class OrganizationsApi extends BaseAPI {
|
|
41160
|
+
/**
|
|
41161
|
+
* Fetches list of all Organizations
|
|
41162
|
+
* @summary Fetches list of all Organizations
|
|
41163
|
+
* @param {*} [options] Override http request option.
|
|
41164
|
+
* @throws {RequiredError}
|
|
41165
|
+
* @memberof OrganizationsApi
|
|
41166
|
+
*/
|
|
41167
|
+
public adminOrganizationsGet(options?: RawAxiosRequestConfig) {
|
|
41168
|
+
return OrganizationsApiFp(this.configuration).adminOrganizationsGet(options).then((request) => request(this.axios, this.basePath));
|
|
41169
|
+
}
|
|
41170
|
+
|
|
39178
41171
|
/**
|
|
39179
41172
|
* Updates Orgnization information by ID.
|
|
39180
41173
|
* @summary Update an existing Orgnization
|
|
@@ -40701,6 +42694,39 @@ export class PaymentGatewayApi extends BaseAPI {
|
|
|
40701
42694
|
*/
|
|
40702
42695
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40703
42696
|
return {
|
|
42697
|
+
/**
|
|
42698
|
+
* Fetches list of all payments
|
|
42699
|
+
* @summary Fetches list of all payments
|
|
42700
|
+
* @param {*} [options] Override http request option.
|
|
42701
|
+
* @throws {RequiredError}
|
|
42702
|
+
*/
|
|
42703
|
+
adminPaymentsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42704
|
+
const localVarPath = `/admin/payments/`;
|
|
42705
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42706
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42707
|
+
let baseOptions;
|
|
42708
|
+
if (configuration) {
|
|
42709
|
+
baseOptions = configuration.baseOptions;
|
|
42710
|
+
}
|
|
42711
|
+
|
|
42712
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
42713
|
+
const localVarHeaderParameter = {} as any;
|
|
42714
|
+
const localVarQueryParameter = {} as any;
|
|
42715
|
+
|
|
42716
|
+
// authentication BearerAuth required
|
|
42717
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
42718
|
+
|
|
42719
|
+
|
|
42720
|
+
|
|
42721
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42722
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42723
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
42724
|
+
|
|
42725
|
+
return {
|
|
42726
|
+
url: toPathString(localVarUrlObj),
|
|
42727
|
+
options: localVarRequestOptions,
|
|
42728
|
+
};
|
|
42729
|
+
},
|
|
40704
42730
|
/**
|
|
40705
42731
|
* Deletes a payment from the system by ID.
|
|
40706
42732
|
* @summary Delete a payment
|
|
@@ -40867,6 +42893,18 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
40867
42893
|
export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
40868
42894
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
40869
42895
|
return {
|
|
42896
|
+
/**
|
|
42897
|
+
* Fetches list of all payments
|
|
42898
|
+
* @summary Fetches list of all payments
|
|
42899
|
+
* @param {*} [options] Override http request option.
|
|
42900
|
+
* @throws {RequiredError}
|
|
42901
|
+
*/
|
|
42902
|
+
async adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentsListResponse>> {
|
|
42903
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminPaymentsGet(options);
|
|
42904
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
42905
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentsApi.adminPaymentsGet']?.[localVarOperationServerIndex]?.url;
|
|
42906
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42907
|
+
},
|
|
40870
42908
|
/**
|
|
40871
42909
|
* Deletes a payment from the system by ID.
|
|
40872
42910
|
* @summary Delete a payment
|
|
@@ -40930,6 +42968,15 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
40930
42968
|
export const PaymentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
40931
42969
|
const localVarFp = PaymentsApiFp(configuration)
|
|
40932
42970
|
return {
|
|
42971
|
+
/**
|
|
42972
|
+
* Fetches list of all payments
|
|
42973
|
+
* @summary Fetches list of all payments
|
|
42974
|
+
* @param {*} [options] Override http request option.
|
|
42975
|
+
* @throws {RequiredError}
|
|
42976
|
+
*/
|
|
42977
|
+
adminPaymentsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentsListResponse> {
|
|
42978
|
+
return localVarFp.adminPaymentsGet(options).then((request) => request(axios, basePath));
|
|
42979
|
+
},
|
|
40933
42980
|
/**
|
|
40934
42981
|
* Deletes a payment from the system by ID.
|
|
40935
42982
|
* @summary Delete a payment
|
|
@@ -40981,6 +43028,17 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
40981
43028
|
* @extends {BaseAPI}
|
|
40982
43029
|
*/
|
|
40983
43030
|
export class PaymentsApi extends BaseAPI {
|
|
43031
|
+
/**
|
|
43032
|
+
* Fetches list of all payments
|
|
43033
|
+
* @summary Fetches list of all payments
|
|
43034
|
+
* @param {*} [options] Override http request option.
|
|
43035
|
+
* @throws {RequiredError}
|
|
43036
|
+
* @memberof PaymentsApi
|
|
43037
|
+
*/
|
|
43038
|
+
public adminPaymentsGet(options?: RawAxiosRequestConfig) {
|
|
43039
|
+
return PaymentsApiFp(this.configuration).adminPaymentsGet(options).then((request) => request(this.axios, this.basePath));
|
|
43040
|
+
}
|
|
43041
|
+
|
|
40984
43042
|
/**
|
|
40985
43043
|
* Deletes a payment from the system by ID.
|
|
40986
43044
|
* @summary Delete a payment
|
|
@@ -41039,6 +43097,39 @@ export class PaymentsApi extends BaseAPI {
|
|
|
41039
43097
|
*/
|
|
41040
43098
|
export const PlansApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
41041
43099
|
return {
|
|
43100
|
+
/**
|
|
43101
|
+
* Fetches list of all Plans
|
|
43102
|
+
* @summary Fetches list of all Plans
|
|
43103
|
+
* @param {*} [options] Override http request option.
|
|
43104
|
+
* @throws {RequiredError}
|
|
43105
|
+
*/
|
|
43106
|
+
miscPlansGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43107
|
+
const localVarPath = `/misc/Plans`;
|
|
43108
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43109
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43110
|
+
let baseOptions;
|
|
43111
|
+
if (configuration) {
|
|
43112
|
+
baseOptions = configuration.baseOptions;
|
|
43113
|
+
}
|
|
43114
|
+
|
|
43115
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
43116
|
+
const localVarHeaderParameter = {} as any;
|
|
43117
|
+
const localVarQueryParameter = {} as any;
|
|
43118
|
+
|
|
43119
|
+
// authentication BearerAuth required
|
|
43120
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
43121
|
+
|
|
43122
|
+
|
|
43123
|
+
|
|
43124
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43125
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43126
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43127
|
+
|
|
43128
|
+
return {
|
|
43129
|
+
url: toPathString(localVarUrlObj),
|
|
43130
|
+
options: localVarRequestOptions,
|
|
43131
|
+
};
|
|
43132
|
+
},
|
|
41042
43133
|
/**
|
|
41043
43134
|
* Fetches plan by id
|
|
41044
43135
|
* @summary Fetches plan by id
|
|
@@ -41209,6 +43300,18 @@ export const PlansApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
41209
43300
|
export const PlansApiFp = function(configuration?: Configuration) {
|
|
41210
43301
|
const localVarAxiosParamCreator = PlansApiAxiosParamCreator(configuration)
|
|
41211
43302
|
return {
|
|
43303
|
+
/**
|
|
43304
|
+
* Fetches list of all Plans
|
|
43305
|
+
* @summary Fetches list of all Plans
|
|
43306
|
+
* @param {*} [options] Override http request option.
|
|
43307
|
+
* @throws {RequiredError}
|
|
43308
|
+
*/
|
|
43309
|
+
async miscPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPlansListResponse>> {
|
|
43310
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscPlansGet(options);
|
|
43311
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
43312
|
+
const localVarOperationServerBasePath = operationServerMap['PlansApi.miscPlansGet']?.[localVarOperationServerIndex]?.url;
|
|
43313
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43314
|
+
},
|
|
41212
43315
|
/**
|
|
41213
43316
|
* Fetches plan by id
|
|
41214
43317
|
* @summary Fetches plan by id
|
|
@@ -41273,6 +43376,15 @@ export const PlansApiFp = function(configuration?: Configuration) {
|
|
|
41273
43376
|
export const PlansApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
41274
43377
|
const localVarFp = PlansApiFp(configuration)
|
|
41275
43378
|
return {
|
|
43379
|
+
/**
|
|
43380
|
+
* Fetches list of all Plans
|
|
43381
|
+
* @summary Fetches list of all Plans
|
|
43382
|
+
* @param {*} [options] Override http request option.
|
|
43383
|
+
* @throws {RequiredError}
|
|
43384
|
+
*/
|
|
43385
|
+
miscPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPlansListResponse> {
|
|
43386
|
+
return localVarFp.miscPlansGet(options).then((request) => request(axios, basePath));
|
|
43387
|
+
},
|
|
41276
43388
|
/**
|
|
41277
43389
|
* Fetches plan by id
|
|
41278
43390
|
* @summary Fetches plan by id
|
|
@@ -41325,6 +43437,17 @@ export const PlansApiFactory = function (configuration?: Configuration, basePath
|
|
|
41325
43437
|
* @extends {BaseAPI}
|
|
41326
43438
|
*/
|
|
41327
43439
|
export class PlansApi extends BaseAPI {
|
|
43440
|
+
/**
|
|
43441
|
+
* Fetches list of all Plans
|
|
43442
|
+
* @summary Fetches list of all Plans
|
|
43443
|
+
* @param {*} [options] Override http request option.
|
|
43444
|
+
* @throws {RequiredError}
|
|
43445
|
+
* @memberof PlansApi
|
|
43446
|
+
*/
|
|
43447
|
+
public miscPlansGet(options?: RawAxiosRequestConfig) {
|
|
43448
|
+
return PlansApiFp(this.configuration).miscPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
43449
|
+
}
|
|
43450
|
+
|
|
41328
43451
|
/**
|
|
41329
43452
|
* Fetches plan by id
|
|
41330
43453
|
* @summary Fetches plan by id
|
|
@@ -46239,6 +48362,39 @@ export class RegisterApi extends BaseAPI {
|
|
|
46239
48362
|
*/
|
|
46240
48363
|
export const RequestsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46241
48364
|
return {
|
|
48365
|
+
/**
|
|
48366
|
+
* Fetches list of all ServiceRequest
|
|
48367
|
+
* @summary Fetches list of all ServiceRequest
|
|
48368
|
+
* @param {*} [options] Override http request option.
|
|
48369
|
+
* @throws {RequiredError}
|
|
48370
|
+
*/
|
|
48371
|
+
miscRequestsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48372
|
+
const localVarPath = `/misc/Requests`;
|
|
48373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
48374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48375
|
+
let baseOptions;
|
|
48376
|
+
if (configuration) {
|
|
48377
|
+
baseOptions = configuration.baseOptions;
|
|
48378
|
+
}
|
|
48379
|
+
|
|
48380
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
48381
|
+
const localVarHeaderParameter = {} as any;
|
|
48382
|
+
const localVarQueryParameter = {} as any;
|
|
48383
|
+
|
|
48384
|
+
// authentication BearerAuth required
|
|
48385
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
48386
|
+
|
|
48387
|
+
|
|
48388
|
+
|
|
48389
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
48390
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48391
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
48392
|
+
|
|
48393
|
+
return {
|
|
48394
|
+
url: toPathString(localVarUrlObj),
|
|
48395
|
+
options: localVarRequestOptions,
|
|
48396
|
+
};
|
|
48397
|
+
},
|
|
46242
48398
|
/**
|
|
46243
48399
|
* Updates ServiceRequest information by ID.
|
|
46244
48400
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -46446,6 +48602,18 @@ export const RequestsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
46446
48602
|
export const RequestsApiFp = function(configuration?: Configuration) {
|
|
46447
48603
|
const localVarAxiosParamCreator = RequestsApiAxiosParamCreator(configuration)
|
|
46448
48604
|
return {
|
|
48605
|
+
/**
|
|
48606
|
+
* Fetches list of all ServiceRequest
|
|
48607
|
+
* @summary Fetches list of all ServiceRequest
|
|
48608
|
+
* @param {*} [options] Override http request option.
|
|
48609
|
+
* @throws {RequiredError}
|
|
48610
|
+
*/
|
|
48611
|
+
async miscRequestsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesServiceRequestsListResponse>> {
|
|
48612
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscRequestsGet(options);
|
|
48613
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
48614
|
+
const localVarOperationServerBasePath = operationServerMap['RequestsApi.miscRequestsGet']?.[localVarOperationServerIndex]?.url;
|
|
48615
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
48616
|
+
},
|
|
46449
48617
|
/**
|
|
46450
48618
|
* Updates ServiceRequest information by ID.
|
|
46451
48619
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -46523,6 +48691,15 @@ export const RequestsApiFp = function(configuration?: Configuration) {
|
|
|
46523
48691
|
export const RequestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
46524
48692
|
const localVarFp = RequestsApiFp(configuration)
|
|
46525
48693
|
return {
|
|
48694
|
+
/**
|
|
48695
|
+
* Fetches list of all ServiceRequest
|
|
48696
|
+
* @summary Fetches list of all ServiceRequest
|
|
48697
|
+
* @param {*} [options] Override http request option.
|
|
48698
|
+
* @throws {RequiredError}
|
|
48699
|
+
*/
|
|
48700
|
+
miscRequestsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesServiceRequestsListResponse> {
|
|
48701
|
+
return localVarFp.miscRequestsGet(options).then((request) => request(axios, basePath));
|
|
48702
|
+
},
|
|
46526
48703
|
/**
|
|
46527
48704
|
* Updates ServiceRequest information by ID.
|
|
46528
48705
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -46585,6 +48762,17 @@ export const RequestsApiFactory = function (configuration?: Configuration, baseP
|
|
|
46585
48762
|
* @extends {BaseAPI}
|
|
46586
48763
|
*/
|
|
46587
48764
|
export class RequestsApi extends BaseAPI {
|
|
48765
|
+
/**
|
|
48766
|
+
* Fetches list of all ServiceRequest
|
|
48767
|
+
* @summary Fetches list of all ServiceRequest
|
|
48768
|
+
* @param {*} [options] Override http request option.
|
|
48769
|
+
* @throws {RequiredError}
|
|
48770
|
+
* @memberof RequestsApi
|
|
48771
|
+
*/
|
|
48772
|
+
public miscRequestsGet(options?: RawAxiosRequestConfig) {
|
|
48773
|
+
return RequestsApiFp(this.configuration).miscRequestsGet(options).then((request) => request(this.axios, this.basePath));
|
|
48774
|
+
}
|
|
48775
|
+
|
|
46588
48776
|
/**
|
|
46589
48777
|
* Updates ServiceRequest information by ID.
|
|
46590
48778
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -46695,6 +48883,39 @@ export const RoleRightsApiAxiosParamCreator = function (configuration?: Configur
|
|
|
46695
48883
|
options: localVarRequestOptions,
|
|
46696
48884
|
};
|
|
46697
48885
|
},
|
|
48886
|
+
/**
|
|
48887
|
+
* Fetches list of all roleright
|
|
48888
|
+
* @summary Fetches list of all roleright
|
|
48889
|
+
* @param {*} [options] Override http request option.
|
|
48890
|
+
* @throws {RequiredError}
|
|
48891
|
+
*/
|
|
48892
|
+
adminRolerightsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48893
|
+
const localVarPath = `/admin/rolerights`;
|
|
48894
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
48895
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48896
|
+
let baseOptions;
|
|
48897
|
+
if (configuration) {
|
|
48898
|
+
baseOptions = configuration.baseOptions;
|
|
48899
|
+
}
|
|
48900
|
+
|
|
48901
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
48902
|
+
const localVarHeaderParameter = {} as any;
|
|
48903
|
+
const localVarQueryParameter = {} as any;
|
|
48904
|
+
|
|
48905
|
+
// authentication BearerAuth required
|
|
48906
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
48907
|
+
|
|
48908
|
+
|
|
48909
|
+
|
|
48910
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
48911
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
48912
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
48913
|
+
|
|
48914
|
+
return {
|
|
48915
|
+
url: toPathString(localVarUrlObj),
|
|
48916
|
+
options: localVarRequestOptions,
|
|
48917
|
+
};
|
|
48918
|
+
},
|
|
46698
48919
|
/**
|
|
46699
48920
|
* Fetches roleright by role id
|
|
46700
48921
|
* @summary Fetches roleright by role id
|
|
@@ -46948,6 +49169,18 @@ export const RoleRightsApiFp = function(configuration?: Configuration) {
|
|
|
46948
49169
|
const localVarOperationServerBasePath = operationServerMap['RoleRightsApi.adminRolerightsBulkPost']?.[localVarOperationServerIndex]?.url;
|
|
46949
49170
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
46950
49171
|
},
|
|
49172
|
+
/**
|
|
49173
|
+
* Fetches list of all roleright
|
|
49174
|
+
* @summary Fetches list of all roleright
|
|
49175
|
+
* @param {*} [options] Override http request option.
|
|
49176
|
+
* @throws {RequiredError}
|
|
49177
|
+
*/
|
|
49178
|
+
async adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRoleRightsListResponse>> {
|
|
49179
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminRolerightsGet(options);
|
|
49180
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
49181
|
+
const localVarOperationServerBasePath = operationServerMap['RoleRightsApi.adminRolerightsGet']?.[localVarOperationServerIndex]?.url;
|
|
49182
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
49183
|
+
},
|
|
46951
49184
|
/**
|
|
46952
49185
|
* Fetches roleright by role id
|
|
46953
49186
|
* @summary Fetches roleright by role id
|
|
@@ -47047,6 +49280,15 @@ export const RoleRightsApiFactory = function (configuration?: Configuration, bas
|
|
|
47047
49280
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
47048
49281
|
return localVarFp.adminRolerightsBulkPost(dataTypesRoleRightRequestDto, options).then((request) => request(axios, basePath));
|
|
47049
49282
|
},
|
|
49283
|
+
/**
|
|
49284
|
+
* Fetches list of all roleright
|
|
49285
|
+
* @summary Fetches list of all roleright
|
|
49286
|
+
* @param {*} [options] Override http request option.
|
|
49287
|
+
* @throws {RequiredError}
|
|
49288
|
+
*/
|
|
49289
|
+
adminRolerightsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRoleRightsListResponse> {
|
|
49290
|
+
return localVarFp.adminRolerightsGet(options).then((request) => request(axios, basePath));
|
|
49291
|
+
},
|
|
47050
49292
|
/**
|
|
47051
49293
|
* Fetches roleright by role id
|
|
47052
49294
|
* @summary Fetches roleright by role id
|
|
@@ -47130,6 +49372,17 @@ export class RoleRightsApi extends BaseAPI {
|
|
|
47130
49372
|
return RoleRightsApiFp(this.configuration).adminRolerightsBulkPost(dataTypesRoleRightRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
47131
49373
|
}
|
|
47132
49374
|
|
|
49375
|
+
/**
|
|
49376
|
+
* Fetches list of all roleright
|
|
49377
|
+
* @summary Fetches list of all roleright
|
|
49378
|
+
* @param {*} [options] Override http request option.
|
|
49379
|
+
* @throws {RequiredError}
|
|
49380
|
+
* @memberof RoleRightsApi
|
|
49381
|
+
*/
|
|
49382
|
+
public adminRolerightsGet(options?: RawAxiosRequestConfig) {
|
|
49383
|
+
return RoleRightsApiFp(this.configuration).adminRolerightsGet(options).then((request) => request(this.axios, this.basePath));
|
|
49384
|
+
}
|
|
49385
|
+
|
|
47133
49386
|
/**
|
|
47134
49387
|
* Fetches roleright by role id
|
|
47135
49388
|
* @summary Fetches roleright by role id
|
|
@@ -47292,6 +49545,43 @@ export const RolesApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
47292
49545
|
options: localVarRequestOptions,
|
|
47293
49546
|
};
|
|
47294
49547
|
},
|
|
49548
|
+
/**
|
|
49549
|
+
* Fetches list of all roles
|
|
49550
|
+
* @summary Fetches list of all roles
|
|
49551
|
+
* @param {number} orgId Org ID
|
|
49552
|
+
* @param {*} [options] Override http request option.
|
|
49553
|
+
* @throws {RequiredError}
|
|
49554
|
+
*/
|
|
49555
|
+
adminRolesOrgIdGet: async (orgId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
49556
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
49557
|
+
assertParamExists('adminRolesOrgIdGet', 'orgId', orgId)
|
|
49558
|
+
const localVarPath = `/admin/roles/{OrgId}`
|
|
49559
|
+
.replace(`{${"OrgId"}}`, encodeURIComponent(String(orgId)));
|
|
49560
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49561
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
49562
|
+
let baseOptions;
|
|
49563
|
+
if (configuration) {
|
|
49564
|
+
baseOptions = configuration.baseOptions;
|
|
49565
|
+
}
|
|
49566
|
+
|
|
49567
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
49568
|
+
const localVarHeaderParameter = {} as any;
|
|
49569
|
+
const localVarQueryParameter = {} as any;
|
|
49570
|
+
|
|
49571
|
+
// authentication BearerAuth required
|
|
49572
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
49573
|
+
|
|
49574
|
+
|
|
49575
|
+
|
|
49576
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
49577
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
49578
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
49579
|
+
|
|
49580
|
+
return {
|
|
49581
|
+
url: toPathString(localVarUrlObj),
|
|
49582
|
+
options: localVarRequestOptions,
|
|
49583
|
+
};
|
|
49584
|
+
},
|
|
47295
49585
|
/**
|
|
47296
49586
|
* Fetches role by id
|
|
47297
49587
|
* @summary Fetches role by id
|
|
@@ -47409,6 +49699,19 @@ export const RolesApiFp = function(configuration?: Configuration) {
|
|
|
47409
49699
|
const localVarOperationServerBasePath = operationServerMap['RolesApi.adminRolesIdPut']?.[localVarOperationServerIndex]?.url;
|
|
47410
49700
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
47411
49701
|
},
|
|
49702
|
+
/**
|
|
49703
|
+
* Fetches list of all roles
|
|
49704
|
+
* @summary Fetches list of all roles
|
|
49705
|
+
* @param {number} orgId Org ID
|
|
49706
|
+
* @param {*} [options] Override http request option.
|
|
49707
|
+
* @throws {RequiredError}
|
|
49708
|
+
*/
|
|
49709
|
+
async adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRolesListResponse>> {
|
|
49710
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminRolesOrgIdGet(orgId, options);
|
|
49711
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
49712
|
+
const localVarOperationServerBasePath = operationServerMap['RolesApi.adminRolesOrgIdGet']?.[localVarOperationServerIndex]?.url;
|
|
49713
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
49714
|
+
},
|
|
47412
49715
|
/**
|
|
47413
49716
|
* Fetches role by id
|
|
47414
49717
|
* @summary Fetches role by id
|
|
@@ -47467,6 +49770,16 @@ export const RolesApiFactory = function (configuration?: Configuration, basePath
|
|
|
47467
49770
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
47468
49771
|
return localVarFp.adminRolesIdPut(id, dataTypesCreateRoleRequestDto, options).then((request) => request(axios, basePath));
|
|
47469
49772
|
},
|
|
49773
|
+
/**
|
|
49774
|
+
* Fetches list of all roles
|
|
49775
|
+
* @summary Fetches list of all roles
|
|
49776
|
+
* @param {number} orgId Org ID
|
|
49777
|
+
* @param {*} [options] Override http request option.
|
|
49778
|
+
* @throws {RequiredError}
|
|
49779
|
+
*/
|
|
49780
|
+
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRolesListResponse> {
|
|
49781
|
+
return localVarFp.adminRolesOrgIdGet(orgId, options).then((request) => request(axios, basePath));
|
|
49782
|
+
},
|
|
47470
49783
|
/**
|
|
47471
49784
|
* Fetches role by id
|
|
47472
49785
|
* @summary Fetches role by id
|
|
@@ -47523,6 +49836,18 @@ export class RolesApi extends BaseAPI {
|
|
|
47523
49836
|
return RolesApiFp(this.configuration).adminRolesIdPut(id, dataTypesCreateRoleRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
47524
49837
|
}
|
|
47525
49838
|
|
|
49839
|
+
/**
|
|
49840
|
+
* Fetches list of all roles
|
|
49841
|
+
* @summary Fetches list of all roles
|
|
49842
|
+
* @param {number} orgId Org ID
|
|
49843
|
+
* @param {*} [options] Override http request option.
|
|
49844
|
+
* @throws {RequiredError}
|
|
49845
|
+
* @memberof RolesApi
|
|
49846
|
+
*/
|
|
49847
|
+
public adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig) {
|
|
49848
|
+
return RolesApiFp(this.configuration).adminRolesOrgIdGet(orgId, options).then((request) => request(this.axios, this.basePath));
|
|
49849
|
+
}
|
|
49850
|
+
|
|
47526
49851
|
/**
|
|
47527
49852
|
* Fetches role by id
|
|
47528
49853
|
* @summary Fetches role by id
|
|
@@ -47782,6 +50107,54 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
47782
50107
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
47783
50108
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
47784
50109
|
|
|
50110
|
+
return {
|
|
50111
|
+
url: toPathString(localVarUrlObj),
|
|
50112
|
+
options: localVarRequestOptions,
|
|
50113
|
+
};
|
|
50114
|
+
},
|
|
50115
|
+
/**
|
|
50116
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
50117
|
+
* @summary Public Search API
|
|
50118
|
+
* @param {string} xStoreid Store ID
|
|
50119
|
+
* @param {string} xStoresecret Store Secret
|
|
50120
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
50121
|
+
* @param {*} [options] Override http request option.
|
|
50122
|
+
* @throws {RequiredError}
|
|
50123
|
+
*/
|
|
50124
|
+
v1SearchPost: async (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50125
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
50126
|
+
assertParamExists('v1SearchPost', 'xStoreid', xStoreid)
|
|
50127
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
50128
|
+
assertParamExists('v1SearchPost', 'xStoresecret', xStoresecret)
|
|
50129
|
+
// verify required parameter 'dataTypesPublicSearchRequest' is not null or undefined
|
|
50130
|
+
assertParamExists('v1SearchPost', 'dataTypesPublicSearchRequest', dataTypesPublicSearchRequest)
|
|
50131
|
+
const localVarPath = `/v1/search`;
|
|
50132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50133
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50134
|
+
let baseOptions;
|
|
50135
|
+
if (configuration) {
|
|
50136
|
+
baseOptions = configuration.baseOptions;
|
|
50137
|
+
}
|
|
50138
|
+
|
|
50139
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50140
|
+
const localVarHeaderParameter = {} as any;
|
|
50141
|
+
const localVarQueryParameter = {} as any;
|
|
50142
|
+
|
|
50143
|
+
|
|
50144
|
+
|
|
50145
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
50146
|
+
|
|
50147
|
+
if (xStoreid != null) {
|
|
50148
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
50149
|
+
}
|
|
50150
|
+
if (xStoresecret != null) {
|
|
50151
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
50152
|
+
}
|
|
50153
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50154
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50155
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50156
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesPublicSearchRequest, localVarRequestOptions, configuration)
|
|
50157
|
+
|
|
47785
50158
|
return {
|
|
47786
50159
|
url: toPathString(localVarUrlObj),
|
|
47787
50160
|
options: localVarRequestOptions,
|
|
@@ -47879,6 +50252,21 @@ export const SearchApiFp = function(configuration?: Configuration) {
|
|
|
47879
50252
|
const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexIndexnameDefaultsGet']?.[localVarOperationServerIndex]?.url;
|
|
47880
50253
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
47881
50254
|
},
|
|
50255
|
+
/**
|
|
50256
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
50257
|
+
* @summary Public Search API
|
|
50258
|
+
* @param {string} xStoreid Store ID
|
|
50259
|
+
* @param {string} xStoresecret Store Secret
|
|
50260
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
50261
|
+
* @param {*} [options] Override http request option.
|
|
50262
|
+
* @throws {RequiredError}
|
|
50263
|
+
*/
|
|
50264
|
+
async v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>> {
|
|
50265
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1SearchPost(xStoreid, xStoresecret, dataTypesPublicSearchRequest, options);
|
|
50266
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
50267
|
+
const localVarOperationServerBasePath = operationServerMap['SearchApi.v1SearchPost']?.[localVarOperationServerIndex]?.url;
|
|
50268
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
50269
|
+
},
|
|
47882
50270
|
}
|
|
47883
50271
|
};
|
|
47884
50272
|
|
|
@@ -47953,6 +50341,18 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
|
|
|
47953
50341
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper> {
|
|
47954
50342
|
return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
|
|
47955
50343
|
},
|
|
50344
|
+
/**
|
|
50345
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
50346
|
+
* @summary Public Search API
|
|
50347
|
+
* @param {string} xStoreid Store ID
|
|
50348
|
+
* @param {string} xStoresecret Store Secret
|
|
50349
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
50350
|
+
* @param {*} [options] Override http request option.
|
|
50351
|
+
* @throws {RequiredError}
|
|
50352
|
+
*/
|
|
50353
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper> {
|
|
50354
|
+
return localVarFp.v1SearchPost(xStoreid, xStoresecret, dataTypesPublicSearchRequest, options).then((request) => request(axios, basePath));
|
|
50355
|
+
},
|
|
47956
50356
|
};
|
|
47957
50357
|
};
|
|
47958
50358
|
|
|
@@ -48038,6 +50438,20 @@ export class SearchApi extends BaseAPI {
|
|
|
48038
50438
|
public v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig) {
|
|
48039
50439
|
return SearchApiFp(this.configuration).v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(this.axios, this.basePath));
|
|
48040
50440
|
}
|
|
50441
|
+
|
|
50442
|
+
/**
|
|
50443
|
+
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
50444
|
+
* @summary Public Search API
|
|
50445
|
+
* @param {string} xStoreid Store ID
|
|
50446
|
+
* @param {string} xStoresecret Store Secret
|
|
50447
|
+
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
50448
|
+
* @param {*} [options] Override http request option.
|
|
50449
|
+
* @throws {RequiredError}
|
|
50450
|
+
* @memberof SearchApi
|
|
50451
|
+
*/
|
|
50452
|
+
public v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) {
|
|
50453
|
+
return SearchApiFp(this.configuration).v1SearchPost(xStoreid, xStoresecret, dataTypesPublicSearchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
50454
|
+
}
|
|
48041
50455
|
}
|
|
48042
50456
|
|
|
48043
50457
|
|
|
@@ -51486,6 +53900,39 @@ export const SubscriptionsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
51486
53900
|
|
|
51487
53901
|
|
|
51488
53902
|
|
|
53903
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
53904
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53905
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
53906
|
+
|
|
53907
|
+
return {
|
|
53908
|
+
url: toPathString(localVarUrlObj),
|
|
53909
|
+
options: localVarRequestOptions,
|
|
53910
|
+
};
|
|
53911
|
+
},
|
|
53912
|
+
/**
|
|
53913
|
+
* Fetches list of all Subscription
|
|
53914
|
+
* @summary Fetches list of all Subscription
|
|
53915
|
+
* @param {*} [options] Override http request option.
|
|
53916
|
+
* @throws {RequiredError}
|
|
53917
|
+
*/
|
|
53918
|
+
miscSubscriptionsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53919
|
+
const localVarPath = `/misc/subscriptions`;
|
|
53920
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
53921
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
53922
|
+
let baseOptions;
|
|
53923
|
+
if (configuration) {
|
|
53924
|
+
baseOptions = configuration.baseOptions;
|
|
53925
|
+
}
|
|
53926
|
+
|
|
53927
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
53928
|
+
const localVarHeaderParameter = {} as any;
|
|
53929
|
+
const localVarQueryParameter = {} as any;
|
|
53930
|
+
|
|
53931
|
+
// authentication BearerAuth required
|
|
53932
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
53933
|
+
|
|
53934
|
+
|
|
53935
|
+
|
|
51489
53936
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51490
53937
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51491
53938
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -51635,6 +54082,18 @@ export const SubscriptionsApiFp = function(configuration?: Configuration) {
|
|
|
51635
54082
|
const localVarOperationServerBasePath = operationServerMap['SubscriptionsApi.adminSubscriptionsUpdatestatusSubscriptionIDStatusPut']?.[localVarOperationServerIndex]?.url;
|
|
51636
54083
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
51637
54084
|
},
|
|
54085
|
+
/**
|
|
54086
|
+
* Fetches list of all Subscription
|
|
54087
|
+
* @summary Fetches list of all Subscription
|
|
54088
|
+
* @param {*} [options] Override http request option.
|
|
54089
|
+
* @throws {RequiredError}
|
|
54090
|
+
*/
|
|
54091
|
+
async miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSubscriptionsListResponse>> {
|
|
54092
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.miscSubscriptionsGet(options);
|
|
54093
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
54094
|
+
const localVarOperationServerBasePath = operationServerMap['SubscriptionsApi.miscSubscriptionsGet']?.[localVarOperationServerIndex]?.url;
|
|
54095
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
54096
|
+
},
|
|
51638
54097
|
/**
|
|
51639
54098
|
* Adds a new Subscription to the system
|
|
51640
54099
|
* @summary Creates a new Subscription
|
|
@@ -51713,6 +54172,15 @@ export const SubscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
51713
54172
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
51714
54173
|
return localVarFp.adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID, status, options).then((request) => request(axios, basePath));
|
|
51715
54174
|
},
|
|
54175
|
+
/**
|
|
54176
|
+
* Fetches list of all Subscription
|
|
54177
|
+
* @summary Fetches list of all Subscription
|
|
54178
|
+
* @param {*} [options] Override http request option.
|
|
54179
|
+
* @throws {RequiredError}
|
|
54180
|
+
*/
|
|
54181
|
+
miscSubscriptionsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSubscriptionsListResponse> {
|
|
54182
|
+
return localVarFp.miscSubscriptionsGet(options).then((request) => request(axios, basePath));
|
|
54183
|
+
},
|
|
51716
54184
|
/**
|
|
51717
54185
|
* Adds a new Subscription to the system
|
|
51718
54186
|
* @summary Creates a new Subscription
|
|
@@ -51793,6 +54261,17 @@ export class SubscriptionsApi extends BaseAPI {
|
|
|
51793
54261
|
return SubscriptionsApiFp(this.configuration).adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID, status, options).then((request) => request(this.axios, this.basePath));
|
|
51794
54262
|
}
|
|
51795
54263
|
|
|
54264
|
+
/**
|
|
54265
|
+
* Fetches list of all Subscription
|
|
54266
|
+
* @summary Fetches list of all Subscription
|
|
54267
|
+
* @param {*} [options] Override http request option.
|
|
54268
|
+
* @throws {RequiredError}
|
|
54269
|
+
* @memberof SubscriptionsApi
|
|
54270
|
+
*/
|
|
54271
|
+
public miscSubscriptionsGet(options?: RawAxiosRequestConfig) {
|
|
54272
|
+
return SubscriptionsApiFp(this.configuration).miscSubscriptionsGet(options).then((request) => request(this.axios, this.basePath));
|
|
54273
|
+
}
|
|
54274
|
+
|
|
51796
54275
|
/**
|
|
51797
54276
|
* Adds a new Subscription to the system
|
|
51798
54277
|
* @summary Creates a new Subscription
|