@seekora-ai/admin-api 1.1.12 → 1.1.13
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 +29 -46
- package/api.ts +8702 -9633
- package/dist/api.d.ts +1020 -1926
- package/dist/api.js +953 -988
- package/dist/esm/api.d.ts +1020 -1926
- package/dist/esm/api.js +943 -982
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.13.tgz +0 -0
- package/seekora-ai-admin-api-1.1.12.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -703,49 +703,6 @@ export interface AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response {
|
|
|
703
703
|
*/
|
|
704
704
|
'total'?: number;
|
|
705
705
|
}
|
|
706
|
-
/**
|
|
707
|
-
*
|
|
708
|
-
* @export
|
|
709
|
-
* @interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
710
|
-
*/
|
|
711
|
-
export interface AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response {
|
|
712
|
-
/**
|
|
713
|
-
* Comparison metadata when in compare mode
|
|
714
|
-
* @type {AnalyticsComparisonMeta}
|
|
715
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
716
|
-
*/
|
|
717
|
-
'comparison'?: AnalyticsComparisonMeta;
|
|
718
|
-
/**
|
|
719
|
-
*
|
|
720
|
-
* @type {AnalyticsQueryInsights}
|
|
721
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
722
|
-
*/
|
|
723
|
-
'data'?: AnalyticsQueryInsights;
|
|
724
|
-
/**
|
|
725
|
-
*
|
|
726
|
-
* @type {string}
|
|
727
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
728
|
-
*/
|
|
729
|
-
'error'?: string;
|
|
730
|
-
/**
|
|
731
|
-
*
|
|
732
|
-
* @type {string}
|
|
733
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
734
|
-
*/
|
|
735
|
-
'status'?: string;
|
|
736
|
-
/**
|
|
737
|
-
*
|
|
738
|
-
* @type {string}
|
|
739
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
740
|
-
*/
|
|
741
|
-
'timestamp'?: string;
|
|
742
|
-
/**
|
|
743
|
-
*
|
|
744
|
-
* @type {number}
|
|
745
|
-
* @memberof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response
|
|
746
|
-
*/
|
|
747
|
-
'total'?: number;
|
|
748
|
-
}
|
|
749
706
|
/**
|
|
750
707
|
*
|
|
751
708
|
* @export
|
|
@@ -1459,153 +1416,6 @@ export interface AnalyticsAnalyticsAPIResponse {
|
|
|
1459
1416
|
*/
|
|
1460
1417
|
'total'?: number;
|
|
1461
1418
|
}
|
|
1462
|
-
/**
|
|
1463
|
-
*
|
|
1464
|
-
* @export
|
|
1465
|
-
* @interface AnalyticsArrayElementAnalytic
|
|
1466
|
-
*/
|
|
1467
|
-
export interface AnalyticsArrayElementAnalytic {
|
|
1468
|
-
/**
|
|
1469
|
-
* Position in array (0-based)
|
|
1470
|
-
* @type {number}
|
|
1471
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1472
|
-
*/
|
|
1473
|
-
'array_index'?: number;
|
|
1474
|
-
/**
|
|
1475
|
-
* Total array size
|
|
1476
|
-
* @type {number}
|
|
1477
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1478
|
-
*/
|
|
1479
|
-
'array_length'?: number;
|
|
1480
|
-
/**
|
|
1481
|
-
* Average results when this element is used
|
|
1482
|
-
* @type {number}
|
|
1483
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1484
|
-
*/
|
|
1485
|
-
'avg_results_count'?: number;
|
|
1486
|
-
/**
|
|
1487
|
-
* e.g., \"tags\"
|
|
1488
|
-
* @type {string}
|
|
1489
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1490
|
-
*/
|
|
1491
|
-
'filter_key'?: string;
|
|
1492
|
-
/**
|
|
1493
|
-
* e.g., \"fashion\"
|
|
1494
|
-
* @type {string}
|
|
1495
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1496
|
-
*/
|
|
1497
|
-
'filter_value'?: string;
|
|
1498
|
-
/**
|
|
1499
|
-
* \"array\", \"object\", \"string\"
|
|
1500
|
-
* @type {string}
|
|
1501
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1502
|
-
*/
|
|
1503
|
-
'original_type'?: string;
|
|
1504
|
-
/**
|
|
1505
|
-
* How often this element appears at this position
|
|
1506
|
-
* @type {number}
|
|
1507
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1508
|
-
*/
|
|
1509
|
-
'position_popularity'?: number;
|
|
1510
|
-
/**
|
|
1511
|
-
* Percentage with results > 0
|
|
1512
|
-
* @type {number}
|
|
1513
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1514
|
-
*/
|
|
1515
|
-
'success_rate'?: number;
|
|
1516
|
-
/**
|
|
1517
|
-
* Unique searches using this element
|
|
1518
|
-
* @type {number}
|
|
1519
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1520
|
-
*/
|
|
1521
|
-
'unique_searches'?: number;
|
|
1522
|
-
/**
|
|
1523
|
-
* How many times this element was used
|
|
1524
|
-
* @type {number}
|
|
1525
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1526
|
-
*/
|
|
1527
|
-
'usage_count'?: number;
|
|
1528
|
-
/**
|
|
1529
|
-
* \"array_element\", \"object_key\", etc.
|
|
1530
|
-
* @type {string}
|
|
1531
|
-
* @memberof AnalyticsArrayElementAnalytic
|
|
1532
|
-
*/
|
|
1533
|
-
'value_type'?: string;
|
|
1534
|
-
}
|
|
1535
|
-
/**
|
|
1536
|
-
*
|
|
1537
|
-
* @export
|
|
1538
|
-
* @interface AnalyticsArrayFilterStats
|
|
1539
|
-
*/
|
|
1540
|
-
export interface AnalyticsArrayFilterStats {
|
|
1541
|
-
/**
|
|
1542
|
-
* Average array size
|
|
1543
|
-
* @type {number}
|
|
1544
|
-
* @memberof AnalyticsArrayFilterStats
|
|
1545
|
-
*/
|
|
1546
|
-
'avg_array_length'?: number;
|
|
1547
|
-
/**
|
|
1548
|
-
* Largest array seen
|
|
1549
|
-
* @type {number}
|
|
1550
|
-
* @memberof AnalyticsArrayFilterStats
|
|
1551
|
-
*/
|
|
1552
|
-
'max_array_length'?: number;
|
|
1553
|
-
/**
|
|
1554
|
-
* Top values across all arrays
|
|
1555
|
-
* @type {Array<string>}
|
|
1556
|
-
* @memberof AnalyticsArrayFilterStats
|
|
1557
|
-
*/
|
|
1558
|
-
'most_popular_values'?: Array<string>;
|
|
1559
|
-
/**
|
|
1560
|
-
* Usage by array position
|
|
1561
|
-
* @type {Array<AnalyticsArrayPositionAnalytic>}
|
|
1562
|
-
* @memberof AnalyticsArrayFilterStats
|
|
1563
|
-
*/
|
|
1564
|
-
'position_analytics'?: Array<AnalyticsArrayPositionAnalytic>;
|
|
1565
|
-
/**
|
|
1566
|
-
* Total times arrays were used for this filter
|
|
1567
|
-
* @type {number}
|
|
1568
|
-
* @memberof AnalyticsArrayFilterStats
|
|
1569
|
-
*/
|
|
1570
|
-
'total_array_usage'?: number;
|
|
1571
|
-
}
|
|
1572
|
-
/**
|
|
1573
|
-
*
|
|
1574
|
-
* @export
|
|
1575
|
-
* @interface AnalyticsArrayPositionAnalytic
|
|
1576
|
-
*/
|
|
1577
|
-
export interface AnalyticsArrayPositionAnalytic {
|
|
1578
|
-
/**
|
|
1579
|
-
* Most popular value at this position
|
|
1580
|
-
* @type {string}
|
|
1581
|
-
* @memberof AnalyticsArrayPositionAnalytic
|
|
1582
|
-
*/
|
|
1583
|
-
'popular_value'?: string;
|
|
1584
|
-
/**
|
|
1585
|
-
* 0-based array position
|
|
1586
|
-
* @type {number}
|
|
1587
|
-
* @memberof AnalyticsArrayPositionAnalytic
|
|
1588
|
-
*/
|
|
1589
|
-
'position'?: number;
|
|
1590
|
-
/**
|
|
1591
|
-
* Success rate for searches with values at this position
|
|
1592
|
-
* @type {number}
|
|
1593
|
-
* @memberof AnalyticsArrayPositionAnalytic
|
|
1594
|
-
*/
|
|
1595
|
-
'success_rate'?: number;
|
|
1596
|
-
/**
|
|
1597
|
-
* Unique values at this position
|
|
1598
|
-
* @type {number}
|
|
1599
|
-
* @memberof AnalyticsArrayPositionAnalytic
|
|
1600
|
-
*/
|
|
1601
|
-
'unique_values'?: number;
|
|
1602
|
-
/**
|
|
1603
|
-
* Times this position was used
|
|
1604
|
-
* @type {number}
|
|
1605
|
-
* @memberof AnalyticsArrayPositionAnalytic
|
|
1606
|
-
*/
|
|
1607
|
-
'usage_count'?: number;
|
|
1608
|
-
}
|
|
1609
1419
|
/**
|
|
1610
1420
|
*
|
|
1611
1421
|
* @export
|
|
@@ -1850,43 +1660,6 @@ export interface AnalyticsCategoryWithCount {
|
|
|
1850
1660
|
*/
|
|
1851
1661
|
'value'?: string;
|
|
1852
1662
|
}
|
|
1853
|
-
/**
|
|
1854
|
-
*
|
|
1855
|
-
* @export
|
|
1856
|
-
* @interface AnalyticsClickPositionBucket
|
|
1857
|
-
*/
|
|
1858
|
-
export interface AnalyticsClickPositionBucket {
|
|
1859
|
-
/**
|
|
1860
|
-
*
|
|
1861
|
-
* @type {number}
|
|
1862
|
-
* @memberof AnalyticsClickPositionBucket
|
|
1863
|
-
*/
|
|
1864
|
-
'click_rate'?: number;
|
|
1865
|
-
/**
|
|
1866
|
-
*
|
|
1867
|
-
* @type {number}
|
|
1868
|
-
* @memberof AnalyticsClickPositionBucket
|
|
1869
|
-
*/
|
|
1870
|
-
'clicks'?: number;
|
|
1871
|
-
/**
|
|
1872
|
-
*
|
|
1873
|
-
* @type {number}
|
|
1874
|
-
* @memberof AnalyticsClickPositionBucket
|
|
1875
|
-
*/
|
|
1876
|
-
'impressions'?: number;
|
|
1877
|
-
/**
|
|
1878
|
-
* \"1\", \"2\", \"3\", \"4-5\", \"6-10\", \"11-20\", \"21+\"
|
|
1879
|
-
* @type {string}
|
|
1880
|
-
* @memberof AnalyticsClickPositionBucket
|
|
1881
|
-
*/
|
|
1882
|
-
'position_range'?: string;
|
|
1883
|
-
/**
|
|
1884
|
-
* percentage of total clicks for this query
|
|
1885
|
-
* @type {number}
|
|
1886
|
-
* @memberof AnalyticsClickPositionBucket
|
|
1887
|
-
*/
|
|
1888
|
-
'share'?: number;
|
|
1889
|
-
}
|
|
1890
1663
|
/**
|
|
1891
1664
|
*
|
|
1892
1665
|
* @export
|
|
@@ -2535,43 +2308,6 @@ export interface AnalyticsFilterEffectivenessCategory {
|
|
|
2535
2308
|
*/
|
|
2536
2309
|
'unique_searches'?: number;
|
|
2537
2310
|
}
|
|
2538
|
-
/**
|
|
2539
|
-
*
|
|
2540
|
-
* @export
|
|
2541
|
-
* @interface AnalyticsFilterEffectivenessMetrics
|
|
2542
|
-
*/
|
|
2543
|
-
export interface AnalyticsFilterEffectivenessMetrics {
|
|
2544
|
-
/**
|
|
2545
|
-
*
|
|
2546
|
-
* @type {number}
|
|
2547
|
-
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2548
|
-
*/
|
|
2549
|
-
'avg_results_count'?: number;
|
|
2550
|
-
/**
|
|
2551
|
-
*
|
|
2552
|
-
* @type {number}
|
|
2553
|
-
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2554
|
-
*/
|
|
2555
|
-
'click_through_rate'?: number;
|
|
2556
|
-
/**
|
|
2557
|
-
*
|
|
2558
|
-
* @type {number}
|
|
2559
|
-
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2560
|
-
*/
|
|
2561
|
-
'conversion_rate'?: number;
|
|
2562
|
-
/**
|
|
2563
|
-
*
|
|
2564
|
-
* @type {number}
|
|
2565
|
-
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2566
|
-
*/
|
|
2567
|
-
'search_count'?: number;
|
|
2568
|
-
/**
|
|
2569
|
-
* percentage with results > 0
|
|
2570
|
-
* @type {number}
|
|
2571
|
-
* @memberof AnalyticsFilterEffectivenessMetrics
|
|
2572
|
-
*/
|
|
2573
|
-
'success_rate'?: number;
|
|
2574
|
-
}
|
|
2575
2311
|
/**
|
|
2576
2312
|
*
|
|
2577
2313
|
* @export
|
|
@@ -2615,37 +2351,6 @@ export interface AnalyticsFilterEffectivenessSummary {
|
|
|
2615
2351
|
*/
|
|
2616
2352
|
'total_searches'?: number;
|
|
2617
2353
|
}
|
|
2618
|
-
/**
|
|
2619
|
-
*
|
|
2620
|
-
* @export
|
|
2621
|
-
* @interface AnalyticsFilterImprovementMetrics
|
|
2622
|
-
*/
|
|
2623
|
-
export interface AnalyticsFilterImprovementMetrics {
|
|
2624
|
-
/**
|
|
2625
|
-
* percentage points
|
|
2626
|
-
* @type {number}
|
|
2627
|
-
* @memberof AnalyticsFilterImprovementMetrics
|
|
2628
|
-
*/
|
|
2629
|
-
'conversion_improvement'?: number;
|
|
2630
|
-
/**
|
|
2631
|
-
* percentage points
|
|
2632
|
-
* @type {number}
|
|
2633
|
-
* @memberof AnalyticsFilterImprovementMetrics
|
|
2634
|
-
*/
|
|
2635
|
-
'ctr_improvement'?: number;
|
|
2636
|
-
/**
|
|
2637
|
-
* percentage
|
|
2638
|
-
* @type {number}
|
|
2639
|
-
* @memberof AnalyticsFilterImprovementMetrics
|
|
2640
|
-
*/
|
|
2641
|
-
'results_count_improvement'?: number;
|
|
2642
|
-
/**
|
|
2643
|
-
* percentage points
|
|
2644
|
-
* @type {number}
|
|
2645
|
-
* @memberof AnalyticsFilterImprovementMetrics
|
|
2646
|
-
*/
|
|
2647
|
-
'success_rate_improvement'?: number;
|
|
2648
|
-
}
|
|
2649
2354
|
/**
|
|
2650
2355
|
*
|
|
2651
2356
|
* @export
|
|
@@ -2873,73 +2578,6 @@ export interface AnalyticsFilterValueStatistic {
|
|
|
2873
2578
|
*/
|
|
2874
2579
|
'value_type'?: string;
|
|
2875
2580
|
}
|
|
2876
|
-
/**
|
|
2877
|
-
*
|
|
2878
|
-
* @export
|
|
2879
|
-
* @interface AnalyticsFilterValueUsage
|
|
2880
|
-
*/
|
|
2881
|
-
export interface AnalyticsFilterValueUsage {
|
|
2882
|
-
/**
|
|
2883
|
-
* Position in array (if applicable)
|
|
2884
|
-
* @type {number}
|
|
2885
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2886
|
-
*/
|
|
2887
|
-
'array_index'?: number;
|
|
2888
|
-
/**
|
|
2889
|
-
* Total array size (if applicable)
|
|
2890
|
-
* @type {number}
|
|
2891
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2892
|
-
*/
|
|
2893
|
-
'array_length'?: number;
|
|
2894
|
-
/**
|
|
2895
|
-
*
|
|
2896
|
-
* @type {number}
|
|
2897
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2898
|
-
*/
|
|
2899
|
-
'avg_results_count'?: number;
|
|
2900
|
-
/**
|
|
2901
|
-
* \"array\", \"object\", \"string\"
|
|
2902
|
-
* @type {string}
|
|
2903
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2904
|
-
*/
|
|
2905
|
-
'original_type'?: string;
|
|
2906
|
-
/**
|
|
2907
|
-
* Percentage of total usage for this filter key
|
|
2908
|
-
* @type {number}
|
|
2909
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2910
|
-
*/
|
|
2911
|
-
'share_of_filter_key'?: number;
|
|
2912
|
-
/**
|
|
2913
|
-
*
|
|
2914
|
-
* @type {number}
|
|
2915
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2916
|
-
*/
|
|
2917
|
-
'success_rate'?: number;
|
|
2918
|
-
/**
|
|
2919
|
-
*
|
|
2920
|
-
* @type {number}
|
|
2921
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2922
|
-
*/
|
|
2923
|
-
'unique_searches'?: number;
|
|
2924
|
-
/**
|
|
2925
|
-
*
|
|
2926
|
-
* @type {number}
|
|
2927
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2928
|
-
*/
|
|
2929
|
-
'usage_count'?: number;
|
|
2930
|
-
/**
|
|
2931
|
-
*
|
|
2932
|
-
* @type {string}
|
|
2933
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2934
|
-
*/
|
|
2935
|
-
'value'?: string;
|
|
2936
|
-
/**
|
|
2937
|
-
* \"array_element\", \"object_key\", \"string\", etc.
|
|
2938
|
-
* @type {string}
|
|
2939
|
-
* @memberof AnalyticsFilterValueUsage
|
|
2940
|
-
*/
|
|
2941
|
-
'value_type'?: string;
|
|
2942
|
-
}
|
|
2943
2581
|
/**
|
|
2944
2582
|
*
|
|
2945
2583
|
* @export
|
|
@@ -5112,446 +4750,6 @@ export interface AnalyticsQueryAnalytic {
|
|
|
5112
4750
|
*/
|
|
5113
4751
|
'unique_users'?: number;
|
|
5114
4752
|
}
|
|
5115
|
-
/**
|
|
5116
|
-
*
|
|
5117
|
-
* @export
|
|
5118
|
-
* @interface AnalyticsQueryFilterAnalytics
|
|
5119
|
-
*/
|
|
5120
|
-
export interface AnalyticsQueryFilterAnalytics {
|
|
5121
|
-
/**
|
|
5122
|
-
* NEW: Individual array element insights
|
|
5123
|
-
* @type {Array<AnalyticsArrayElementAnalytic>}
|
|
5124
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5125
|
-
*/
|
|
5126
|
-
'array_element_analytics'?: Array<AnalyticsArrayElementAnalytic>;
|
|
5127
|
-
/**
|
|
5128
|
-
*
|
|
5129
|
-
* @type {number}
|
|
5130
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5131
|
-
*/
|
|
5132
|
-
'avg_filters_per_search'?: number;
|
|
5133
|
-
/**
|
|
5134
|
-
*
|
|
5135
|
-
* @type {Array<AnalyticsQueryFilterCombination>}
|
|
5136
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5137
|
-
*/
|
|
5138
|
-
'filter_combinations'?: Array<AnalyticsQueryFilterCombination>;
|
|
5139
|
-
/**
|
|
5140
|
-
*
|
|
5141
|
-
* @type {AnalyticsQueryFilterEffectiveness}
|
|
5142
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5143
|
-
*/
|
|
5144
|
-
'filter_effectiveness'?: AnalyticsQueryFilterEffectiveness;
|
|
5145
|
-
/**
|
|
5146
|
-
*
|
|
5147
|
-
* @type {Array<AnalyticsQueryFilterTrend>}
|
|
5148
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5149
|
-
*/
|
|
5150
|
-
'filter_trends'?: Array<AnalyticsQueryFilterTrend>;
|
|
5151
|
-
/**
|
|
5152
|
-
*
|
|
5153
|
-
* @type {number}
|
|
5154
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5155
|
-
*/
|
|
5156
|
-
'filter_usage_rate'?: number;
|
|
5157
|
-
/**
|
|
5158
|
-
* NEW: Enhanced filter usage with array data (removed omitempty to always show field)
|
|
5159
|
-
* @type {Array<AnalyticsQueryFilterUsage>}
|
|
5160
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5161
|
-
*/
|
|
5162
|
-
'popular_filters'?: Array<AnalyticsQueryFilterUsage>;
|
|
5163
|
-
/**
|
|
5164
|
-
*
|
|
5165
|
-
* @type {number}
|
|
5166
|
-
* @memberof AnalyticsQueryFilterAnalytics
|
|
5167
|
-
*/
|
|
5168
|
-
'total_searches_with_filters'?: number;
|
|
5169
|
-
}
|
|
5170
|
-
/**
|
|
5171
|
-
*
|
|
5172
|
-
* @export
|
|
5173
|
-
* @interface AnalyticsQueryFilterCombination
|
|
5174
|
-
*/
|
|
5175
|
-
export interface AnalyticsQueryFilterCombination {
|
|
5176
|
-
/**
|
|
5177
|
-
*
|
|
5178
|
-
* @type {number}
|
|
5179
|
-
* @memberof AnalyticsQueryFilterCombination
|
|
5180
|
-
*/
|
|
5181
|
-
'avg_results_count'?: number;
|
|
5182
|
-
/**
|
|
5183
|
-
*
|
|
5184
|
-
* @type {Array<string>}
|
|
5185
|
-
* @memberof AnalyticsQueryFilterCombination
|
|
5186
|
-
*/
|
|
5187
|
-
'filters'?: Array<string>;
|
|
5188
|
-
/**
|
|
5189
|
-
* percentage of filtered searches
|
|
5190
|
-
* @type {number}
|
|
5191
|
-
* @memberof AnalyticsQueryFilterCombination
|
|
5192
|
-
*/
|
|
5193
|
-
'share'?: number;
|
|
5194
|
-
/**
|
|
5195
|
-
*
|
|
5196
|
-
* @type {number}
|
|
5197
|
-
* @memberof AnalyticsQueryFilterCombination
|
|
5198
|
-
*/
|
|
5199
|
-
'success_rate'?: number;
|
|
5200
|
-
/**
|
|
5201
|
-
*
|
|
5202
|
-
* @type {number}
|
|
5203
|
-
* @memberof AnalyticsQueryFilterCombination
|
|
5204
|
-
*/
|
|
5205
|
-
'usage_count'?: number;
|
|
5206
|
-
}
|
|
5207
|
-
/**
|
|
5208
|
-
*
|
|
5209
|
-
* @export
|
|
5210
|
-
* @interface AnalyticsQueryFilterEffectiveness
|
|
5211
|
-
*/
|
|
5212
|
-
export interface AnalyticsQueryFilterEffectiveness {
|
|
5213
|
-
/**
|
|
5214
|
-
*
|
|
5215
|
-
* @type {AnalyticsFilterImprovementMetrics}
|
|
5216
|
-
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5217
|
-
*/
|
|
5218
|
-
'improvement'?: AnalyticsFilterImprovementMetrics;
|
|
5219
|
-
/**
|
|
5220
|
-
*
|
|
5221
|
-
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5222
|
-
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5223
|
-
*/
|
|
5224
|
-
'with_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5225
|
-
/**
|
|
5226
|
-
*
|
|
5227
|
-
* @type {AnalyticsFilterEffectivenessMetrics}
|
|
5228
|
-
* @memberof AnalyticsQueryFilterEffectiveness
|
|
5229
|
-
*/
|
|
5230
|
-
'without_filters'?: AnalyticsFilterEffectivenessMetrics;
|
|
5231
|
-
}
|
|
5232
|
-
/**
|
|
5233
|
-
*
|
|
5234
|
-
* @export
|
|
5235
|
-
* @interface AnalyticsQueryFilterTrend
|
|
5236
|
-
*/
|
|
5237
|
-
export interface AnalyticsQueryFilterTrend {
|
|
5238
|
-
/**
|
|
5239
|
-
*
|
|
5240
|
-
* @type {string}
|
|
5241
|
-
* @memberof AnalyticsQueryFilterTrend
|
|
5242
|
-
*/
|
|
5243
|
-
'filter_key'?: string;
|
|
5244
|
-
/**
|
|
5245
|
-
*
|
|
5246
|
-
* @type {number}
|
|
5247
|
-
* @memberof AnalyticsQueryFilterTrend
|
|
5248
|
-
*/
|
|
5249
|
-
'growth_rate'?: number;
|
|
5250
|
-
/**
|
|
5251
|
-
* \"increasing\", \"decreasing\", \"stable\"
|
|
5252
|
-
* @type {string}
|
|
5253
|
-
* @memberof AnalyticsQueryFilterTrend
|
|
5254
|
-
*/
|
|
5255
|
-
'trend'?: string;
|
|
5256
|
-
/**
|
|
5257
|
-
*
|
|
5258
|
-
* @type {Array<AnalyticsTimeSeriesPoint>}
|
|
5259
|
-
* @memberof AnalyticsQueryFilterTrend
|
|
5260
|
-
*/
|
|
5261
|
-
'trend_data'?: Array<AnalyticsTimeSeriesPoint>;
|
|
5262
|
-
}
|
|
5263
|
-
/**
|
|
5264
|
-
*
|
|
5265
|
-
* @export
|
|
5266
|
-
* @interface AnalyticsQueryFilterUsage
|
|
5267
|
-
*/
|
|
5268
|
-
export interface AnalyticsQueryFilterUsage {
|
|
5269
|
-
/**
|
|
5270
|
-
* Stats specific to array-type filters
|
|
5271
|
-
* @type {AnalyticsArrayFilterStats}
|
|
5272
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5273
|
-
*/
|
|
5274
|
-
'array_stats'?: AnalyticsArrayFilterStats;
|
|
5275
|
-
/**
|
|
5276
|
-
*
|
|
5277
|
-
* @type {number}
|
|
5278
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5279
|
-
*/
|
|
5280
|
-
'effectiveness_score'?: number;
|
|
5281
|
-
/**
|
|
5282
|
-
*
|
|
5283
|
-
* @type {string}
|
|
5284
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5285
|
-
*/
|
|
5286
|
-
'filter_key'?: string;
|
|
5287
|
-
/**
|
|
5288
|
-
* Individual values with array explosion data
|
|
5289
|
-
* @type {Array<AnalyticsFilterValueUsage>}
|
|
5290
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5291
|
-
*/
|
|
5292
|
-
'filter_values'?: Array<AnalyticsFilterValueUsage>;
|
|
5293
|
-
/**
|
|
5294
|
-
* Total times this filter key was used
|
|
5295
|
-
* @type {number}
|
|
5296
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5297
|
-
*/
|
|
5298
|
-
'total_usage'?: number;
|
|
5299
|
-
/**
|
|
5300
|
-
* Unique searches using this filter
|
|
5301
|
-
* @type {number}
|
|
5302
|
-
* @memberof AnalyticsQueryFilterUsage
|
|
5303
|
-
*/
|
|
5304
|
-
'unique_searches'?: number;
|
|
5305
|
-
}
|
|
5306
|
-
/**
|
|
5307
|
-
*
|
|
5308
|
-
* @export
|
|
5309
|
-
* @interface AnalyticsQueryGeoAnalytic
|
|
5310
|
-
*/
|
|
5311
|
-
export interface AnalyticsQueryGeoAnalytic {
|
|
5312
|
-
/**
|
|
5313
|
-
*
|
|
5314
|
-
* @type {string}
|
|
5315
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5316
|
-
*/
|
|
5317
|
-
'city'?: string;
|
|
5318
|
-
/**
|
|
5319
|
-
* Clicks / Results Shown
|
|
5320
|
-
* @type {number}
|
|
5321
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5322
|
-
*/
|
|
5323
|
-
'click_through_rate'?: number;
|
|
5324
|
-
/**
|
|
5325
|
-
* Count of result-click events
|
|
5326
|
-
* @type {number}
|
|
5327
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5328
|
-
*/
|
|
5329
|
-
'clicks'?: number;
|
|
5330
|
-
/**
|
|
5331
|
-
* Conversions / Clicks (CVR)
|
|
5332
|
-
* @type {number}
|
|
5333
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5334
|
-
*/
|
|
5335
|
-
'conversion_rate'?: number;
|
|
5336
|
-
/**
|
|
5337
|
-
* Conversions / Searches
|
|
5338
|
-
* @type {number}
|
|
5339
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5340
|
-
*/
|
|
5341
|
-
'conversion_rate_per_search'?: number;
|
|
5342
|
-
/**
|
|
5343
|
-
* Post-click conversions attributed to search
|
|
5344
|
-
* @type {number}
|
|
5345
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5346
|
-
*/
|
|
5347
|
-
'conversions'?: number;
|
|
5348
|
-
/**
|
|
5349
|
-
*
|
|
5350
|
-
* @type {string}
|
|
5351
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5352
|
-
*/
|
|
5353
|
-
'country'?: string;
|
|
5354
|
-
/**
|
|
5355
|
-
*
|
|
5356
|
-
* @type {string}
|
|
5357
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5358
|
-
*/
|
|
5359
|
-
'country_code'?: string;
|
|
5360
|
-
/**
|
|
5361
|
-
* Searches with results but zero clicks / Results Shown
|
|
5362
|
-
* @type {number}
|
|
5363
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5364
|
-
*/
|
|
5365
|
-
'no_click_rate'?: number;
|
|
5366
|
-
/**
|
|
5367
|
-
* No-result searches / Searches
|
|
5368
|
-
* @type {number}
|
|
5369
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5370
|
-
*/
|
|
5371
|
-
'no_result_rate'?: number;
|
|
5372
|
-
/**
|
|
5373
|
-
*
|
|
5374
|
-
* @type {string}
|
|
5375
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5376
|
-
*/
|
|
5377
|
-
'region'?: string;
|
|
5378
|
-
/**
|
|
5379
|
-
* Count of searches that returned ≥1 result
|
|
5380
|
-
* @type {number}
|
|
5381
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5382
|
-
*/
|
|
5383
|
-
'results_shown'?: number;
|
|
5384
|
-
/**
|
|
5385
|
-
* Sum of attributed revenue
|
|
5386
|
-
* @type {number}
|
|
5387
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5388
|
-
*/
|
|
5389
|
-
'revenue'?: number;
|
|
5390
|
-
/**
|
|
5391
|
-
* Count of search events
|
|
5392
|
-
* @type {number}
|
|
5393
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5394
|
-
*/
|
|
5395
|
-
'searches'?: number;
|
|
5396
|
-
/**
|
|
5397
|
-
* percentage of total searches for this query
|
|
5398
|
-
* @type {number}
|
|
5399
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5400
|
-
*/
|
|
5401
|
-
'share'?: number;
|
|
5402
|
-
/**
|
|
5403
|
-
* Unique users
|
|
5404
|
-
* @type {number}
|
|
5405
|
-
* @memberof AnalyticsQueryGeoAnalytic
|
|
5406
|
-
*/
|
|
5407
|
-
'unique_users'?: number;
|
|
5408
|
-
}
|
|
5409
|
-
/**
|
|
5410
|
-
*
|
|
5411
|
-
* @export
|
|
5412
|
-
* @interface AnalyticsQueryGeoAnalyticsSection
|
|
5413
|
-
*/
|
|
5414
|
-
export interface AnalyticsQueryGeoAnalyticsSection {
|
|
5415
|
-
/**
|
|
5416
|
-
*
|
|
5417
|
-
* @type {Array<AnalyticsQueryGeoAnalytic>}
|
|
5418
|
-
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5419
|
-
*/
|
|
5420
|
-
'items'?: Array<AnalyticsQueryGeoAnalytic>;
|
|
5421
|
-
/**
|
|
5422
|
-
*
|
|
5423
|
-
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5424
|
-
* @memberof AnalyticsQueryGeoAnalyticsSection
|
|
5425
|
-
*/
|
|
5426
|
-
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5427
|
-
}
|
|
5428
|
-
/**
|
|
5429
|
-
*
|
|
5430
|
-
* @export
|
|
5431
|
-
* @interface AnalyticsQueryInsights
|
|
5432
|
-
*/
|
|
5433
|
-
export interface AnalyticsQueryInsights {
|
|
5434
|
-
/**
|
|
5435
|
-
* Average rank position of clicked results (renamed for clarity)
|
|
5436
|
-
* @type {number}
|
|
5437
|
-
* @memberof AnalyticsQueryInsights
|
|
5438
|
-
*/
|
|
5439
|
-
'avg_click_position'?: number;
|
|
5440
|
-
/**
|
|
5441
|
-
* Average rank of the top result shown per search
|
|
5442
|
-
* @type {number}
|
|
5443
|
-
* @memberof AnalyticsQueryInsights
|
|
5444
|
-
*/
|
|
5445
|
-
'avg_result_rank'?: number;
|
|
5446
|
-
/**
|
|
5447
|
-
*
|
|
5448
|
-
* @type {Array<AnalyticsClickPositionBucket>}
|
|
5449
|
-
* @memberof AnalyticsQueryInsights
|
|
5450
|
-
*/
|
|
5451
|
-
'click_position_histogram'?: Array<AnalyticsClickPositionBucket>;
|
|
5452
|
-
/**
|
|
5453
|
-
* Clicks / Results Shown
|
|
5454
|
-
* @type {number}
|
|
5455
|
-
* @memberof AnalyticsQueryInsights
|
|
5456
|
-
*/
|
|
5457
|
-
'click_through_rate'?: number;
|
|
5458
|
-
/**
|
|
5459
|
-
* Conversions / Clicks (CVR)
|
|
5460
|
-
* @type {number}
|
|
5461
|
-
* @memberof AnalyticsQueryInsights
|
|
5462
|
-
*/
|
|
5463
|
-
'conversion_rate'?: number;
|
|
5464
|
-
/**
|
|
5465
|
-
* Conversions / Searches
|
|
5466
|
-
* @type {number}
|
|
5467
|
-
* @memberof AnalyticsQueryInsights
|
|
5468
|
-
*/
|
|
5469
|
-
'conversion_rate_per_search'?: number;
|
|
5470
|
-
/**
|
|
5471
|
-
* Enhanced filter analytics
|
|
5472
|
-
* @type {AnalyticsQueryFilterAnalytics}
|
|
5473
|
-
* @memberof AnalyticsQueryInsights
|
|
5474
|
-
*/
|
|
5475
|
-
'filter_analytics'?: AnalyticsQueryFilterAnalytics;
|
|
5476
|
-
/**
|
|
5477
|
-
*
|
|
5478
|
-
* @type {AnalyticsQueryGeoAnalyticsSection}
|
|
5479
|
-
* @memberof AnalyticsQueryInsights
|
|
5480
|
-
*/
|
|
5481
|
-
'geo_analytics'?: AnalyticsQueryGeoAnalyticsSection;
|
|
5482
|
-
/**
|
|
5483
|
-
*
|
|
5484
|
-
* @type {string}
|
|
5485
|
-
* @memberof AnalyticsQueryInsights
|
|
5486
|
-
*/
|
|
5487
|
-
'last_searched'?: string;
|
|
5488
|
-
/**
|
|
5489
|
-
* Searches with results but zero clicks / Results Shown
|
|
5490
|
-
* @type {number}
|
|
5491
|
-
* @memberof AnalyticsQueryInsights
|
|
5492
|
-
*/
|
|
5493
|
-
'no_click_rate'?: number;
|
|
5494
|
-
/**
|
|
5495
|
-
* No-result searches / Searches
|
|
5496
|
-
* @type {number}
|
|
5497
|
-
* @memberof AnalyticsQueryInsights
|
|
5498
|
-
*/
|
|
5499
|
-
'no_results_rate'?: number;
|
|
5500
|
-
/**
|
|
5501
|
-
*
|
|
5502
|
-
* @type {AnalyticsQueryPopularFiltersSection}
|
|
5503
|
-
* @memberof AnalyticsQueryInsights
|
|
5504
|
-
*/
|
|
5505
|
-
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
5506
|
-
/**
|
|
5507
|
-
*
|
|
5508
|
-
* @type {AnalyticsQueryPopularResultsSection}
|
|
5509
|
-
* @memberof AnalyticsQueryInsights
|
|
5510
|
-
*/
|
|
5511
|
-
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
5512
|
-
/**
|
|
5513
|
-
*
|
|
5514
|
-
* @type {string}
|
|
5515
|
-
* @memberof AnalyticsQueryInsights
|
|
5516
|
-
*/
|
|
5517
|
-
'query'?: string;
|
|
5518
|
-
/**
|
|
5519
|
-
* Searches that returned ≥1 result
|
|
5520
|
-
* @type {number}
|
|
5521
|
-
* @memberof AnalyticsQueryInsights
|
|
5522
|
-
*/
|
|
5523
|
-
'results_shown'?: number;
|
|
5524
|
-
/**
|
|
5525
|
-
* Count of result-click events
|
|
5526
|
-
* @type {number}
|
|
5527
|
-
* @memberof AnalyticsQueryInsights
|
|
5528
|
-
*/
|
|
5529
|
-
'total_clicks'?: number;
|
|
5530
|
-
/**
|
|
5531
|
-
* Count of conversions
|
|
5532
|
-
* @type {number}
|
|
5533
|
-
* @memberof AnalyticsQueryInsights
|
|
5534
|
-
*/
|
|
5535
|
-
'total_conversions'?: number;
|
|
5536
|
-
/**
|
|
5537
|
-
* Sum of attributed revenue
|
|
5538
|
-
* @type {number}
|
|
5539
|
-
* @memberof AnalyticsQueryInsights
|
|
5540
|
-
*/
|
|
5541
|
-
'total_revenue'?: number;
|
|
5542
|
-
/**
|
|
5543
|
-
*
|
|
5544
|
-
* @type {number}
|
|
5545
|
-
* @memberof AnalyticsQueryInsights
|
|
5546
|
-
*/
|
|
5547
|
-
'total_searches'?: number;
|
|
5548
|
-
/**
|
|
5549
|
-
*
|
|
5550
|
-
* @type {number}
|
|
5551
|
-
* @memberof AnalyticsQueryInsights
|
|
5552
|
-
*/
|
|
5553
|
-
'unique_users'?: number;
|
|
5554
|
-
}
|
|
5555
4753
|
/**
|
|
5556
4754
|
*
|
|
5557
4755
|
* @export
|
|
@@ -5649,250 +4847,6 @@ export interface AnalyticsQueryPerformanceAnalytics {
|
|
|
5649
4847
|
*/
|
|
5650
4848
|
'unique_users'?: number;
|
|
5651
4849
|
}
|
|
5652
|
-
/**
|
|
5653
|
-
*
|
|
5654
|
-
* @export
|
|
5655
|
-
* @interface AnalyticsQueryPopularFilter
|
|
5656
|
-
*/
|
|
5657
|
-
export interface AnalyticsQueryPopularFilter {
|
|
5658
|
-
/**
|
|
5659
|
-
* Clicks / Results Shown
|
|
5660
|
-
* @type {number}
|
|
5661
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5662
|
-
*/
|
|
5663
|
-
'click_through_rate'?: number;
|
|
5664
|
-
/**
|
|
5665
|
-
* Count of result-click events
|
|
5666
|
-
* @type {number}
|
|
5667
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5668
|
-
*/
|
|
5669
|
-
'clicks'?: number;
|
|
5670
|
-
/**
|
|
5671
|
-
* Conversions / Clicks (CVR)
|
|
5672
|
-
* @type {number}
|
|
5673
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5674
|
-
*/
|
|
5675
|
-
'conversion_rate'?: number;
|
|
5676
|
-
/**
|
|
5677
|
-
* Conversions / Searches
|
|
5678
|
-
* @type {number}
|
|
5679
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5680
|
-
*/
|
|
5681
|
-
'conversion_rate_per_search'?: number;
|
|
5682
|
-
/**
|
|
5683
|
-
* Post-click conversions attributed to search
|
|
5684
|
-
* @type {number}
|
|
5685
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5686
|
-
*/
|
|
5687
|
-
'conversions'?: number;
|
|
5688
|
-
/**
|
|
5689
|
-
*
|
|
5690
|
-
* @type {string}
|
|
5691
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5692
|
-
*/
|
|
5693
|
-
'filter_key'?: string;
|
|
5694
|
-
/**
|
|
5695
|
-
*
|
|
5696
|
-
* @type {string}
|
|
5697
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5698
|
-
*/
|
|
5699
|
-
'filter_value'?: string;
|
|
5700
|
-
/**
|
|
5701
|
-
* Searches with results but zero clicks / Results Shown
|
|
5702
|
-
* @type {number}
|
|
5703
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5704
|
-
*/
|
|
5705
|
-
'no_click_rate'?: number;
|
|
5706
|
-
/**
|
|
5707
|
-
* No-result searches / Searches
|
|
5708
|
-
* @type {number}
|
|
5709
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5710
|
-
*/
|
|
5711
|
-
'no_result_rate'?: number;
|
|
5712
|
-
/**
|
|
5713
|
-
* Count of searches that returned ≥1 result
|
|
5714
|
-
* @type {number}
|
|
5715
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5716
|
-
*/
|
|
5717
|
-
'results_shown'?: number;
|
|
5718
|
-
/**
|
|
5719
|
-
* Sum of attributed revenue
|
|
5720
|
-
* @type {number}
|
|
5721
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5722
|
-
*/
|
|
5723
|
-
'revenue'?: number;
|
|
5724
|
-
/**
|
|
5725
|
-
* Count of search events with this filter
|
|
5726
|
-
* @type {number}
|
|
5727
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5728
|
-
*/
|
|
5729
|
-
'searches'?: number;
|
|
5730
|
-
/**
|
|
5731
|
-
* percentage of searches with this filter
|
|
5732
|
-
* @type {number}
|
|
5733
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5734
|
-
*/
|
|
5735
|
-
'share'?: number;
|
|
5736
|
-
/**
|
|
5737
|
-
* Number of times this filter was used
|
|
5738
|
-
* @type {number}
|
|
5739
|
-
* @memberof AnalyticsQueryPopularFilter
|
|
5740
|
-
*/
|
|
5741
|
-
'usage_count'?: number;
|
|
5742
|
-
}
|
|
5743
|
-
/**
|
|
5744
|
-
*
|
|
5745
|
-
* @export
|
|
5746
|
-
* @interface AnalyticsQueryPopularFiltersSection
|
|
5747
|
-
*/
|
|
5748
|
-
export interface AnalyticsQueryPopularFiltersSection {
|
|
5749
|
-
/**
|
|
5750
|
-
*
|
|
5751
|
-
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
5752
|
-
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5753
|
-
*/
|
|
5754
|
-
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
5755
|
-
/**
|
|
5756
|
-
*
|
|
5757
|
-
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5758
|
-
* @memberof AnalyticsQueryPopularFiltersSection
|
|
5759
|
-
*/
|
|
5760
|
-
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5761
|
-
}
|
|
5762
|
-
/**
|
|
5763
|
-
*
|
|
5764
|
-
* @export
|
|
5765
|
-
* @interface AnalyticsQueryPopularResultWithWidget
|
|
5766
|
-
*/
|
|
5767
|
-
export interface AnalyticsQueryPopularResultWithWidget {
|
|
5768
|
-
/**
|
|
5769
|
-
* Average rank position of clicked results
|
|
5770
|
-
* @type {number}
|
|
5771
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5772
|
-
*/
|
|
5773
|
-
'avg_click_rank'?: number;
|
|
5774
|
-
/**
|
|
5775
|
-
* Same as AvgResultRank (backward compatibility)
|
|
5776
|
-
* @type {number}
|
|
5777
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5778
|
-
*/
|
|
5779
|
-
'avg_position'?: number;
|
|
5780
|
-
/**
|
|
5781
|
-
* Average rank of the top result shown per search
|
|
5782
|
-
* @type {number}
|
|
5783
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5784
|
-
*/
|
|
5785
|
-
'avg_result_rank'?: number;
|
|
5786
|
-
/**
|
|
5787
|
-
* Clicks / Results Shown
|
|
5788
|
-
* @type {number}
|
|
5789
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5790
|
-
*/
|
|
5791
|
-
'click_through_rate'?: number;
|
|
5792
|
-
/**
|
|
5793
|
-
* Count of result-click events
|
|
5794
|
-
* @type {number}
|
|
5795
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5796
|
-
*/
|
|
5797
|
-
'clicks'?: number;
|
|
5798
|
-
/**
|
|
5799
|
-
* Conversions / Clicks (CVR)
|
|
5800
|
-
* @type {number}
|
|
5801
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5802
|
-
*/
|
|
5803
|
-
'conversion_rate'?: number;
|
|
5804
|
-
/**
|
|
5805
|
-
* Conversions / Searches
|
|
5806
|
-
* @type {number}
|
|
5807
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5808
|
-
*/
|
|
5809
|
-
'conversion_rate_per_search'?: number;
|
|
5810
|
-
/**
|
|
5811
|
-
* Post-click conversions attributed to search
|
|
5812
|
-
* @type {number}
|
|
5813
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5814
|
-
*/
|
|
5815
|
-
'conversions'?: number;
|
|
5816
|
-
/**
|
|
5817
|
-
* Count of times item was shown
|
|
5818
|
-
* @type {number}
|
|
5819
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5820
|
-
*/
|
|
5821
|
-
'impressions'?: number;
|
|
5822
|
-
/**
|
|
5823
|
-
*
|
|
5824
|
-
* @type {string}
|
|
5825
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5826
|
-
*/
|
|
5827
|
-
'item_id'?: string;
|
|
5828
|
-
/**
|
|
5829
|
-
*
|
|
5830
|
-
* @type {string}
|
|
5831
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5832
|
-
*/
|
|
5833
|
-
'item_name'?: string;
|
|
5834
|
-
/**
|
|
5835
|
-
* Searches with results but zero clicks / Results Shown
|
|
5836
|
-
* @type {number}
|
|
5837
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5838
|
-
*/
|
|
5839
|
-
'no_click_rate'?: number;
|
|
5840
|
-
/**
|
|
5841
|
-
* No-result searches / Searches
|
|
5842
|
-
* @type {number}
|
|
5843
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5844
|
-
*/
|
|
5845
|
-
'no_result_rate'?: number;
|
|
5846
|
-
/**
|
|
5847
|
-
* Count of searches that returned ≥1 result
|
|
5848
|
-
* @type {number}
|
|
5849
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5850
|
-
*/
|
|
5851
|
-
'results_shown'?: number;
|
|
5852
|
-
/**
|
|
5853
|
-
* Sum of attributed revenue
|
|
5854
|
-
* @type {number}
|
|
5855
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5856
|
-
*/
|
|
5857
|
-
'revenue'?: number;
|
|
5858
|
-
/**
|
|
5859
|
-
* Count of search events
|
|
5860
|
-
* @type {number}
|
|
5861
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5862
|
-
*/
|
|
5863
|
-
'searches'?: number;
|
|
5864
|
-
/**
|
|
5865
|
-
* percentage of total impressions for this query
|
|
5866
|
-
* @type {number}
|
|
5867
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5868
|
-
*/
|
|
5869
|
-
'share'?: number;
|
|
5870
|
-
/**
|
|
5871
|
-
* Widget display fields
|
|
5872
|
-
* @type {AnalyticsWidgetData}
|
|
5873
|
-
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
5874
|
-
*/
|
|
5875
|
-
'widget'?: AnalyticsWidgetData;
|
|
5876
|
-
}
|
|
5877
|
-
/**
|
|
5878
|
-
*
|
|
5879
|
-
* @export
|
|
5880
|
-
* @interface AnalyticsQueryPopularResultsSection
|
|
5881
|
-
*/
|
|
5882
|
-
export interface AnalyticsQueryPopularResultsSection {
|
|
5883
|
-
/**
|
|
5884
|
-
*
|
|
5885
|
-
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
5886
|
-
* @memberof AnalyticsQueryPopularResultsSection
|
|
5887
|
-
*/
|
|
5888
|
-
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
5889
|
-
/**
|
|
5890
|
-
*
|
|
5891
|
-
* @type {SeekoraGoSrcAnalyticsPaginationMeta}
|
|
5892
|
-
* @memberof AnalyticsQueryPopularResultsSection
|
|
5893
|
-
*/
|
|
5894
|
-
'meta'?: SeekoraGoSrcAnalyticsPaginationMeta;
|
|
5895
|
-
}
|
|
5896
4850
|
/**
|
|
5897
4851
|
*
|
|
5898
4852
|
* @export
|
|
@@ -11499,6 +10453,31 @@ export interface DataTypesGetStoreResult {
|
|
|
11499
10453
|
*/
|
|
11500
10454
|
'xStoreWriteSecret'?: string;
|
|
11501
10455
|
}
|
|
10456
|
+
/**
|
|
10457
|
+
*
|
|
10458
|
+
* @export
|
|
10459
|
+
* @interface DataTypesGrantStoreAccessRequest
|
|
10460
|
+
*/
|
|
10461
|
+
export interface DataTypesGrantStoreAccessRequest {
|
|
10462
|
+
/**
|
|
10463
|
+
*
|
|
10464
|
+
* @type {string}
|
|
10465
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10466
|
+
*/
|
|
10467
|
+
'access_level': DataTypesGrantStoreAccessRequestAccessLevelEnum;
|
|
10468
|
+
/**
|
|
10469
|
+
*
|
|
10470
|
+
* @type {number}
|
|
10471
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10472
|
+
*/
|
|
10473
|
+
'user_id': number;
|
|
10474
|
+
}
|
|
10475
|
+
export declare const DataTypesGrantStoreAccessRequestAccessLevelEnum: {
|
|
10476
|
+
readonly Read: "read";
|
|
10477
|
+
readonly Write: "write";
|
|
10478
|
+
readonly Admin: "admin";
|
|
10479
|
+
};
|
|
10480
|
+
export type DataTypesGrantStoreAccessRequestAccessLevelEnum = typeof DataTypesGrantStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesGrantStoreAccessRequestAccessLevelEnum];
|
|
11502
10481
|
/**
|
|
11503
10482
|
*
|
|
11504
10483
|
* @export
|
|
@@ -11946,6 +10925,73 @@ export interface DataTypesIndexField {
|
|
|
11946
10925
|
*/
|
|
11947
10926
|
'type'?: string;
|
|
11948
10927
|
}
|
|
10928
|
+
/**
|
|
10929
|
+
*
|
|
10930
|
+
* @export
|
|
10931
|
+
* @interface DataTypesInvitationCreatedResponse
|
|
10932
|
+
*/
|
|
10933
|
+
export interface DataTypesInvitationCreatedResponse {
|
|
10934
|
+
/**
|
|
10935
|
+
*
|
|
10936
|
+
* @type {DataTypesTeamInvitationWithDetails}
|
|
10937
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10938
|
+
*/
|
|
10939
|
+
'data'?: DataTypesTeamInvitationWithDetails;
|
|
10940
|
+
/**
|
|
10941
|
+
*
|
|
10942
|
+
* @type {string}
|
|
10943
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10944
|
+
*/
|
|
10945
|
+
'message'?: string;
|
|
10946
|
+
/**
|
|
10947
|
+
*
|
|
10948
|
+
* @type {number}
|
|
10949
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10950
|
+
*/
|
|
10951
|
+
'status'?: number;
|
|
10952
|
+
}
|
|
10953
|
+
/**
|
|
10954
|
+
*
|
|
10955
|
+
* @export
|
|
10956
|
+
* @interface DataTypesInviteMemberRequest
|
|
10957
|
+
*/
|
|
10958
|
+
export interface DataTypesInviteMemberRequest {
|
|
10959
|
+
/**
|
|
10960
|
+
* Optional custom message in invitation
|
|
10961
|
+
* @type {string}
|
|
10962
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10963
|
+
*/
|
|
10964
|
+
'custom_message'?: string;
|
|
10965
|
+
/**
|
|
10966
|
+
*
|
|
10967
|
+
* @type {string}
|
|
10968
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10969
|
+
*/
|
|
10970
|
+
'email': string;
|
|
10971
|
+
/**
|
|
10972
|
+
*
|
|
10973
|
+
* @type {string}
|
|
10974
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10975
|
+
*/
|
|
10976
|
+
'member_role': DataTypesInviteMemberRequestMemberRoleEnum;
|
|
10977
|
+
/**
|
|
10978
|
+
* Whether to send invitation email
|
|
10979
|
+
* @type {boolean}
|
|
10980
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10981
|
+
*/
|
|
10982
|
+
'send_email'?: boolean;
|
|
10983
|
+
/**
|
|
10984
|
+
* Optional: specific stores to grant access to
|
|
10985
|
+
* @type {Array<DataTypesStoreAccessRequest>}
|
|
10986
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10987
|
+
*/
|
|
10988
|
+
'stores'?: Array<DataTypesStoreAccessRequest>;
|
|
10989
|
+
}
|
|
10990
|
+
export declare const DataTypesInviteMemberRequestMemberRoleEnum: {
|
|
10991
|
+
readonly Admin: "admin";
|
|
10992
|
+
readonly Member: "member";
|
|
10993
|
+
};
|
|
10994
|
+
export type DataTypesInviteMemberRequestMemberRoleEnum = typeof DataTypesInviteMemberRequestMemberRoleEnum[keyof typeof DataTypesInviteMemberRequestMemberRoleEnum];
|
|
11949
10995
|
/**
|
|
11950
10996
|
*
|
|
11951
10997
|
* @export
|
|
@@ -12635,31 +11681,6 @@ export interface DataTypesLimitResponse {
|
|
|
12635
11681
|
*/
|
|
12636
11682
|
'status'?: number;
|
|
12637
11683
|
}
|
|
12638
|
-
/**
|
|
12639
|
-
*
|
|
12640
|
-
* @export
|
|
12641
|
-
* @interface DataTypesLimitsListResponse
|
|
12642
|
-
*/
|
|
12643
|
-
export interface DataTypesLimitsListResponse {
|
|
12644
|
-
/**
|
|
12645
|
-
*
|
|
12646
|
-
* @type {Array<DataTypesLimit>}
|
|
12647
|
-
* @memberof DataTypesLimitsListResponse
|
|
12648
|
-
*/
|
|
12649
|
-
'data'?: Array<DataTypesLimit>;
|
|
12650
|
-
/**
|
|
12651
|
-
*
|
|
12652
|
-
* @type {string}
|
|
12653
|
-
* @memberof DataTypesLimitsListResponse
|
|
12654
|
-
*/
|
|
12655
|
-
'message'?: string;
|
|
12656
|
-
/**
|
|
12657
|
-
*
|
|
12658
|
-
* @type {number}
|
|
12659
|
-
* @memberof DataTypesLimitsListResponse
|
|
12660
|
-
*/
|
|
12661
|
-
'status'?: number;
|
|
12662
|
-
}
|
|
12663
11684
|
/**
|
|
12664
11685
|
*
|
|
12665
11686
|
* @export
|
|
@@ -13093,6 +12114,12 @@ export interface DataTypesMenuAccess {
|
|
|
13093
12114
|
* @memberof DataTypesMenuAccess
|
|
13094
12115
|
*/
|
|
13095
12116
|
'SubMenuAccess'?: Array<DataTypesSubMenuAccess>;
|
|
12117
|
+
/**
|
|
12118
|
+
* Store IDs user has access to (for store-specific menus)
|
|
12119
|
+
* @type {Array<number>}
|
|
12120
|
+
* @memberof DataTypesMenuAccess
|
|
12121
|
+
*/
|
|
12122
|
+
'accessibleStores'?: Array<number>;
|
|
13096
12123
|
/**
|
|
13097
12124
|
*
|
|
13098
12125
|
* @type {boolean}
|
|
@@ -13483,31 +12510,6 @@ export interface DataTypesNewsLetterRequestResponse {
|
|
|
13483
12510
|
*/
|
|
13484
12511
|
'status'?: number;
|
|
13485
12512
|
}
|
|
13486
|
-
/**
|
|
13487
|
-
*
|
|
13488
|
-
* @export
|
|
13489
|
-
* @interface DataTypesNewsLetterRequestsListResponse
|
|
13490
|
-
*/
|
|
13491
|
-
export interface DataTypesNewsLetterRequestsListResponse {
|
|
13492
|
-
/**
|
|
13493
|
-
*
|
|
13494
|
-
* @type {Array<DataTypesNewsLetterRequest>}
|
|
13495
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13496
|
-
*/
|
|
13497
|
-
'data'?: Array<DataTypesNewsLetterRequest>;
|
|
13498
|
-
/**
|
|
13499
|
-
*
|
|
13500
|
-
* @type {string}
|
|
13501
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13502
|
-
*/
|
|
13503
|
-
'message'?: string;
|
|
13504
|
-
/**
|
|
13505
|
-
*
|
|
13506
|
-
* @type {number}
|
|
13507
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13508
|
-
*/
|
|
13509
|
-
'status'?: number;
|
|
13510
|
-
}
|
|
13511
12513
|
/**
|
|
13512
12514
|
*
|
|
13513
12515
|
* @export
|
|
@@ -13546,109 +12548,6 @@ export interface DataTypesOTPPayload {
|
|
|
13546
12548
|
*/
|
|
13547
12549
|
'otp'?: string;
|
|
13548
12550
|
}
|
|
13549
|
-
/**
|
|
13550
|
-
*
|
|
13551
|
-
* @export
|
|
13552
|
-
* @interface DataTypesOfficialSearchResponse
|
|
13553
|
-
*/
|
|
13554
|
-
export interface DataTypesOfficialSearchResponse {
|
|
13555
|
-
/**
|
|
13556
|
-
*
|
|
13557
|
-
* @type {any}
|
|
13558
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13559
|
-
*/
|
|
13560
|
-
'facets'?: any;
|
|
13561
|
-
/**
|
|
13562
|
-
*
|
|
13563
|
-
* @type {number}
|
|
13564
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13565
|
-
*/
|
|
13566
|
-
'page'?: number;
|
|
13567
|
-
/**
|
|
13568
|
-
*
|
|
13569
|
-
* @type {number}
|
|
13570
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13571
|
-
*/
|
|
13572
|
-
'per_page'?: number;
|
|
13573
|
-
/**
|
|
13574
|
-
*
|
|
13575
|
-
* @type {Array<DataTypesOfficialSearchResult>}
|
|
13576
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13577
|
-
*/
|
|
13578
|
-
'results'?: Array<DataTypesOfficialSearchResult>;
|
|
13579
|
-
/**
|
|
13580
|
-
*
|
|
13581
|
-
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
13582
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13583
|
-
*/
|
|
13584
|
-
'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
|
|
13585
|
-
/**
|
|
13586
|
-
*
|
|
13587
|
-
* @type {number}
|
|
13588
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13589
|
-
*/
|
|
13590
|
-
'total_results'?: number;
|
|
13591
|
-
}
|
|
13592
|
-
/**
|
|
13593
|
-
*
|
|
13594
|
-
* @export
|
|
13595
|
-
* @interface DataTypesOfficialSearchResponseWrapper
|
|
13596
|
-
*/
|
|
13597
|
-
export interface DataTypesOfficialSearchResponseWrapper {
|
|
13598
|
-
/**
|
|
13599
|
-
*
|
|
13600
|
-
* @type {DataTypesOfficialSearchResponse}
|
|
13601
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13602
|
-
*/
|
|
13603
|
-
'data'?: DataTypesOfficialSearchResponse;
|
|
13604
|
-
/**
|
|
13605
|
-
*
|
|
13606
|
-
* @type {string}
|
|
13607
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13608
|
-
*/
|
|
13609
|
-
'message'?: string;
|
|
13610
|
-
/**
|
|
13611
|
-
*
|
|
13612
|
-
* @type {number}
|
|
13613
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13614
|
-
*/
|
|
13615
|
-
'status'?: number;
|
|
13616
|
-
}
|
|
13617
|
-
/**
|
|
13618
|
-
*
|
|
13619
|
-
* @export
|
|
13620
|
-
* @interface DataTypesOfficialSearchResult
|
|
13621
|
-
*/
|
|
13622
|
-
export interface DataTypesOfficialSearchResult {
|
|
13623
|
-
/**
|
|
13624
|
-
*
|
|
13625
|
-
* @type {{ [key: string]: any; }}
|
|
13626
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13627
|
-
*/
|
|
13628
|
-
'document'?: {
|
|
13629
|
-
[key: string]: any;
|
|
13630
|
-
};
|
|
13631
|
-
/**
|
|
13632
|
-
*
|
|
13633
|
-
* @type {{ [key: string]: any; }}
|
|
13634
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13635
|
-
*/
|
|
13636
|
-
'highlight'?: {
|
|
13637
|
-
[key: string]: any;
|
|
13638
|
-
};
|
|
13639
|
-
/**
|
|
13640
|
-
*
|
|
13641
|
-
* @type {string}
|
|
13642
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13643
|
-
*/
|
|
13644
|
-
'id'?: string;
|
|
13645
|
-
/**
|
|
13646
|
-
*
|
|
13647
|
-
* @type {number}
|
|
13648
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13649
|
-
*/
|
|
13650
|
-
'score'?: number;
|
|
13651
|
-
}
|
|
13652
12551
|
/**
|
|
13653
12552
|
*
|
|
13654
12553
|
* @export
|
|
@@ -14190,6 +13089,117 @@ export interface DataTypesOrdersListResponse {
|
|
|
14190
13089
|
*/
|
|
14191
13090
|
'total_pages'?: number;
|
|
14192
13091
|
}
|
|
13092
|
+
/**
|
|
13093
|
+
*
|
|
13094
|
+
* @export
|
|
13095
|
+
* @interface DataTypesOrgMemberWithUser
|
|
13096
|
+
*/
|
|
13097
|
+
export interface DataTypesOrgMemberWithUser {
|
|
13098
|
+
/**
|
|
13099
|
+
*
|
|
13100
|
+
* @type {string}
|
|
13101
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13102
|
+
*/
|
|
13103
|
+
'email'?: string;
|
|
13104
|
+
/**
|
|
13105
|
+
*
|
|
13106
|
+
* @type {string}
|
|
13107
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13108
|
+
*/
|
|
13109
|
+
'first_name'?: string;
|
|
13110
|
+
/**
|
|
13111
|
+
*
|
|
13112
|
+
* @type {boolean}
|
|
13113
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13114
|
+
*/
|
|
13115
|
+
'is_active'?: boolean;
|
|
13116
|
+
/**
|
|
13117
|
+
*
|
|
13118
|
+
* @type {string}
|
|
13119
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13120
|
+
*/
|
|
13121
|
+
'joined_at'?: string;
|
|
13122
|
+
/**
|
|
13123
|
+
*
|
|
13124
|
+
* @type {string}
|
|
13125
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13126
|
+
*/
|
|
13127
|
+
'last_name'?: string;
|
|
13128
|
+
/**
|
|
13129
|
+
*
|
|
13130
|
+
* @type {number}
|
|
13131
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13132
|
+
*/
|
|
13133
|
+
'member_id'?: number;
|
|
13134
|
+
/**
|
|
13135
|
+
*
|
|
13136
|
+
* @type {string}
|
|
13137
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13138
|
+
*/
|
|
13139
|
+
'member_role'?: string;
|
|
13140
|
+
/**
|
|
13141
|
+
*
|
|
13142
|
+
* @type {number}
|
|
13143
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13144
|
+
*/
|
|
13145
|
+
'org_id'?: number;
|
|
13146
|
+
/**
|
|
13147
|
+
* Number of stores user has access to
|
|
13148
|
+
* @type {number}
|
|
13149
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13150
|
+
*/
|
|
13151
|
+
'stores_count'?: number;
|
|
13152
|
+
/**
|
|
13153
|
+
*
|
|
13154
|
+
* @type {number}
|
|
13155
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13156
|
+
*/
|
|
13157
|
+
'user_id'?: number;
|
|
13158
|
+
}
|
|
13159
|
+
/**
|
|
13160
|
+
*
|
|
13161
|
+
* @export
|
|
13162
|
+
* @interface DataTypesOrgMembersData
|
|
13163
|
+
*/
|
|
13164
|
+
export interface DataTypesOrgMembersData {
|
|
13165
|
+
/**
|
|
13166
|
+
*
|
|
13167
|
+
* @type {Array<DataTypesOrgMemberWithUser>}
|
|
13168
|
+
* @memberof DataTypesOrgMembersData
|
|
13169
|
+
*/
|
|
13170
|
+
'members'?: Array<DataTypesOrgMemberWithUser>;
|
|
13171
|
+
/**
|
|
13172
|
+
*
|
|
13173
|
+
* @type {number}
|
|
13174
|
+
* @memberof DataTypesOrgMembersData
|
|
13175
|
+
*/
|
|
13176
|
+
'total'?: number;
|
|
13177
|
+
}
|
|
13178
|
+
/**
|
|
13179
|
+
*
|
|
13180
|
+
* @export
|
|
13181
|
+
* @interface DataTypesOrgMembersResponse
|
|
13182
|
+
*/
|
|
13183
|
+
export interface DataTypesOrgMembersResponse {
|
|
13184
|
+
/**
|
|
13185
|
+
*
|
|
13186
|
+
* @type {DataTypesOrgMembersData}
|
|
13187
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13188
|
+
*/
|
|
13189
|
+
'data'?: DataTypesOrgMembersData;
|
|
13190
|
+
/**
|
|
13191
|
+
*
|
|
13192
|
+
* @type {string}
|
|
13193
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13194
|
+
*/
|
|
13195
|
+
'message'?: string;
|
|
13196
|
+
/**
|
|
13197
|
+
*
|
|
13198
|
+
* @type {number}
|
|
13199
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13200
|
+
*/
|
|
13201
|
+
'status'?: number;
|
|
13202
|
+
}
|
|
14193
13203
|
/**
|
|
14194
13204
|
*
|
|
14195
13205
|
* @export
|
|
@@ -14555,31 +13565,6 @@ export interface DataTypesOrganizationTaxDetails {
|
|
|
14555
13565
|
[key: string]: any;
|
|
14556
13566
|
};
|
|
14557
13567
|
}
|
|
14558
|
-
/**
|
|
14559
|
-
*
|
|
14560
|
-
* @export
|
|
14561
|
-
* @interface DataTypesOrganizationsListResponse
|
|
14562
|
-
*/
|
|
14563
|
-
export interface DataTypesOrganizationsListResponse {
|
|
14564
|
-
/**
|
|
14565
|
-
*
|
|
14566
|
-
* @type {Array<DataTypesOrganization>}
|
|
14567
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14568
|
-
*/
|
|
14569
|
-
'data'?: Array<DataTypesOrganization>;
|
|
14570
|
-
/**
|
|
14571
|
-
*
|
|
14572
|
-
* @type {string}
|
|
14573
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14574
|
-
*/
|
|
14575
|
-
'message'?: string;
|
|
14576
|
-
/**
|
|
14577
|
-
*
|
|
14578
|
-
* @type {number}
|
|
14579
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14580
|
-
*/
|
|
14581
|
-
'status'?: number;
|
|
14582
|
-
}
|
|
14583
13568
|
/**
|
|
14584
13569
|
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
14585
13570
|
* @export
|
|
@@ -15092,31 +14077,6 @@ export interface DataTypesPaymentStatusPollResponse {
|
|
|
15092
14077
|
*/
|
|
15093
14078
|
'updated_at'?: string;
|
|
15094
14079
|
}
|
|
15095
|
-
/**
|
|
15096
|
-
*
|
|
15097
|
-
* @export
|
|
15098
|
-
* @interface DataTypesPaymentsListResponse
|
|
15099
|
-
*/
|
|
15100
|
-
export interface DataTypesPaymentsListResponse {
|
|
15101
|
-
/**
|
|
15102
|
-
*
|
|
15103
|
-
* @type {Array<DataTypesPayment>}
|
|
15104
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15105
|
-
*/
|
|
15106
|
-
'data'?: Array<DataTypesPayment>;
|
|
15107
|
-
/**
|
|
15108
|
-
*
|
|
15109
|
-
* @type {string}
|
|
15110
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15111
|
-
*/
|
|
15112
|
-
'message'?: string;
|
|
15113
|
-
/**
|
|
15114
|
-
*
|
|
15115
|
-
* @type {number}
|
|
15116
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15117
|
-
*/
|
|
15118
|
-
'status'?: number;
|
|
15119
|
-
}
|
|
15120
14080
|
/**
|
|
15121
14081
|
*
|
|
15122
14082
|
* @export
|
|
@@ -15238,31 +14198,6 @@ export interface DataTypesPlanResponse {
|
|
|
15238
14198
|
*/
|
|
15239
14199
|
'status'?: number;
|
|
15240
14200
|
}
|
|
15241
|
-
/**
|
|
15242
|
-
*
|
|
15243
|
-
* @export
|
|
15244
|
-
* @interface DataTypesPlansListResponse
|
|
15245
|
-
*/
|
|
15246
|
-
export interface DataTypesPlansListResponse {
|
|
15247
|
-
/**
|
|
15248
|
-
*
|
|
15249
|
-
* @type {Array<DataTypesPlan>}
|
|
15250
|
-
* @memberof DataTypesPlansListResponse
|
|
15251
|
-
*/
|
|
15252
|
-
'data'?: Array<DataTypesPlan>;
|
|
15253
|
-
/**
|
|
15254
|
-
*
|
|
15255
|
-
* @type {string}
|
|
15256
|
-
* @memberof DataTypesPlansListResponse
|
|
15257
|
-
*/
|
|
15258
|
-
'message'?: string;
|
|
15259
|
-
/**
|
|
15260
|
-
*
|
|
15261
|
-
* @type {number}
|
|
15262
|
-
* @memberof DataTypesPlansListResponse
|
|
15263
|
-
*/
|
|
15264
|
-
'status'?: number;
|
|
15265
|
-
}
|
|
15266
14201
|
/**
|
|
15267
14202
|
*
|
|
15268
14203
|
* @export
|
|
@@ -15578,91 +14513,6 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
15578
14513
|
*/
|
|
15579
14514
|
'status'?: number;
|
|
15580
14515
|
}
|
|
15581
|
-
/**
|
|
15582
|
-
*
|
|
15583
|
-
* @export
|
|
15584
|
-
* @interface DataTypesPublicSearchRequest
|
|
15585
|
-
*/
|
|
15586
|
-
export interface DataTypesPublicSearchRequest {
|
|
15587
|
-
/**
|
|
15588
|
-
*
|
|
15589
|
-
* @type {Array<string>}
|
|
15590
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15591
|
-
*/
|
|
15592
|
-
'analytics_tags'?: Array<string>;
|
|
15593
|
-
/**
|
|
15594
|
-
*
|
|
15595
|
-
* @type {string}
|
|
15596
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15597
|
-
*/
|
|
15598
|
-
'facet_by'?: string;
|
|
15599
|
-
/**
|
|
15600
|
-
*
|
|
15601
|
-
* @type {string}
|
|
15602
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15603
|
-
*/
|
|
15604
|
-
'filter'?: string;
|
|
15605
|
-
/**
|
|
15606
|
-
*
|
|
15607
|
-
* @type {boolean}
|
|
15608
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15609
|
-
*/
|
|
15610
|
-
'include_suggestions'?: boolean;
|
|
15611
|
-
/**
|
|
15612
|
-
*
|
|
15613
|
-
* @type {number}
|
|
15614
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15615
|
-
*/
|
|
15616
|
-
'max_facet_values'?: number;
|
|
15617
|
-
/**
|
|
15618
|
-
*
|
|
15619
|
-
* @type {number}
|
|
15620
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15621
|
-
*/
|
|
15622
|
-
'page'?: number;
|
|
15623
|
-
/**
|
|
15624
|
-
*
|
|
15625
|
-
* @type {number}
|
|
15626
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15627
|
-
*/
|
|
15628
|
-
'per_page'?: number;
|
|
15629
|
-
/**
|
|
15630
|
-
*
|
|
15631
|
-
* @type {string}
|
|
15632
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15633
|
-
*/
|
|
15634
|
-
'q': string;
|
|
15635
|
-
/**
|
|
15636
|
-
*
|
|
15637
|
-
* @type {string}
|
|
15638
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15639
|
-
*/
|
|
15640
|
-
'sort'?: string;
|
|
15641
|
-
/**
|
|
15642
|
-
* IDs of stopword sets to use
|
|
15643
|
-
* @type {Array<string>}
|
|
15644
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15645
|
-
*/
|
|
15646
|
-
'stopword_sets'?: Array<string>;
|
|
15647
|
-
/**
|
|
15648
|
-
*
|
|
15649
|
-
* @type {number}
|
|
15650
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15651
|
-
*/
|
|
15652
|
-
'suggestions_limit'?: number;
|
|
15653
|
-
/**
|
|
15654
|
-
* IDs of synonym sets to use
|
|
15655
|
-
* @type {Array<string>}
|
|
15656
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15657
|
-
*/
|
|
15658
|
-
'synonym_sets'?: Array<string>;
|
|
15659
|
-
/**
|
|
15660
|
-
* If true, returns only display fields instead of full document (used in public API only)
|
|
15661
|
-
* @type {boolean}
|
|
15662
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15663
|
-
*/
|
|
15664
|
-
'widget_mode'?: boolean;
|
|
15665
|
-
}
|
|
15666
14516
|
/**
|
|
15667
14517
|
*
|
|
15668
14518
|
* @export
|
|
@@ -16679,31 +15529,6 @@ export interface DataTypesRoleRightsListResponse {
|
|
|
16679
15529
|
*/
|
|
16680
15530
|
'status'?: number;
|
|
16681
15531
|
}
|
|
16682
|
-
/**
|
|
16683
|
-
*
|
|
16684
|
-
* @export
|
|
16685
|
-
* @interface DataTypesRolesListResponse
|
|
16686
|
-
*/
|
|
16687
|
-
export interface DataTypesRolesListResponse {
|
|
16688
|
-
/**
|
|
16689
|
-
*
|
|
16690
|
-
* @type {Array<DataTypesRole>}
|
|
16691
|
-
* @memberof DataTypesRolesListResponse
|
|
16692
|
-
*/
|
|
16693
|
-
'data'?: Array<DataTypesRole>;
|
|
16694
|
-
/**
|
|
16695
|
-
*
|
|
16696
|
-
* @type {string}
|
|
16697
|
-
* @memberof DataTypesRolesListResponse
|
|
16698
|
-
*/
|
|
16699
|
-
'message'?: string;
|
|
16700
|
-
/**
|
|
16701
|
-
*
|
|
16702
|
-
* @type {number}
|
|
16703
|
-
* @memberof DataTypesRolesListResponse
|
|
16704
|
-
*/
|
|
16705
|
-
'status'?: number;
|
|
16706
|
-
}
|
|
16707
15532
|
/**
|
|
16708
15533
|
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
16709
15534
|
* @export
|
|
@@ -17263,31 +16088,6 @@ export interface DataTypesServiceRequestResponse {
|
|
|
17263
16088
|
*/
|
|
17264
16089
|
'status'?: number;
|
|
17265
16090
|
}
|
|
17266
|
-
/**
|
|
17267
|
-
*
|
|
17268
|
-
* @export
|
|
17269
|
-
* @interface DataTypesServiceRequestsListResponse
|
|
17270
|
-
*/
|
|
17271
|
-
export interface DataTypesServiceRequestsListResponse {
|
|
17272
|
-
/**
|
|
17273
|
-
*
|
|
17274
|
-
* @type {Array<DataTypesServiceRequest>}
|
|
17275
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17276
|
-
*/
|
|
17277
|
-
'data'?: Array<DataTypesServiceRequest>;
|
|
17278
|
-
/**
|
|
17279
|
-
*
|
|
17280
|
-
* @type {string}
|
|
17281
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17282
|
-
*/
|
|
17283
|
-
'message'?: string;
|
|
17284
|
-
/**
|
|
17285
|
-
*
|
|
17286
|
-
* @type {number}
|
|
17287
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17288
|
-
*/
|
|
17289
|
-
'status'?: number;
|
|
17290
|
-
}
|
|
17291
16091
|
/**
|
|
17292
16092
|
*
|
|
17293
16093
|
* @export
|
|
@@ -17534,6 +16334,129 @@ export interface DataTypesStore {
|
|
|
17534
16334
|
*/
|
|
17535
16335
|
'xStoreID'?: string;
|
|
17536
16336
|
}
|
|
16337
|
+
/**
|
|
16338
|
+
*
|
|
16339
|
+
* @export
|
|
16340
|
+
* @interface DataTypesStoreAccessRequest
|
|
16341
|
+
*/
|
|
16342
|
+
export interface DataTypesStoreAccessRequest {
|
|
16343
|
+
/**
|
|
16344
|
+
*
|
|
16345
|
+
* @type {string}
|
|
16346
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16347
|
+
*/
|
|
16348
|
+
'access_level': DataTypesStoreAccessRequestAccessLevelEnum;
|
|
16349
|
+
/**
|
|
16350
|
+
*
|
|
16351
|
+
* @type {number}
|
|
16352
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16353
|
+
*/
|
|
16354
|
+
'store_id': number;
|
|
16355
|
+
}
|
|
16356
|
+
export declare const DataTypesStoreAccessRequestAccessLevelEnum: {
|
|
16357
|
+
readonly Read: "read";
|
|
16358
|
+
readonly Write: "write";
|
|
16359
|
+
readonly Admin: "admin";
|
|
16360
|
+
};
|
|
16361
|
+
export type DataTypesStoreAccessRequestAccessLevelEnum = typeof DataTypesStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesStoreAccessRequestAccessLevelEnum];
|
|
16362
|
+
/**
|
|
16363
|
+
*
|
|
16364
|
+
* @export
|
|
16365
|
+
* @interface DataTypesStoreAccessResponse
|
|
16366
|
+
*/
|
|
16367
|
+
export interface DataTypesStoreAccessResponse {
|
|
16368
|
+
/**
|
|
16369
|
+
*
|
|
16370
|
+
* @type {Array<DataTypesStoreAccessWithDetails>}
|
|
16371
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16372
|
+
*/
|
|
16373
|
+
'data'?: Array<DataTypesStoreAccessWithDetails>;
|
|
16374
|
+
/**
|
|
16375
|
+
*
|
|
16376
|
+
* @type {string}
|
|
16377
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16378
|
+
*/
|
|
16379
|
+
'message'?: string;
|
|
16380
|
+
/**
|
|
16381
|
+
*
|
|
16382
|
+
* @type {number}
|
|
16383
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16384
|
+
*/
|
|
16385
|
+
'status'?: number;
|
|
16386
|
+
}
|
|
16387
|
+
/**
|
|
16388
|
+
*
|
|
16389
|
+
* @export
|
|
16390
|
+
* @interface DataTypesStoreAccessWithDetails
|
|
16391
|
+
*/
|
|
16392
|
+
export interface DataTypesStoreAccessWithDetails {
|
|
16393
|
+
/**
|
|
16394
|
+
*
|
|
16395
|
+
* @type {number}
|
|
16396
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16397
|
+
*/
|
|
16398
|
+
'access_id'?: number;
|
|
16399
|
+
/**
|
|
16400
|
+
*
|
|
16401
|
+
* @type {string}
|
|
16402
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16403
|
+
*/
|
|
16404
|
+
'access_level'?: string;
|
|
16405
|
+
/**
|
|
16406
|
+
*
|
|
16407
|
+
* @type {string}
|
|
16408
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16409
|
+
*/
|
|
16410
|
+
'email'?: string;
|
|
16411
|
+
/**
|
|
16412
|
+
*
|
|
16413
|
+
* @type {string}
|
|
16414
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16415
|
+
*/
|
|
16416
|
+
'first_name'?: string;
|
|
16417
|
+
/**
|
|
16418
|
+
*
|
|
16419
|
+
* @type {string}
|
|
16420
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16421
|
+
*/
|
|
16422
|
+
'granted_at'?: string;
|
|
16423
|
+
/**
|
|
16424
|
+
*
|
|
16425
|
+
* @type {number}
|
|
16426
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16427
|
+
*/
|
|
16428
|
+
'granted_by'?: number;
|
|
16429
|
+
/**
|
|
16430
|
+
*
|
|
16431
|
+
* @type {boolean}
|
|
16432
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16433
|
+
*/
|
|
16434
|
+
'is_active'?: boolean;
|
|
16435
|
+
/**
|
|
16436
|
+
*
|
|
16437
|
+
* @type {string}
|
|
16438
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16439
|
+
*/
|
|
16440
|
+
'last_name'?: string;
|
|
16441
|
+
/**
|
|
16442
|
+
*
|
|
16443
|
+
* @type {number}
|
|
16444
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16445
|
+
*/
|
|
16446
|
+
'store_id'?: number;
|
|
16447
|
+
/**
|
|
16448
|
+
*
|
|
16449
|
+
* @type {string}
|
|
16450
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16451
|
+
*/
|
|
16452
|
+
'store_name'?: string;
|
|
16453
|
+
/**
|
|
16454
|
+
*
|
|
16455
|
+
* @type {number}
|
|
16456
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16457
|
+
*/
|
|
16458
|
+
'user_id'?: number;
|
|
16459
|
+
}
|
|
17537
16460
|
/**
|
|
17538
16461
|
*
|
|
17539
16462
|
* @export
|
|
@@ -17818,6 +16741,12 @@ export interface DataTypesStoresListResponse {
|
|
|
17818
16741
|
* @interface DataTypesSubMenuAccess
|
|
17819
16742
|
*/
|
|
17820
16743
|
export interface DataTypesSubMenuAccess {
|
|
16744
|
+
/**
|
|
16745
|
+
* Store IDs user has access to (for store-specific menus)
|
|
16746
|
+
* @type {Array<number>}
|
|
16747
|
+
* @memberof DataTypesSubMenuAccess
|
|
16748
|
+
*/
|
|
16749
|
+
'accessibleStores'?: Array<number>;
|
|
17821
16750
|
/**
|
|
17822
16751
|
*
|
|
17823
16752
|
* @type {boolean}
|
|
@@ -18025,31 +16954,6 @@ export interface DataTypesSubscriptionResponse {
|
|
|
18025
16954
|
*/
|
|
18026
16955
|
'status'?: number;
|
|
18027
16956
|
}
|
|
18028
|
-
/**
|
|
18029
|
-
*
|
|
18030
|
-
* @export
|
|
18031
|
-
* @interface DataTypesSubscriptionsListResponse
|
|
18032
|
-
*/
|
|
18033
|
-
export interface DataTypesSubscriptionsListResponse {
|
|
18034
|
-
/**
|
|
18035
|
-
*
|
|
18036
|
-
* @type {Array<DataTypesSubscription>}
|
|
18037
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18038
|
-
*/
|
|
18039
|
-
'data'?: Array<DataTypesSubscription>;
|
|
18040
|
-
/**
|
|
18041
|
-
*
|
|
18042
|
-
* @type {string}
|
|
18043
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18044
|
-
*/
|
|
18045
|
-
'message'?: string;
|
|
18046
|
-
/**
|
|
18047
|
-
*
|
|
18048
|
-
* @type {number}
|
|
18049
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18050
|
-
*/
|
|
18051
|
-
'status'?: number;
|
|
18052
|
-
}
|
|
18053
16957
|
/**
|
|
18054
16958
|
*
|
|
18055
16959
|
* @export
|
|
@@ -18521,6 +17425,128 @@ export interface DataTypesTaxComponent {
|
|
|
18521
17425
|
*/
|
|
18522
17426
|
'taxable_amount'?: number;
|
|
18523
17427
|
}
|
|
17428
|
+
/**
|
|
17429
|
+
*
|
|
17430
|
+
* @export
|
|
17431
|
+
* @interface DataTypesTeamInvitationWithDetails
|
|
17432
|
+
*/
|
|
17433
|
+
export interface DataTypesTeamInvitationWithDetails {
|
|
17434
|
+
/**
|
|
17435
|
+
*
|
|
17436
|
+
* @type {string}
|
|
17437
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17438
|
+
*/
|
|
17439
|
+
'accepted_at'?: string;
|
|
17440
|
+
/**
|
|
17441
|
+
*
|
|
17442
|
+
* @type {string}
|
|
17443
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17444
|
+
*/
|
|
17445
|
+
'created_at'?: string;
|
|
17446
|
+
/**
|
|
17447
|
+
*
|
|
17448
|
+
* @type {string}
|
|
17449
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17450
|
+
*/
|
|
17451
|
+
'email'?: string;
|
|
17452
|
+
/**
|
|
17453
|
+
*
|
|
17454
|
+
* @type {string}
|
|
17455
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17456
|
+
*/
|
|
17457
|
+
'expires_at'?: string;
|
|
17458
|
+
/**
|
|
17459
|
+
*
|
|
17460
|
+
* @type {number}
|
|
17461
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17462
|
+
*/
|
|
17463
|
+
'invitation_id'?: number;
|
|
17464
|
+
/**
|
|
17465
|
+
*
|
|
17466
|
+
* @type {number}
|
|
17467
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17468
|
+
*/
|
|
17469
|
+
'invited_by'?: number;
|
|
17470
|
+
/**
|
|
17471
|
+
*
|
|
17472
|
+
* @type {string}
|
|
17473
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17474
|
+
*/
|
|
17475
|
+
'inviter_email'?: string;
|
|
17476
|
+
/**
|
|
17477
|
+
*
|
|
17478
|
+
* @type {string}
|
|
17479
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17480
|
+
*/
|
|
17481
|
+
'inviter_name'?: string;
|
|
17482
|
+
/**
|
|
17483
|
+
*
|
|
17484
|
+
* @type {string}
|
|
17485
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17486
|
+
*/
|
|
17487
|
+
'member_role'?: string;
|
|
17488
|
+
/**
|
|
17489
|
+
*
|
|
17490
|
+
* @type {number}
|
|
17491
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17492
|
+
*/
|
|
17493
|
+
'org_id'?: number;
|
|
17494
|
+
/**
|
|
17495
|
+
*
|
|
17496
|
+
* @type {string}
|
|
17497
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17498
|
+
*/
|
|
17499
|
+
'org_name'?: string;
|
|
17500
|
+
/**
|
|
17501
|
+
*
|
|
17502
|
+
* @type {string}
|
|
17503
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17504
|
+
*/
|
|
17505
|
+
'rejected_at'?: string;
|
|
17506
|
+
/**
|
|
17507
|
+
*
|
|
17508
|
+
* @type {string}
|
|
17509
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17510
|
+
*/
|
|
17511
|
+
'status'?: string;
|
|
17512
|
+
/**
|
|
17513
|
+
* Store IDs to grant access to
|
|
17514
|
+
* @type {Array<number>}
|
|
17515
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17516
|
+
*/
|
|
17517
|
+
'store_access'?: Array<number>;
|
|
17518
|
+
/**
|
|
17519
|
+
* Only for pending invitations
|
|
17520
|
+
* @type {string}
|
|
17521
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17522
|
+
*/
|
|
17523
|
+
'token'?: string;
|
|
17524
|
+
}
|
|
17525
|
+
/**
|
|
17526
|
+
*
|
|
17527
|
+
* @export
|
|
17528
|
+
* @interface DataTypesTeamInvitationsResponse
|
|
17529
|
+
*/
|
|
17530
|
+
export interface DataTypesTeamInvitationsResponse {
|
|
17531
|
+
/**
|
|
17532
|
+
*
|
|
17533
|
+
* @type {Array<DataTypesTeamInvitationWithDetails>}
|
|
17534
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17535
|
+
*/
|
|
17536
|
+
'data'?: Array<DataTypesTeamInvitationWithDetails>;
|
|
17537
|
+
/**
|
|
17538
|
+
*
|
|
17539
|
+
* @type {string}
|
|
17540
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17541
|
+
*/
|
|
17542
|
+
'message'?: string;
|
|
17543
|
+
/**
|
|
17544
|
+
*
|
|
17545
|
+
* @type {number}
|
|
17546
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17547
|
+
*/
|
|
17548
|
+
'status'?: number;
|
|
17549
|
+
}
|
|
18524
17550
|
/**
|
|
18525
17551
|
*
|
|
18526
17552
|
* @export
|
|
@@ -18707,6 +17733,25 @@ export interface DataTypesUpdateInvoiceRequest {
|
|
|
18707
17733
|
*/
|
|
18708
17734
|
'status'?: string;
|
|
18709
17735
|
}
|
|
17736
|
+
/**
|
|
17737
|
+
*
|
|
17738
|
+
* @export
|
|
17739
|
+
* @interface DataTypesUpdateMemberRoleRequest
|
|
17740
|
+
*/
|
|
17741
|
+
export interface DataTypesUpdateMemberRoleRequest {
|
|
17742
|
+
/**
|
|
17743
|
+
*
|
|
17744
|
+
* @type {string}
|
|
17745
|
+
* @memberof DataTypesUpdateMemberRoleRequest
|
|
17746
|
+
*/
|
|
17747
|
+
'member_role': DataTypesUpdateMemberRoleRequestMemberRoleEnum;
|
|
17748
|
+
}
|
|
17749
|
+
export declare const DataTypesUpdateMemberRoleRequestMemberRoleEnum: {
|
|
17750
|
+
readonly Owner: "owner";
|
|
17751
|
+
readonly Admin: "admin";
|
|
17752
|
+
readonly Member: "member";
|
|
17753
|
+
};
|
|
17754
|
+
export type DataTypesUpdateMemberRoleRequestMemberRoleEnum = typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum[keyof typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum];
|
|
18710
17755
|
/**
|
|
18711
17756
|
*
|
|
18712
17757
|
* @export
|
|
@@ -19111,6 +18156,25 @@ export interface DataTypesUpdateSourceConfigResponseWrapper {
|
|
|
19111
18156
|
*/
|
|
19112
18157
|
'status'?: number;
|
|
19113
18158
|
}
|
|
18159
|
+
/**
|
|
18160
|
+
*
|
|
18161
|
+
* @export
|
|
18162
|
+
* @interface DataTypesUpdateStoreAccessRequest
|
|
18163
|
+
*/
|
|
18164
|
+
export interface DataTypesUpdateStoreAccessRequest {
|
|
18165
|
+
/**
|
|
18166
|
+
*
|
|
18167
|
+
* @type {string}
|
|
18168
|
+
* @memberof DataTypesUpdateStoreAccessRequest
|
|
18169
|
+
*/
|
|
18170
|
+
'access_level': DataTypesUpdateStoreAccessRequestAccessLevelEnum;
|
|
18171
|
+
}
|
|
18172
|
+
export declare const DataTypesUpdateStoreAccessRequestAccessLevelEnum: {
|
|
18173
|
+
readonly Read: "read";
|
|
18174
|
+
readonly Write: "write";
|
|
18175
|
+
readonly Admin: "admin";
|
|
18176
|
+
};
|
|
18177
|
+
export type DataTypesUpdateStoreAccessRequestAccessLevelEnum = typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum];
|
|
19114
18178
|
/**
|
|
19115
18179
|
*
|
|
19116
18180
|
* @export
|
|
@@ -19435,6 +18499,74 @@ export interface DataTypesUserResponse {
|
|
|
19435
18499
|
*/
|
|
19436
18500
|
'status'?: number;
|
|
19437
18501
|
}
|
|
18502
|
+
/**
|
|
18503
|
+
*
|
|
18504
|
+
* @export
|
|
18505
|
+
* @interface DataTypesUserStoreAccess
|
|
18506
|
+
*/
|
|
18507
|
+
export interface DataTypesUserStoreAccess {
|
|
18508
|
+
/**
|
|
18509
|
+
*
|
|
18510
|
+
* @type {string}
|
|
18511
|
+
* @memberof DataTypesUserStoreAccess
|
|
18512
|
+
*/
|
|
18513
|
+
'access_level'?: string;
|
|
18514
|
+
/**
|
|
18515
|
+
*
|
|
18516
|
+
* @type {number}
|
|
18517
|
+
* @memberof DataTypesUserStoreAccess
|
|
18518
|
+
*/
|
|
18519
|
+
'org_id'?: number;
|
|
18520
|
+
/**
|
|
18521
|
+
*
|
|
18522
|
+
* @type {string}
|
|
18523
|
+
* @memberof DataTypesUserStoreAccess
|
|
18524
|
+
*/
|
|
18525
|
+
'org_name'?: string;
|
|
18526
|
+
/**
|
|
18527
|
+
*
|
|
18528
|
+
* @type {number}
|
|
18529
|
+
* @memberof DataTypesUserStoreAccess
|
|
18530
|
+
*/
|
|
18531
|
+
'store_id'?: number;
|
|
18532
|
+
/**
|
|
18533
|
+
*
|
|
18534
|
+
* @type {string}
|
|
18535
|
+
* @memberof DataTypesUserStoreAccess
|
|
18536
|
+
*/
|
|
18537
|
+
'store_name'?: string;
|
|
18538
|
+
/**
|
|
18539
|
+
*
|
|
18540
|
+
* @type {string}
|
|
18541
|
+
* @memberof DataTypesUserStoreAccess
|
|
18542
|
+
*/
|
|
18543
|
+
'x_store_id'?: string;
|
|
18544
|
+
}
|
|
18545
|
+
/**
|
|
18546
|
+
*
|
|
18547
|
+
* @export
|
|
18548
|
+
* @interface DataTypesUserStoresResponse
|
|
18549
|
+
*/
|
|
18550
|
+
export interface DataTypesUserStoresResponse {
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @type {Array<DataTypesUserStoreAccess>}
|
|
18554
|
+
* @memberof DataTypesUserStoresResponse
|
|
18555
|
+
*/
|
|
18556
|
+
'data'?: Array<DataTypesUserStoreAccess>;
|
|
18557
|
+
/**
|
|
18558
|
+
*
|
|
18559
|
+
* @type {string}
|
|
18560
|
+
* @memberof DataTypesUserStoresResponse
|
|
18561
|
+
*/
|
|
18562
|
+
'message'?: string;
|
|
18563
|
+
/**
|
|
18564
|
+
*
|
|
18565
|
+
* @type {number}
|
|
18566
|
+
* @memberof DataTypesUserStoresResponse
|
|
18567
|
+
*/
|
|
18568
|
+
'status'?: number;
|
|
18569
|
+
}
|
|
19438
18570
|
/**
|
|
19439
18571
|
*
|
|
19440
18572
|
* @export
|
|
@@ -21887,41 +21019,6 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
21887
21019
|
* @throws {RequiredError}
|
|
21888
21020
|
*/
|
|
21889
21021
|
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) => Promise<RequestArgs>;
|
|
21890
|
-
/**
|
|
21891
|
-
* 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
|
|
21892
|
-
* @summary Get Query Insights
|
|
21893
|
-
* @param {string} xStoreID Store ID
|
|
21894
|
-
* @param {string} query Search query to analyze
|
|
21895
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
21896
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21897
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
21898
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
21899
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
21900
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
21901
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
21902
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
21903
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
21904
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
21905
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
21906
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
21907
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
21908
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
21909
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
21910
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21911
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
21912
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
21913
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
21914
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21915
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
21916
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21917
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21918
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
21919
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21920
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
21921
|
-
* @param {*} [options] Override http request option.
|
|
21922
|
-
* @throws {RequiredError}
|
|
21923
|
-
*/
|
|
21924
|
-
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<RequestArgs>;
|
|
21925
21022
|
/**
|
|
21926
21023
|
* 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.
|
|
21927
21024
|
* @summary Get Top Results Analytics
|
|
@@ -22327,41 +21424,6 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22327
21424
|
* @throws {RequiredError}
|
|
22328
21425
|
*/
|
|
22329
21426
|
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
22330
|
-
/**
|
|
22331
|
-
* 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
|
|
22332
|
-
* @summary Get Query Insights
|
|
22333
|
-
* @param {string} xStoreID Store ID
|
|
22334
|
-
* @param {string} query Search query to analyze
|
|
22335
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
22336
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
22337
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22338
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22339
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22340
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22341
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22342
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22343
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22344
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22345
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22346
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22347
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22348
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22349
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22350
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22351
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22352
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22353
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22354
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22355
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
22356
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22357
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22358
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22359
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22360
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22361
|
-
* @param {*} [options] Override http request option.
|
|
22362
|
-
* @throws {RequiredError}
|
|
22363
|
-
*/
|
|
22364
|
-
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>>;
|
|
22365
21427
|
/**
|
|
22366
21428
|
* 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.
|
|
22367
21429
|
* @summary Get Top Results Analytics
|
|
@@ -22767,41 +21829,6 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
22767
21829
|
* @throws {RequiredError}
|
|
22768
21830
|
*/
|
|
22769
21831
|
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>;
|
|
22770
|
-
/**
|
|
22771
|
-
* 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
|
|
22772
|
-
* @summary Get Query Insights
|
|
22773
|
-
* @param {string} xStoreID Store ID
|
|
22774
|
-
* @param {string} query Search query to analyze
|
|
22775
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
22776
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
22777
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22778
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22779
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22780
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22781
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22782
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22783
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22784
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22785
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22786
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22787
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22788
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22789
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22790
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22791
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22792
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22793
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22794
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22795
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
22796
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22797
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22798
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22799
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22800
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22801
|
-
* @param {*} [options] Override http request option.
|
|
22802
|
-
* @throws {RequiredError}
|
|
22803
|
-
*/
|
|
22804
|
-
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>;
|
|
22805
21832
|
/**
|
|
22806
21833
|
* 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.
|
|
22807
21834
|
* @summary Get Top Results Analytics
|
|
@@ -23223,42 +22250,6 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
23223
22250
|
* @memberof AnalyticsApi
|
|
23224
22251
|
*/
|
|
23225
22252
|
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): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
23226
|
-
/**
|
|
23227
|
-
* 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
|
|
23228
|
-
* @summary Get Query Insights
|
|
23229
|
-
* @param {string} xStoreID Store ID
|
|
23230
|
-
* @param {string} query Search query to analyze
|
|
23231
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
23232
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
23233
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23234
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23235
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23236
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23237
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23238
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23239
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23240
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23241
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23242
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23243
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23244
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23245
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23246
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23247
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23248
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23249
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23250
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23251
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
23252
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23253
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23254
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23255
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23256
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23257
|
-
* @param {*} [options] Override http request option.
|
|
23258
|
-
* @throws {RequiredError}
|
|
23259
|
-
* @memberof AnalyticsApi
|
|
23260
|
-
*/
|
|
23261
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
23262
22253
|
/**
|
|
23263
22254
|
* 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.
|
|
23264
22255
|
* @summary Get Top Results Analytics
|
|
@@ -23670,22 +22661,6 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
23670
22661
|
readonly Desc: "desc";
|
|
23671
22662
|
};
|
|
23672
22663
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
23673
|
-
/**
|
|
23674
|
-
* @export
|
|
23675
|
-
*/
|
|
23676
|
-
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
23677
|
-
readonly Any: "any";
|
|
23678
|
-
readonly All: "all";
|
|
23679
|
-
};
|
|
23680
|
-
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
23681
|
-
/**
|
|
23682
|
-
* @export
|
|
23683
|
-
*/
|
|
23684
|
-
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
23685
|
-
readonly Any: "any";
|
|
23686
|
-
readonly All: "all";
|
|
23687
|
-
};
|
|
23688
|
-
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
23689
22664
|
/**
|
|
23690
22665
|
* @export
|
|
23691
22666
|
*/
|
|
@@ -28999,13 +27974,6 @@ export declare const LimitsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
28999
27974
|
* @throws {RequiredError}
|
|
29000
27975
|
*/
|
|
29001
27976
|
miscLimitsChangeStatusLimitIDIsActivePut: (limitID: number, isActive: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29002
|
-
/**
|
|
29003
|
-
* Fetches list of all limits
|
|
29004
|
-
* @summary Fetches list of all limits
|
|
29005
|
-
* @param {*} [options] Override http request option.
|
|
29006
|
-
* @throws {RequiredError}
|
|
29007
|
-
*/
|
|
29008
|
-
miscLimitsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29009
27977
|
/**
|
|
29010
27978
|
* Fetches limit by id
|
|
29011
27979
|
* @summary Fetches limit by id
|
|
@@ -29046,13 +28014,6 @@ export declare const LimitsApiFp: (configuration?: Configuration) => {
|
|
|
29046
28014
|
* @throws {RequiredError}
|
|
29047
28015
|
*/
|
|
29048
28016
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
29049
|
-
/**
|
|
29050
|
-
* Fetches list of all limits
|
|
29051
|
-
* @summary Fetches list of all limits
|
|
29052
|
-
* @param {*} [options] Override http request option.
|
|
29053
|
-
* @throws {RequiredError}
|
|
29054
|
-
*/
|
|
29055
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLimitsListResponse>>;
|
|
29056
28017
|
/**
|
|
29057
28018
|
* Fetches limit by id
|
|
29058
28019
|
* @summary Fetches limit by id
|
|
@@ -29093,13 +28054,6 @@ export declare const LimitsApiFactory: (configuration?: Configuration, basePath?
|
|
|
29093
28054
|
* @throws {RequiredError}
|
|
29094
28055
|
*/
|
|
29095
28056
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
29096
|
-
/**
|
|
29097
|
-
* Fetches list of all limits
|
|
29098
|
-
* @summary Fetches list of all limits
|
|
29099
|
-
* @param {*} [options] Override http request option.
|
|
29100
|
-
* @throws {RequiredError}
|
|
29101
|
-
*/
|
|
29102
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLimitsListResponse>;
|
|
29103
28057
|
/**
|
|
29104
28058
|
* Fetches limit by id
|
|
29105
28059
|
* @summary Fetches limit by id
|
|
@@ -29143,14 +28097,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29143
28097
|
* @memberof LimitsApi
|
|
29144
28098
|
*/
|
|
29145
28099
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
29146
|
-
/**
|
|
29147
|
-
* Fetches list of all limits
|
|
29148
|
-
* @summary Fetches list of all limits
|
|
29149
|
-
* @param {*} [options] Override http request option.
|
|
29150
|
-
* @throws {RequiredError}
|
|
29151
|
-
* @memberof LimitsApi
|
|
29152
|
-
*/
|
|
29153
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesLimitsListResponse, any, {}>>;
|
|
29154
28100
|
/**
|
|
29155
28101
|
* Fetches limit by id
|
|
29156
28102
|
* @summary Fetches limit by id
|
|
@@ -29185,13 +28131,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29185
28131
|
* @export
|
|
29186
28132
|
*/
|
|
29187
28133
|
export declare const MenusApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29188
|
-
/**
|
|
29189
|
-
* Fetches list of all menus
|
|
29190
|
-
* @summary Fetches list of all menus
|
|
29191
|
-
* @param {*} [options] Override http request option.
|
|
29192
|
-
* @throws {RequiredError}
|
|
29193
|
-
*/
|
|
29194
|
-
miscMenusGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29195
28134
|
/**
|
|
29196
28135
|
* Deletes a menu from the system by ID.
|
|
29197
28136
|
* @summary Delete a menu
|
|
@@ -29310,13 +28249,6 @@ export declare const MenusApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29310
28249
|
* @export
|
|
29311
28250
|
*/
|
|
29312
28251
|
export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
29313
|
-
/**
|
|
29314
|
-
* Fetches list of all menus
|
|
29315
|
-
* @summary Fetches list of all menus
|
|
29316
|
-
* @param {*} [options] Override http request option.
|
|
29317
|
-
* @throws {RequiredError}
|
|
29318
|
-
*/
|
|
29319
|
-
miscMenusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMenusListResponse>>;
|
|
29320
28252
|
/**
|
|
29321
28253
|
* Deletes a menu from the system by ID.
|
|
29322
28254
|
* @summary Delete a menu
|
|
@@ -29435,13 +28367,6 @@ export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
|
29435
28367
|
* @export
|
|
29436
28368
|
*/
|
|
29437
28369
|
export declare const MenusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29438
|
-
/**
|
|
29439
|
-
* Fetches list of all menus
|
|
29440
|
-
* @summary Fetches list of all menus
|
|
29441
|
-
* @param {*} [options] Override http request option.
|
|
29442
|
-
* @throws {RequiredError}
|
|
29443
|
-
*/
|
|
29444
|
-
miscMenusGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMenusListResponse>;
|
|
29445
28370
|
/**
|
|
29446
28371
|
* Deletes a menu from the system by ID.
|
|
29447
28372
|
* @summary Delete a menu
|
|
@@ -29562,14 +28487,6 @@ export declare const MenusApiFactory: (configuration?: Configuration, basePath?:
|
|
|
29562
28487
|
* @extends {BaseAPI}
|
|
29563
28488
|
*/
|
|
29564
28489
|
export declare class MenusApi extends BaseAPI {
|
|
29565
|
-
/**
|
|
29566
|
-
* Fetches list of all menus
|
|
29567
|
-
* @summary Fetches list of all menus
|
|
29568
|
-
* @param {*} [options] Override http request option.
|
|
29569
|
-
* @throws {RequiredError}
|
|
29570
|
-
* @memberof MenusApi
|
|
29571
|
-
*/
|
|
29572
|
-
miscMenusGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesMenusListResponse, any, {}>>;
|
|
29573
28490
|
/**
|
|
29574
28491
|
* Deletes a menu from the system by ID.
|
|
29575
28492
|
* @summary Delete a menu
|
|
@@ -30120,13 +29037,6 @@ export declare class MongoDbApi extends BaseAPI {
|
|
|
30120
29037
|
* @export
|
|
30121
29038
|
*/
|
|
30122
29039
|
export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30123
|
-
/**
|
|
30124
|
-
* Fetches list of all NewsLetterSubscription
|
|
30125
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30126
|
-
* @param {*} [options] Override http request option.
|
|
30127
|
-
* @throws {RequiredError}
|
|
30128
|
-
*/
|
|
30129
|
-
miscNewsLettersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30130
29040
|
/**
|
|
30131
29041
|
* Fetches NewsLetterSubscription by id
|
|
30132
29042
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30167,13 +29077,6 @@ export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configura
|
|
|
30167
29077
|
* @export
|
|
30168
29078
|
*/
|
|
30169
29079
|
export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
30170
|
-
/**
|
|
30171
|
-
* Fetches list of all NewsLetterSubscription
|
|
30172
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30173
|
-
* @param {*} [options] Override http request option.
|
|
30174
|
-
* @throws {RequiredError}
|
|
30175
|
-
*/
|
|
30176
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesNewsLetterRequestsListResponse>>;
|
|
30177
29080
|
/**
|
|
30178
29081
|
* Fetches NewsLetterSubscription by id
|
|
30179
29082
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30214,13 +29117,6 @@ export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
|
30214
29117
|
* @export
|
|
30215
29118
|
*/
|
|
30216
29119
|
export declare const NewsLettersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30217
|
-
/**
|
|
30218
|
-
* Fetches list of all NewsLetterSubscription
|
|
30219
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30220
|
-
* @param {*} [options] Override http request option.
|
|
30221
|
-
* @throws {RequiredError}
|
|
30222
|
-
*/
|
|
30223
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesNewsLetterRequestsListResponse>;
|
|
30224
29120
|
/**
|
|
30225
29121
|
* Fetches NewsLetterSubscription by id
|
|
30226
29122
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30263,14 +29159,6 @@ export declare const NewsLettersApiFactory: (configuration?: Configuration, base
|
|
|
30263
29159
|
* @extends {BaseAPI}
|
|
30264
29160
|
*/
|
|
30265
29161
|
export declare class NewsLettersApi extends BaseAPI {
|
|
30266
|
-
/**
|
|
30267
|
-
* Fetches list of all NewsLetterSubscription
|
|
30268
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30269
|
-
* @param {*} [options] Override http request option.
|
|
30270
|
-
* @throws {RequiredError}
|
|
30271
|
-
* @memberof NewsLettersApi
|
|
30272
|
-
*/
|
|
30273
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesNewsLetterRequestsListResponse, any, {}>>;
|
|
30274
29162
|
/**
|
|
30275
29163
|
* Fetches NewsLetterSubscription by id
|
|
30276
29164
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30622,13 +29510,6 @@ export declare class OnboardingApi extends BaseAPI {
|
|
|
30622
29510
|
* @export
|
|
30623
29511
|
*/
|
|
30624
29512
|
export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30625
|
-
/**
|
|
30626
|
-
* Fetches list of all Organizations
|
|
30627
|
-
* @summary Fetches list of all Organizations
|
|
30628
|
-
* @param {*} [options] Override http request option.
|
|
30629
|
-
* @throws {RequiredError}
|
|
30630
|
-
*/
|
|
30631
|
-
adminOrganizationsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30632
29513
|
/**
|
|
30633
29514
|
* Updates Orgnization information by ID.
|
|
30634
29515
|
* @summary Update an existing Orgnization
|
|
@@ -30669,13 +29550,6 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
30669
29550
|
* @export
|
|
30670
29551
|
*/
|
|
30671
29552
|
export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
30672
|
-
/**
|
|
30673
|
-
* Fetches list of all Organizations
|
|
30674
|
-
* @summary Fetches list of all Organizations
|
|
30675
|
-
* @param {*} [options] Override http request option.
|
|
30676
|
-
* @throws {RequiredError}
|
|
30677
|
-
*/
|
|
30678
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrganizationsListResponse>>;
|
|
30679
29553
|
/**
|
|
30680
29554
|
* Updates Orgnization information by ID.
|
|
30681
29555
|
* @summary Update an existing Orgnization
|
|
@@ -30716,13 +29590,6 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
30716
29590
|
* @export
|
|
30717
29591
|
*/
|
|
30718
29592
|
export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30719
|
-
/**
|
|
30720
|
-
* Fetches list of all Organizations
|
|
30721
|
-
* @summary Fetches list of all Organizations
|
|
30722
|
-
* @param {*} [options] Override http request option.
|
|
30723
|
-
* @throws {RequiredError}
|
|
30724
|
-
*/
|
|
30725
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrganizationsListResponse>;
|
|
30726
29593
|
/**
|
|
30727
29594
|
* Updates Orgnization information by ID.
|
|
30728
29595
|
* @summary Update an existing Orgnization
|
|
@@ -30765,14 +29632,6 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
30765
29632
|
* @extends {BaseAPI}
|
|
30766
29633
|
*/
|
|
30767
29634
|
export declare class OrganizationsApi extends BaseAPI {
|
|
30768
|
-
/**
|
|
30769
|
-
* Fetches list of all Organizations
|
|
30770
|
-
* @summary Fetches list of all Organizations
|
|
30771
|
-
* @param {*} [options] Override http request option.
|
|
30772
|
-
* @throws {RequiredError}
|
|
30773
|
-
* @memberof OrganizationsApi
|
|
30774
|
-
*/
|
|
30775
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrganizationsListResponse, any, {}>>;
|
|
30776
29635
|
/**
|
|
30777
29636
|
* Updates Orgnization information by ID.
|
|
30778
29637
|
* @summary Update an existing Orgnization
|
|
@@ -31519,13 +30378,6 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
31519
30378
|
* @export
|
|
31520
30379
|
*/
|
|
31521
30380
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31522
|
-
/**
|
|
31523
|
-
* Fetches list of all payments
|
|
31524
|
-
* @summary Fetches list of all payments
|
|
31525
|
-
* @param {*} [options] Override http request option.
|
|
31526
|
-
* @throws {RequiredError}
|
|
31527
|
-
*/
|
|
31528
|
-
adminPaymentsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31529
30381
|
/**
|
|
31530
30382
|
* Deletes a payment from the system by ID.
|
|
31531
30383
|
* @summary Delete a payment
|
|
@@ -31565,13 +30417,6 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31565
30417
|
* @export
|
|
31566
30418
|
*/
|
|
31567
30419
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
31568
|
-
/**
|
|
31569
|
-
* Fetches list of all payments
|
|
31570
|
-
* @summary Fetches list of all payments
|
|
31571
|
-
* @param {*} [options] Override http request option.
|
|
31572
|
-
* @throws {RequiredError}
|
|
31573
|
-
*/
|
|
31574
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentsListResponse>>;
|
|
31575
30420
|
/**
|
|
31576
30421
|
* Deletes a payment from the system by ID.
|
|
31577
30422
|
* @summary Delete a payment
|
|
@@ -31611,13 +30456,6 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
31611
30456
|
* @export
|
|
31612
30457
|
*/
|
|
31613
30458
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31614
|
-
/**
|
|
31615
|
-
* Fetches list of all payments
|
|
31616
|
-
* @summary Fetches list of all payments
|
|
31617
|
-
* @param {*} [options] Override http request option.
|
|
31618
|
-
* @throws {RequiredError}
|
|
31619
|
-
*/
|
|
31620
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentsListResponse>;
|
|
31621
30459
|
/**
|
|
31622
30460
|
* Deletes a payment from the system by ID.
|
|
31623
30461
|
* @summary Delete a payment
|
|
@@ -31659,14 +30497,6 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
31659
30497
|
* @extends {BaseAPI}
|
|
31660
30498
|
*/
|
|
31661
30499
|
export declare class PaymentsApi extends BaseAPI {
|
|
31662
|
-
/**
|
|
31663
|
-
* Fetches list of all payments
|
|
31664
|
-
* @summary Fetches list of all payments
|
|
31665
|
-
* @param {*} [options] Override http request option.
|
|
31666
|
-
* @throws {RequiredError}
|
|
31667
|
-
* @memberof PaymentsApi
|
|
31668
|
-
*/
|
|
31669
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentsListResponse, any, {}>>;
|
|
31670
30500
|
/**
|
|
31671
30501
|
* Deletes a payment from the system by ID.
|
|
31672
30502
|
* @summary Delete a payment
|
|
@@ -31710,13 +30540,6 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
31710
30540
|
* @export
|
|
31711
30541
|
*/
|
|
31712
30542
|
export declare const PlansApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31713
|
-
/**
|
|
31714
|
-
* Fetches list of all Plans
|
|
31715
|
-
* @summary Fetches list of all Plans
|
|
31716
|
-
* @param {*} [options] Override http request option.
|
|
31717
|
-
* @throws {RequiredError}
|
|
31718
|
-
*/
|
|
31719
|
-
miscPlansGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31720
30543
|
/**
|
|
31721
30544
|
* Fetches plan by id
|
|
31722
30545
|
* @summary Fetches plan by id
|
|
@@ -31757,13 +30580,6 @@ export declare const PlansApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
31757
30580
|
* @export
|
|
31758
30581
|
*/
|
|
31759
30582
|
export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
31760
|
-
/**
|
|
31761
|
-
* Fetches list of all Plans
|
|
31762
|
-
* @summary Fetches list of all Plans
|
|
31763
|
-
* @param {*} [options] Override http request option.
|
|
31764
|
-
* @throws {RequiredError}
|
|
31765
|
-
*/
|
|
31766
|
-
miscPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPlansListResponse>>;
|
|
31767
30583
|
/**
|
|
31768
30584
|
* Fetches plan by id
|
|
31769
30585
|
* @summary Fetches plan by id
|
|
@@ -31804,13 +30620,6 @@ export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
|
31804
30620
|
* @export
|
|
31805
30621
|
*/
|
|
31806
30622
|
export declare const PlansApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31807
|
-
/**
|
|
31808
|
-
* Fetches list of all Plans
|
|
31809
|
-
* @summary Fetches list of all Plans
|
|
31810
|
-
* @param {*} [options] Override http request option.
|
|
31811
|
-
* @throws {RequiredError}
|
|
31812
|
-
*/
|
|
31813
|
-
miscPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPlansListResponse>;
|
|
31814
30623
|
/**
|
|
31815
30624
|
* Fetches plan by id
|
|
31816
30625
|
* @summary Fetches plan by id
|
|
@@ -31853,14 +30662,6 @@ export declare const PlansApiFactory: (configuration?: Configuration, basePath?:
|
|
|
31853
30662
|
* @extends {BaseAPI}
|
|
31854
30663
|
*/
|
|
31855
30664
|
export declare class PlansApi extends BaseAPI {
|
|
31856
|
-
/**
|
|
31857
|
-
* Fetches list of all Plans
|
|
31858
|
-
* @summary Fetches list of all Plans
|
|
31859
|
-
* @param {*} [options] Override http request option.
|
|
31860
|
-
* @throws {RequiredError}
|
|
31861
|
-
* @memberof PlansApi
|
|
31862
|
-
*/
|
|
31863
|
-
miscPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPlansListResponse, any, {}>>;
|
|
31864
30665
|
/**
|
|
31865
30666
|
* Fetches plan by id
|
|
31866
30667
|
* @summary Fetches plan by id
|
|
@@ -34195,13 +32996,6 @@ export declare class RegisterApi extends BaseAPI {
|
|
|
34195
32996
|
* @export
|
|
34196
32997
|
*/
|
|
34197
32998
|
export declare const RequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34198
|
-
/**
|
|
34199
|
-
* Fetches list of all ServiceRequest
|
|
34200
|
-
* @summary Fetches list of all ServiceRequest
|
|
34201
|
-
* @param {*} [options] Override http request option.
|
|
34202
|
-
* @throws {RequiredError}
|
|
34203
|
-
*/
|
|
34204
|
-
miscRequestsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34205
32999
|
/**
|
|
34206
33000
|
* Updates ServiceRequest information by ID.
|
|
34207
33001
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34250,13 +33044,6 @@ export declare const RequestsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34250
33044
|
* @export
|
|
34251
33045
|
*/
|
|
34252
33046
|
export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
34253
|
-
/**
|
|
34254
|
-
* Fetches list of all ServiceRequest
|
|
34255
|
-
* @summary Fetches list of all ServiceRequest
|
|
34256
|
-
* @param {*} [options] Override http request option.
|
|
34257
|
-
* @throws {RequiredError}
|
|
34258
|
-
*/
|
|
34259
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesServiceRequestsListResponse>>;
|
|
34260
33047
|
/**
|
|
34261
33048
|
* Updates ServiceRequest information by ID.
|
|
34262
33049
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34305,13 +33092,6 @@ export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
|
34305
33092
|
* @export
|
|
34306
33093
|
*/
|
|
34307
33094
|
export declare const RequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34308
|
-
/**
|
|
34309
|
-
* Fetches list of all ServiceRequest
|
|
34310
|
-
* @summary Fetches list of all ServiceRequest
|
|
34311
|
-
* @param {*} [options] Override http request option.
|
|
34312
|
-
* @throws {RequiredError}
|
|
34313
|
-
*/
|
|
34314
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesServiceRequestsListResponse>;
|
|
34315
33095
|
/**
|
|
34316
33096
|
* Updates ServiceRequest information by ID.
|
|
34317
33097
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34362,14 +33142,6 @@ export declare const RequestsApiFactory: (configuration?: Configuration, basePat
|
|
|
34362
33142
|
* @extends {BaseAPI}
|
|
34363
33143
|
*/
|
|
34364
33144
|
export declare class RequestsApi extends BaseAPI {
|
|
34365
|
-
/**
|
|
34366
|
-
* Fetches list of all ServiceRequest
|
|
34367
|
-
* @summary Fetches list of all ServiceRequest
|
|
34368
|
-
* @param {*} [options] Override http request option.
|
|
34369
|
-
* @throws {RequiredError}
|
|
34370
|
-
* @memberof RequestsApi
|
|
34371
|
-
*/
|
|
34372
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesServiceRequestsListResponse, any, {}>>;
|
|
34373
33145
|
/**
|
|
34374
33146
|
* Updates ServiceRequest information by ID.
|
|
34375
33147
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34431,13 +33203,6 @@ export declare const RoleRightsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
34431
33203
|
* @throws {RequiredError}
|
|
34432
33204
|
*/
|
|
34433
33205
|
adminRolerightsBulkPost: (dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34434
|
-
/**
|
|
34435
|
-
* Fetches list of all roleright
|
|
34436
|
-
* @summary Fetches list of all roleright
|
|
34437
|
-
* @param {*} [options] Override http request option.
|
|
34438
|
-
* @throws {RequiredError}
|
|
34439
|
-
*/
|
|
34440
|
-
adminRolerightsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34441
33206
|
/**
|
|
34442
33207
|
* Fetches roleright by role id
|
|
34443
33208
|
* @summary Fetches roleright by role id
|
|
@@ -34501,13 +33266,6 @@ export declare const RoleRightsApiFp: (configuration?: Configuration) => {
|
|
|
34501
33266
|
* @throws {RequiredError}
|
|
34502
33267
|
*/
|
|
34503
33268
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
34504
|
-
/**
|
|
34505
|
-
* Fetches list of all roleright
|
|
34506
|
-
* @summary Fetches list of all roleright
|
|
34507
|
-
* @param {*} [options] Override http request option.
|
|
34508
|
-
* @throws {RequiredError}
|
|
34509
|
-
*/
|
|
34510
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRoleRightsListResponse>>;
|
|
34511
33269
|
/**
|
|
34512
33270
|
* Fetches roleright by role id
|
|
34513
33271
|
* @summary Fetches roleright by role id
|
|
@@ -34571,13 +33329,6 @@ export declare const RoleRightsApiFactory: (configuration?: Configuration, baseP
|
|
|
34571
33329
|
* @throws {RequiredError}
|
|
34572
33330
|
*/
|
|
34573
33331
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
34574
|
-
/**
|
|
34575
|
-
* Fetches list of all roleright
|
|
34576
|
-
* @summary Fetches list of all roleright
|
|
34577
|
-
* @param {*} [options] Override http request option.
|
|
34578
|
-
* @throws {RequiredError}
|
|
34579
|
-
*/
|
|
34580
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRoleRightsListResponse>;
|
|
34581
33332
|
/**
|
|
34582
33333
|
* Fetches roleright by role id
|
|
34583
33334
|
* @summary Fetches roleright by role id
|
|
@@ -34644,14 +33395,6 @@ export declare class RoleRightsApi extends BaseAPI {
|
|
|
34644
33395
|
* @memberof RoleRightsApi
|
|
34645
33396
|
*/
|
|
34646
33397
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
34647
|
-
/**
|
|
34648
|
-
* Fetches list of all roleright
|
|
34649
|
-
* @summary Fetches list of all roleright
|
|
34650
|
-
* @param {*} [options] Override http request option.
|
|
34651
|
-
* @throws {RequiredError}
|
|
34652
|
-
* @memberof RoleRightsApi
|
|
34653
|
-
*/
|
|
34654
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRoleRightsListResponse, any, {}>>;
|
|
34655
33398
|
/**
|
|
34656
33399
|
* Fetches roleright by role id
|
|
34657
33400
|
* @summary Fetches roleright by role id
|
|
@@ -34730,14 +33473,6 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34730
33473
|
* @throws {RequiredError}
|
|
34731
33474
|
*/
|
|
34732
33475
|
adminRolesIdPut: (id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34733
|
-
/**
|
|
34734
|
-
* Fetches list of all roles
|
|
34735
|
-
* @summary Fetches list of all roles
|
|
34736
|
-
* @param {number} orgId Org ID
|
|
34737
|
-
* @param {*} [options] Override http request option.
|
|
34738
|
-
* @throws {RequiredError}
|
|
34739
|
-
*/
|
|
34740
|
-
adminRolesOrgIdGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34741
33476
|
/**
|
|
34742
33477
|
* Fetches role by id
|
|
34743
33478
|
* @summary Fetches role by id
|
|
@@ -34778,14 +33513,6 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
34778
33513
|
* @throws {RequiredError}
|
|
34779
33514
|
*/
|
|
34780
33515
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
34781
|
-
/**
|
|
34782
|
-
* Fetches list of all roles
|
|
34783
|
-
* @summary Fetches list of all roles
|
|
34784
|
-
* @param {number} orgId Org ID
|
|
34785
|
-
* @param {*} [options] Override http request option.
|
|
34786
|
-
* @throws {RequiredError}
|
|
34787
|
-
*/
|
|
34788
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRolesListResponse>>;
|
|
34789
33516
|
/**
|
|
34790
33517
|
* Fetches role by id
|
|
34791
33518
|
* @summary Fetches role by id
|
|
@@ -34826,14 +33553,6 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
34826
33553
|
* @throws {RequiredError}
|
|
34827
33554
|
*/
|
|
34828
33555
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
34829
|
-
/**
|
|
34830
|
-
* Fetches list of all roles
|
|
34831
|
-
* @summary Fetches list of all roles
|
|
34832
|
-
* @param {number} orgId Org ID
|
|
34833
|
-
* @param {*} [options] Override http request option.
|
|
34834
|
-
* @throws {RequiredError}
|
|
34835
|
-
*/
|
|
34836
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRolesListResponse>;
|
|
34837
33556
|
/**
|
|
34838
33557
|
* Fetches role by id
|
|
34839
33558
|
* @summary Fetches role by id
|
|
@@ -34878,15 +33597,6 @@ export declare class RolesApi extends BaseAPI {
|
|
|
34878
33597
|
* @memberof RolesApi
|
|
34879
33598
|
*/
|
|
34880
33599
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
34881
|
-
/**
|
|
34882
|
-
* Fetches list of all roles
|
|
34883
|
-
* @summary Fetches list of all roles
|
|
34884
|
-
* @param {number} orgId Org ID
|
|
34885
|
-
* @param {*} [options] Override http request option.
|
|
34886
|
-
* @throws {RequiredError}
|
|
34887
|
-
* @memberof RolesApi
|
|
34888
|
-
*/
|
|
34889
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRolesListResponse, any, {}>>;
|
|
34890
33600
|
/**
|
|
34891
33601
|
* Fetches role by id
|
|
34892
33602
|
* @summary Fetches role by id
|
|
@@ -34964,16 +33674,6 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34964
33674
|
* @throws {RequiredError}
|
|
34965
33675
|
*/
|
|
34966
33676
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34967
|
-
/**
|
|
34968
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
34969
|
-
* @summary Public Search API
|
|
34970
|
-
* @param {string} xStoreid Store ID
|
|
34971
|
-
* @param {string} xStoresecret Store Secret
|
|
34972
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
34973
|
-
* @param {*} [options] Override http request option.
|
|
34974
|
-
* @throws {RequiredError}
|
|
34975
|
-
*/
|
|
34976
|
-
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34977
33677
|
};
|
|
34978
33678
|
/**
|
|
34979
33679
|
* SearchApi - functional programming interface
|
|
@@ -35032,16 +33732,6 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
35032
33732
|
* @throws {RequiredError}
|
|
35033
33733
|
*/
|
|
35034
33734
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
35035
|
-
/**
|
|
35036
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35037
|
-
* @summary Public Search API
|
|
35038
|
-
* @param {string} xStoreid Store ID
|
|
35039
|
-
* @param {string} xStoresecret Store Secret
|
|
35040
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35041
|
-
* @param {*} [options] Override http request option.
|
|
35042
|
-
* @throws {RequiredError}
|
|
35043
|
-
*/
|
|
35044
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
35045
33735
|
};
|
|
35046
33736
|
/**
|
|
35047
33737
|
* SearchApi - factory interface
|
|
@@ -35100,16 +33790,6 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
35100
33790
|
* @throws {RequiredError}
|
|
35101
33791
|
*/
|
|
35102
33792
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
35103
|
-
/**
|
|
35104
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35105
|
-
* @summary Public Search API
|
|
35106
|
-
* @param {string} xStoreid Store ID
|
|
35107
|
-
* @param {string} xStoresecret Store Secret
|
|
35108
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35109
|
-
* @param {*} [options] Override http request option.
|
|
35110
|
-
* @throws {RequiredError}
|
|
35111
|
-
*/
|
|
35112
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
35113
33793
|
};
|
|
35114
33794
|
/**
|
|
35115
33795
|
* SearchApi - object-oriented interface
|
|
@@ -35176,17 +33856,6 @@ export declare class SearchApi extends BaseAPI {
|
|
|
35176
33856
|
* @memberof SearchApi
|
|
35177
33857
|
*/
|
|
35178
33858
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
35179
|
-
/**
|
|
35180
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35181
|
-
* @summary Public Search API
|
|
35182
|
-
* @param {string} xStoreid Store ID
|
|
35183
|
-
* @param {string} xStoresecret Store Secret
|
|
35184
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35185
|
-
* @param {*} [options] Override http request option.
|
|
35186
|
-
* @throws {RequiredError}
|
|
35187
|
-
* @memberof SearchApi
|
|
35188
|
-
*/
|
|
35189
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
35190
33859
|
}
|
|
35191
33860
|
/**
|
|
35192
33861
|
* StopwordsApi - axios parameter creator
|
|
@@ -36769,13 +35438,6 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
36769
35438
|
* @throws {RequiredError}
|
|
36770
35439
|
*/
|
|
36771
35440
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut: (subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36772
|
-
/**
|
|
36773
|
-
* Fetches list of all Subscription
|
|
36774
|
-
* @summary Fetches list of all Subscription
|
|
36775
|
-
* @param {*} [options] Override http request option.
|
|
36776
|
-
* @throws {RequiredError}
|
|
36777
|
-
*/
|
|
36778
|
-
miscSubscriptionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36779
35441
|
/**
|
|
36780
35442
|
* Adds a new Subscription to the system
|
|
36781
35443
|
* @summary Creates a new Subscription
|
|
@@ -36832,13 +35494,6 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
36832
35494
|
* @throws {RequiredError}
|
|
36833
35495
|
*/
|
|
36834
35496
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
36835
|
-
/**
|
|
36836
|
-
* Fetches list of all Subscription
|
|
36837
|
-
* @summary Fetches list of all Subscription
|
|
36838
|
-
* @param {*} [options] Override http request option.
|
|
36839
|
-
* @throws {RequiredError}
|
|
36840
|
-
*/
|
|
36841
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSubscriptionsListResponse>>;
|
|
36842
35497
|
/**
|
|
36843
35498
|
* Adds a new Subscription to the system
|
|
36844
35499
|
* @summary Creates a new Subscription
|
|
@@ -36895,13 +35550,6 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
36895
35550
|
* @throws {RequiredError}
|
|
36896
35551
|
*/
|
|
36897
35552
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36898
|
-
/**
|
|
36899
|
-
* Fetches list of all Subscription
|
|
36900
|
-
* @summary Fetches list of all Subscription
|
|
36901
|
-
* @param {*} [options] Override http request option.
|
|
36902
|
-
* @throws {RequiredError}
|
|
36903
|
-
*/
|
|
36904
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSubscriptionsListResponse>;
|
|
36905
35553
|
/**
|
|
36906
35554
|
* Adds a new Subscription to the system
|
|
36907
35555
|
* @summary Creates a new Subscription
|
|
@@ -36964,14 +35612,6 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
36964
35612
|
* @memberof SubscriptionsApi
|
|
36965
35613
|
*/
|
|
36966
35614
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36967
|
-
/**
|
|
36968
|
-
* Fetches list of all Subscription
|
|
36969
|
-
* @summary Fetches list of all Subscription
|
|
36970
|
-
* @param {*} [options] Override http request option.
|
|
36971
|
-
* @throws {RequiredError}
|
|
36972
|
-
* @memberof SubscriptionsApi
|
|
36973
|
-
*/
|
|
36974
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSubscriptionsListResponse, any, {}>>;
|
|
36975
35615
|
/**
|
|
36976
35616
|
* Adds a new Subscription to the system
|
|
36977
35617
|
* @summary Creates a new Subscription
|
|
@@ -37145,6 +35785,460 @@ export declare class TaxManagementApi extends BaseAPI {
|
|
|
37145
35785
|
*/
|
|
37146
35786
|
adminTaxValidateGstinPost(dataTypesGSTVerificationRequest: DataTypesGSTVerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesGSTVerificationResponse, any, {}>>;
|
|
37147
35787
|
}
|
|
35788
|
+
/**
|
|
35789
|
+
* TeamApi - axios parameter creator
|
|
35790
|
+
* @export
|
|
35791
|
+
*/
|
|
35792
|
+
export declare const TeamApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35793
|
+
/**
|
|
35794
|
+
* Cancels a pending invitation
|
|
35795
|
+
* @summary Cancel invitation
|
|
35796
|
+
* @param {number} invitationId Invitation ID
|
|
35797
|
+
* @param {*} [options] Override http request option.
|
|
35798
|
+
* @throws {RequiredError}
|
|
35799
|
+
*/
|
|
35800
|
+
apiV1InvitationsInvitationIdDelete: (invitationId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35801
|
+
/**
|
|
35802
|
+
* Accepts a team invitation using token
|
|
35803
|
+
* @summary Accept invitation
|
|
35804
|
+
* @param {string} token Invitation Token
|
|
35805
|
+
* @param {*} [options] Override http request option.
|
|
35806
|
+
* @throws {RequiredError}
|
|
35807
|
+
*/
|
|
35808
|
+
apiV1InvitationsTokenAcceptPost: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35809
|
+
/**
|
|
35810
|
+
* Retrieves all pending invitations for an organization
|
|
35811
|
+
* @summary Get pending invitations
|
|
35812
|
+
* @param {number} orgId Organization ID
|
|
35813
|
+
* @param {*} [options] Override http request option.
|
|
35814
|
+
* @throws {RequiredError}
|
|
35815
|
+
*/
|
|
35816
|
+
apiV1OrganizationsOrgIdInvitationsGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35817
|
+
/**
|
|
35818
|
+
* Retrieves all members of an organization with their details
|
|
35819
|
+
* @summary Get all members of an organization
|
|
35820
|
+
* @param {number} orgId Organization ID
|
|
35821
|
+
* @param {*} [options] Override http request option.
|
|
35822
|
+
* @throws {RequiredError}
|
|
35823
|
+
*/
|
|
35824
|
+
apiV1OrganizationsOrgIdMembersGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35825
|
+
/**
|
|
35826
|
+
* Sends an invitation to a user to join the organization
|
|
35827
|
+
* @summary Invite a member to join organization
|
|
35828
|
+
* @param {number} orgId Organization ID
|
|
35829
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35830
|
+
* @param {*} [options] Override http request option.
|
|
35831
|
+
* @throws {RequiredError}
|
|
35832
|
+
*/
|
|
35833
|
+
apiV1OrganizationsOrgIdMembersInvitePost: (orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35834
|
+
/**
|
|
35835
|
+
* Removes a member from the organization
|
|
35836
|
+
* @summary Remove member from organization
|
|
35837
|
+
* @param {number} orgId Organization ID
|
|
35838
|
+
* @param {number} memberId Member ID
|
|
35839
|
+
* @param {*} [options] Override http request option.
|
|
35840
|
+
* @throws {RequiredError}
|
|
35841
|
+
*/
|
|
35842
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete: (orgId: number, memberId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35843
|
+
/**
|
|
35844
|
+
* Updates the role of a member in the organization
|
|
35845
|
+
* @summary Update member role
|
|
35846
|
+
* @param {number} orgId Organization ID
|
|
35847
|
+
* @param {number} memberId Member ID
|
|
35848
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35849
|
+
* @param {*} [options] Override http request option.
|
|
35850
|
+
* @throws {RequiredError}
|
|
35851
|
+
*/
|
|
35852
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut: (orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35853
|
+
/**
|
|
35854
|
+
* Retrieves all users with access to a store
|
|
35855
|
+
* @summary Get store access list
|
|
35856
|
+
* @param {number} storeId Store ID
|
|
35857
|
+
* @param {*} [options] Override http request option.
|
|
35858
|
+
* @throws {RequiredError}
|
|
35859
|
+
*/
|
|
35860
|
+
apiV1StoresStoreIdAccessGet: (storeId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35861
|
+
/**
|
|
35862
|
+
* Grants a user access to a store
|
|
35863
|
+
* @summary Grant store access
|
|
35864
|
+
* @param {number} storeId Store ID
|
|
35865
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35866
|
+
* @param {*} [options] Override http request option.
|
|
35867
|
+
* @throws {RequiredError}
|
|
35868
|
+
*/
|
|
35869
|
+
apiV1StoresStoreIdAccessPost: (storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35870
|
+
/**
|
|
35871
|
+
* Revokes a user\'s access to a store
|
|
35872
|
+
* @summary Revoke store access
|
|
35873
|
+
* @param {number} storeId Store ID
|
|
35874
|
+
* @param {number} userId User ID
|
|
35875
|
+
* @param {*} [options] Override http request option.
|
|
35876
|
+
* @throws {RequiredError}
|
|
35877
|
+
*/
|
|
35878
|
+
apiV1StoresStoreIdAccessUserIdDelete: (storeId: number, userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35879
|
+
/**
|
|
35880
|
+
* Updates a user\'s access level to a store
|
|
35881
|
+
* @summary Update store access level
|
|
35882
|
+
* @param {number} storeId Store ID
|
|
35883
|
+
* @param {number} userId User ID
|
|
35884
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
35885
|
+
* @param {*} [options] Override http request option.
|
|
35886
|
+
* @throws {RequiredError}
|
|
35887
|
+
*/
|
|
35888
|
+
apiV1StoresStoreIdAccessUserIdPut: (storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35889
|
+
/**
|
|
35890
|
+
* Retrieves all stores accessible to a user
|
|
35891
|
+
* @summary Get user\'s accessible stores
|
|
35892
|
+
* @param {number} userId User ID
|
|
35893
|
+
* @param {*} [options] Override http request option.
|
|
35894
|
+
* @throws {RequiredError}
|
|
35895
|
+
*/
|
|
35896
|
+
apiV1UsersUserIdStoresGet: (userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35897
|
+
};
|
|
35898
|
+
/**
|
|
35899
|
+
* TeamApi - functional programming interface
|
|
35900
|
+
* @export
|
|
35901
|
+
*/
|
|
35902
|
+
export declare const TeamApiFp: (configuration?: Configuration) => {
|
|
35903
|
+
/**
|
|
35904
|
+
* Cancels a pending invitation
|
|
35905
|
+
* @summary Cancel invitation
|
|
35906
|
+
* @param {number} invitationId Invitation ID
|
|
35907
|
+
* @param {*} [options] Override http request option.
|
|
35908
|
+
* @throws {RequiredError}
|
|
35909
|
+
*/
|
|
35910
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35911
|
+
/**
|
|
35912
|
+
* Accepts a team invitation using token
|
|
35913
|
+
* @summary Accept invitation
|
|
35914
|
+
* @param {string} token Invitation Token
|
|
35915
|
+
* @param {*} [options] Override http request option.
|
|
35916
|
+
* @throws {RequiredError}
|
|
35917
|
+
*/
|
|
35918
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35919
|
+
/**
|
|
35920
|
+
* Retrieves all pending invitations for an organization
|
|
35921
|
+
* @summary Get pending invitations
|
|
35922
|
+
* @param {number} orgId Organization ID
|
|
35923
|
+
* @param {*} [options] Override http request option.
|
|
35924
|
+
* @throws {RequiredError}
|
|
35925
|
+
*/
|
|
35926
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesTeamInvitationsResponse>>;
|
|
35927
|
+
/**
|
|
35928
|
+
* Retrieves all members of an organization with their details
|
|
35929
|
+
* @summary Get all members of an organization
|
|
35930
|
+
* @param {number} orgId Organization ID
|
|
35931
|
+
* @param {*} [options] Override http request option.
|
|
35932
|
+
* @throws {RequiredError}
|
|
35933
|
+
*/
|
|
35934
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrgMembersResponse>>;
|
|
35935
|
+
/**
|
|
35936
|
+
* Sends an invitation to a user to join the organization
|
|
35937
|
+
* @summary Invite a member to join organization
|
|
35938
|
+
* @param {number} orgId Organization ID
|
|
35939
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35940
|
+
* @param {*} [options] Override http request option.
|
|
35941
|
+
* @throws {RequiredError}
|
|
35942
|
+
*/
|
|
35943
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesInvitationCreatedResponse>>;
|
|
35944
|
+
/**
|
|
35945
|
+
* Removes a member from the organization
|
|
35946
|
+
* @summary Remove member from organization
|
|
35947
|
+
* @param {number} orgId Organization ID
|
|
35948
|
+
* @param {number} memberId Member ID
|
|
35949
|
+
* @param {*} [options] Override http request option.
|
|
35950
|
+
* @throws {RequiredError}
|
|
35951
|
+
*/
|
|
35952
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35953
|
+
/**
|
|
35954
|
+
* Updates the role of a member in the organization
|
|
35955
|
+
* @summary Update member role
|
|
35956
|
+
* @param {number} orgId Organization ID
|
|
35957
|
+
* @param {number} memberId Member ID
|
|
35958
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35959
|
+
* @param {*} [options] Override http request option.
|
|
35960
|
+
* @throws {RequiredError}
|
|
35961
|
+
*/
|
|
35962
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35963
|
+
/**
|
|
35964
|
+
* Retrieves all users with access to a store
|
|
35965
|
+
* @summary Get store access list
|
|
35966
|
+
* @param {number} storeId Store ID
|
|
35967
|
+
* @param {*} [options] Override http request option.
|
|
35968
|
+
* @throws {RequiredError}
|
|
35969
|
+
*/
|
|
35970
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreAccessResponse>>;
|
|
35971
|
+
/**
|
|
35972
|
+
* Grants a user access to a store
|
|
35973
|
+
* @summary Grant store access
|
|
35974
|
+
* @param {number} storeId Store ID
|
|
35975
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35976
|
+
* @param {*} [options] Override http request option.
|
|
35977
|
+
* @throws {RequiredError}
|
|
35978
|
+
*/
|
|
35979
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35980
|
+
/**
|
|
35981
|
+
* Revokes a user\'s access to a store
|
|
35982
|
+
* @summary Revoke store access
|
|
35983
|
+
* @param {number} storeId Store ID
|
|
35984
|
+
* @param {number} userId User ID
|
|
35985
|
+
* @param {*} [options] Override http request option.
|
|
35986
|
+
* @throws {RequiredError}
|
|
35987
|
+
*/
|
|
35988
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35989
|
+
/**
|
|
35990
|
+
* Updates a user\'s access level to a store
|
|
35991
|
+
* @summary Update store access level
|
|
35992
|
+
* @param {number} storeId Store ID
|
|
35993
|
+
* @param {number} userId User ID
|
|
35994
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
35995
|
+
* @param {*} [options] Override http request option.
|
|
35996
|
+
* @throws {RequiredError}
|
|
35997
|
+
*/
|
|
35998
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35999
|
+
/**
|
|
36000
|
+
* Retrieves all stores accessible to a user
|
|
36001
|
+
* @summary Get user\'s accessible stores
|
|
36002
|
+
* @param {number} userId User ID
|
|
36003
|
+
* @param {*} [options] Override http request option.
|
|
36004
|
+
* @throws {RequiredError}
|
|
36005
|
+
*/
|
|
36006
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUserStoresResponse>>;
|
|
36007
|
+
};
|
|
36008
|
+
/**
|
|
36009
|
+
* TeamApi - factory interface
|
|
36010
|
+
* @export
|
|
36011
|
+
*/
|
|
36012
|
+
export declare const TeamApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36013
|
+
/**
|
|
36014
|
+
* Cancels a pending invitation
|
|
36015
|
+
* @summary Cancel invitation
|
|
36016
|
+
* @param {number} invitationId Invitation ID
|
|
36017
|
+
* @param {*} [options] Override http request option.
|
|
36018
|
+
* @throws {RequiredError}
|
|
36019
|
+
*/
|
|
36020
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36021
|
+
/**
|
|
36022
|
+
* Accepts a team invitation using token
|
|
36023
|
+
* @summary Accept invitation
|
|
36024
|
+
* @param {string} token Invitation Token
|
|
36025
|
+
* @param {*} [options] Override http request option.
|
|
36026
|
+
* @throws {RequiredError}
|
|
36027
|
+
*/
|
|
36028
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36029
|
+
/**
|
|
36030
|
+
* Retrieves all pending invitations for an organization
|
|
36031
|
+
* @summary Get pending invitations
|
|
36032
|
+
* @param {number} orgId Organization ID
|
|
36033
|
+
* @param {*} [options] Override http request option.
|
|
36034
|
+
* @throws {RequiredError}
|
|
36035
|
+
*/
|
|
36036
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesTeamInvitationsResponse>;
|
|
36037
|
+
/**
|
|
36038
|
+
* Retrieves all members of an organization with their details
|
|
36039
|
+
* @summary Get all members of an organization
|
|
36040
|
+
* @param {number} orgId Organization ID
|
|
36041
|
+
* @param {*} [options] Override http request option.
|
|
36042
|
+
* @throws {RequiredError}
|
|
36043
|
+
*/
|
|
36044
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrgMembersResponse>;
|
|
36045
|
+
/**
|
|
36046
|
+
* Sends an invitation to a user to join the organization
|
|
36047
|
+
* @summary Invite a member to join organization
|
|
36048
|
+
* @param {number} orgId Organization ID
|
|
36049
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36050
|
+
* @param {*} [options] Override http request option.
|
|
36051
|
+
* @throws {RequiredError}
|
|
36052
|
+
*/
|
|
36053
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesInvitationCreatedResponse>;
|
|
36054
|
+
/**
|
|
36055
|
+
* Removes a member from the organization
|
|
36056
|
+
* @summary Remove member from organization
|
|
36057
|
+
* @param {number} orgId Organization ID
|
|
36058
|
+
* @param {number} memberId Member ID
|
|
36059
|
+
* @param {*} [options] Override http request option.
|
|
36060
|
+
* @throws {RequiredError}
|
|
36061
|
+
*/
|
|
36062
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36063
|
+
/**
|
|
36064
|
+
* Updates the role of a member in the organization
|
|
36065
|
+
* @summary Update member role
|
|
36066
|
+
* @param {number} orgId Organization ID
|
|
36067
|
+
* @param {number} memberId Member ID
|
|
36068
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36069
|
+
* @param {*} [options] Override http request option.
|
|
36070
|
+
* @throws {RequiredError}
|
|
36071
|
+
*/
|
|
36072
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36073
|
+
/**
|
|
36074
|
+
* Retrieves all users with access to a store
|
|
36075
|
+
* @summary Get store access list
|
|
36076
|
+
* @param {number} storeId Store ID
|
|
36077
|
+
* @param {*} [options] Override http request option.
|
|
36078
|
+
* @throws {RequiredError}
|
|
36079
|
+
*/
|
|
36080
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreAccessResponse>;
|
|
36081
|
+
/**
|
|
36082
|
+
* Grants a user access to a store
|
|
36083
|
+
* @summary Grant store access
|
|
36084
|
+
* @param {number} storeId Store ID
|
|
36085
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36086
|
+
* @param {*} [options] Override http request option.
|
|
36087
|
+
* @throws {RequiredError}
|
|
36088
|
+
*/
|
|
36089
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36090
|
+
/**
|
|
36091
|
+
* Revokes a user\'s access to a store
|
|
36092
|
+
* @summary Revoke store access
|
|
36093
|
+
* @param {number} storeId Store ID
|
|
36094
|
+
* @param {number} userId User ID
|
|
36095
|
+
* @param {*} [options] Override http request option.
|
|
36096
|
+
* @throws {RequiredError}
|
|
36097
|
+
*/
|
|
36098
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36099
|
+
/**
|
|
36100
|
+
* Updates a user\'s access level to a store
|
|
36101
|
+
* @summary Update store access level
|
|
36102
|
+
* @param {number} storeId Store ID
|
|
36103
|
+
* @param {number} userId User ID
|
|
36104
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36105
|
+
* @param {*} [options] Override http request option.
|
|
36106
|
+
* @throws {RequiredError}
|
|
36107
|
+
*/
|
|
36108
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36109
|
+
/**
|
|
36110
|
+
* Retrieves all stores accessible to a user
|
|
36111
|
+
* @summary Get user\'s accessible stores
|
|
36112
|
+
* @param {number} userId User ID
|
|
36113
|
+
* @param {*} [options] Override http request option.
|
|
36114
|
+
* @throws {RequiredError}
|
|
36115
|
+
*/
|
|
36116
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUserStoresResponse>;
|
|
36117
|
+
};
|
|
36118
|
+
/**
|
|
36119
|
+
* TeamApi - object-oriented interface
|
|
36120
|
+
* @export
|
|
36121
|
+
* @class TeamApi
|
|
36122
|
+
* @extends {BaseAPI}
|
|
36123
|
+
*/
|
|
36124
|
+
export declare class TeamApi extends BaseAPI {
|
|
36125
|
+
/**
|
|
36126
|
+
* Cancels a pending invitation
|
|
36127
|
+
* @summary Cancel invitation
|
|
36128
|
+
* @param {number} invitationId Invitation ID
|
|
36129
|
+
* @param {*} [options] Override http request option.
|
|
36130
|
+
* @throws {RequiredError}
|
|
36131
|
+
* @memberof TeamApi
|
|
36132
|
+
*/
|
|
36133
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36134
|
+
/**
|
|
36135
|
+
* Accepts a team invitation using token
|
|
36136
|
+
* @summary Accept invitation
|
|
36137
|
+
* @param {string} token Invitation Token
|
|
36138
|
+
* @param {*} [options] Override http request option.
|
|
36139
|
+
* @throws {RequiredError}
|
|
36140
|
+
* @memberof TeamApi
|
|
36141
|
+
*/
|
|
36142
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36143
|
+
/**
|
|
36144
|
+
* Retrieves all pending invitations for an organization
|
|
36145
|
+
* @summary Get pending invitations
|
|
36146
|
+
* @param {number} orgId Organization ID
|
|
36147
|
+
* @param {*} [options] Override http request option.
|
|
36148
|
+
* @throws {RequiredError}
|
|
36149
|
+
* @memberof TeamApi
|
|
36150
|
+
*/
|
|
36151
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesTeamInvitationsResponse, any, {}>>;
|
|
36152
|
+
/**
|
|
36153
|
+
* Retrieves all members of an organization with their details
|
|
36154
|
+
* @summary Get all members of an organization
|
|
36155
|
+
* @param {number} orgId Organization ID
|
|
36156
|
+
* @param {*} [options] Override http request option.
|
|
36157
|
+
* @throws {RequiredError}
|
|
36158
|
+
* @memberof TeamApi
|
|
36159
|
+
*/
|
|
36160
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrgMembersResponse, any, {}>>;
|
|
36161
|
+
/**
|
|
36162
|
+
* Sends an invitation to a user to join the organization
|
|
36163
|
+
* @summary Invite a member to join organization
|
|
36164
|
+
* @param {number} orgId Organization ID
|
|
36165
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36166
|
+
* @param {*} [options] Override http request option.
|
|
36167
|
+
* @throws {RequiredError}
|
|
36168
|
+
* @memberof TeamApi
|
|
36169
|
+
*/
|
|
36170
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesInvitationCreatedResponse, any, {}>>;
|
|
36171
|
+
/**
|
|
36172
|
+
* Removes a member from the organization
|
|
36173
|
+
* @summary Remove member from organization
|
|
36174
|
+
* @param {number} orgId Organization ID
|
|
36175
|
+
* @param {number} memberId Member ID
|
|
36176
|
+
* @param {*} [options] Override http request option.
|
|
36177
|
+
* @throws {RequiredError}
|
|
36178
|
+
* @memberof TeamApi
|
|
36179
|
+
*/
|
|
36180
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36181
|
+
/**
|
|
36182
|
+
* Updates the role of a member in the organization
|
|
36183
|
+
* @summary Update member role
|
|
36184
|
+
* @param {number} orgId Organization ID
|
|
36185
|
+
* @param {number} memberId Member ID
|
|
36186
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36187
|
+
* @param {*} [options] Override http request option.
|
|
36188
|
+
* @throws {RequiredError}
|
|
36189
|
+
* @memberof TeamApi
|
|
36190
|
+
*/
|
|
36191
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36192
|
+
/**
|
|
36193
|
+
* Retrieves all users with access to a store
|
|
36194
|
+
* @summary Get store access list
|
|
36195
|
+
* @param {number} storeId Store ID
|
|
36196
|
+
* @param {*} [options] Override http request option.
|
|
36197
|
+
* @throws {RequiredError}
|
|
36198
|
+
* @memberof TeamApi
|
|
36199
|
+
*/
|
|
36200
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreAccessResponse, any, {}>>;
|
|
36201
|
+
/**
|
|
36202
|
+
* Grants a user access to a store
|
|
36203
|
+
* @summary Grant store access
|
|
36204
|
+
* @param {number} storeId Store ID
|
|
36205
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36206
|
+
* @param {*} [options] Override http request option.
|
|
36207
|
+
* @throws {RequiredError}
|
|
36208
|
+
* @memberof TeamApi
|
|
36209
|
+
*/
|
|
36210
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36211
|
+
/**
|
|
36212
|
+
* Revokes a user\'s access to a store
|
|
36213
|
+
* @summary Revoke store access
|
|
36214
|
+
* @param {number} storeId Store ID
|
|
36215
|
+
* @param {number} userId User ID
|
|
36216
|
+
* @param {*} [options] Override http request option.
|
|
36217
|
+
* @throws {RequiredError}
|
|
36218
|
+
* @memberof TeamApi
|
|
36219
|
+
*/
|
|
36220
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36221
|
+
/**
|
|
36222
|
+
* Updates a user\'s access level to a store
|
|
36223
|
+
* @summary Update store access level
|
|
36224
|
+
* @param {number} storeId Store ID
|
|
36225
|
+
* @param {number} userId User ID
|
|
36226
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36227
|
+
* @param {*} [options] Override http request option.
|
|
36228
|
+
* @throws {RequiredError}
|
|
36229
|
+
* @memberof TeamApi
|
|
36230
|
+
*/
|
|
36231
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36232
|
+
/**
|
|
36233
|
+
* Retrieves all stores accessible to a user
|
|
36234
|
+
* @summary Get user\'s accessible stores
|
|
36235
|
+
* @param {number} userId User ID
|
|
36236
|
+
* @param {*} [options] Override http request option.
|
|
36237
|
+
* @throws {RequiredError}
|
|
36238
|
+
* @memberof TeamApi
|
|
36239
|
+
*/
|
|
36240
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUserStoresResponse, any, {}>>;
|
|
36241
|
+
}
|
|
37148
36242
|
/**
|
|
37149
36243
|
* UserApi - axios parameter creator
|
|
37150
36244
|
* @export
|