@seekora-ai/admin-api 1.1.12 → 1.1.14
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 +8705 -9630
- package/dist/api.d.ts +1026 -1926
- package/dist/api.js +953 -988
- package/dist/esm/api.d.ts +1026 -1926
- package/dist/esm/api.js +943 -982
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.14.tgz +0 -0
- package/seekora-ai-admin-api-1.1.12.tgz +0 -0
package/dist/esm/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
|
|
@@ -7797,6 +6751,12 @@ export interface DataTypesBillingAlertRequest {
|
|
|
7797
6751
|
* @memberof DataTypesBillingAlertRequest
|
|
7798
6752
|
*/
|
|
7799
6753
|
'threshold_value'?: number;
|
|
6754
|
+
/**
|
|
6755
|
+
* Alternative to store_id - will be converted to store_id
|
|
6756
|
+
* @type {string}
|
|
6757
|
+
* @memberof DataTypesBillingAlertRequest
|
|
6758
|
+
*/
|
|
6759
|
+
'xstoreid'?: string;
|
|
7800
6760
|
}
|
|
7801
6761
|
export declare const DataTypesBillingAlertRequestAlertTypeEnum: {
|
|
7802
6762
|
readonly LowBalance: "low_balance";
|
|
@@ -11499,6 +10459,31 @@ export interface DataTypesGetStoreResult {
|
|
|
11499
10459
|
*/
|
|
11500
10460
|
'xStoreWriteSecret'?: string;
|
|
11501
10461
|
}
|
|
10462
|
+
/**
|
|
10463
|
+
*
|
|
10464
|
+
* @export
|
|
10465
|
+
* @interface DataTypesGrantStoreAccessRequest
|
|
10466
|
+
*/
|
|
10467
|
+
export interface DataTypesGrantStoreAccessRequest {
|
|
10468
|
+
/**
|
|
10469
|
+
*
|
|
10470
|
+
* @type {string}
|
|
10471
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10472
|
+
*/
|
|
10473
|
+
'access_level': DataTypesGrantStoreAccessRequestAccessLevelEnum;
|
|
10474
|
+
/**
|
|
10475
|
+
*
|
|
10476
|
+
* @type {number}
|
|
10477
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10478
|
+
*/
|
|
10479
|
+
'user_id': number;
|
|
10480
|
+
}
|
|
10481
|
+
export declare const DataTypesGrantStoreAccessRequestAccessLevelEnum: {
|
|
10482
|
+
readonly Read: "read";
|
|
10483
|
+
readonly Write: "write";
|
|
10484
|
+
readonly Admin: "admin";
|
|
10485
|
+
};
|
|
10486
|
+
export type DataTypesGrantStoreAccessRequestAccessLevelEnum = typeof DataTypesGrantStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesGrantStoreAccessRequestAccessLevelEnum];
|
|
11502
10487
|
/**
|
|
11503
10488
|
*
|
|
11504
10489
|
* @export
|
|
@@ -11946,6 +10931,73 @@ export interface DataTypesIndexField {
|
|
|
11946
10931
|
*/
|
|
11947
10932
|
'type'?: string;
|
|
11948
10933
|
}
|
|
10934
|
+
/**
|
|
10935
|
+
*
|
|
10936
|
+
* @export
|
|
10937
|
+
* @interface DataTypesInvitationCreatedResponse
|
|
10938
|
+
*/
|
|
10939
|
+
export interface DataTypesInvitationCreatedResponse {
|
|
10940
|
+
/**
|
|
10941
|
+
*
|
|
10942
|
+
* @type {DataTypesTeamInvitationWithDetails}
|
|
10943
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10944
|
+
*/
|
|
10945
|
+
'data'?: DataTypesTeamInvitationWithDetails;
|
|
10946
|
+
/**
|
|
10947
|
+
*
|
|
10948
|
+
* @type {string}
|
|
10949
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10950
|
+
*/
|
|
10951
|
+
'message'?: string;
|
|
10952
|
+
/**
|
|
10953
|
+
*
|
|
10954
|
+
* @type {number}
|
|
10955
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10956
|
+
*/
|
|
10957
|
+
'status'?: number;
|
|
10958
|
+
}
|
|
10959
|
+
/**
|
|
10960
|
+
*
|
|
10961
|
+
* @export
|
|
10962
|
+
* @interface DataTypesInviteMemberRequest
|
|
10963
|
+
*/
|
|
10964
|
+
export interface DataTypesInviteMemberRequest {
|
|
10965
|
+
/**
|
|
10966
|
+
* Optional custom message in invitation
|
|
10967
|
+
* @type {string}
|
|
10968
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10969
|
+
*/
|
|
10970
|
+
'custom_message'?: string;
|
|
10971
|
+
/**
|
|
10972
|
+
*
|
|
10973
|
+
* @type {string}
|
|
10974
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10975
|
+
*/
|
|
10976
|
+
'email': string;
|
|
10977
|
+
/**
|
|
10978
|
+
*
|
|
10979
|
+
* @type {string}
|
|
10980
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10981
|
+
*/
|
|
10982
|
+
'member_role': DataTypesInviteMemberRequestMemberRoleEnum;
|
|
10983
|
+
/**
|
|
10984
|
+
* Whether to send invitation email
|
|
10985
|
+
* @type {boolean}
|
|
10986
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10987
|
+
*/
|
|
10988
|
+
'send_email'?: boolean;
|
|
10989
|
+
/**
|
|
10990
|
+
* Optional: specific stores to grant access to
|
|
10991
|
+
* @type {Array<DataTypesStoreAccessRequest>}
|
|
10992
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10993
|
+
*/
|
|
10994
|
+
'stores'?: Array<DataTypesStoreAccessRequest>;
|
|
10995
|
+
}
|
|
10996
|
+
export declare const DataTypesInviteMemberRequestMemberRoleEnum: {
|
|
10997
|
+
readonly Admin: "admin";
|
|
10998
|
+
readonly Member: "member";
|
|
10999
|
+
};
|
|
11000
|
+
export type DataTypesInviteMemberRequestMemberRoleEnum = typeof DataTypesInviteMemberRequestMemberRoleEnum[keyof typeof DataTypesInviteMemberRequestMemberRoleEnum];
|
|
11949
11001
|
/**
|
|
11950
11002
|
*
|
|
11951
11003
|
* @export
|
|
@@ -12635,31 +11687,6 @@ export interface DataTypesLimitResponse {
|
|
|
12635
11687
|
*/
|
|
12636
11688
|
'status'?: number;
|
|
12637
11689
|
}
|
|
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
11690
|
/**
|
|
12664
11691
|
*
|
|
12665
11692
|
* @export
|
|
@@ -13093,6 +12120,12 @@ export interface DataTypesMenuAccess {
|
|
|
13093
12120
|
* @memberof DataTypesMenuAccess
|
|
13094
12121
|
*/
|
|
13095
12122
|
'SubMenuAccess'?: Array<DataTypesSubMenuAccess>;
|
|
12123
|
+
/**
|
|
12124
|
+
* Store IDs user has access to (for store-specific menus)
|
|
12125
|
+
* @type {Array<number>}
|
|
12126
|
+
* @memberof DataTypesMenuAccess
|
|
12127
|
+
*/
|
|
12128
|
+
'accessibleStores'?: Array<number>;
|
|
13096
12129
|
/**
|
|
13097
12130
|
*
|
|
13098
12131
|
* @type {boolean}
|
|
@@ -13483,31 +12516,6 @@ export interface DataTypesNewsLetterRequestResponse {
|
|
|
13483
12516
|
*/
|
|
13484
12517
|
'status'?: number;
|
|
13485
12518
|
}
|
|
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
12519
|
/**
|
|
13512
12520
|
*
|
|
13513
12521
|
* @export
|
|
@@ -13546,109 +12554,6 @@ export interface DataTypesOTPPayload {
|
|
|
13546
12554
|
*/
|
|
13547
12555
|
'otp'?: string;
|
|
13548
12556
|
}
|
|
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
12557
|
/**
|
|
13653
12558
|
*
|
|
13654
12559
|
* @export
|
|
@@ -14190,6 +13095,117 @@ export interface DataTypesOrdersListResponse {
|
|
|
14190
13095
|
*/
|
|
14191
13096
|
'total_pages'?: number;
|
|
14192
13097
|
}
|
|
13098
|
+
/**
|
|
13099
|
+
*
|
|
13100
|
+
* @export
|
|
13101
|
+
* @interface DataTypesOrgMemberWithUser
|
|
13102
|
+
*/
|
|
13103
|
+
export interface DataTypesOrgMemberWithUser {
|
|
13104
|
+
/**
|
|
13105
|
+
*
|
|
13106
|
+
* @type {string}
|
|
13107
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13108
|
+
*/
|
|
13109
|
+
'email'?: string;
|
|
13110
|
+
/**
|
|
13111
|
+
*
|
|
13112
|
+
* @type {string}
|
|
13113
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13114
|
+
*/
|
|
13115
|
+
'first_name'?: string;
|
|
13116
|
+
/**
|
|
13117
|
+
*
|
|
13118
|
+
* @type {boolean}
|
|
13119
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13120
|
+
*/
|
|
13121
|
+
'is_active'?: boolean;
|
|
13122
|
+
/**
|
|
13123
|
+
*
|
|
13124
|
+
* @type {string}
|
|
13125
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13126
|
+
*/
|
|
13127
|
+
'joined_at'?: string;
|
|
13128
|
+
/**
|
|
13129
|
+
*
|
|
13130
|
+
* @type {string}
|
|
13131
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13132
|
+
*/
|
|
13133
|
+
'last_name'?: string;
|
|
13134
|
+
/**
|
|
13135
|
+
*
|
|
13136
|
+
* @type {number}
|
|
13137
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13138
|
+
*/
|
|
13139
|
+
'member_id'?: number;
|
|
13140
|
+
/**
|
|
13141
|
+
*
|
|
13142
|
+
* @type {string}
|
|
13143
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13144
|
+
*/
|
|
13145
|
+
'member_role'?: string;
|
|
13146
|
+
/**
|
|
13147
|
+
*
|
|
13148
|
+
* @type {number}
|
|
13149
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13150
|
+
*/
|
|
13151
|
+
'org_id'?: number;
|
|
13152
|
+
/**
|
|
13153
|
+
* Number of stores user has access to
|
|
13154
|
+
* @type {number}
|
|
13155
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13156
|
+
*/
|
|
13157
|
+
'stores_count'?: number;
|
|
13158
|
+
/**
|
|
13159
|
+
*
|
|
13160
|
+
* @type {number}
|
|
13161
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13162
|
+
*/
|
|
13163
|
+
'user_id'?: number;
|
|
13164
|
+
}
|
|
13165
|
+
/**
|
|
13166
|
+
*
|
|
13167
|
+
* @export
|
|
13168
|
+
* @interface DataTypesOrgMembersData
|
|
13169
|
+
*/
|
|
13170
|
+
export interface DataTypesOrgMembersData {
|
|
13171
|
+
/**
|
|
13172
|
+
*
|
|
13173
|
+
* @type {Array<DataTypesOrgMemberWithUser>}
|
|
13174
|
+
* @memberof DataTypesOrgMembersData
|
|
13175
|
+
*/
|
|
13176
|
+
'members'?: Array<DataTypesOrgMemberWithUser>;
|
|
13177
|
+
/**
|
|
13178
|
+
*
|
|
13179
|
+
* @type {number}
|
|
13180
|
+
* @memberof DataTypesOrgMembersData
|
|
13181
|
+
*/
|
|
13182
|
+
'total'?: number;
|
|
13183
|
+
}
|
|
13184
|
+
/**
|
|
13185
|
+
*
|
|
13186
|
+
* @export
|
|
13187
|
+
* @interface DataTypesOrgMembersResponse
|
|
13188
|
+
*/
|
|
13189
|
+
export interface DataTypesOrgMembersResponse {
|
|
13190
|
+
/**
|
|
13191
|
+
*
|
|
13192
|
+
* @type {DataTypesOrgMembersData}
|
|
13193
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13194
|
+
*/
|
|
13195
|
+
'data'?: DataTypesOrgMembersData;
|
|
13196
|
+
/**
|
|
13197
|
+
*
|
|
13198
|
+
* @type {string}
|
|
13199
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13200
|
+
*/
|
|
13201
|
+
'message'?: string;
|
|
13202
|
+
/**
|
|
13203
|
+
*
|
|
13204
|
+
* @type {number}
|
|
13205
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13206
|
+
*/
|
|
13207
|
+
'status'?: number;
|
|
13208
|
+
}
|
|
14193
13209
|
/**
|
|
14194
13210
|
*
|
|
14195
13211
|
* @export
|
|
@@ -14555,31 +13571,6 @@ export interface DataTypesOrganizationTaxDetails {
|
|
|
14555
13571
|
[key: string]: any;
|
|
14556
13572
|
};
|
|
14557
13573
|
}
|
|
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
13574
|
/**
|
|
14584
13575
|
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
14585
13576
|
* @export
|
|
@@ -15092,31 +14083,6 @@ export interface DataTypesPaymentStatusPollResponse {
|
|
|
15092
14083
|
*/
|
|
15093
14084
|
'updated_at'?: string;
|
|
15094
14085
|
}
|
|
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
14086
|
/**
|
|
15121
14087
|
*
|
|
15122
14088
|
* @export
|
|
@@ -15238,31 +14204,6 @@ export interface DataTypesPlanResponse {
|
|
|
15238
14204
|
*/
|
|
15239
14205
|
'status'?: number;
|
|
15240
14206
|
}
|
|
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
14207
|
/**
|
|
15267
14208
|
*
|
|
15268
14209
|
* @export
|
|
@@ -15578,91 +14519,6 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
15578
14519
|
*/
|
|
15579
14520
|
'status'?: number;
|
|
15580
14521
|
}
|
|
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
14522
|
/**
|
|
15667
14523
|
*
|
|
15668
14524
|
* @export
|
|
@@ -16679,31 +15535,6 @@ export interface DataTypesRoleRightsListResponse {
|
|
|
16679
15535
|
*/
|
|
16680
15536
|
'status'?: number;
|
|
16681
15537
|
}
|
|
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
15538
|
/**
|
|
16708
15539
|
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
16709
15540
|
* @export
|
|
@@ -17263,31 +16094,6 @@ export interface DataTypesServiceRequestResponse {
|
|
|
17263
16094
|
*/
|
|
17264
16095
|
'status'?: number;
|
|
17265
16096
|
}
|
|
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
16097
|
/**
|
|
17292
16098
|
*
|
|
17293
16099
|
* @export
|
|
@@ -17534,6 +16340,129 @@ export interface DataTypesStore {
|
|
|
17534
16340
|
*/
|
|
17535
16341
|
'xStoreID'?: string;
|
|
17536
16342
|
}
|
|
16343
|
+
/**
|
|
16344
|
+
*
|
|
16345
|
+
* @export
|
|
16346
|
+
* @interface DataTypesStoreAccessRequest
|
|
16347
|
+
*/
|
|
16348
|
+
export interface DataTypesStoreAccessRequest {
|
|
16349
|
+
/**
|
|
16350
|
+
*
|
|
16351
|
+
* @type {string}
|
|
16352
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16353
|
+
*/
|
|
16354
|
+
'access_level': DataTypesStoreAccessRequestAccessLevelEnum;
|
|
16355
|
+
/**
|
|
16356
|
+
*
|
|
16357
|
+
* @type {number}
|
|
16358
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16359
|
+
*/
|
|
16360
|
+
'store_id': number;
|
|
16361
|
+
}
|
|
16362
|
+
export declare const DataTypesStoreAccessRequestAccessLevelEnum: {
|
|
16363
|
+
readonly Read: "read";
|
|
16364
|
+
readonly Write: "write";
|
|
16365
|
+
readonly Admin: "admin";
|
|
16366
|
+
};
|
|
16367
|
+
export type DataTypesStoreAccessRequestAccessLevelEnum = typeof DataTypesStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesStoreAccessRequestAccessLevelEnum];
|
|
16368
|
+
/**
|
|
16369
|
+
*
|
|
16370
|
+
* @export
|
|
16371
|
+
* @interface DataTypesStoreAccessResponse
|
|
16372
|
+
*/
|
|
16373
|
+
export interface DataTypesStoreAccessResponse {
|
|
16374
|
+
/**
|
|
16375
|
+
*
|
|
16376
|
+
* @type {Array<DataTypesStoreAccessWithDetails>}
|
|
16377
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16378
|
+
*/
|
|
16379
|
+
'data'?: Array<DataTypesStoreAccessWithDetails>;
|
|
16380
|
+
/**
|
|
16381
|
+
*
|
|
16382
|
+
* @type {string}
|
|
16383
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16384
|
+
*/
|
|
16385
|
+
'message'?: string;
|
|
16386
|
+
/**
|
|
16387
|
+
*
|
|
16388
|
+
* @type {number}
|
|
16389
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16390
|
+
*/
|
|
16391
|
+
'status'?: number;
|
|
16392
|
+
}
|
|
16393
|
+
/**
|
|
16394
|
+
*
|
|
16395
|
+
* @export
|
|
16396
|
+
* @interface DataTypesStoreAccessWithDetails
|
|
16397
|
+
*/
|
|
16398
|
+
export interface DataTypesStoreAccessWithDetails {
|
|
16399
|
+
/**
|
|
16400
|
+
*
|
|
16401
|
+
* @type {number}
|
|
16402
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16403
|
+
*/
|
|
16404
|
+
'access_id'?: number;
|
|
16405
|
+
/**
|
|
16406
|
+
*
|
|
16407
|
+
* @type {string}
|
|
16408
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16409
|
+
*/
|
|
16410
|
+
'access_level'?: string;
|
|
16411
|
+
/**
|
|
16412
|
+
*
|
|
16413
|
+
* @type {string}
|
|
16414
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16415
|
+
*/
|
|
16416
|
+
'email'?: string;
|
|
16417
|
+
/**
|
|
16418
|
+
*
|
|
16419
|
+
* @type {string}
|
|
16420
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16421
|
+
*/
|
|
16422
|
+
'first_name'?: string;
|
|
16423
|
+
/**
|
|
16424
|
+
*
|
|
16425
|
+
* @type {string}
|
|
16426
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16427
|
+
*/
|
|
16428
|
+
'granted_at'?: string;
|
|
16429
|
+
/**
|
|
16430
|
+
*
|
|
16431
|
+
* @type {number}
|
|
16432
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16433
|
+
*/
|
|
16434
|
+
'granted_by'?: number;
|
|
16435
|
+
/**
|
|
16436
|
+
*
|
|
16437
|
+
* @type {boolean}
|
|
16438
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16439
|
+
*/
|
|
16440
|
+
'is_active'?: boolean;
|
|
16441
|
+
/**
|
|
16442
|
+
*
|
|
16443
|
+
* @type {string}
|
|
16444
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16445
|
+
*/
|
|
16446
|
+
'last_name'?: string;
|
|
16447
|
+
/**
|
|
16448
|
+
*
|
|
16449
|
+
* @type {number}
|
|
16450
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16451
|
+
*/
|
|
16452
|
+
'store_id'?: number;
|
|
16453
|
+
/**
|
|
16454
|
+
*
|
|
16455
|
+
* @type {string}
|
|
16456
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16457
|
+
*/
|
|
16458
|
+
'store_name'?: string;
|
|
16459
|
+
/**
|
|
16460
|
+
*
|
|
16461
|
+
* @type {number}
|
|
16462
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16463
|
+
*/
|
|
16464
|
+
'user_id'?: number;
|
|
16465
|
+
}
|
|
17537
16466
|
/**
|
|
17538
16467
|
*
|
|
17539
16468
|
* @export
|
|
@@ -17818,6 +16747,12 @@ export interface DataTypesStoresListResponse {
|
|
|
17818
16747
|
* @interface DataTypesSubMenuAccess
|
|
17819
16748
|
*/
|
|
17820
16749
|
export interface DataTypesSubMenuAccess {
|
|
16750
|
+
/**
|
|
16751
|
+
* Store IDs user has access to (for store-specific menus)
|
|
16752
|
+
* @type {Array<number>}
|
|
16753
|
+
* @memberof DataTypesSubMenuAccess
|
|
16754
|
+
*/
|
|
16755
|
+
'accessibleStores'?: Array<number>;
|
|
17821
16756
|
/**
|
|
17822
16757
|
*
|
|
17823
16758
|
* @type {boolean}
|
|
@@ -18025,31 +16960,6 @@ export interface DataTypesSubscriptionResponse {
|
|
|
18025
16960
|
*/
|
|
18026
16961
|
'status'?: number;
|
|
18027
16962
|
}
|
|
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
16963
|
/**
|
|
18054
16964
|
*
|
|
18055
16965
|
* @export
|
|
@@ -18521,6 +17431,128 @@ export interface DataTypesTaxComponent {
|
|
|
18521
17431
|
*/
|
|
18522
17432
|
'taxable_amount'?: number;
|
|
18523
17433
|
}
|
|
17434
|
+
/**
|
|
17435
|
+
*
|
|
17436
|
+
* @export
|
|
17437
|
+
* @interface DataTypesTeamInvitationWithDetails
|
|
17438
|
+
*/
|
|
17439
|
+
export interface DataTypesTeamInvitationWithDetails {
|
|
17440
|
+
/**
|
|
17441
|
+
*
|
|
17442
|
+
* @type {string}
|
|
17443
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17444
|
+
*/
|
|
17445
|
+
'accepted_at'?: string;
|
|
17446
|
+
/**
|
|
17447
|
+
*
|
|
17448
|
+
* @type {string}
|
|
17449
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17450
|
+
*/
|
|
17451
|
+
'created_at'?: string;
|
|
17452
|
+
/**
|
|
17453
|
+
*
|
|
17454
|
+
* @type {string}
|
|
17455
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17456
|
+
*/
|
|
17457
|
+
'email'?: string;
|
|
17458
|
+
/**
|
|
17459
|
+
*
|
|
17460
|
+
* @type {string}
|
|
17461
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17462
|
+
*/
|
|
17463
|
+
'expires_at'?: string;
|
|
17464
|
+
/**
|
|
17465
|
+
*
|
|
17466
|
+
* @type {number}
|
|
17467
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17468
|
+
*/
|
|
17469
|
+
'invitation_id'?: number;
|
|
17470
|
+
/**
|
|
17471
|
+
*
|
|
17472
|
+
* @type {number}
|
|
17473
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17474
|
+
*/
|
|
17475
|
+
'invited_by'?: number;
|
|
17476
|
+
/**
|
|
17477
|
+
*
|
|
17478
|
+
* @type {string}
|
|
17479
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17480
|
+
*/
|
|
17481
|
+
'inviter_email'?: string;
|
|
17482
|
+
/**
|
|
17483
|
+
*
|
|
17484
|
+
* @type {string}
|
|
17485
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17486
|
+
*/
|
|
17487
|
+
'inviter_name'?: string;
|
|
17488
|
+
/**
|
|
17489
|
+
*
|
|
17490
|
+
* @type {string}
|
|
17491
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17492
|
+
*/
|
|
17493
|
+
'member_role'?: string;
|
|
17494
|
+
/**
|
|
17495
|
+
*
|
|
17496
|
+
* @type {number}
|
|
17497
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17498
|
+
*/
|
|
17499
|
+
'org_id'?: number;
|
|
17500
|
+
/**
|
|
17501
|
+
*
|
|
17502
|
+
* @type {string}
|
|
17503
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17504
|
+
*/
|
|
17505
|
+
'org_name'?: string;
|
|
17506
|
+
/**
|
|
17507
|
+
*
|
|
17508
|
+
* @type {string}
|
|
17509
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17510
|
+
*/
|
|
17511
|
+
'rejected_at'?: string;
|
|
17512
|
+
/**
|
|
17513
|
+
*
|
|
17514
|
+
* @type {string}
|
|
17515
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17516
|
+
*/
|
|
17517
|
+
'status'?: string;
|
|
17518
|
+
/**
|
|
17519
|
+
* Store IDs to grant access to
|
|
17520
|
+
* @type {Array<number>}
|
|
17521
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17522
|
+
*/
|
|
17523
|
+
'store_access'?: Array<number>;
|
|
17524
|
+
/**
|
|
17525
|
+
* Only for pending invitations
|
|
17526
|
+
* @type {string}
|
|
17527
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17528
|
+
*/
|
|
17529
|
+
'token'?: string;
|
|
17530
|
+
}
|
|
17531
|
+
/**
|
|
17532
|
+
*
|
|
17533
|
+
* @export
|
|
17534
|
+
* @interface DataTypesTeamInvitationsResponse
|
|
17535
|
+
*/
|
|
17536
|
+
export interface DataTypesTeamInvitationsResponse {
|
|
17537
|
+
/**
|
|
17538
|
+
*
|
|
17539
|
+
* @type {Array<DataTypesTeamInvitationWithDetails>}
|
|
17540
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17541
|
+
*/
|
|
17542
|
+
'data'?: Array<DataTypesTeamInvitationWithDetails>;
|
|
17543
|
+
/**
|
|
17544
|
+
*
|
|
17545
|
+
* @type {string}
|
|
17546
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17547
|
+
*/
|
|
17548
|
+
'message'?: string;
|
|
17549
|
+
/**
|
|
17550
|
+
*
|
|
17551
|
+
* @type {number}
|
|
17552
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17553
|
+
*/
|
|
17554
|
+
'status'?: number;
|
|
17555
|
+
}
|
|
18524
17556
|
/**
|
|
18525
17557
|
*
|
|
18526
17558
|
* @export
|
|
@@ -18707,6 +17739,25 @@ export interface DataTypesUpdateInvoiceRequest {
|
|
|
18707
17739
|
*/
|
|
18708
17740
|
'status'?: string;
|
|
18709
17741
|
}
|
|
17742
|
+
/**
|
|
17743
|
+
*
|
|
17744
|
+
* @export
|
|
17745
|
+
* @interface DataTypesUpdateMemberRoleRequest
|
|
17746
|
+
*/
|
|
17747
|
+
export interface DataTypesUpdateMemberRoleRequest {
|
|
17748
|
+
/**
|
|
17749
|
+
*
|
|
17750
|
+
* @type {string}
|
|
17751
|
+
* @memberof DataTypesUpdateMemberRoleRequest
|
|
17752
|
+
*/
|
|
17753
|
+
'member_role': DataTypesUpdateMemberRoleRequestMemberRoleEnum;
|
|
17754
|
+
}
|
|
17755
|
+
export declare const DataTypesUpdateMemberRoleRequestMemberRoleEnum: {
|
|
17756
|
+
readonly Owner: "owner";
|
|
17757
|
+
readonly Admin: "admin";
|
|
17758
|
+
readonly Member: "member";
|
|
17759
|
+
};
|
|
17760
|
+
export type DataTypesUpdateMemberRoleRequestMemberRoleEnum = typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum[keyof typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum];
|
|
18710
17761
|
/**
|
|
18711
17762
|
*
|
|
18712
17763
|
* @export
|
|
@@ -19111,6 +18162,25 @@ export interface DataTypesUpdateSourceConfigResponseWrapper {
|
|
|
19111
18162
|
*/
|
|
19112
18163
|
'status'?: number;
|
|
19113
18164
|
}
|
|
18165
|
+
/**
|
|
18166
|
+
*
|
|
18167
|
+
* @export
|
|
18168
|
+
* @interface DataTypesUpdateStoreAccessRequest
|
|
18169
|
+
*/
|
|
18170
|
+
export interface DataTypesUpdateStoreAccessRequest {
|
|
18171
|
+
/**
|
|
18172
|
+
*
|
|
18173
|
+
* @type {string}
|
|
18174
|
+
* @memberof DataTypesUpdateStoreAccessRequest
|
|
18175
|
+
*/
|
|
18176
|
+
'access_level': DataTypesUpdateStoreAccessRequestAccessLevelEnum;
|
|
18177
|
+
}
|
|
18178
|
+
export declare const DataTypesUpdateStoreAccessRequestAccessLevelEnum: {
|
|
18179
|
+
readonly Read: "read";
|
|
18180
|
+
readonly Write: "write";
|
|
18181
|
+
readonly Admin: "admin";
|
|
18182
|
+
};
|
|
18183
|
+
export type DataTypesUpdateStoreAccessRequestAccessLevelEnum = typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum];
|
|
19114
18184
|
/**
|
|
19115
18185
|
*
|
|
19116
18186
|
* @export
|
|
@@ -19435,6 +18505,74 @@ export interface DataTypesUserResponse {
|
|
|
19435
18505
|
*/
|
|
19436
18506
|
'status'?: number;
|
|
19437
18507
|
}
|
|
18508
|
+
/**
|
|
18509
|
+
*
|
|
18510
|
+
* @export
|
|
18511
|
+
* @interface DataTypesUserStoreAccess
|
|
18512
|
+
*/
|
|
18513
|
+
export interface DataTypesUserStoreAccess {
|
|
18514
|
+
/**
|
|
18515
|
+
*
|
|
18516
|
+
* @type {string}
|
|
18517
|
+
* @memberof DataTypesUserStoreAccess
|
|
18518
|
+
*/
|
|
18519
|
+
'access_level'?: string;
|
|
18520
|
+
/**
|
|
18521
|
+
*
|
|
18522
|
+
* @type {number}
|
|
18523
|
+
* @memberof DataTypesUserStoreAccess
|
|
18524
|
+
*/
|
|
18525
|
+
'org_id'?: number;
|
|
18526
|
+
/**
|
|
18527
|
+
*
|
|
18528
|
+
* @type {string}
|
|
18529
|
+
* @memberof DataTypesUserStoreAccess
|
|
18530
|
+
*/
|
|
18531
|
+
'org_name'?: string;
|
|
18532
|
+
/**
|
|
18533
|
+
*
|
|
18534
|
+
* @type {number}
|
|
18535
|
+
* @memberof DataTypesUserStoreAccess
|
|
18536
|
+
*/
|
|
18537
|
+
'store_id'?: number;
|
|
18538
|
+
/**
|
|
18539
|
+
*
|
|
18540
|
+
* @type {string}
|
|
18541
|
+
* @memberof DataTypesUserStoreAccess
|
|
18542
|
+
*/
|
|
18543
|
+
'store_name'?: string;
|
|
18544
|
+
/**
|
|
18545
|
+
*
|
|
18546
|
+
* @type {string}
|
|
18547
|
+
* @memberof DataTypesUserStoreAccess
|
|
18548
|
+
*/
|
|
18549
|
+
'x_store_id'?: string;
|
|
18550
|
+
}
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @export
|
|
18554
|
+
* @interface DataTypesUserStoresResponse
|
|
18555
|
+
*/
|
|
18556
|
+
export interface DataTypesUserStoresResponse {
|
|
18557
|
+
/**
|
|
18558
|
+
*
|
|
18559
|
+
* @type {Array<DataTypesUserStoreAccess>}
|
|
18560
|
+
* @memberof DataTypesUserStoresResponse
|
|
18561
|
+
*/
|
|
18562
|
+
'data'?: Array<DataTypesUserStoreAccess>;
|
|
18563
|
+
/**
|
|
18564
|
+
*
|
|
18565
|
+
* @type {string}
|
|
18566
|
+
* @memberof DataTypesUserStoresResponse
|
|
18567
|
+
*/
|
|
18568
|
+
'message'?: string;
|
|
18569
|
+
/**
|
|
18570
|
+
*
|
|
18571
|
+
* @type {number}
|
|
18572
|
+
* @memberof DataTypesUserStoresResponse
|
|
18573
|
+
*/
|
|
18574
|
+
'status'?: number;
|
|
18575
|
+
}
|
|
19438
18576
|
/**
|
|
19439
18577
|
*
|
|
19440
18578
|
* @export
|
|
@@ -21887,41 +21025,6 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
21887
21025
|
* @throws {RequiredError}
|
|
21888
21026
|
*/
|
|
21889
21027
|
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
21028
|
/**
|
|
21926
21029
|
* 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
21030
|
* @summary Get Top Results Analytics
|
|
@@ -22327,41 +21430,6 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22327
21430
|
* @throws {RequiredError}
|
|
22328
21431
|
*/
|
|
22329
21432
|
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
21433
|
/**
|
|
22366
21434
|
* 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
21435
|
* @summary Get Top Results Analytics
|
|
@@ -22767,41 +21835,6 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
22767
21835
|
* @throws {RequiredError}
|
|
22768
21836
|
*/
|
|
22769
21837
|
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
21838
|
/**
|
|
22806
21839
|
* 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
21840
|
* @summary Get Top Results Analytics
|
|
@@ -23223,42 +22256,6 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
23223
22256
|
* @memberof AnalyticsApi
|
|
23224
22257
|
*/
|
|
23225
22258
|
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
22259
|
/**
|
|
23263
22260
|
* 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
22261
|
* @summary Get Top Results Analytics
|
|
@@ -23670,22 +22667,6 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
23670
22667
|
readonly Desc: "desc";
|
|
23671
22668
|
};
|
|
23672
22669
|
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
22670
|
/**
|
|
23690
22671
|
* @export
|
|
23691
22672
|
*/
|
|
@@ -28999,13 +27980,6 @@ export declare const LimitsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
28999
27980
|
* @throws {RequiredError}
|
|
29000
27981
|
*/
|
|
29001
27982
|
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
27983
|
/**
|
|
29010
27984
|
* Fetches limit by id
|
|
29011
27985
|
* @summary Fetches limit by id
|
|
@@ -29046,13 +28020,6 @@ export declare const LimitsApiFp: (configuration?: Configuration) => {
|
|
|
29046
28020
|
* @throws {RequiredError}
|
|
29047
28021
|
*/
|
|
29048
28022
|
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
28023
|
/**
|
|
29057
28024
|
* Fetches limit by id
|
|
29058
28025
|
* @summary Fetches limit by id
|
|
@@ -29093,13 +28060,6 @@ export declare const LimitsApiFactory: (configuration?: Configuration, basePath?
|
|
|
29093
28060
|
* @throws {RequiredError}
|
|
29094
28061
|
*/
|
|
29095
28062
|
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
28063
|
/**
|
|
29104
28064
|
* Fetches limit by id
|
|
29105
28065
|
* @summary Fetches limit by id
|
|
@@ -29143,14 +28103,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29143
28103
|
* @memberof LimitsApi
|
|
29144
28104
|
*/
|
|
29145
28105
|
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
28106
|
/**
|
|
29155
28107
|
* Fetches limit by id
|
|
29156
28108
|
* @summary Fetches limit by id
|
|
@@ -29185,13 +28137,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29185
28137
|
* @export
|
|
29186
28138
|
*/
|
|
29187
28139
|
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
28140
|
/**
|
|
29196
28141
|
* Deletes a menu from the system by ID.
|
|
29197
28142
|
* @summary Delete a menu
|
|
@@ -29310,13 +28255,6 @@ export declare const MenusApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29310
28255
|
* @export
|
|
29311
28256
|
*/
|
|
29312
28257
|
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
28258
|
/**
|
|
29321
28259
|
* Deletes a menu from the system by ID.
|
|
29322
28260
|
* @summary Delete a menu
|
|
@@ -29435,13 +28373,6 @@ export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
|
29435
28373
|
* @export
|
|
29436
28374
|
*/
|
|
29437
28375
|
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
28376
|
/**
|
|
29446
28377
|
* Deletes a menu from the system by ID.
|
|
29447
28378
|
* @summary Delete a menu
|
|
@@ -29562,14 +28493,6 @@ export declare const MenusApiFactory: (configuration?: Configuration, basePath?:
|
|
|
29562
28493
|
* @extends {BaseAPI}
|
|
29563
28494
|
*/
|
|
29564
28495
|
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
28496
|
/**
|
|
29574
28497
|
* Deletes a menu from the system by ID.
|
|
29575
28498
|
* @summary Delete a menu
|
|
@@ -30120,13 +29043,6 @@ export declare class MongoDbApi extends BaseAPI {
|
|
|
30120
29043
|
* @export
|
|
30121
29044
|
*/
|
|
30122
29045
|
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
29046
|
/**
|
|
30131
29047
|
* Fetches NewsLetterSubscription by id
|
|
30132
29048
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30167,13 +29083,6 @@ export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configura
|
|
|
30167
29083
|
* @export
|
|
30168
29084
|
*/
|
|
30169
29085
|
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
29086
|
/**
|
|
30178
29087
|
* Fetches NewsLetterSubscription by id
|
|
30179
29088
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30214,13 +29123,6 @@ export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
|
30214
29123
|
* @export
|
|
30215
29124
|
*/
|
|
30216
29125
|
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
29126
|
/**
|
|
30225
29127
|
* Fetches NewsLetterSubscription by id
|
|
30226
29128
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30263,14 +29165,6 @@ export declare const NewsLettersApiFactory: (configuration?: Configuration, base
|
|
|
30263
29165
|
* @extends {BaseAPI}
|
|
30264
29166
|
*/
|
|
30265
29167
|
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
29168
|
/**
|
|
30275
29169
|
* Fetches NewsLetterSubscription by id
|
|
30276
29170
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30622,13 +29516,6 @@ export declare class OnboardingApi extends BaseAPI {
|
|
|
30622
29516
|
* @export
|
|
30623
29517
|
*/
|
|
30624
29518
|
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
29519
|
/**
|
|
30633
29520
|
* Updates Orgnization information by ID.
|
|
30634
29521
|
* @summary Update an existing Orgnization
|
|
@@ -30669,13 +29556,6 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
30669
29556
|
* @export
|
|
30670
29557
|
*/
|
|
30671
29558
|
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
29559
|
/**
|
|
30680
29560
|
* Updates Orgnization information by ID.
|
|
30681
29561
|
* @summary Update an existing Orgnization
|
|
@@ -30716,13 +29596,6 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
30716
29596
|
* @export
|
|
30717
29597
|
*/
|
|
30718
29598
|
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
29599
|
/**
|
|
30727
29600
|
* Updates Orgnization information by ID.
|
|
30728
29601
|
* @summary Update an existing Orgnization
|
|
@@ -30765,14 +29638,6 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
30765
29638
|
* @extends {BaseAPI}
|
|
30766
29639
|
*/
|
|
30767
29640
|
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
29641
|
/**
|
|
30777
29642
|
* Updates Orgnization information by ID.
|
|
30778
29643
|
* @summary Update an existing Orgnization
|
|
@@ -31519,13 +30384,6 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
31519
30384
|
* @export
|
|
31520
30385
|
*/
|
|
31521
30386
|
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
30387
|
/**
|
|
31530
30388
|
* Deletes a payment from the system by ID.
|
|
31531
30389
|
* @summary Delete a payment
|
|
@@ -31565,13 +30423,6 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31565
30423
|
* @export
|
|
31566
30424
|
*/
|
|
31567
30425
|
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
30426
|
/**
|
|
31576
30427
|
* Deletes a payment from the system by ID.
|
|
31577
30428
|
* @summary Delete a payment
|
|
@@ -31611,13 +30462,6 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
31611
30462
|
* @export
|
|
31612
30463
|
*/
|
|
31613
30464
|
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
30465
|
/**
|
|
31622
30466
|
* Deletes a payment from the system by ID.
|
|
31623
30467
|
* @summary Delete a payment
|
|
@@ -31659,14 +30503,6 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
31659
30503
|
* @extends {BaseAPI}
|
|
31660
30504
|
*/
|
|
31661
30505
|
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
30506
|
/**
|
|
31671
30507
|
* Deletes a payment from the system by ID.
|
|
31672
30508
|
* @summary Delete a payment
|
|
@@ -31710,13 +30546,6 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
31710
30546
|
* @export
|
|
31711
30547
|
*/
|
|
31712
30548
|
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
30549
|
/**
|
|
31721
30550
|
* Fetches plan by id
|
|
31722
30551
|
* @summary Fetches plan by id
|
|
@@ -31757,13 +30586,6 @@ export declare const PlansApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
31757
30586
|
* @export
|
|
31758
30587
|
*/
|
|
31759
30588
|
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
30589
|
/**
|
|
31768
30590
|
* Fetches plan by id
|
|
31769
30591
|
* @summary Fetches plan by id
|
|
@@ -31804,13 +30626,6 @@ export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
|
31804
30626
|
* @export
|
|
31805
30627
|
*/
|
|
31806
30628
|
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
30629
|
/**
|
|
31815
30630
|
* Fetches plan by id
|
|
31816
30631
|
* @summary Fetches plan by id
|
|
@@ -31853,14 +30668,6 @@ export declare const PlansApiFactory: (configuration?: Configuration, basePath?:
|
|
|
31853
30668
|
* @extends {BaseAPI}
|
|
31854
30669
|
*/
|
|
31855
30670
|
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
30671
|
/**
|
|
31865
30672
|
* Fetches plan by id
|
|
31866
30673
|
* @summary Fetches plan by id
|
|
@@ -34195,13 +33002,6 @@ export declare class RegisterApi extends BaseAPI {
|
|
|
34195
33002
|
* @export
|
|
34196
33003
|
*/
|
|
34197
33004
|
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
33005
|
/**
|
|
34206
33006
|
* Updates ServiceRequest information by ID.
|
|
34207
33007
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34250,13 +33050,6 @@ export declare const RequestsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34250
33050
|
* @export
|
|
34251
33051
|
*/
|
|
34252
33052
|
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
33053
|
/**
|
|
34261
33054
|
* Updates ServiceRequest information by ID.
|
|
34262
33055
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34305,13 +33098,6 @@ export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
|
34305
33098
|
* @export
|
|
34306
33099
|
*/
|
|
34307
33100
|
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
33101
|
/**
|
|
34316
33102
|
* Updates ServiceRequest information by ID.
|
|
34317
33103
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34362,14 +33148,6 @@ export declare const RequestsApiFactory: (configuration?: Configuration, basePat
|
|
|
34362
33148
|
* @extends {BaseAPI}
|
|
34363
33149
|
*/
|
|
34364
33150
|
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
33151
|
/**
|
|
34374
33152
|
* Updates ServiceRequest information by ID.
|
|
34375
33153
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34431,13 +33209,6 @@ export declare const RoleRightsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
34431
33209
|
* @throws {RequiredError}
|
|
34432
33210
|
*/
|
|
34433
33211
|
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
33212
|
/**
|
|
34442
33213
|
* Fetches roleright by role id
|
|
34443
33214
|
* @summary Fetches roleright by role id
|
|
@@ -34501,13 +33272,6 @@ export declare const RoleRightsApiFp: (configuration?: Configuration) => {
|
|
|
34501
33272
|
* @throws {RequiredError}
|
|
34502
33273
|
*/
|
|
34503
33274
|
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
33275
|
/**
|
|
34512
33276
|
* Fetches roleright by role id
|
|
34513
33277
|
* @summary Fetches roleright by role id
|
|
@@ -34571,13 +33335,6 @@ export declare const RoleRightsApiFactory: (configuration?: Configuration, baseP
|
|
|
34571
33335
|
* @throws {RequiredError}
|
|
34572
33336
|
*/
|
|
34573
33337
|
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
33338
|
/**
|
|
34582
33339
|
* Fetches roleright by role id
|
|
34583
33340
|
* @summary Fetches roleright by role id
|
|
@@ -34644,14 +33401,6 @@ export declare class RoleRightsApi extends BaseAPI {
|
|
|
34644
33401
|
* @memberof RoleRightsApi
|
|
34645
33402
|
*/
|
|
34646
33403
|
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
33404
|
/**
|
|
34656
33405
|
* Fetches roleright by role id
|
|
34657
33406
|
* @summary Fetches roleright by role id
|
|
@@ -34730,14 +33479,6 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34730
33479
|
* @throws {RequiredError}
|
|
34731
33480
|
*/
|
|
34732
33481
|
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
33482
|
/**
|
|
34742
33483
|
* Fetches role by id
|
|
34743
33484
|
* @summary Fetches role by id
|
|
@@ -34778,14 +33519,6 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
34778
33519
|
* @throws {RequiredError}
|
|
34779
33520
|
*/
|
|
34780
33521
|
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
33522
|
/**
|
|
34790
33523
|
* Fetches role by id
|
|
34791
33524
|
* @summary Fetches role by id
|
|
@@ -34826,14 +33559,6 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
34826
33559
|
* @throws {RequiredError}
|
|
34827
33560
|
*/
|
|
34828
33561
|
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
33562
|
/**
|
|
34838
33563
|
* Fetches role by id
|
|
34839
33564
|
* @summary Fetches role by id
|
|
@@ -34878,15 +33603,6 @@ export declare class RolesApi extends BaseAPI {
|
|
|
34878
33603
|
* @memberof RolesApi
|
|
34879
33604
|
*/
|
|
34880
33605
|
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
33606
|
/**
|
|
34891
33607
|
* Fetches role by id
|
|
34892
33608
|
* @summary Fetches role by id
|
|
@@ -34964,16 +33680,6 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34964
33680
|
* @throws {RequiredError}
|
|
34965
33681
|
*/
|
|
34966
33682
|
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
33683
|
};
|
|
34978
33684
|
/**
|
|
34979
33685
|
* SearchApi - functional programming interface
|
|
@@ -35032,16 +33738,6 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
35032
33738
|
* @throws {RequiredError}
|
|
35033
33739
|
*/
|
|
35034
33740
|
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
33741
|
};
|
|
35046
33742
|
/**
|
|
35047
33743
|
* SearchApi - factory interface
|
|
@@ -35100,16 +33796,6 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
35100
33796
|
* @throws {RequiredError}
|
|
35101
33797
|
*/
|
|
35102
33798
|
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
33799
|
};
|
|
35114
33800
|
/**
|
|
35115
33801
|
* SearchApi - object-oriented interface
|
|
@@ -35176,17 +33862,6 @@ export declare class SearchApi extends BaseAPI {
|
|
|
35176
33862
|
* @memberof SearchApi
|
|
35177
33863
|
*/
|
|
35178
33864
|
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
33865
|
}
|
|
35191
33866
|
/**
|
|
35192
33867
|
* StopwordsApi - axios parameter creator
|
|
@@ -36769,13 +35444,6 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
36769
35444
|
* @throws {RequiredError}
|
|
36770
35445
|
*/
|
|
36771
35446
|
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
35447
|
/**
|
|
36780
35448
|
* Adds a new Subscription to the system
|
|
36781
35449
|
* @summary Creates a new Subscription
|
|
@@ -36832,13 +35500,6 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
36832
35500
|
* @throws {RequiredError}
|
|
36833
35501
|
*/
|
|
36834
35502
|
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
35503
|
/**
|
|
36843
35504
|
* Adds a new Subscription to the system
|
|
36844
35505
|
* @summary Creates a new Subscription
|
|
@@ -36895,13 +35556,6 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
36895
35556
|
* @throws {RequiredError}
|
|
36896
35557
|
*/
|
|
36897
35558
|
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
35559
|
/**
|
|
36906
35560
|
* Adds a new Subscription to the system
|
|
36907
35561
|
* @summary Creates a new Subscription
|
|
@@ -36964,14 +35618,6 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
36964
35618
|
* @memberof SubscriptionsApi
|
|
36965
35619
|
*/
|
|
36966
35620
|
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
35621
|
/**
|
|
36976
35622
|
* Adds a new Subscription to the system
|
|
36977
35623
|
* @summary Creates a new Subscription
|
|
@@ -37145,6 +35791,460 @@ export declare class TaxManagementApi extends BaseAPI {
|
|
|
37145
35791
|
*/
|
|
37146
35792
|
adminTaxValidateGstinPost(dataTypesGSTVerificationRequest: DataTypesGSTVerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesGSTVerificationResponse, any, {}>>;
|
|
37147
35793
|
}
|
|
35794
|
+
/**
|
|
35795
|
+
* TeamApi - axios parameter creator
|
|
35796
|
+
* @export
|
|
35797
|
+
*/
|
|
35798
|
+
export declare const TeamApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35799
|
+
/**
|
|
35800
|
+
* Cancels a pending invitation
|
|
35801
|
+
* @summary Cancel invitation
|
|
35802
|
+
* @param {number} invitationId Invitation ID
|
|
35803
|
+
* @param {*} [options] Override http request option.
|
|
35804
|
+
* @throws {RequiredError}
|
|
35805
|
+
*/
|
|
35806
|
+
apiV1InvitationsInvitationIdDelete: (invitationId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35807
|
+
/**
|
|
35808
|
+
* Accepts a team invitation using token
|
|
35809
|
+
* @summary Accept invitation
|
|
35810
|
+
* @param {string} token Invitation Token
|
|
35811
|
+
* @param {*} [options] Override http request option.
|
|
35812
|
+
* @throws {RequiredError}
|
|
35813
|
+
*/
|
|
35814
|
+
apiV1InvitationsTokenAcceptPost: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35815
|
+
/**
|
|
35816
|
+
* Retrieves all pending invitations for an organization
|
|
35817
|
+
* @summary Get pending invitations
|
|
35818
|
+
* @param {number} orgId Organization ID
|
|
35819
|
+
* @param {*} [options] Override http request option.
|
|
35820
|
+
* @throws {RequiredError}
|
|
35821
|
+
*/
|
|
35822
|
+
apiV1OrganizationsOrgIdInvitationsGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35823
|
+
/**
|
|
35824
|
+
* Retrieves all members of an organization with their details
|
|
35825
|
+
* @summary Get all members of an organization
|
|
35826
|
+
* @param {number} orgId Organization ID
|
|
35827
|
+
* @param {*} [options] Override http request option.
|
|
35828
|
+
* @throws {RequiredError}
|
|
35829
|
+
*/
|
|
35830
|
+
apiV1OrganizationsOrgIdMembersGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35831
|
+
/**
|
|
35832
|
+
* Sends an invitation to a user to join the organization
|
|
35833
|
+
* @summary Invite a member to join organization
|
|
35834
|
+
* @param {number} orgId Organization ID
|
|
35835
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35836
|
+
* @param {*} [options] Override http request option.
|
|
35837
|
+
* @throws {RequiredError}
|
|
35838
|
+
*/
|
|
35839
|
+
apiV1OrganizationsOrgIdMembersInvitePost: (orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35840
|
+
/**
|
|
35841
|
+
* Removes a member from the organization
|
|
35842
|
+
* @summary Remove member from organization
|
|
35843
|
+
* @param {number} orgId Organization ID
|
|
35844
|
+
* @param {number} memberId Member ID
|
|
35845
|
+
* @param {*} [options] Override http request option.
|
|
35846
|
+
* @throws {RequiredError}
|
|
35847
|
+
*/
|
|
35848
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete: (orgId: number, memberId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35849
|
+
/**
|
|
35850
|
+
* Updates the role of a member in the organization
|
|
35851
|
+
* @summary Update member role
|
|
35852
|
+
* @param {number} orgId Organization ID
|
|
35853
|
+
* @param {number} memberId Member ID
|
|
35854
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35855
|
+
* @param {*} [options] Override http request option.
|
|
35856
|
+
* @throws {RequiredError}
|
|
35857
|
+
*/
|
|
35858
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut: (orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35859
|
+
/**
|
|
35860
|
+
* Retrieves all users with access to a store
|
|
35861
|
+
* @summary Get store access list
|
|
35862
|
+
* @param {number} storeId Store ID
|
|
35863
|
+
* @param {*} [options] Override http request option.
|
|
35864
|
+
* @throws {RequiredError}
|
|
35865
|
+
*/
|
|
35866
|
+
apiV1StoresStoreIdAccessGet: (storeId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35867
|
+
/**
|
|
35868
|
+
* Grants a user access to a store
|
|
35869
|
+
* @summary Grant store access
|
|
35870
|
+
* @param {number} storeId Store ID
|
|
35871
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35872
|
+
* @param {*} [options] Override http request option.
|
|
35873
|
+
* @throws {RequiredError}
|
|
35874
|
+
*/
|
|
35875
|
+
apiV1StoresStoreIdAccessPost: (storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35876
|
+
/**
|
|
35877
|
+
* Revokes a user\'s access to a store
|
|
35878
|
+
* @summary Revoke store access
|
|
35879
|
+
* @param {number} storeId Store ID
|
|
35880
|
+
* @param {number} userId User ID
|
|
35881
|
+
* @param {*} [options] Override http request option.
|
|
35882
|
+
* @throws {RequiredError}
|
|
35883
|
+
*/
|
|
35884
|
+
apiV1StoresStoreIdAccessUserIdDelete: (storeId: number, userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35885
|
+
/**
|
|
35886
|
+
* Updates a user\'s access level to a store
|
|
35887
|
+
* @summary Update store access level
|
|
35888
|
+
* @param {number} storeId Store ID
|
|
35889
|
+
* @param {number} userId User ID
|
|
35890
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
35891
|
+
* @param {*} [options] Override http request option.
|
|
35892
|
+
* @throws {RequiredError}
|
|
35893
|
+
*/
|
|
35894
|
+
apiV1StoresStoreIdAccessUserIdPut: (storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35895
|
+
/**
|
|
35896
|
+
* Retrieves all stores accessible to a user
|
|
35897
|
+
* @summary Get user\'s accessible stores
|
|
35898
|
+
* @param {number} userId User ID
|
|
35899
|
+
* @param {*} [options] Override http request option.
|
|
35900
|
+
* @throws {RequiredError}
|
|
35901
|
+
*/
|
|
35902
|
+
apiV1UsersUserIdStoresGet: (userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35903
|
+
};
|
|
35904
|
+
/**
|
|
35905
|
+
* TeamApi - functional programming interface
|
|
35906
|
+
* @export
|
|
35907
|
+
*/
|
|
35908
|
+
export declare const TeamApiFp: (configuration?: Configuration) => {
|
|
35909
|
+
/**
|
|
35910
|
+
* Cancels a pending invitation
|
|
35911
|
+
* @summary Cancel invitation
|
|
35912
|
+
* @param {number} invitationId Invitation ID
|
|
35913
|
+
* @param {*} [options] Override http request option.
|
|
35914
|
+
* @throws {RequiredError}
|
|
35915
|
+
*/
|
|
35916
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35917
|
+
/**
|
|
35918
|
+
* Accepts a team invitation using token
|
|
35919
|
+
* @summary Accept invitation
|
|
35920
|
+
* @param {string} token Invitation Token
|
|
35921
|
+
* @param {*} [options] Override http request option.
|
|
35922
|
+
* @throws {RequiredError}
|
|
35923
|
+
*/
|
|
35924
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35925
|
+
/**
|
|
35926
|
+
* Retrieves all pending invitations for an organization
|
|
35927
|
+
* @summary Get pending invitations
|
|
35928
|
+
* @param {number} orgId Organization ID
|
|
35929
|
+
* @param {*} [options] Override http request option.
|
|
35930
|
+
* @throws {RequiredError}
|
|
35931
|
+
*/
|
|
35932
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesTeamInvitationsResponse>>;
|
|
35933
|
+
/**
|
|
35934
|
+
* Retrieves all members of an organization with their details
|
|
35935
|
+
* @summary Get all members of an organization
|
|
35936
|
+
* @param {number} orgId Organization ID
|
|
35937
|
+
* @param {*} [options] Override http request option.
|
|
35938
|
+
* @throws {RequiredError}
|
|
35939
|
+
*/
|
|
35940
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrgMembersResponse>>;
|
|
35941
|
+
/**
|
|
35942
|
+
* Sends an invitation to a user to join the organization
|
|
35943
|
+
* @summary Invite a member to join organization
|
|
35944
|
+
* @param {number} orgId Organization ID
|
|
35945
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35946
|
+
* @param {*} [options] Override http request option.
|
|
35947
|
+
* @throws {RequiredError}
|
|
35948
|
+
*/
|
|
35949
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesInvitationCreatedResponse>>;
|
|
35950
|
+
/**
|
|
35951
|
+
* Removes a member from the organization
|
|
35952
|
+
* @summary Remove member from organization
|
|
35953
|
+
* @param {number} orgId Organization ID
|
|
35954
|
+
* @param {number} memberId Member ID
|
|
35955
|
+
* @param {*} [options] Override http request option.
|
|
35956
|
+
* @throws {RequiredError}
|
|
35957
|
+
*/
|
|
35958
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35959
|
+
/**
|
|
35960
|
+
* Updates the role of a member in the organization
|
|
35961
|
+
* @summary Update member role
|
|
35962
|
+
* @param {number} orgId Organization ID
|
|
35963
|
+
* @param {number} memberId Member ID
|
|
35964
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35965
|
+
* @param {*} [options] Override http request option.
|
|
35966
|
+
* @throws {RequiredError}
|
|
35967
|
+
*/
|
|
35968
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35969
|
+
/**
|
|
35970
|
+
* Retrieves all users with access to a store
|
|
35971
|
+
* @summary Get store access list
|
|
35972
|
+
* @param {number} storeId Store ID
|
|
35973
|
+
* @param {*} [options] Override http request option.
|
|
35974
|
+
* @throws {RequiredError}
|
|
35975
|
+
*/
|
|
35976
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreAccessResponse>>;
|
|
35977
|
+
/**
|
|
35978
|
+
* Grants a user access to a store
|
|
35979
|
+
* @summary Grant store access
|
|
35980
|
+
* @param {number} storeId Store ID
|
|
35981
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35982
|
+
* @param {*} [options] Override http request option.
|
|
35983
|
+
* @throws {RequiredError}
|
|
35984
|
+
*/
|
|
35985
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35986
|
+
/**
|
|
35987
|
+
* Revokes a user\'s access to a store
|
|
35988
|
+
* @summary Revoke store access
|
|
35989
|
+
* @param {number} storeId Store ID
|
|
35990
|
+
* @param {number} userId User ID
|
|
35991
|
+
* @param {*} [options] Override http request option.
|
|
35992
|
+
* @throws {RequiredError}
|
|
35993
|
+
*/
|
|
35994
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35995
|
+
/**
|
|
35996
|
+
* Updates a user\'s access level to a store
|
|
35997
|
+
* @summary Update store access level
|
|
35998
|
+
* @param {number} storeId Store ID
|
|
35999
|
+
* @param {number} userId User ID
|
|
36000
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36001
|
+
* @param {*} [options] Override http request option.
|
|
36002
|
+
* @throws {RequiredError}
|
|
36003
|
+
*/
|
|
36004
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
36005
|
+
/**
|
|
36006
|
+
* Retrieves all stores accessible to a user
|
|
36007
|
+
* @summary Get user\'s accessible stores
|
|
36008
|
+
* @param {number} userId User ID
|
|
36009
|
+
* @param {*} [options] Override http request option.
|
|
36010
|
+
* @throws {RequiredError}
|
|
36011
|
+
*/
|
|
36012
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUserStoresResponse>>;
|
|
36013
|
+
};
|
|
36014
|
+
/**
|
|
36015
|
+
* TeamApi - factory interface
|
|
36016
|
+
* @export
|
|
36017
|
+
*/
|
|
36018
|
+
export declare const TeamApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36019
|
+
/**
|
|
36020
|
+
* Cancels a pending invitation
|
|
36021
|
+
* @summary Cancel invitation
|
|
36022
|
+
* @param {number} invitationId Invitation ID
|
|
36023
|
+
* @param {*} [options] Override http request option.
|
|
36024
|
+
* @throws {RequiredError}
|
|
36025
|
+
*/
|
|
36026
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36027
|
+
/**
|
|
36028
|
+
* Accepts a team invitation using token
|
|
36029
|
+
* @summary Accept invitation
|
|
36030
|
+
* @param {string} token Invitation Token
|
|
36031
|
+
* @param {*} [options] Override http request option.
|
|
36032
|
+
* @throws {RequiredError}
|
|
36033
|
+
*/
|
|
36034
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36035
|
+
/**
|
|
36036
|
+
* Retrieves all pending invitations for an organization
|
|
36037
|
+
* @summary Get pending invitations
|
|
36038
|
+
* @param {number} orgId Organization ID
|
|
36039
|
+
* @param {*} [options] Override http request option.
|
|
36040
|
+
* @throws {RequiredError}
|
|
36041
|
+
*/
|
|
36042
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesTeamInvitationsResponse>;
|
|
36043
|
+
/**
|
|
36044
|
+
* Retrieves all members of an organization with their details
|
|
36045
|
+
* @summary Get all members of an organization
|
|
36046
|
+
* @param {number} orgId Organization ID
|
|
36047
|
+
* @param {*} [options] Override http request option.
|
|
36048
|
+
* @throws {RequiredError}
|
|
36049
|
+
*/
|
|
36050
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrgMembersResponse>;
|
|
36051
|
+
/**
|
|
36052
|
+
* Sends an invitation to a user to join the organization
|
|
36053
|
+
* @summary Invite a member to join organization
|
|
36054
|
+
* @param {number} orgId Organization ID
|
|
36055
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36056
|
+
* @param {*} [options] Override http request option.
|
|
36057
|
+
* @throws {RequiredError}
|
|
36058
|
+
*/
|
|
36059
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesInvitationCreatedResponse>;
|
|
36060
|
+
/**
|
|
36061
|
+
* Removes a member from the organization
|
|
36062
|
+
* @summary Remove member from organization
|
|
36063
|
+
* @param {number} orgId Organization ID
|
|
36064
|
+
* @param {number} memberId Member ID
|
|
36065
|
+
* @param {*} [options] Override http request option.
|
|
36066
|
+
* @throws {RequiredError}
|
|
36067
|
+
*/
|
|
36068
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36069
|
+
/**
|
|
36070
|
+
* Updates the role of a member in the organization
|
|
36071
|
+
* @summary Update member role
|
|
36072
|
+
* @param {number} orgId Organization ID
|
|
36073
|
+
* @param {number} memberId Member ID
|
|
36074
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36075
|
+
* @param {*} [options] Override http request option.
|
|
36076
|
+
* @throws {RequiredError}
|
|
36077
|
+
*/
|
|
36078
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36079
|
+
/**
|
|
36080
|
+
* Retrieves all users with access to a store
|
|
36081
|
+
* @summary Get store access list
|
|
36082
|
+
* @param {number} storeId Store ID
|
|
36083
|
+
* @param {*} [options] Override http request option.
|
|
36084
|
+
* @throws {RequiredError}
|
|
36085
|
+
*/
|
|
36086
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreAccessResponse>;
|
|
36087
|
+
/**
|
|
36088
|
+
* Grants a user access to a store
|
|
36089
|
+
* @summary Grant store access
|
|
36090
|
+
* @param {number} storeId Store ID
|
|
36091
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36092
|
+
* @param {*} [options] Override http request option.
|
|
36093
|
+
* @throws {RequiredError}
|
|
36094
|
+
*/
|
|
36095
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36096
|
+
/**
|
|
36097
|
+
* Revokes a user\'s access to a store
|
|
36098
|
+
* @summary Revoke store access
|
|
36099
|
+
* @param {number} storeId Store ID
|
|
36100
|
+
* @param {number} userId User ID
|
|
36101
|
+
* @param {*} [options] Override http request option.
|
|
36102
|
+
* @throws {RequiredError}
|
|
36103
|
+
*/
|
|
36104
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36105
|
+
/**
|
|
36106
|
+
* Updates a user\'s access level to a store
|
|
36107
|
+
* @summary Update store access level
|
|
36108
|
+
* @param {number} storeId Store ID
|
|
36109
|
+
* @param {number} userId User ID
|
|
36110
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36111
|
+
* @param {*} [options] Override http request option.
|
|
36112
|
+
* @throws {RequiredError}
|
|
36113
|
+
*/
|
|
36114
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36115
|
+
/**
|
|
36116
|
+
* Retrieves all stores accessible to a user
|
|
36117
|
+
* @summary Get user\'s accessible stores
|
|
36118
|
+
* @param {number} userId User ID
|
|
36119
|
+
* @param {*} [options] Override http request option.
|
|
36120
|
+
* @throws {RequiredError}
|
|
36121
|
+
*/
|
|
36122
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUserStoresResponse>;
|
|
36123
|
+
};
|
|
36124
|
+
/**
|
|
36125
|
+
* TeamApi - object-oriented interface
|
|
36126
|
+
* @export
|
|
36127
|
+
* @class TeamApi
|
|
36128
|
+
* @extends {BaseAPI}
|
|
36129
|
+
*/
|
|
36130
|
+
export declare class TeamApi extends BaseAPI {
|
|
36131
|
+
/**
|
|
36132
|
+
* Cancels a pending invitation
|
|
36133
|
+
* @summary Cancel invitation
|
|
36134
|
+
* @param {number} invitationId Invitation ID
|
|
36135
|
+
* @param {*} [options] Override http request option.
|
|
36136
|
+
* @throws {RequiredError}
|
|
36137
|
+
* @memberof TeamApi
|
|
36138
|
+
*/
|
|
36139
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36140
|
+
/**
|
|
36141
|
+
* Accepts a team invitation using token
|
|
36142
|
+
* @summary Accept invitation
|
|
36143
|
+
* @param {string} token Invitation Token
|
|
36144
|
+
* @param {*} [options] Override http request option.
|
|
36145
|
+
* @throws {RequiredError}
|
|
36146
|
+
* @memberof TeamApi
|
|
36147
|
+
*/
|
|
36148
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36149
|
+
/**
|
|
36150
|
+
* Retrieves all pending invitations for an organization
|
|
36151
|
+
* @summary Get pending invitations
|
|
36152
|
+
* @param {number} orgId Organization ID
|
|
36153
|
+
* @param {*} [options] Override http request option.
|
|
36154
|
+
* @throws {RequiredError}
|
|
36155
|
+
* @memberof TeamApi
|
|
36156
|
+
*/
|
|
36157
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesTeamInvitationsResponse, any, {}>>;
|
|
36158
|
+
/**
|
|
36159
|
+
* Retrieves all members of an organization with their details
|
|
36160
|
+
* @summary Get all members of an organization
|
|
36161
|
+
* @param {number} orgId Organization ID
|
|
36162
|
+
* @param {*} [options] Override http request option.
|
|
36163
|
+
* @throws {RequiredError}
|
|
36164
|
+
* @memberof TeamApi
|
|
36165
|
+
*/
|
|
36166
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrgMembersResponse, any, {}>>;
|
|
36167
|
+
/**
|
|
36168
|
+
* Sends an invitation to a user to join the organization
|
|
36169
|
+
* @summary Invite a member to join organization
|
|
36170
|
+
* @param {number} orgId Organization ID
|
|
36171
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36172
|
+
* @param {*} [options] Override http request option.
|
|
36173
|
+
* @throws {RequiredError}
|
|
36174
|
+
* @memberof TeamApi
|
|
36175
|
+
*/
|
|
36176
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesInvitationCreatedResponse, any, {}>>;
|
|
36177
|
+
/**
|
|
36178
|
+
* Removes a member from the organization
|
|
36179
|
+
* @summary Remove member from organization
|
|
36180
|
+
* @param {number} orgId Organization ID
|
|
36181
|
+
* @param {number} memberId Member ID
|
|
36182
|
+
* @param {*} [options] Override http request option.
|
|
36183
|
+
* @throws {RequiredError}
|
|
36184
|
+
* @memberof TeamApi
|
|
36185
|
+
*/
|
|
36186
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36187
|
+
/**
|
|
36188
|
+
* Updates the role of a member in the organization
|
|
36189
|
+
* @summary Update member role
|
|
36190
|
+
* @param {number} orgId Organization ID
|
|
36191
|
+
* @param {number} memberId Member ID
|
|
36192
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36193
|
+
* @param {*} [options] Override http request option.
|
|
36194
|
+
* @throws {RequiredError}
|
|
36195
|
+
* @memberof TeamApi
|
|
36196
|
+
*/
|
|
36197
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36198
|
+
/**
|
|
36199
|
+
* Retrieves all users with access to a store
|
|
36200
|
+
* @summary Get store access list
|
|
36201
|
+
* @param {number} storeId Store ID
|
|
36202
|
+
* @param {*} [options] Override http request option.
|
|
36203
|
+
* @throws {RequiredError}
|
|
36204
|
+
* @memberof TeamApi
|
|
36205
|
+
*/
|
|
36206
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreAccessResponse, any, {}>>;
|
|
36207
|
+
/**
|
|
36208
|
+
* Grants a user access to a store
|
|
36209
|
+
* @summary Grant store access
|
|
36210
|
+
* @param {number} storeId Store ID
|
|
36211
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36212
|
+
* @param {*} [options] Override http request option.
|
|
36213
|
+
* @throws {RequiredError}
|
|
36214
|
+
* @memberof TeamApi
|
|
36215
|
+
*/
|
|
36216
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36217
|
+
/**
|
|
36218
|
+
* Revokes a user\'s access to a store
|
|
36219
|
+
* @summary Revoke store access
|
|
36220
|
+
* @param {number} storeId Store ID
|
|
36221
|
+
* @param {number} userId User ID
|
|
36222
|
+
* @param {*} [options] Override http request option.
|
|
36223
|
+
* @throws {RequiredError}
|
|
36224
|
+
* @memberof TeamApi
|
|
36225
|
+
*/
|
|
36226
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36227
|
+
/**
|
|
36228
|
+
* Updates a user\'s access level to a store
|
|
36229
|
+
* @summary Update store access level
|
|
36230
|
+
* @param {number} storeId Store ID
|
|
36231
|
+
* @param {number} userId User ID
|
|
36232
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36233
|
+
* @param {*} [options] Override http request option.
|
|
36234
|
+
* @throws {RequiredError}
|
|
36235
|
+
* @memberof TeamApi
|
|
36236
|
+
*/
|
|
36237
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36238
|
+
/**
|
|
36239
|
+
* Retrieves all stores accessible to a user
|
|
36240
|
+
* @summary Get user\'s accessible stores
|
|
36241
|
+
* @param {number} userId User ID
|
|
36242
|
+
* @param {*} [options] Override http request option.
|
|
36243
|
+
* @throws {RequiredError}
|
|
36244
|
+
* @memberof TeamApi
|
|
36245
|
+
*/
|
|
36246
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUserStoresResponse, any, {}>>;
|
|
36247
|
+
}
|
|
37148
36248
|
/**
|
|
37149
36249
|
* UserApi - axios parameter creator
|
|
37150
36250
|
* @export
|