@seekora-ai/admin-api 1.1.11 → 1.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -46
- package/api.ts +9153 -9954
- package/dist/api.d.ts +1222 -1998
- package/dist/api.js +1152 -1069
- package/dist/esm/api.d.ts +1222 -1998
- package/dist/esm/api.js +1141 -1062
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.13.tgz +0 -0
- package/seekora-ai-admin-api-1.1.11.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
|
|
@@ -11499,6 +10453,31 @@ export interface DataTypesGetStoreResult {
|
|
|
11499
10453
|
*/
|
|
11500
10454
|
'xStoreWriteSecret'?: string;
|
|
11501
10455
|
}
|
|
10456
|
+
/**
|
|
10457
|
+
*
|
|
10458
|
+
* @export
|
|
10459
|
+
* @interface DataTypesGrantStoreAccessRequest
|
|
10460
|
+
*/
|
|
10461
|
+
export interface DataTypesGrantStoreAccessRequest {
|
|
10462
|
+
/**
|
|
10463
|
+
*
|
|
10464
|
+
* @type {string}
|
|
10465
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10466
|
+
*/
|
|
10467
|
+
'access_level': DataTypesGrantStoreAccessRequestAccessLevelEnum;
|
|
10468
|
+
/**
|
|
10469
|
+
*
|
|
10470
|
+
* @type {number}
|
|
10471
|
+
* @memberof DataTypesGrantStoreAccessRequest
|
|
10472
|
+
*/
|
|
10473
|
+
'user_id': number;
|
|
10474
|
+
}
|
|
10475
|
+
export declare const DataTypesGrantStoreAccessRequestAccessLevelEnum: {
|
|
10476
|
+
readonly Read: "read";
|
|
10477
|
+
readonly Write: "write";
|
|
10478
|
+
readonly Admin: "admin";
|
|
10479
|
+
};
|
|
10480
|
+
export type DataTypesGrantStoreAccessRequestAccessLevelEnum = typeof DataTypesGrantStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesGrantStoreAccessRequestAccessLevelEnum];
|
|
11502
10481
|
/**
|
|
11503
10482
|
*
|
|
11504
10483
|
* @export
|
|
@@ -11946,6 +10925,73 @@ export interface DataTypesIndexField {
|
|
|
11946
10925
|
*/
|
|
11947
10926
|
'type'?: string;
|
|
11948
10927
|
}
|
|
10928
|
+
/**
|
|
10929
|
+
*
|
|
10930
|
+
* @export
|
|
10931
|
+
* @interface DataTypesInvitationCreatedResponse
|
|
10932
|
+
*/
|
|
10933
|
+
export interface DataTypesInvitationCreatedResponse {
|
|
10934
|
+
/**
|
|
10935
|
+
*
|
|
10936
|
+
* @type {DataTypesTeamInvitationWithDetails}
|
|
10937
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10938
|
+
*/
|
|
10939
|
+
'data'?: DataTypesTeamInvitationWithDetails;
|
|
10940
|
+
/**
|
|
10941
|
+
*
|
|
10942
|
+
* @type {string}
|
|
10943
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10944
|
+
*/
|
|
10945
|
+
'message'?: string;
|
|
10946
|
+
/**
|
|
10947
|
+
*
|
|
10948
|
+
* @type {number}
|
|
10949
|
+
* @memberof DataTypesInvitationCreatedResponse
|
|
10950
|
+
*/
|
|
10951
|
+
'status'?: number;
|
|
10952
|
+
}
|
|
10953
|
+
/**
|
|
10954
|
+
*
|
|
10955
|
+
* @export
|
|
10956
|
+
* @interface DataTypesInviteMemberRequest
|
|
10957
|
+
*/
|
|
10958
|
+
export interface DataTypesInviteMemberRequest {
|
|
10959
|
+
/**
|
|
10960
|
+
* Optional custom message in invitation
|
|
10961
|
+
* @type {string}
|
|
10962
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10963
|
+
*/
|
|
10964
|
+
'custom_message'?: string;
|
|
10965
|
+
/**
|
|
10966
|
+
*
|
|
10967
|
+
* @type {string}
|
|
10968
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10969
|
+
*/
|
|
10970
|
+
'email': string;
|
|
10971
|
+
/**
|
|
10972
|
+
*
|
|
10973
|
+
* @type {string}
|
|
10974
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10975
|
+
*/
|
|
10976
|
+
'member_role': DataTypesInviteMemberRequestMemberRoleEnum;
|
|
10977
|
+
/**
|
|
10978
|
+
* Whether to send invitation email
|
|
10979
|
+
* @type {boolean}
|
|
10980
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10981
|
+
*/
|
|
10982
|
+
'send_email'?: boolean;
|
|
10983
|
+
/**
|
|
10984
|
+
* Optional: specific stores to grant access to
|
|
10985
|
+
* @type {Array<DataTypesStoreAccessRequest>}
|
|
10986
|
+
* @memberof DataTypesInviteMemberRequest
|
|
10987
|
+
*/
|
|
10988
|
+
'stores'?: Array<DataTypesStoreAccessRequest>;
|
|
10989
|
+
}
|
|
10990
|
+
export declare const DataTypesInviteMemberRequestMemberRoleEnum: {
|
|
10991
|
+
readonly Admin: "admin";
|
|
10992
|
+
readonly Member: "member";
|
|
10993
|
+
};
|
|
10994
|
+
export type DataTypesInviteMemberRequestMemberRoleEnum = typeof DataTypesInviteMemberRequestMemberRoleEnum[keyof typeof DataTypesInviteMemberRequestMemberRoleEnum];
|
|
11949
10995
|
/**
|
|
11950
10996
|
*
|
|
11951
10997
|
* @export
|
|
@@ -12635,31 +11681,6 @@ export interface DataTypesLimitResponse {
|
|
|
12635
11681
|
*/
|
|
12636
11682
|
'status'?: number;
|
|
12637
11683
|
}
|
|
12638
|
-
/**
|
|
12639
|
-
*
|
|
12640
|
-
* @export
|
|
12641
|
-
* @interface DataTypesLimitsListResponse
|
|
12642
|
-
*/
|
|
12643
|
-
export interface DataTypesLimitsListResponse {
|
|
12644
|
-
/**
|
|
12645
|
-
*
|
|
12646
|
-
* @type {Array<DataTypesLimit>}
|
|
12647
|
-
* @memberof DataTypesLimitsListResponse
|
|
12648
|
-
*/
|
|
12649
|
-
'data'?: Array<DataTypesLimit>;
|
|
12650
|
-
/**
|
|
12651
|
-
*
|
|
12652
|
-
* @type {string}
|
|
12653
|
-
* @memberof DataTypesLimitsListResponse
|
|
12654
|
-
*/
|
|
12655
|
-
'message'?: string;
|
|
12656
|
-
/**
|
|
12657
|
-
*
|
|
12658
|
-
* @type {number}
|
|
12659
|
-
* @memberof DataTypesLimitsListResponse
|
|
12660
|
-
*/
|
|
12661
|
-
'status'?: number;
|
|
12662
|
-
}
|
|
12663
11684
|
/**
|
|
12664
11685
|
*
|
|
12665
11686
|
* @export
|
|
@@ -13093,6 +12114,12 @@ export interface DataTypesMenuAccess {
|
|
|
13093
12114
|
* @memberof DataTypesMenuAccess
|
|
13094
12115
|
*/
|
|
13095
12116
|
'SubMenuAccess'?: Array<DataTypesSubMenuAccess>;
|
|
12117
|
+
/**
|
|
12118
|
+
* Store IDs user has access to (for store-specific menus)
|
|
12119
|
+
* @type {Array<number>}
|
|
12120
|
+
* @memberof DataTypesMenuAccess
|
|
12121
|
+
*/
|
|
12122
|
+
'accessibleStores'?: Array<number>;
|
|
13096
12123
|
/**
|
|
13097
12124
|
*
|
|
13098
12125
|
* @type {boolean}
|
|
@@ -13483,31 +12510,6 @@ export interface DataTypesNewsLetterRequestResponse {
|
|
|
13483
12510
|
*/
|
|
13484
12511
|
'status'?: number;
|
|
13485
12512
|
}
|
|
13486
|
-
/**
|
|
13487
|
-
*
|
|
13488
|
-
* @export
|
|
13489
|
-
* @interface DataTypesNewsLetterRequestsListResponse
|
|
13490
|
-
*/
|
|
13491
|
-
export interface DataTypesNewsLetterRequestsListResponse {
|
|
13492
|
-
/**
|
|
13493
|
-
*
|
|
13494
|
-
* @type {Array<DataTypesNewsLetterRequest>}
|
|
13495
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13496
|
-
*/
|
|
13497
|
-
'data'?: Array<DataTypesNewsLetterRequest>;
|
|
13498
|
-
/**
|
|
13499
|
-
*
|
|
13500
|
-
* @type {string}
|
|
13501
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13502
|
-
*/
|
|
13503
|
-
'message'?: string;
|
|
13504
|
-
/**
|
|
13505
|
-
*
|
|
13506
|
-
* @type {number}
|
|
13507
|
-
* @memberof DataTypesNewsLetterRequestsListResponse
|
|
13508
|
-
*/
|
|
13509
|
-
'status'?: number;
|
|
13510
|
-
}
|
|
13511
12513
|
/**
|
|
13512
12514
|
*
|
|
13513
12515
|
* @export
|
|
@@ -13546,109 +12548,6 @@ export interface DataTypesOTPPayload {
|
|
|
13546
12548
|
*/
|
|
13547
12549
|
'otp'?: string;
|
|
13548
12550
|
}
|
|
13549
|
-
/**
|
|
13550
|
-
*
|
|
13551
|
-
* @export
|
|
13552
|
-
* @interface DataTypesOfficialSearchResponse
|
|
13553
|
-
*/
|
|
13554
|
-
export interface DataTypesOfficialSearchResponse {
|
|
13555
|
-
/**
|
|
13556
|
-
*
|
|
13557
|
-
* @type {any}
|
|
13558
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13559
|
-
*/
|
|
13560
|
-
'facets'?: any;
|
|
13561
|
-
/**
|
|
13562
|
-
*
|
|
13563
|
-
* @type {number}
|
|
13564
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13565
|
-
*/
|
|
13566
|
-
'page'?: number;
|
|
13567
|
-
/**
|
|
13568
|
-
*
|
|
13569
|
-
* @type {number}
|
|
13570
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13571
|
-
*/
|
|
13572
|
-
'per_page'?: number;
|
|
13573
|
-
/**
|
|
13574
|
-
*
|
|
13575
|
-
* @type {Array<DataTypesOfficialSearchResult>}
|
|
13576
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13577
|
-
*/
|
|
13578
|
-
'results'?: Array<DataTypesOfficialSearchResult>;
|
|
13579
|
-
/**
|
|
13580
|
-
*
|
|
13581
|
-
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
13582
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13583
|
-
*/
|
|
13584
|
-
'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
|
|
13585
|
-
/**
|
|
13586
|
-
*
|
|
13587
|
-
* @type {number}
|
|
13588
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
13589
|
-
*/
|
|
13590
|
-
'total_results'?: number;
|
|
13591
|
-
}
|
|
13592
|
-
/**
|
|
13593
|
-
*
|
|
13594
|
-
* @export
|
|
13595
|
-
* @interface DataTypesOfficialSearchResponseWrapper
|
|
13596
|
-
*/
|
|
13597
|
-
export interface DataTypesOfficialSearchResponseWrapper {
|
|
13598
|
-
/**
|
|
13599
|
-
*
|
|
13600
|
-
* @type {DataTypesOfficialSearchResponse}
|
|
13601
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13602
|
-
*/
|
|
13603
|
-
'data'?: DataTypesOfficialSearchResponse;
|
|
13604
|
-
/**
|
|
13605
|
-
*
|
|
13606
|
-
* @type {string}
|
|
13607
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13608
|
-
*/
|
|
13609
|
-
'message'?: string;
|
|
13610
|
-
/**
|
|
13611
|
-
*
|
|
13612
|
-
* @type {number}
|
|
13613
|
-
* @memberof DataTypesOfficialSearchResponseWrapper
|
|
13614
|
-
*/
|
|
13615
|
-
'status'?: number;
|
|
13616
|
-
}
|
|
13617
|
-
/**
|
|
13618
|
-
*
|
|
13619
|
-
* @export
|
|
13620
|
-
* @interface DataTypesOfficialSearchResult
|
|
13621
|
-
*/
|
|
13622
|
-
export interface DataTypesOfficialSearchResult {
|
|
13623
|
-
/**
|
|
13624
|
-
*
|
|
13625
|
-
* @type {{ [key: string]: any; }}
|
|
13626
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13627
|
-
*/
|
|
13628
|
-
'document'?: {
|
|
13629
|
-
[key: string]: any;
|
|
13630
|
-
};
|
|
13631
|
-
/**
|
|
13632
|
-
*
|
|
13633
|
-
* @type {{ [key: string]: any; }}
|
|
13634
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13635
|
-
*/
|
|
13636
|
-
'highlight'?: {
|
|
13637
|
-
[key: string]: any;
|
|
13638
|
-
};
|
|
13639
|
-
/**
|
|
13640
|
-
*
|
|
13641
|
-
* @type {string}
|
|
13642
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13643
|
-
*/
|
|
13644
|
-
'id'?: string;
|
|
13645
|
-
/**
|
|
13646
|
-
*
|
|
13647
|
-
* @type {number}
|
|
13648
|
-
* @memberof DataTypesOfficialSearchResult
|
|
13649
|
-
*/
|
|
13650
|
-
'score'?: number;
|
|
13651
|
-
}
|
|
13652
12551
|
/**
|
|
13653
12552
|
*
|
|
13654
12553
|
* @export
|
|
@@ -14190,6 +13089,117 @@ export interface DataTypesOrdersListResponse {
|
|
|
14190
13089
|
*/
|
|
14191
13090
|
'total_pages'?: number;
|
|
14192
13091
|
}
|
|
13092
|
+
/**
|
|
13093
|
+
*
|
|
13094
|
+
* @export
|
|
13095
|
+
* @interface DataTypesOrgMemberWithUser
|
|
13096
|
+
*/
|
|
13097
|
+
export interface DataTypesOrgMemberWithUser {
|
|
13098
|
+
/**
|
|
13099
|
+
*
|
|
13100
|
+
* @type {string}
|
|
13101
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13102
|
+
*/
|
|
13103
|
+
'email'?: string;
|
|
13104
|
+
/**
|
|
13105
|
+
*
|
|
13106
|
+
* @type {string}
|
|
13107
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13108
|
+
*/
|
|
13109
|
+
'first_name'?: string;
|
|
13110
|
+
/**
|
|
13111
|
+
*
|
|
13112
|
+
* @type {boolean}
|
|
13113
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13114
|
+
*/
|
|
13115
|
+
'is_active'?: boolean;
|
|
13116
|
+
/**
|
|
13117
|
+
*
|
|
13118
|
+
* @type {string}
|
|
13119
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13120
|
+
*/
|
|
13121
|
+
'joined_at'?: string;
|
|
13122
|
+
/**
|
|
13123
|
+
*
|
|
13124
|
+
* @type {string}
|
|
13125
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13126
|
+
*/
|
|
13127
|
+
'last_name'?: string;
|
|
13128
|
+
/**
|
|
13129
|
+
*
|
|
13130
|
+
* @type {number}
|
|
13131
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13132
|
+
*/
|
|
13133
|
+
'member_id'?: number;
|
|
13134
|
+
/**
|
|
13135
|
+
*
|
|
13136
|
+
* @type {string}
|
|
13137
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13138
|
+
*/
|
|
13139
|
+
'member_role'?: string;
|
|
13140
|
+
/**
|
|
13141
|
+
*
|
|
13142
|
+
* @type {number}
|
|
13143
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13144
|
+
*/
|
|
13145
|
+
'org_id'?: number;
|
|
13146
|
+
/**
|
|
13147
|
+
* Number of stores user has access to
|
|
13148
|
+
* @type {number}
|
|
13149
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13150
|
+
*/
|
|
13151
|
+
'stores_count'?: number;
|
|
13152
|
+
/**
|
|
13153
|
+
*
|
|
13154
|
+
* @type {number}
|
|
13155
|
+
* @memberof DataTypesOrgMemberWithUser
|
|
13156
|
+
*/
|
|
13157
|
+
'user_id'?: number;
|
|
13158
|
+
}
|
|
13159
|
+
/**
|
|
13160
|
+
*
|
|
13161
|
+
* @export
|
|
13162
|
+
* @interface DataTypesOrgMembersData
|
|
13163
|
+
*/
|
|
13164
|
+
export interface DataTypesOrgMembersData {
|
|
13165
|
+
/**
|
|
13166
|
+
*
|
|
13167
|
+
* @type {Array<DataTypesOrgMemberWithUser>}
|
|
13168
|
+
* @memberof DataTypesOrgMembersData
|
|
13169
|
+
*/
|
|
13170
|
+
'members'?: Array<DataTypesOrgMemberWithUser>;
|
|
13171
|
+
/**
|
|
13172
|
+
*
|
|
13173
|
+
* @type {number}
|
|
13174
|
+
* @memberof DataTypesOrgMembersData
|
|
13175
|
+
*/
|
|
13176
|
+
'total'?: number;
|
|
13177
|
+
}
|
|
13178
|
+
/**
|
|
13179
|
+
*
|
|
13180
|
+
* @export
|
|
13181
|
+
* @interface DataTypesOrgMembersResponse
|
|
13182
|
+
*/
|
|
13183
|
+
export interface DataTypesOrgMembersResponse {
|
|
13184
|
+
/**
|
|
13185
|
+
*
|
|
13186
|
+
* @type {DataTypesOrgMembersData}
|
|
13187
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13188
|
+
*/
|
|
13189
|
+
'data'?: DataTypesOrgMembersData;
|
|
13190
|
+
/**
|
|
13191
|
+
*
|
|
13192
|
+
* @type {string}
|
|
13193
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13194
|
+
*/
|
|
13195
|
+
'message'?: string;
|
|
13196
|
+
/**
|
|
13197
|
+
*
|
|
13198
|
+
* @type {number}
|
|
13199
|
+
* @memberof DataTypesOrgMembersResponse
|
|
13200
|
+
*/
|
|
13201
|
+
'status'?: number;
|
|
13202
|
+
}
|
|
14193
13203
|
/**
|
|
14194
13204
|
*
|
|
14195
13205
|
* @export
|
|
@@ -14555,31 +13565,6 @@ export interface DataTypesOrganizationTaxDetails {
|
|
|
14555
13565
|
[key: string]: any;
|
|
14556
13566
|
};
|
|
14557
13567
|
}
|
|
14558
|
-
/**
|
|
14559
|
-
*
|
|
14560
|
-
* @export
|
|
14561
|
-
* @interface DataTypesOrganizationsListResponse
|
|
14562
|
-
*/
|
|
14563
|
-
export interface DataTypesOrganizationsListResponse {
|
|
14564
|
-
/**
|
|
14565
|
-
*
|
|
14566
|
-
* @type {Array<DataTypesOrganization>}
|
|
14567
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14568
|
-
*/
|
|
14569
|
-
'data'?: Array<DataTypesOrganization>;
|
|
14570
|
-
/**
|
|
14571
|
-
*
|
|
14572
|
-
* @type {string}
|
|
14573
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14574
|
-
*/
|
|
14575
|
-
'message'?: string;
|
|
14576
|
-
/**
|
|
14577
|
-
*
|
|
14578
|
-
* @type {number}
|
|
14579
|
-
* @memberof DataTypesOrganizationsListResponse
|
|
14580
|
-
*/
|
|
14581
|
-
'status'?: number;
|
|
14582
|
-
}
|
|
14583
13568
|
/**
|
|
14584
13569
|
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
14585
13570
|
* @export
|
|
@@ -15092,31 +14077,6 @@ export interface DataTypesPaymentStatusPollResponse {
|
|
|
15092
14077
|
*/
|
|
15093
14078
|
'updated_at'?: string;
|
|
15094
14079
|
}
|
|
15095
|
-
/**
|
|
15096
|
-
*
|
|
15097
|
-
* @export
|
|
15098
|
-
* @interface DataTypesPaymentsListResponse
|
|
15099
|
-
*/
|
|
15100
|
-
export interface DataTypesPaymentsListResponse {
|
|
15101
|
-
/**
|
|
15102
|
-
*
|
|
15103
|
-
* @type {Array<DataTypesPayment>}
|
|
15104
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15105
|
-
*/
|
|
15106
|
-
'data'?: Array<DataTypesPayment>;
|
|
15107
|
-
/**
|
|
15108
|
-
*
|
|
15109
|
-
* @type {string}
|
|
15110
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15111
|
-
*/
|
|
15112
|
-
'message'?: string;
|
|
15113
|
-
/**
|
|
15114
|
-
*
|
|
15115
|
-
* @type {number}
|
|
15116
|
-
* @memberof DataTypesPaymentsListResponse
|
|
15117
|
-
*/
|
|
15118
|
-
'status'?: number;
|
|
15119
|
-
}
|
|
15120
14080
|
/**
|
|
15121
14081
|
*
|
|
15122
14082
|
* @export
|
|
@@ -15238,31 +14198,6 @@ export interface DataTypesPlanResponse {
|
|
|
15238
14198
|
*/
|
|
15239
14199
|
'status'?: number;
|
|
15240
14200
|
}
|
|
15241
|
-
/**
|
|
15242
|
-
*
|
|
15243
|
-
* @export
|
|
15244
|
-
* @interface DataTypesPlansListResponse
|
|
15245
|
-
*/
|
|
15246
|
-
export interface DataTypesPlansListResponse {
|
|
15247
|
-
/**
|
|
15248
|
-
*
|
|
15249
|
-
* @type {Array<DataTypesPlan>}
|
|
15250
|
-
* @memberof DataTypesPlansListResponse
|
|
15251
|
-
*/
|
|
15252
|
-
'data'?: Array<DataTypesPlan>;
|
|
15253
|
-
/**
|
|
15254
|
-
*
|
|
15255
|
-
* @type {string}
|
|
15256
|
-
* @memberof DataTypesPlansListResponse
|
|
15257
|
-
*/
|
|
15258
|
-
'message'?: string;
|
|
15259
|
-
/**
|
|
15260
|
-
*
|
|
15261
|
-
* @type {number}
|
|
15262
|
-
* @memberof DataTypesPlansListResponse
|
|
15263
|
-
*/
|
|
15264
|
-
'status'?: number;
|
|
15265
|
-
}
|
|
15266
14201
|
/**
|
|
15267
14202
|
*
|
|
15268
14203
|
* @export
|
|
@@ -15578,91 +14513,6 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
15578
14513
|
*/
|
|
15579
14514
|
'status'?: number;
|
|
15580
14515
|
}
|
|
15581
|
-
/**
|
|
15582
|
-
*
|
|
15583
|
-
* @export
|
|
15584
|
-
* @interface DataTypesPublicSearchRequest
|
|
15585
|
-
*/
|
|
15586
|
-
export interface DataTypesPublicSearchRequest {
|
|
15587
|
-
/**
|
|
15588
|
-
*
|
|
15589
|
-
* @type {Array<string>}
|
|
15590
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15591
|
-
*/
|
|
15592
|
-
'analytics_tags'?: Array<string>;
|
|
15593
|
-
/**
|
|
15594
|
-
*
|
|
15595
|
-
* @type {string}
|
|
15596
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15597
|
-
*/
|
|
15598
|
-
'facet_by'?: string;
|
|
15599
|
-
/**
|
|
15600
|
-
*
|
|
15601
|
-
* @type {string}
|
|
15602
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15603
|
-
*/
|
|
15604
|
-
'filter'?: string;
|
|
15605
|
-
/**
|
|
15606
|
-
*
|
|
15607
|
-
* @type {boolean}
|
|
15608
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15609
|
-
*/
|
|
15610
|
-
'include_suggestions'?: boolean;
|
|
15611
|
-
/**
|
|
15612
|
-
*
|
|
15613
|
-
* @type {number}
|
|
15614
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15615
|
-
*/
|
|
15616
|
-
'max_facet_values'?: number;
|
|
15617
|
-
/**
|
|
15618
|
-
*
|
|
15619
|
-
* @type {number}
|
|
15620
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15621
|
-
*/
|
|
15622
|
-
'page'?: number;
|
|
15623
|
-
/**
|
|
15624
|
-
*
|
|
15625
|
-
* @type {number}
|
|
15626
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15627
|
-
*/
|
|
15628
|
-
'per_page'?: number;
|
|
15629
|
-
/**
|
|
15630
|
-
*
|
|
15631
|
-
* @type {string}
|
|
15632
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15633
|
-
*/
|
|
15634
|
-
'q': string;
|
|
15635
|
-
/**
|
|
15636
|
-
*
|
|
15637
|
-
* @type {string}
|
|
15638
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15639
|
-
*/
|
|
15640
|
-
'sort'?: string;
|
|
15641
|
-
/**
|
|
15642
|
-
* IDs of stopword sets to use
|
|
15643
|
-
* @type {Array<string>}
|
|
15644
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15645
|
-
*/
|
|
15646
|
-
'stopword_sets'?: Array<string>;
|
|
15647
|
-
/**
|
|
15648
|
-
*
|
|
15649
|
-
* @type {number}
|
|
15650
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15651
|
-
*/
|
|
15652
|
-
'suggestions_limit'?: number;
|
|
15653
|
-
/**
|
|
15654
|
-
* IDs of synonym sets to use
|
|
15655
|
-
* @type {Array<string>}
|
|
15656
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15657
|
-
*/
|
|
15658
|
-
'synonym_sets'?: Array<string>;
|
|
15659
|
-
/**
|
|
15660
|
-
* If true, returns only display fields instead of full document (used in public API only)
|
|
15661
|
-
* @type {boolean}
|
|
15662
|
-
* @memberof DataTypesPublicSearchRequest
|
|
15663
|
-
*/
|
|
15664
|
-
'widget_mode'?: boolean;
|
|
15665
|
-
}
|
|
15666
14516
|
/**
|
|
15667
14517
|
*
|
|
15668
14518
|
* @export
|
|
@@ -16679,31 +15529,6 @@ export interface DataTypesRoleRightsListResponse {
|
|
|
16679
15529
|
*/
|
|
16680
15530
|
'status'?: number;
|
|
16681
15531
|
}
|
|
16682
|
-
/**
|
|
16683
|
-
*
|
|
16684
|
-
* @export
|
|
16685
|
-
* @interface DataTypesRolesListResponse
|
|
16686
|
-
*/
|
|
16687
|
-
export interface DataTypesRolesListResponse {
|
|
16688
|
-
/**
|
|
16689
|
-
*
|
|
16690
|
-
* @type {Array<DataTypesRole>}
|
|
16691
|
-
* @memberof DataTypesRolesListResponse
|
|
16692
|
-
*/
|
|
16693
|
-
'data'?: Array<DataTypesRole>;
|
|
16694
|
-
/**
|
|
16695
|
-
*
|
|
16696
|
-
* @type {string}
|
|
16697
|
-
* @memberof DataTypesRolesListResponse
|
|
16698
|
-
*/
|
|
16699
|
-
'message'?: string;
|
|
16700
|
-
/**
|
|
16701
|
-
*
|
|
16702
|
-
* @type {number}
|
|
16703
|
-
* @memberof DataTypesRolesListResponse
|
|
16704
|
-
*/
|
|
16705
|
-
'status'?: number;
|
|
16706
|
-
}
|
|
16707
15532
|
/**
|
|
16708
15533
|
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
16709
15534
|
* @export
|
|
@@ -17263,31 +16088,6 @@ export interface DataTypesServiceRequestResponse {
|
|
|
17263
16088
|
*/
|
|
17264
16089
|
'status'?: number;
|
|
17265
16090
|
}
|
|
17266
|
-
/**
|
|
17267
|
-
*
|
|
17268
|
-
* @export
|
|
17269
|
-
* @interface DataTypesServiceRequestsListResponse
|
|
17270
|
-
*/
|
|
17271
|
-
export interface DataTypesServiceRequestsListResponse {
|
|
17272
|
-
/**
|
|
17273
|
-
*
|
|
17274
|
-
* @type {Array<DataTypesServiceRequest>}
|
|
17275
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17276
|
-
*/
|
|
17277
|
-
'data'?: Array<DataTypesServiceRequest>;
|
|
17278
|
-
/**
|
|
17279
|
-
*
|
|
17280
|
-
* @type {string}
|
|
17281
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17282
|
-
*/
|
|
17283
|
-
'message'?: string;
|
|
17284
|
-
/**
|
|
17285
|
-
*
|
|
17286
|
-
* @type {number}
|
|
17287
|
-
* @memberof DataTypesServiceRequestsListResponse
|
|
17288
|
-
*/
|
|
17289
|
-
'status'?: number;
|
|
17290
|
-
}
|
|
17291
16091
|
/**
|
|
17292
16092
|
*
|
|
17293
16093
|
* @export
|
|
@@ -17534,6 +16334,129 @@ export interface DataTypesStore {
|
|
|
17534
16334
|
*/
|
|
17535
16335
|
'xStoreID'?: string;
|
|
17536
16336
|
}
|
|
16337
|
+
/**
|
|
16338
|
+
*
|
|
16339
|
+
* @export
|
|
16340
|
+
* @interface DataTypesStoreAccessRequest
|
|
16341
|
+
*/
|
|
16342
|
+
export interface DataTypesStoreAccessRequest {
|
|
16343
|
+
/**
|
|
16344
|
+
*
|
|
16345
|
+
* @type {string}
|
|
16346
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16347
|
+
*/
|
|
16348
|
+
'access_level': DataTypesStoreAccessRequestAccessLevelEnum;
|
|
16349
|
+
/**
|
|
16350
|
+
*
|
|
16351
|
+
* @type {number}
|
|
16352
|
+
* @memberof DataTypesStoreAccessRequest
|
|
16353
|
+
*/
|
|
16354
|
+
'store_id': number;
|
|
16355
|
+
}
|
|
16356
|
+
export declare const DataTypesStoreAccessRequestAccessLevelEnum: {
|
|
16357
|
+
readonly Read: "read";
|
|
16358
|
+
readonly Write: "write";
|
|
16359
|
+
readonly Admin: "admin";
|
|
16360
|
+
};
|
|
16361
|
+
export type DataTypesStoreAccessRequestAccessLevelEnum = typeof DataTypesStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesStoreAccessRequestAccessLevelEnum];
|
|
16362
|
+
/**
|
|
16363
|
+
*
|
|
16364
|
+
* @export
|
|
16365
|
+
* @interface DataTypesStoreAccessResponse
|
|
16366
|
+
*/
|
|
16367
|
+
export interface DataTypesStoreAccessResponse {
|
|
16368
|
+
/**
|
|
16369
|
+
*
|
|
16370
|
+
* @type {Array<DataTypesStoreAccessWithDetails>}
|
|
16371
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16372
|
+
*/
|
|
16373
|
+
'data'?: Array<DataTypesStoreAccessWithDetails>;
|
|
16374
|
+
/**
|
|
16375
|
+
*
|
|
16376
|
+
* @type {string}
|
|
16377
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16378
|
+
*/
|
|
16379
|
+
'message'?: string;
|
|
16380
|
+
/**
|
|
16381
|
+
*
|
|
16382
|
+
* @type {number}
|
|
16383
|
+
* @memberof DataTypesStoreAccessResponse
|
|
16384
|
+
*/
|
|
16385
|
+
'status'?: number;
|
|
16386
|
+
}
|
|
16387
|
+
/**
|
|
16388
|
+
*
|
|
16389
|
+
* @export
|
|
16390
|
+
* @interface DataTypesStoreAccessWithDetails
|
|
16391
|
+
*/
|
|
16392
|
+
export interface DataTypesStoreAccessWithDetails {
|
|
16393
|
+
/**
|
|
16394
|
+
*
|
|
16395
|
+
* @type {number}
|
|
16396
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16397
|
+
*/
|
|
16398
|
+
'access_id'?: number;
|
|
16399
|
+
/**
|
|
16400
|
+
*
|
|
16401
|
+
* @type {string}
|
|
16402
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16403
|
+
*/
|
|
16404
|
+
'access_level'?: string;
|
|
16405
|
+
/**
|
|
16406
|
+
*
|
|
16407
|
+
* @type {string}
|
|
16408
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16409
|
+
*/
|
|
16410
|
+
'email'?: string;
|
|
16411
|
+
/**
|
|
16412
|
+
*
|
|
16413
|
+
* @type {string}
|
|
16414
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16415
|
+
*/
|
|
16416
|
+
'first_name'?: string;
|
|
16417
|
+
/**
|
|
16418
|
+
*
|
|
16419
|
+
* @type {string}
|
|
16420
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16421
|
+
*/
|
|
16422
|
+
'granted_at'?: string;
|
|
16423
|
+
/**
|
|
16424
|
+
*
|
|
16425
|
+
* @type {number}
|
|
16426
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16427
|
+
*/
|
|
16428
|
+
'granted_by'?: number;
|
|
16429
|
+
/**
|
|
16430
|
+
*
|
|
16431
|
+
* @type {boolean}
|
|
16432
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16433
|
+
*/
|
|
16434
|
+
'is_active'?: boolean;
|
|
16435
|
+
/**
|
|
16436
|
+
*
|
|
16437
|
+
* @type {string}
|
|
16438
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16439
|
+
*/
|
|
16440
|
+
'last_name'?: string;
|
|
16441
|
+
/**
|
|
16442
|
+
*
|
|
16443
|
+
* @type {number}
|
|
16444
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16445
|
+
*/
|
|
16446
|
+
'store_id'?: number;
|
|
16447
|
+
/**
|
|
16448
|
+
*
|
|
16449
|
+
* @type {string}
|
|
16450
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16451
|
+
*/
|
|
16452
|
+
'store_name'?: string;
|
|
16453
|
+
/**
|
|
16454
|
+
*
|
|
16455
|
+
* @type {number}
|
|
16456
|
+
* @memberof DataTypesStoreAccessWithDetails
|
|
16457
|
+
*/
|
|
16458
|
+
'user_id'?: number;
|
|
16459
|
+
}
|
|
17537
16460
|
/**
|
|
17538
16461
|
*
|
|
17539
16462
|
* @export
|
|
@@ -17818,6 +16741,12 @@ export interface DataTypesStoresListResponse {
|
|
|
17818
16741
|
* @interface DataTypesSubMenuAccess
|
|
17819
16742
|
*/
|
|
17820
16743
|
export interface DataTypesSubMenuAccess {
|
|
16744
|
+
/**
|
|
16745
|
+
* Store IDs user has access to (for store-specific menus)
|
|
16746
|
+
* @type {Array<number>}
|
|
16747
|
+
* @memberof DataTypesSubMenuAccess
|
|
16748
|
+
*/
|
|
16749
|
+
'accessibleStores'?: Array<number>;
|
|
17821
16750
|
/**
|
|
17822
16751
|
*
|
|
17823
16752
|
* @type {boolean}
|
|
@@ -18025,31 +16954,6 @@ export interface DataTypesSubscriptionResponse {
|
|
|
18025
16954
|
*/
|
|
18026
16955
|
'status'?: number;
|
|
18027
16956
|
}
|
|
18028
|
-
/**
|
|
18029
|
-
*
|
|
18030
|
-
* @export
|
|
18031
|
-
* @interface DataTypesSubscriptionsListResponse
|
|
18032
|
-
*/
|
|
18033
|
-
export interface DataTypesSubscriptionsListResponse {
|
|
18034
|
-
/**
|
|
18035
|
-
*
|
|
18036
|
-
* @type {Array<DataTypesSubscription>}
|
|
18037
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18038
|
-
*/
|
|
18039
|
-
'data'?: Array<DataTypesSubscription>;
|
|
18040
|
-
/**
|
|
18041
|
-
*
|
|
18042
|
-
* @type {string}
|
|
18043
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18044
|
-
*/
|
|
18045
|
-
'message'?: string;
|
|
18046
|
-
/**
|
|
18047
|
-
*
|
|
18048
|
-
* @type {number}
|
|
18049
|
-
* @memberof DataTypesSubscriptionsListResponse
|
|
18050
|
-
*/
|
|
18051
|
-
'status'?: number;
|
|
18052
|
-
}
|
|
18053
16957
|
/**
|
|
18054
16958
|
*
|
|
18055
16959
|
* @export
|
|
@@ -18521,6 +17425,128 @@ export interface DataTypesTaxComponent {
|
|
|
18521
17425
|
*/
|
|
18522
17426
|
'taxable_amount'?: number;
|
|
18523
17427
|
}
|
|
17428
|
+
/**
|
|
17429
|
+
*
|
|
17430
|
+
* @export
|
|
17431
|
+
* @interface DataTypesTeamInvitationWithDetails
|
|
17432
|
+
*/
|
|
17433
|
+
export interface DataTypesTeamInvitationWithDetails {
|
|
17434
|
+
/**
|
|
17435
|
+
*
|
|
17436
|
+
* @type {string}
|
|
17437
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17438
|
+
*/
|
|
17439
|
+
'accepted_at'?: string;
|
|
17440
|
+
/**
|
|
17441
|
+
*
|
|
17442
|
+
* @type {string}
|
|
17443
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17444
|
+
*/
|
|
17445
|
+
'created_at'?: string;
|
|
17446
|
+
/**
|
|
17447
|
+
*
|
|
17448
|
+
* @type {string}
|
|
17449
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17450
|
+
*/
|
|
17451
|
+
'email'?: string;
|
|
17452
|
+
/**
|
|
17453
|
+
*
|
|
17454
|
+
* @type {string}
|
|
17455
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17456
|
+
*/
|
|
17457
|
+
'expires_at'?: string;
|
|
17458
|
+
/**
|
|
17459
|
+
*
|
|
17460
|
+
* @type {number}
|
|
17461
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17462
|
+
*/
|
|
17463
|
+
'invitation_id'?: number;
|
|
17464
|
+
/**
|
|
17465
|
+
*
|
|
17466
|
+
* @type {number}
|
|
17467
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17468
|
+
*/
|
|
17469
|
+
'invited_by'?: number;
|
|
17470
|
+
/**
|
|
17471
|
+
*
|
|
17472
|
+
* @type {string}
|
|
17473
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17474
|
+
*/
|
|
17475
|
+
'inviter_email'?: string;
|
|
17476
|
+
/**
|
|
17477
|
+
*
|
|
17478
|
+
* @type {string}
|
|
17479
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17480
|
+
*/
|
|
17481
|
+
'inviter_name'?: string;
|
|
17482
|
+
/**
|
|
17483
|
+
*
|
|
17484
|
+
* @type {string}
|
|
17485
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17486
|
+
*/
|
|
17487
|
+
'member_role'?: string;
|
|
17488
|
+
/**
|
|
17489
|
+
*
|
|
17490
|
+
* @type {number}
|
|
17491
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17492
|
+
*/
|
|
17493
|
+
'org_id'?: number;
|
|
17494
|
+
/**
|
|
17495
|
+
*
|
|
17496
|
+
* @type {string}
|
|
17497
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17498
|
+
*/
|
|
17499
|
+
'org_name'?: string;
|
|
17500
|
+
/**
|
|
17501
|
+
*
|
|
17502
|
+
* @type {string}
|
|
17503
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17504
|
+
*/
|
|
17505
|
+
'rejected_at'?: string;
|
|
17506
|
+
/**
|
|
17507
|
+
*
|
|
17508
|
+
* @type {string}
|
|
17509
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17510
|
+
*/
|
|
17511
|
+
'status'?: string;
|
|
17512
|
+
/**
|
|
17513
|
+
* Store IDs to grant access to
|
|
17514
|
+
* @type {Array<number>}
|
|
17515
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17516
|
+
*/
|
|
17517
|
+
'store_access'?: Array<number>;
|
|
17518
|
+
/**
|
|
17519
|
+
* Only for pending invitations
|
|
17520
|
+
* @type {string}
|
|
17521
|
+
* @memberof DataTypesTeamInvitationWithDetails
|
|
17522
|
+
*/
|
|
17523
|
+
'token'?: string;
|
|
17524
|
+
}
|
|
17525
|
+
/**
|
|
17526
|
+
*
|
|
17527
|
+
* @export
|
|
17528
|
+
* @interface DataTypesTeamInvitationsResponse
|
|
17529
|
+
*/
|
|
17530
|
+
export interface DataTypesTeamInvitationsResponse {
|
|
17531
|
+
/**
|
|
17532
|
+
*
|
|
17533
|
+
* @type {Array<DataTypesTeamInvitationWithDetails>}
|
|
17534
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17535
|
+
*/
|
|
17536
|
+
'data'?: Array<DataTypesTeamInvitationWithDetails>;
|
|
17537
|
+
/**
|
|
17538
|
+
*
|
|
17539
|
+
* @type {string}
|
|
17540
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17541
|
+
*/
|
|
17542
|
+
'message'?: string;
|
|
17543
|
+
/**
|
|
17544
|
+
*
|
|
17545
|
+
* @type {number}
|
|
17546
|
+
* @memberof DataTypesTeamInvitationsResponse
|
|
17547
|
+
*/
|
|
17548
|
+
'status'?: number;
|
|
17549
|
+
}
|
|
18524
17550
|
/**
|
|
18525
17551
|
*
|
|
18526
17552
|
* @export
|
|
@@ -18707,6 +17733,25 @@ export interface DataTypesUpdateInvoiceRequest {
|
|
|
18707
17733
|
*/
|
|
18708
17734
|
'status'?: string;
|
|
18709
17735
|
}
|
|
17736
|
+
/**
|
|
17737
|
+
*
|
|
17738
|
+
* @export
|
|
17739
|
+
* @interface DataTypesUpdateMemberRoleRequest
|
|
17740
|
+
*/
|
|
17741
|
+
export interface DataTypesUpdateMemberRoleRequest {
|
|
17742
|
+
/**
|
|
17743
|
+
*
|
|
17744
|
+
* @type {string}
|
|
17745
|
+
* @memberof DataTypesUpdateMemberRoleRequest
|
|
17746
|
+
*/
|
|
17747
|
+
'member_role': DataTypesUpdateMemberRoleRequestMemberRoleEnum;
|
|
17748
|
+
}
|
|
17749
|
+
export declare const DataTypesUpdateMemberRoleRequestMemberRoleEnum: {
|
|
17750
|
+
readonly Owner: "owner";
|
|
17751
|
+
readonly Admin: "admin";
|
|
17752
|
+
readonly Member: "member";
|
|
17753
|
+
};
|
|
17754
|
+
export type DataTypesUpdateMemberRoleRequestMemberRoleEnum = typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum[keyof typeof DataTypesUpdateMemberRoleRequestMemberRoleEnum];
|
|
18710
17755
|
/**
|
|
18711
17756
|
*
|
|
18712
17757
|
* @export
|
|
@@ -19111,6 +18156,25 @@ export interface DataTypesUpdateSourceConfigResponseWrapper {
|
|
|
19111
18156
|
*/
|
|
19112
18157
|
'status'?: number;
|
|
19113
18158
|
}
|
|
18159
|
+
/**
|
|
18160
|
+
*
|
|
18161
|
+
* @export
|
|
18162
|
+
* @interface DataTypesUpdateStoreAccessRequest
|
|
18163
|
+
*/
|
|
18164
|
+
export interface DataTypesUpdateStoreAccessRequest {
|
|
18165
|
+
/**
|
|
18166
|
+
*
|
|
18167
|
+
* @type {string}
|
|
18168
|
+
* @memberof DataTypesUpdateStoreAccessRequest
|
|
18169
|
+
*/
|
|
18170
|
+
'access_level': DataTypesUpdateStoreAccessRequestAccessLevelEnum;
|
|
18171
|
+
}
|
|
18172
|
+
export declare const DataTypesUpdateStoreAccessRequestAccessLevelEnum: {
|
|
18173
|
+
readonly Read: "read";
|
|
18174
|
+
readonly Write: "write";
|
|
18175
|
+
readonly Admin: "admin";
|
|
18176
|
+
};
|
|
18177
|
+
export type DataTypesUpdateStoreAccessRequestAccessLevelEnum = typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum[keyof typeof DataTypesUpdateStoreAccessRequestAccessLevelEnum];
|
|
19114
18178
|
/**
|
|
19115
18179
|
*
|
|
19116
18180
|
* @export
|
|
@@ -19435,6 +18499,74 @@ export interface DataTypesUserResponse {
|
|
|
19435
18499
|
*/
|
|
19436
18500
|
'status'?: number;
|
|
19437
18501
|
}
|
|
18502
|
+
/**
|
|
18503
|
+
*
|
|
18504
|
+
* @export
|
|
18505
|
+
* @interface DataTypesUserStoreAccess
|
|
18506
|
+
*/
|
|
18507
|
+
export interface DataTypesUserStoreAccess {
|
|
18508
|
+
/**
|
|
18509
|
+
*
|
|
18510
|
+
* @type {string}
|
|
18511
|
+
* @memberof DataTypesUserStoreAccess
|
|
18512
|
+
*/
|
|
18513
|
+
'access_level'?: string;
|
|
18514
|
+
/**
|
|
18515
|
+
*
|
|
18516
|
+
* @type {number}
|
|
18517
|
+
* @memberof DataTypesUserStoreAccess
|
|
18518
|
+
*/
|
|
18519
|
+
'org_id'?: number;
|
|
18520
|
+
/**
|
|
18521
|
+
*
|
|
18522
|
+
* @type {string}
|
|
18523
|
+
* @memberof DataTypesUserStoreAccess
|
|
18524
|
+
*/
|
|
18525
|
+
'org_name'?: string;
|
|
18526
|
+
/**
|
|
18527
|
+
*
|
|
18528
|
+
* @type {number}
|
|
18529
|
+
* @memberof DataTypesUserStoreAccess
|
|
18530
|
+
*/
|
|
18531
|
+
'store_id'?: number;
|
|
18532
|
+
/**
|
|
18533
|
+
*
|
|
18534
|
+
* @type {string}
|
|
18535
|
+
* @memberof DataTypesUserStoreAccess
|
|
18536
|
+
*/
|
|
18537
|
+
'store_name'?: string;
|
|
18538
|
+
/**
|
|
18539
|
+
*
|
|
18540
|
+
* @type {string}
|
|
18541
|
+
* @memberof DataTypesUserStoreAccess
|
|
18542
|
+
*/
|
|
18543
|
+
'x_store_id'?: string;
|
|
18544
|
+
}
|
|
18545
|
+
/**
|
|
18546
|
+
*
|
|
18547
|
+
* @export
|
|
18548
|
+
* @interface DataTypesUserStoresResponse
|
|
18549
|
+
*/
|
|
18550
|
+
export interface DataTypesUserStoresResponse {
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @type {Array<DataTypesUserStoreAccess>}
|
|
18554
|
+
* @memberof DataTypesUserStoresResponse
|
|
18555
|
+
*/
|
|
18556
|
+
'data'?: Array<DataTypesUserStoreAccess>;
|
|
18557
|
+
/**
|
|
18558
|
+
*
|
|
18559
|
+
* @type {string}
|
|
18560
|
+
* @memberof DataTypesUserStoresResponse
|
|
18561
|
+
*/
|
|
18562
|
+
'message'?: string;
|
|
18563
|
+
/**
|
|
18564
|
+
*
|
|
18565
|
+
* @type {number}
|
|
18566
|
+
* @memberof DataTypesUserStoresResponse
|
|
18567
|
+
*/
|
|
18568
|
+
'status'?: number;
|
|
18569
|
+
}
|
|
19438
18570
|
/**
|
|
19439
18571
|
*
|
|
19440
18572
|
* @export
|
|
@@ -21887,41 +21019,6 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
21887
21019
|
* @throws {RequiredError}
|
|
21888
21020
|
*/
|
|
21889
21021
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21890
|
-
/**
|
|
21891
|
-
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
21892
|
-
* @summary Get Query Insights
|
|
21893
|
-
* @param {string} xStoreID Store ID
|
|
21894
|
-
* @param {string} query Search query to analyze
|
|
21895
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
21896
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
21897
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
21898
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
21899
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
21900
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
21901
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
21902
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
21903
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
21904
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
21905
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
21906
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
21907
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
21908
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
21909
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
21910
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
21911
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
21912
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
21913
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
21914
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
21915
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
21916
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
21917
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
21918
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
21919
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
21920
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
21921
|
-
* @param {*} [options] Override http request option.
|
|
21922
|
-
* @throws {RequiredError}
|
|
21923
|
-
*/
|
|
21924
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21925
21022
|
/**
|
|
21926
21023
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
21927
21024
|
* @summary Get Top Results Analytics
|
|
@@ -22327,41 +21424,6 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
22327
21424
|
* @throws {RequiredError}
|
|
22328
21425
|
*/
|
|
22329
21426
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>>;
|
|
22330
|
-
/**
|
|
22331
|
-
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
22332
|
-
* @summary Get Query Insights
|
|
22333
|
-
* @param {string} xStoreID Store ID
|
|
22334
|
-
* @param {string} query Search query to analyze
|
|
22335
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
22336
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
22337
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22338
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22339
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22340
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22341
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22342
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22343
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22344
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22345
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22346
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22347
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22348
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22349
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22350
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22351
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22352
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22353
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22354
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22355
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
22356
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22357
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22358
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22359
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22360
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22361
|
-
* @param {*} [options] Override http request option.
|
|
22362
|
-
* @throws {RequiredError}
|
|
22363
|
-
*/
|
|
22364
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
22365
21427
|
/**
|
|
22366
21428
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
22367
21429
|
* @summary Get Top Results Analytics
|
|
@@ -22767,41 +21829,6 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
22767
21829
|
* @throws {RequiredError}
|
|
22768
21830
|
*/
|
|
22769
21831
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>;
|
|
22770
|
-
/**
|
|
22771
|
-
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
22772
|
-
* @summary Get Query Insights
|
|
22773
|
-
* @param {string} xStoreID Store ID
|
|
22774
|
-
* @param {string} query Search query to analyze
|
|
22775
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
22776
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
22777
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
22778
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
22779
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
22780
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
22781
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
22782
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
22783
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
22784
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
22785
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
22786
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
22787
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
22788
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
22789
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
22790
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
22791
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
22792
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
22793
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
22794
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
22795
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
22796
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
22797
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
22798
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
22799
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
22800
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
22801
|
-
* @param {*} [options] Override http request option.
|
|
22802
|
-
* @throws {RequiredError}
|
|
22803
|
-
*/
|
|
22804
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
22805
21832
|
/**
|
|
22806
21833
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
22807
21834
|
* @summary Get Top Results Analytics
|
|
@@ -23223,42 +22250,6 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
23223
22250
|
* @memberof AnalyticsApi
|
|
23224
22251
|
*/
|
|
23225
22252
|
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any, {}>>;
|
|
23226
|
-
/**
|
|
23227
|
-
* Retrieve comprehensive analytics for a specific search query including all core metrics (Searches, Results Shown, Clicks, CTR, Avg Result Rank, Avg Click Rank, Conversions, CVR, Conversion Rate per Search, No-Result Rate, No-Click Rate, Revenue), popular results, filters, click position histogram, geo analytics, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
|
|
23228
|
-
* @summary Get Query Insights
|
|
23229
|
-
* @param {string} xStoreID Store ID
|
|
23230
|
-
* @param {string} query Search query to analyze
|
|
23231
|
-
* @param {string} [startTime] Start time in RFC3339 format
|
|
23232
|
-
* @param {string} [endTime] End time in RFC3339 format
|
|
23233
|
-
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
23234
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
23235
|
-
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
23236
|
-
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
23237
|
-
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
23238
|
-
* @param {string} [search] Search term to filter popular results, filters, and geo analytics (case-insensitive partial match)
|
|
23239
|
-
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
23240
|
-
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
23241
|
-
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
23242
|
-
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
23243
|
-
* @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
23244
|
-
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
23245
|
-
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
23246
|
-
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
23247
|
-
* @param {number} [resultsPage] Page number for popular results pagination
|
|
23248
|
-
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
23249
|
-
* @param {string} [resultsSearch] Search term to filter popular results (case-insensitive partial match on item IDs)
|
|
23250
|
-
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
23251
|
-
* @param {number} [filtersPageSize] Number of filters per page
|
|
23252
|
-
* @param {string} [filtersSearch] Search term to filter popular filters (case-insensitive partial match on filter keys/values)
|
|
23253
|
-
* @param {number} [geoPage] Page number for geo analytics pagination
|
|
23254
|
-
* @param {number} [geoPageSize] Number of geo locations per page
|
|
23255
|
-
* @param {string} [geoSearch] Search term to filter geo analytics (case-insensitive partial match on country/region/city)
|
|
23256
|
-
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
23257
|
-
* @param {*} [options] Override http request option.
|
|
23258
|
-
* @throws {RequiredError}
|
|
23259
|
-
* @memberof AnalyticsApi
|
|
23260
|
-
*/
|
|
23261
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, resultsSearch?: string, filtersPage?: number, filtersPageSize?: number, filtersSearch?: string, geoPage?: number, geoPageSize?: number, geoSearch?: string, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any, {}>>;
|
|
23262
22253
|
/**
|
|
23263
22254
|
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
23264
22255
|
* @summary Get Top Results Analytics
|
|
@@ -23670,22 +22661,6 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
23670
22661
|
readonly Desc: "desc";
|
|
23671
22662
|
};
|
|
23672
22663
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
23673
|
-
/**
|
|
23674
|
-
* @export
|
|
23675
|
-
*/
|
|
23676
|
-
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum: {
|
|
23677
|
-
readonly Any: "any";
|
|
23678
|
-
readonly All: "all";
|
|
23679
|
-
};
|
|
23680
|
-
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum];
|
|
23681
|
-
/**
|
|
23682
|
-
* @export
|
|
23683
|
-
*/
|
|
23684
|
-
export declare const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum: {
|
|
23685
|
-
readonly Any: "any";
|
|
23686
|
-
readonly All: "all";
|
|
23687
|
-
};
|
|
23688
|
-
export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
|
|
23689
22664
|
/**
|
|
23690
22665
|
* @export
|
|
23691
22666
|
*/
|
|
@@ -25158,12 +24133,12 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25158
24133
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25159
24134
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25160
24135
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25161
|
-
* @param {
|
|
25162
|
-
* @param {
|
|
24136
|
+
* @param {AdminBillingCreditLedgerGetSortByEnum} [sortBy] Field to sort by
|
|
24137
|
+
* @param {AdminBillingCreditLedgerGetSortOrderEnum} [sortOrder] Sort direction
|
|
25163
24138
|
* @param {*} [options] Override http request option.
|
|
25164
24139
|
* @throws {RequiredError}
|
|
25165
24140
|
*/
|
|
25166
|
-
adminBillingCreditLedgerGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24141
|
+
adminBillingCreditLedgerGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25167
24142
|
/**
|
|
25168
24143
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25169
24144
|
* @summary Get credit purchases
|
|
@@ -25174,12 +24149,12 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25174
24149
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25175
24150
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25176
24151
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25177
|
-
* @param {
|
|
25178
|
-
* @param {
|
|
24152
|
+
* @param {AdminBillingCreditPurchasesGetSortByEnum} [sortBy] Field to sort by
|
|
24153
|
+
* @param {AdminBillingCreditPurchasesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25179
24154
|
* @param {*} [options] Override http request option.
|
|
25180
24155
|
* @throws {RequiredError}
|
|
25181
24156
|
*/
|
|
25182
|
-
adminBillingCreditPurchasesGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24157
|
+
adminBillingCreditPurchasesGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditPurchasesGetSortByEnum, sortOrder?: AdminBillingCreditPurchasesGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25183
24158
|
/**
|
|
25184
24159
|
* Retrieves paginated list of credit transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25185
24160
|
* @summary Get credit transactions
|
|
@@ -25190,12 +24165,12 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25190
24165
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25191
24166
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25192
24167
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25193
|
-
* @param {
|
|
25194
|
-
* @param {
|
|
24168
|
+
* @param {AdminBillingCreditTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
24169
|
+
* @param {AdminBillingCreditTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
25195
24170
|
* @param {*} [options] Override http request option.
|
|
25196
24171
|
* @throws {RequiredError}
|
|
25197
24172
|
*/
|
|
25198
|
-
adminBillingCreditTransactionsGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24173
|
+
adminBillingCreditTransactionsGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditTransactionsGetSortByEnum, sortOrder?: AdminBillingCreditTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25199
24174
|
/**
|
|
25200
24175
|
* Automatically generates invoices for all completed payments without invoices
|
|
25201
24176
|
* @summary Auto-generate invoices
|
|
@@ -25230,12 +24205,12 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25230
24205
|
* @param {number} [page] Page number (default: 1)
|
|
25231
24206
|
* @param {number} [pageSize] Number of results per page (default: 20, max: 100) - alternative to limit
|
|
25232
24207
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
25233
|
-
* @param {
|
|
25234
|
-
* @param {
|
|
24208
|
+
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
24209
|
+
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25235
24210
|
* @param {*} [options] Override http request option.
|
|
25236
24211
|
* @throws {RequiredError}
|
|
25237
24212
|
*/
|
|
25238
|
-
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24213
|
+
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25239
24214
|
/**
|
|
25240
24215
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
25241
24216
|
* @summary Delete invoice
|
|
@@ -25287,8 +24262,8 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25287
24262
|
* @param {number} [page] Page number (default: 1)
|
|
25288
24263
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25289
24264
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25290
|
-
* @param {
|
|
25291
|
-
* @param {
|
|
24265
|
+
* @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
|
|
24266
|
+
* @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
|
|
25292
24267
|
* @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
|
|
25293
24268
|
* @param {string} [status] Filter by order status (created, paid, failed, refunded)
|
|
25294
24269
|
* @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
|
|
@@ -25296,7 +24271,7 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25296
24271
|
* @param {*} [options] Override http request option.
|
|
25297
24272
|
* @throws {RequiredError}
|
|
25298
24273
|
*/
|
|
25299
|
-
adminBillingOrdersGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24274
|
+
adminBillingOrdersGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingOrdersGetSortByEnum, sortOrder?: AdminBillingOrdersGetSortOrderEnum, search?: string, status?: string, gateway?: string, paymentType?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25300
24275
|
/**
|
|
25301
24276
|
* Retrieves comprehensive order details including all transactions and invoices (supports multiple invoices for subscriptions)
|
|
25302
24277
|
* @summary Get single order with transactions and invoices
|
|
@@ -25351,12 +24326,12 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
25351
24326
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25352
24327
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25353
24328
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25354
|
-
* @param {
|
|
25355
|
-
* @param {
|
|
24329
|
+
* @param {AdminBillingPaymentTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
24330
|
+
* @param {AdminBillingPaymentTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
25356
24331
|
* @param {*} [options] Override http request option.
|
|
25357
24332
|
* @throws {RequiredError}
|
|
25358
24333
|
*/
|
|
25359
|
-
adminBillingPaymentTransactionsGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24334
|
+
adminBillingPaymentTransactionsGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingPaymentTransactionsGetSortByEnum, sortOrder?: AdminBillingPaymentTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
25360
24335
|
/**
|
|
25361
24336
|
* Generates receipts for all completed payments without receipts in the organization
|
|
25362
24337
|
* @summary Auto-generate receipts for organization
|
|
@@ -25496,12 +24471,12 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25496
24471
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25497
24472
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25498
24473
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25499
|
-
* @param {
|
|
25500
|
-
* @param {
|
|
24474
|
+
* @param {AdminBillingCreditLedgerGetSortByEnum} [sortBy] Field to sort by
|
|
24475
|
+
* @param {AdminBillingCreditLedgerGetSortOrderEnum} [sortOrder] Sort direction
|
|
25501
24476
|
* @param {*} [options] Override http request option.
|
|
25502
24477
|
* @throws {RequiredError}
|
|
25503
24478
|
*/
|
|
25504
|
-
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24479
|
+
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25505
24480
|
/**
|
|
25506
24481
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25507
24482
|
* @summary Get credit purchases
|
|
@@ -25512,12 +24487,12 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25512
24487
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25513
24488
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25514
24489
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25515
|
-
* @param {
|
|
25516
|
-
* @param {
|
|
24490
|
+
* @param {AdminBillingCreditPurchasesGetSortByEnum} [sortBy] Field to sort by
|
|
24491
|
+
* @param {AdminBillingCreditPurchasesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25517
24492
|
* @param {*} [options] Override http request option.
|
|
25518
24493
|
* @throws {RequiredError}
|
|
25519
24494
|
*/
|
|
25520
|
-
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24495
|
+
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditPurchasesGetSortByEnum, sortOrder?: AdminBillingCreditPurchasesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25521
24496
|
/**
|
|
25522
24497
|
* Retrieves paginated list of credit transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25523
24498
|
* @summary Get credit transactions
|
|
@@ -25528,12 +24503,12 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25528
24503
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25529
24504
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25530
24505
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25531
|
-
* @param {
|
|
25532
|
-
* @param {
|
|
24506
|
+
* @param {AdminBillingCreditTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
24507
|
+
* @param {AdminBillingCreditTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
25533
24508
|
* @param {*} [options] Override http request option.
|
|
25534
24509
|
* @throws {RequiredError}
|
|
25535
24510
|
*/
|
|
25536
|
-
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24511
|
+
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditTransactionsGetSortByEnum, sortOrder?: AdminBillingCreditTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25537
24512
|
/**
|
|
25538
24513
|
* Automatically generates invoices for all completed payments without invoices
|
|
25539
24514
|
* @summary Auto-generate invoices
|
|
@@ -25568,12 +24543,12 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25568
24543
|
* @param {number} [page] Page number (default: 1)
|
|
25569
24544
|
* @param {number} [pageSize] Number of results per page (default: 20, max: 100) - alternative to limit
|
|
25570
24545
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
25571
|
-
* @param {
|
|
25572
|
-
* @param {
|
|
24546
|
+
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
24547
|
+
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25573
24548
|
* @param {*} [options] Override http request option.
|
|
25574
24549
|
* @throws {RequiredError}
|
|
25575
24550
|
*/
|
|
25576
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24551
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25577
24552
|
/**
|
|
25578
24553
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
25579
24554
|
* @summary Delete invoice
|
|
@@ -25625,8 +24600,8 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25625
24600
|
* @param {number} [page] Page number (default: 1)
|
|
25626
24601
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25627
24602
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25628
|
-
* @param {
|
|
25629
|
-
* @param {
|
|
24603
|
+
* @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
|
|
24604
|
+
* @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
|
|
25630
24605
|
* @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
|
|
25631
24606
|
* @param {string} [status] Filter by order status (created, paid, failed, refunded)
|
|
25632
24607
|
* @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
|
|
@@ -25634,7 +24609,7 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25634
24609
|
* @param {*} [options] Override http request option.
|
|
25635
24610
|
* @throws {RequiredError}
|
|
25636
24611
|
*/
|
|
25637
|
-
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24612
|
+
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingOrdersGetSortByEnum, sortOrder?: AdminBillingOrdersGetSortOrderEnum, search?: string, status?: string, gateway?: string, paymentType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25638
24613
|
/**
|
|
25639
24614
|
* Retrieves comprehensive order details including all transactions and invoices (supports multiple invoices for subscriptions)
|
|
25640
24615
|
* @summary Get single order with transactions and invoices
|
|
@@ -25689,12 +24664,12 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
25689
24664
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25690
24665
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25691
24666
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25692
|
-
* @param {
|
|
25693
|
-
* @param {
|
|
24667
|
+
* @param {AdminBillingPaymentTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
24668
|
+
* @param {AdminBillingPaymentTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
25694
24669
|
* @param {*} [options] Override http request option.
|
|
25695
24670
|
* @throws {RequiredError}
|
|
25696
24671
|
*/
|
|
25697
|
-
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24672
|
+
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingPaymentTransactionsGetSortByEnum, sortOrder?: AdminBillingPaymentTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
25698
24673
|
/**
|
|
25699
24674
|
* Generates receipts for all completed payments without receipts in the organization
|
|
25700
24675
|
* @summary Auto-generate receipts for organization
|
|
@@ -25834,12 +24809,12 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25834
24809
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25835
24810
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25836
24811
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25837
|
-
* @param {
|
|
25838
|
-
* @param {
|
|
24812
|
+
* @param {AdminBillingCreditLedgerGetSortByEnum} [sortBy] Field to sort by
|
|
24813
|
+
* @param {AdminBillingCreditLedgerGetSortOrderEnum} [sortOrder] Sort direction
|
|
25839
24814
|
* @param {*} [options] Override http request option.
|
|
25840
24815
|
* @throws {RequiredError}
|
|
25841
24816
|
*/
|
|
25842
|
-
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24817
|
+
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
25843
24818
|
/**
|
|
25844
24819
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25845
24820
|
* @summary Get credit purchases
|
|
@@ -25850,12 +24825,12 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25850
24825
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25851
24826
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25852
24827
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25853
|
-
* @param {
|
|
25854
|
-
* @param {
|
|
24828
|
+
* @param {AdminBillingCreditPurchasesGetSortByEnum} [sortBy] Field to sort by
|
|
24829
|
+
* @param {AdminBillingCreditPurchasesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25855
24830
|
* @param {*} [options] Override http request option.
|
|
25856
24831
|
* @throws {RequiredError}
|
|
25857
24832
|
*/
|
|
25858
|
-
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24833
|
+
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditPurchasesGetSortByEnum, sortOrder?: AdminBillingCreditPurchasesGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
25859
24834
|
/**
|
|
25860
24835
|
* Retrieves paginated list of credit transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
25861
24836
|
* @summary Get credit transactions
|
|
@@ -25866,12 +24841,12 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25866
24841
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25867
24842
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25868
24843
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
25869
|
-
* @param {
|
|
25870
|
-
* @param {
|
|
24844
|
+
* @param {AdminBillingCreditTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
24845
|
+
* @param {AdminBillingCreditTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
25871
24846
|
* @param {*} [options] Override http request option.
|
|
25872
24847
|
* @throws {RequiredError}
|
|
25873
24848
|
*/
|
|
25874
|
-
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
24849
|
+
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditTransactionsGetSortByEnum, sortOrder?: AdminBillingCreditTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
25875
24850
|
/**
|
|
25876
24851
|
* Automatically generates invoices for all completed payments without invoices
|
|
25877
24852
|
* @summary Auto-generate invoices
|
|
@@ -25906,12 +24881,12 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25906
24881
|
* @param {number} [page] Page number (default: 1)
|
|
25907
24882
|
* @param {number} [pageSize] Number of results per page (default: 20, max: 100) - alternative to limit
|
|
25908
24883
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
25909
|
-
* @param {
|
|
25910
|
-
* @param {
|
|
24884
|
+
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
24885
|
+
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
25911
24886
|
* @param {*} [options] Override http request option.
|
|
25912
24887
|
* @throws {RequiredError}
|
|
25913
24888
|
*/
|
|
25914
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24889
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
25915
24890
|
/**
|
|
25916
24891
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
25917
24892
|
* @summary Delete invoice
|
|
@@ -25963,8 +24938,8 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25963
24938
|
* @param {number} [page] Page number (default: 1)
|
|
25964
24939
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
25965
24940
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
25966
|
-
* @param {
|
|
25967
|
-
* @param {
|
|
24941
|
+
* @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
|
|
24942
|
+
* @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
|
|
25968
24943
|
* @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
|
|
25969
24944
|
* @param {string} [status] Filter by order status (created, paid, failed, refunded)
|
|
25970
24945
|
* @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
|
|
@@ -25972,7 +24947,7 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
25972
24947
|
* @param {*} [options] Override http request option.
|
|
25973
24948
|
* @throws {RequiredError}
|
|
25974
24949
|
*/
|
|
25975
|
-
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
24950
|
+
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingOrdersGetSortByEnum, sortOrder?: AdminBillingOrdersGetSortOrderEnum, search?: string, status?: string, gateway?: string, paymentType?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
25976
24951
|
/**
|
|
25977
24952
|
* Retrieves comprehensive order details including all transactions and invoices (supports multiple invoices for subscriptions)
|
|
25978
24953
|
* @summary Get single order with transactions and invoices
|
|
@@ -26027,12 +25002,12 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
26027
25002
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26028
25003
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26029
25004
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
26030
|
-
* @param {
|
|
26031
|
-
* @param {
|
|
25005
|
+
* @param {AdminBillingPaymentTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
25006
|
+
* @param {AdminBillingPaymentTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
26032
25007
|
* @param {*} [options] Override http request option.
|
|
26033
25008
|
* @throws {RequiredError}
|
|
26034
25009
|
*/
|
|
26035
|
-
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
25010
|
+
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingPaymentTransactionsGetSortByEnum, sortOrder?: AdminBillingPaymentTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
26036
25011
|
/**
|
|
26037
25012
|
* Generates receipts for all completed payments without receipts in the organization
|
|
26038
25013
|
* @summary Auto-generate receipts for organization
|
|
@@ -26180,13 +25155,13 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26180
25155
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26181
25156
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26182
25157
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
26183
|
-
* @param {
|
|
26184
|
-
* @param {
|
|
25158
|
+
* @param {AdminBillingCreditLedgerGetSortByEnum} [sortBy] Field to sort by
|
|
25159
|
+
* @param {AdminBillingCreditLedgerGetSortOrderEnum} [sortOrder] Sort direction
|
|
26185
25160
|
* @param {*} [options] Override http request option.
|
|
26186
25161
|
* @throws {RequiredError}
|
|
26187
25162
|
* @memberof BillingDashboardApi
|
|
26188
25163
|
*/
|
|
26189
|
-
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
25164
|
+
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26190
25165
|
/**
|
|
26191
25166
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
26192
25167
|
* @summary Get credit purchases
|
|
@@ -26197,13 +25172,13 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26197
25172
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26198
25173
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26199
25174
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
26200
|
-
* @param {
|
|
26201
|
-
* @param {
|
|
25175
|
+
* @param {AdminBillingCreditPurchasesGetSortByEnum} [sortBy] Field to sort by
|
|
25176
|
+
* @param {AdminBillingCreditPurchasesGetSortOrderEnum} [sortOrder] Sort direction
|
|
26202
25177
|
* @param {*} [options] Override http request option.
|
|
26203
25178
|
* @throws {RequiredError}
|
|
26204
25179
|
* @memberof BillingDashboardApi
|
|
26205
25180
|
*/
|
|
26206
|
-
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
25181
|
+
adminBillingCreditPurchasesGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditPurchasesGetSortByEnum, sortOrder?: AdminBillingCreditPurchasesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26207
25182
|
/**
|
|
26208
25183
|
* Retrieves paginated list of credit transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
26209
25184
|
* @summary Get credit transactions
|
|
@@ -26214,13 +25189,13 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26214
25189
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26215
25190
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26216
25191
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
26217
|
-
* @param {
|
|
26218
|
-
* @param {
|
|
25192
|
+
* @param {AdminBillingCreditTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
25193
|
+
* @param {AdminBillingCreditTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
26219
25194
|
* @param {*} [options] Override http request option.
|
|
26220
25195
|
* @throws {RequiredError}
|
|
26221
25196
|
* @memberof BillingDashboardApi
|
|
26222
25197
|
*/
|
|
26223
|
-
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
25198
|
+
adminBillingCreditTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditTransactionsGetSortByEnum, sortOrder?: AdminBillingCreditTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26224
25199
|
/**
|
|
26225
25200
|
* Automatically generates invoices for all completed payments without invoices
|
|
26226
25201
|
* @summary Auto-generate invoices
|
|
@@ -26258,13 +25233,13 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26258
25233
|
* @param {number} [page] Page number (default: 1)
|
|
26259
25234
|
* @param {number} [pageSize] Number of results per page (default: 20, max: 100) - alternative to limit
|
|
26260
25235
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
26261
|
-
* @param {
|
|
26262
|
-
* @param {
|
|
25236
|
+
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
25237
|
+
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
26263
25238
|
* @param {*} [options] Override http request option.
|
|
26264
25239
|
* @throws {RequiredError}
|
|
26265
25240
|
* @memberof BillingDashboardApi
|
|
26266
25241
|
*/
|
|
26267
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
25242
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26268
25243
|
/**
|
|
26269
25244
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
26270
25245
|
* @summary Delete invoice
|
|
@@ -26321,8 +25296,8 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26321
25296
|
* @param {number} [page] Page number (default: 1)
|
|
26322
25297
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26323
25298
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26324
|
-
* @param {
|
|
26325
|
-
* @param {
|
|
25299
|
+
* @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
|
|
25300
|
+
* @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
|
|
26326
25301
|
* @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
|
|
26327
25302
|
* @param {string} [status] Filter by order status (created, paid, failed, refunded)
|
|
26328
25303
|
* @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
|
|
@@ -26331,7 +25306,7 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26331
25306
|
* @throws {RequiredError}
|
|
26332
25307
|
* @memberof BillingDashboardApi
|
|
26333
25308
|
*/
|
|
26334
|
-
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?:
|
|
25309
|
+
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingOrdersGetSortByEnum, sortOrder?: AdminBillingOrdersGetSortOrderEnum, search?: string, status?: string, gateway?: string, paymentType?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26335
25310
|
/**
|
|
26336
25311
|
* Retrieves comprehensive order details including all transactions and invoices (supports multiple invoices for subscriptions)
|
|
26337
25312
|
* @summary Get single order with transactions and invoices
|
|
@@ -26391,13 +25366,13 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26391
25366
|
* @param {number} [pageSize] Page size (default: 50, max: 100)
|
|
26392
25367
|
* @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
|
|
26393
25368
|
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
26394
|
-
* @param {
|
|
26395
|
-
* @param {
|
|
25369
|
+
* @param {AdminBillingPaymentTransactionsGetSortByEnum} [sortBy] Field to sort by
|
|
25370
|
+
* @param {AdminBillingPaymentTransactionsGetSortOrderEnum} [sortOrder] Sort direction
|
|
26396
25371
|
* @param {*} [options] Override http request option.
|
|
26397
25372
|
* @throws {RequiredError}
|
|
26398
25373
|
* @memberof BillingDashboardApi
|
|
26399
25374
|
*/
|
|
26400
|
-
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?:
|
|
25375
|
+
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingPaymentTransactionsGetSortByEnum, sortOrder?: AdminBillingPaymentTransactionsGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26401
25376
|
/**
|
|
26402
25377
|
* Generates receipts for all completed payments without receipts in the organization
|
|
26403
25378
|
* @summary Auto-generate receipts for organization
|
|
@@ -26472,6 +25447,136 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
26472
25447
|
*/
|
|
26473
25448
|
adminBillingUsageDetailsGet(xstoreid?: string, startDate?: string, endDate?: string, granularity?: AdminBillingUsageDetailsGetGranularityEnum, chartPage?: number, chartPageSize?: number, endpointPage?: number, endpointPageSize?: number, consumptionPage?: number, consumptionPageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
26474
25449
|
}
|
|
25450
|
+
/**
|
|
25451
|
+
* @export
|
|
25452
|
+
*/
|
|
25453
|
+
export declare const AdminBillingCreditLedgerGetSortByEnum: {
|
|
25454
|
+
readonly Id: "id";
|
|
25455
|
+
readonly Credits: "credits";
|
|
25456
|
+
readonly TransactionDate: "transaction_date";
|
|
25457
|
+
readonly TransactionType: "transaction_type";
|
|
25458
|
+
};
|
|
25459
|
+
export type AdminBillingCreditLedgerGetSortByEnum = typeof AdminBillingCreditLedgerGetSortByEnum[keyof typeof AdminBillingCreditLedgerGetSortByEnum];
|
|
25460
|
+
/**
|
|
25461
|
+
* @export
|
|
25462
|
+
*/
|
|
25463
|
+
export declare const AdminBillingCreditLedgerGetSortOrderEnum: {
|
|
25464
|
+
readonly Asc: "asc";
|
|
25465
|
+
readonly Desc: "desc";
|
|
25466
|
+
readonly Asc2: "ASC";
|
|
25467
|
+
readonly Desc2: "DESC";
|
|
25468
|
+
};
|
|
25469
|
+
export type AdminBillingCreditLedgerGetSortOrderEnum = typeof AdminBillingCreditLedgerGetSortOrderEnum[keyof typeof AdminBillingCreditLedgerGetSortOrderEnum];
|
|
25470
|
+
/**
|
|
25471
|
+
* @export
|
|
25472
|
+
*/
|
|
25473
|
+
export declare const AdminBillingCreditPurchasesGetSortByEnum: {
|
|
25474
|
+
readonly Id: "id";
|
|
25475
|
+
readonly Amount: "amount";
|
|
25476
|
+
readonly CreatedAt: "created_at";
|
|
25477
|
+
readonly CreditsPurchased: "credits_purchased";
|
|
25478
|
+
};
|
|
25479
|
+
export type AdminBillingCreditPurchasesGetSortByEnum = typeof AdminBillingCreditPurchasesGetSortByEnum[keyof typeof AdminBillingCreditPurchasesGetSortByEnum];
|
|
25480
|
+
/**
|
|
25481
|
+
* @export
|
|
25482
|
+
*/
|
|
25483
|
+
export declare const AdminBillingCreditPurchasesGetSortOrderEnum: {
|
|
25484
|
+
readonly Asc: "asc";
|
|
25485
|
+
readonly Desc: "desc";
|
|
25486
|
+
readonly Asc2: "ASC";
|
|
25487
|
+
readonly Desc2: "DESC";
|
|
25488
|
+
};
|
|
25489
|
+
export type AdminBillingCreditPurchasesGetSortOrderEnum = typeof AdminBillingCreditPurchasesGetSortOrderEnum[keyof typeof AdminBillingCreditPurchasesGetSortOrderEnum];
|
|
25490
|
+
/**
|
|
25491
|
+
* @export
|
|
25492
|
+
*/
|
|
25493
|
+
export declare const AdminBillingCreditTransactionsGetSortByEnum: {
|
|
25494
|
+
readonly Id: "id";
|
|
25495
|
+
readonly CreditsUsed: "credits_used";
|
|
25496
|
+
readonly TransactionDate: "transaction_date";
|
|
25497
|
+
readonly TransactionType: "transaction_type";
|
|
25498
|
+
};
|
|
25499
|
+
export type AdminBillingCreditTransactionsGetSortByEnum = typeof AdminBillingCreditTransactionsGetSortByEnum[keyof typeof AdminBillingCreditTransactionsGetSortByEnum];
|
|
25500
|
+
/**
|
|
25501
|
+
* @export
|
|
25502
|
+
*/
|
|
25503
|
+
export declare const AdminBillingCreditTransactionsGetSortOrderEnum: {
|
|
25504
|
+
readonly Asc: "asc";
|
|
25505
|
+
readonly Desc: "desc";
|
|
25506
|
+
readonly Asc2: "ASC";
|
|
25507
|
+
readonly Desc2: "DESC";
|
|
25508
|
+
};
|
|
25509
|
+
export type AdminBillingCreditTransactionsGetSortOrderEnum = typeof AdminBillingCreditTransactionsGetSortOrderEnum[keyof typeof AdminBillingCreditTransactionsGetSortOrderEnum];
|
|
25510
|
+
/**
|
|
25511
|
+
* @export
|
|
25512
|
+
*/
|
|
25513
|
+
export declare const AdminBillingInvoicesGetSortByEnum: {
|
|
25514
|
+
readonly Id: "id";
|
|
25515
|
+
readonly InvoiceId: "invoice_id";
|
|
25516
|
+
readonly InvoiceNumber: "invoice_number";
|
|
25517
|
+
readonly Amount: "amount";
|
|
25518
|
+
readonly TotalAmount: "total_amount";
|
|
25519
|
+
readonly CreatedAt: "created_at";
|
|
25520
|
+
readonly IssueDate: "issue_date";
|
|
25521
|
+
readonly DueDate: "due_date";
|
|
25522
|
+
readonly PaidDate: "paid_date";
|
|
25523
|
+
readonly Status: "status";
|
|
25524
|
+
};
|
|
25525
|
+
export type AdminBillingInvoicesGetSortByEnum = typeof AdminBillingInvoicesGetSortByEnum[keyof typeof AdminBillingInvoicesGetSortByEnum];
|
|
25526
|
+
/**
|
|
25527
|
+
* @export
|
|
25528
|
+
*/
|
|
25529
|
+
export declare const AdminBillingInvoicesGetSortOrderEnum: {
|
|
25530
|
+
readonly Asc: "asc";
|
|
25531
|
+
readonly Desc: "desc";
|
|
25532
|
+
readonly Asc2: "ASC";
|
|
25533
|
+
readonly Desc2: "DESC";
|
|
25534
|
+
};
|
|
25535
|
+
export type AdminBillingInvoicesGetSortOrderEnum = typeof AdminBillingInvoicesGetSortOrderEnum[keyof typeof AdminBillingInvoicesGetSortOrderEnum];
|
|
25536
|
+
/**
|
|
25537
|
+
* @export
|
|
25538
|
+
*/
|
|
25539
|
+
export declare const AdminBillingOrdersGetSortByEnum: {
|
|
25540
|
+
readonly Id: "id";
|
|
25541
|
+
readonly Amount: "amount";
|
|
25542
|
+
readonly CreatedAt: "created_at";
|
|
25543
|
+
readonly UpdatedAt: "updated_at";
|
|
25544
|
+
readonly Status: "status";
|
|
25545
|
+
};
|
|
25546
|
+
export type AdminBillingOrdersGetSortByEnum = typeof AdminBillingOrdersGetSortByEnum[keyof typeof AdminBillingOrdersGetSortByEnum];
|
|
25547
|
+
/**
|
|
25548
|
+
* @export
|
|
25549
|
+
*/
|
|
25550
|
+
export declare const AdminBillingOrdersGetSortOrderEnum: {
|
|
25551
|
+
readonly Asc: "asc";
|
|
25552
|
+
readonly Desc: "desc";
|
|
25553
|
+
readonly Asc2: "ASC";
|
|
25554
|
+
readonly Desc2: "DESC";
|
|
25555
|
+
};
|
|
25556
|
+
export type AdminBillingOrdersGetSortOrderEnum = typeof AdminBillingOrdersGetSortOrderEnum[keyof typeof AdminBillingOrdersGetSortOrderEnum];
|
|
25557
|
+
/**
|
|
25558
|
+
* @export
|
|
25559
|
+
*/
|
|
25560
|
+
export declare const AdminBillingPaymentTransactionsGetSortByEnum: {
|
|
25561
|
+
readonly PaymentId: "payment_id";
|
|
25562
|
+
readonly Amount: "amount";
|
|
25563
|
+
readonly PaymentDate: "payment_date";
|
|
25564
|
+
readonly CreatedAt: "created_at";
|
|
25565
|
+
readonly PaymentStatus: "payment_status";
|
|
25566
|
+
readonly Gateway: "gateway";
|
|
25567
|
+
readonly RefundAmount: "refund_amount";
|
|
25568
|
+
};
|
|
25569
|
+
export type AdminBillingPaymentTransactionsGetSortByEnum = typeof AdminBillingPaymentTransactionsGetSortByEnum[keyof typeof AdminBillingPaymentTransactionsGetSortByEnum];
|
|
25570
|
+
/**
|
|
25571
|
+
* @export
|
|
25572
|
+
*/
|
|
25573
|
+
export declare const AdminBillingPaymentTransactionsGetSortOrderEnum: {
|
|
25574
|
+
readonly Asc: "asc";
|
|
25575
|
+
readonly Desc: "desc";
|
|
25576
|
+
readonly Asc2: "ASC";
|
|
25577
|
+
readonly Desc2: "DESC";
|
|
25578
|
+
};
|
|
25579
|
+
export type AdminBillingPaymentTransactionsGetSortOrderEnum = typeof AdminBillingPaymentTransactionsGetSortOrderEnum[keyof typeof AdminBillingPaymentTransactionsGetSortOrderEnum];
|
|
26475
25580
|
/**
|
|
26476
25581
|
* @export
|
|
26477
25582
|
*/
|
|
@@ -28869,13 +27974,6 @@ export declare const LimitsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
28869
27974
|
* @throws {RequiredError}
|
|
28870
27975
|
*/
|
|
28871
27976
|
miscLimitsChangeStatusLimitIDIsActivePut: (limitID: number, isActive: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28872
|
-
/**
|
|
28873
|
-
* Fetches list of all limits
|
|
28874
|
-
* @summary Fetches list of all limits
|
|
28875
|
-
* @param {*} [options] Override http request option.
|
|
28876
|
-
* @throws {RequiredError}
|
|
28877
|
-
*/
|
|
28878
|
-
miscLimitsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28879
27977
|
/**
|
|
28880
27978
|
* Fetches limit by id
|
|
28881
27979
|
* @summary Fetches limit by id
|
|
@@ -28916,13 +28014,6 @@ export declare const LimitsApiFp: (configuration?: Configuration) => {
|
|
|
28916
28014
|
* @throws {RequiredError}
|
|
28917
28015
|
*/
|
|
28918
28016
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
28919
|
-
/**
|
|
28920
|
-
* Fetches list of all limits
|
|
28921
|
-
* @summary Fetches list of all limits
|
|
28922
|
-
* @param {*} [options] Override http request option.
|
|
28923
|
-
* @throws {RequiredError}
|
|
28924
|
-
*/
|
|
28925
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesLimitsListResponse>>;
|
|
28926
28017
|
/**
|
|
28927
28018
|
* Fetches limit by id
|
|
28928
28019
|
* @summary Fetches limit by id
|
|
@@ -28963,13 +28054,6 @@ export declare const LimitsApiFactory: (configuration?: Configuration, basePath?
|
|
|
28963
28054
|
* @throws {RequiredError}
|
|
28964
28055
|
*/
|
|
28965
28056
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
28966
|
-
/**
|
|
28967
|
-
* Fetches list of all limits
|
|
28968
|
-
* @summary Fetches list of all limits
|
|
28969
|
-
* @param {*} [options] Override http request option.
|
|
28970
|
-
* @throws {RequiredError}
|
|
28971
|
-
*/
|
|
28972
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesLimitsListResponse>;
|
|
28973
28057
|
/**
|
|
28974
28058
|
* Fetches limit by id
|
|
28975
28059
|
* @summary Fetches limit by id
|
|
@@ -29013,14 +28097,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29013
28097
|
* @memberof LimitsApi
|
|
29014
28098
|
*/
|
|
29015
28099
|
miscLimitsChangeStatusLimitIDIsActivePut(limitID: number, isActive: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
29016
|
-
/**
|
|
29017
|
-
* Fetches list of all limits
|
|
29018
|
-
* @summary Fetches list of all limits
|
|
29019
|
-
* @param {*} [options] Override http request option.
|
|
29020
|
-
* @throws {RequiredError}
|
|
29021
|
-
* @memberof LimitsApi
|
|
29022
|
-
*/
|
|
29023
|
-
miscLimitsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesLimitsListResponse, any, {}>>;
|
|
29024
28100
|
/**
|
|
29025
28101
|
* Fetches limit by id
|
|
29026
28102
|
* @summary Fetches limit by id
|
|
@@ -29055,13 +28131,6 @@ export declare class LimitsApi extends BaseAPI {
|
|
|
29055
28131
|
* @export
|
|
29056
28132
|
*/
|
|
29057
28133
|
export declare const MenusApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29058
|
-
/**
|
|
29059
|
-
* Fetches list of all menus
|
|
29060
|
-
* @summary Fetches list of all menus
|
|
29061
|
-
* @param {*} [options] Override http request option.
|
|
29062
|
-
* @throws {RequiredError}
|
|
29063
|
-
*/
|
|
29064
|
-
miscMenusGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29065
28134
|
/**
|
|
29066
28135
|
* Deletes a menu from the system by ID.
|
|
29067
28136
|
* @summary Delete a menu
|
|
@@ -29180,13 +28249,6 @@ export declare const MenusApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
29180
28249
|
* @export
|
|
29181
28250
|
*/
|
|
29182
28251
|
export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
29183
|
-
/**
|
|
29184
|
-
* Fetches list of all menus
|
|
29185
|
-
* @summary Fetches list of all menus
|
|
29186
|
-
* @param {*} [options] Override http request option.
|
|
29187
|
-
* @throws {RequiredError}
|
|
29188
|
-
*/
|
|
29189
|
-
miscMenusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesMenusListResponse>>;
|
|
29190
28252
|
/**
|
|
29191
28253
|
* Deletes a menu from the system by ID.
|
|
29192
28254
|
* @summary Delete a menu
|
|
@@ -29305,13 +28367,6 @@ export declare const MenusApiFp: (configuration?: Configuration) => {
|
|
|
29305
28367
|
* @export
|
|
29306
28368
|
*/
|
|
29307
28369
|
export declare const MenusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29308
|
-
/**
|
|
29309
|
-
* Fetches list of all menus
|
|
29310
|
-
* @summary Fetches list of all menus
|
|
29311
|
-
* @param {*} [options] Override http request option.
|
|
29312
|
-
* @throws {RequiredError}
|
|
29313
|
-
*/
|
|
29314
|
-
miscMenusGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesMenusListResponse>;
|
|
29315
28370
|
/**
|
|
29316
28371
|
* Deletes a menu from the system by ID.
|
|
29317
28372
|
* @summary Delete a menu
|
|
@@ -29432,14 +28487,6 @@ export declare const MenusApiFactory: (configuration?: Configuration, basePath?:
|
|
|
29432
28487
|
* @extends {BaseAPI}
|
|
29433
28488
|
*/
|
|
29434
28489
|
export declare class MenusApi extends BaseAPI {
|
|
29435
|
-
/**
|
|
29436
|
-
* Fetches list of all menus
|
|
29437
|
-
* @summary Fetches list of all menus
|
|
29438
|
-
* @param {*} [options] Override http request option.
|
|
29439
|
-
* @throws {RequiredError}
|
|
29440
|
-
* @memberof MenusApi
|
|
29441
|
-
*/
|
|
29442
|
-
miscMenusGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesMenusListResponse, any, {}>>;
|
|
29443
28490
|
/**
|
|
29444
28491
|
* Deletes a menu from the system by ID.
|
|
29445
28492
|
* @summary Delete a menu
|
|
@@ -29990,13 +29037,6 @@ export declare class MongoDbApi extends BaseAPI {
|
|
|
29990
29037
|
* @export
|
|
29991
29038
|
*/
|
|
29992
29039
|
export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29993
|
-
/**
|
|
29994
|
-
* Fetches list of all NewsLetterSubscription
|
|
29995
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
29996
|
-
* @param {*} [options] Override http request option.
|
|
29997
|
-
* @throws {RequiredError}
|
|
29998
|
-
*/
|
|
29999
|
-
miscNewsLettersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30000
29040
|
/**
|
|
30001
29041
|
* Fetches NewsLetterSubscription by id
|
|
30002
29042
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30037,13 +29077,6 @@ export declare const NewsLettersApiAxiosParamCreator: (configuration?: Configura
|
|
|
30037
29077
|
* @export
|
|
30038
29078
|
*/
|
|
30039
29079
|
export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
30040
|
-
/**
|
|
30041
|
-
* Fetches list of all NewsLetterSubscription
|
|
30042
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30043
|
-
* @param {*} [options] Override http request option.
|
|
30044
|
-
* @throws {RequiredError}
|
|
30045
|
-
*/
|
|
30046
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesNewsLetterRequestsListResponse>>;
|
|
30047
29080
|
/**
|
|
30048
29081
|
* Fetches NewsLetterSubscription by id
|
|
30049
29082
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30084,13 +29117,6 @@ export declare const NewsLettersApiFp: (configuration?: Configuration) => {
|
|
|
30084
29117
|
* @export
|
|
30085
29118
|
*/
|
|
30086
29119
|
export declare const NewsLettersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30087
|
-
/**
|
|
30088
|
-
* Fetches list of all NewsLetterSubscription
|
|
30089
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30090
|
-
* @param {*} [options] Override http request option.
|
|
30091
|
-
* @throws {RequiredError}
|
|
30092
|
-
*/
|
|
30093
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesNewsLetterRequestsListResponse>;
|
|
30094
29120
|
/**
|
|
30095
29121
|
* Fetches NewsLetterSubscription by id
|
|
30096
29122
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30133,14 +29159,6 @@ export declare const NewsLettersApiFactory: (configuration?: Configuration, base
|
|
|
30133
29159
|
* @extends {BaseAPI}
|
|
30134
29160
|
*/
|
|
30135
29161
|
export declare class NewsLettersApi extends BaseAPI {
|
|
30136
|
-
/**
|
|
30137
|
-
* Fetches list of all NewsLetterSubscription
|
|
30138
|
-
* @summary Fetches list of all NewsLetterSubscription
|
|
30139
|
-
* @param {*} [options] Override http request option.
|
|
30140
|
-
* @throws {RequiredError}
|
|
30141
|
-
* @memberof NewsLettersApi
|
|
30142
|
-
*/
|
|
30143
|
-
miscNewsLettersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesNewsLetterRequestsListResponse, any, {}>>;
|
|
30144
29162
|
/**
|
|
30145
29163
|
* Fetches NewsLetterSubscription by id
|
|
30146
29164
|
* @summary Fetches NewsLetterSubscription by id
|
|
@@ -30492,13 +29510,6 @@ export declare class OnboardingApi extends BaseAPI {
|
|
|
30492
29510
|
* @export
|
|
30493
29511
|
*/
|
|
30494
29512
|
export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30495
|
-
/**
|
|
30496
|
-
* Fetches list of all Organizations
|
|
30497
|
-
* @summary Fetches list of all Organizations
|
|
30498
|
-
* @param {*} [options] Override http request option.
|
|
30499
|
-
* @throws {RequiredError}
|
|
30500
|
-
*/
|
|
30501
|
-
adminOrganizationsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30502
29513
|
/**
|
|
30503
29514
|
* Updates Orgnization information by ID.
|
|
30504
29515
|
* @summary Update an existing Orgnization
|
|
@@ -30539,13 +29550,6 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
30539
29550
|
* @export
|
|
30540
29551
|
*/
|
|
30541
29552
|
export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
30542
|
-
/**
|
|
30543
|
-
* Fetches list of all Organizations
|
|
30544
|
-
* @summary Fetches list of all Organizations
|
|
30545
|
-
* @param {*} [options] Override http request option.
|
|
30546
|
-
* @throws {RequiredError}
|
|
30547
|
-
*/
|
|
30548
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrganizationsListResponse>>;
|
|
30549
29553
|
/**
|
|
30550
29554
|
* Updates Orgnization information by ID.
|
|
30551
29555
|
* @summary Update an existing Orgnization
|
|
@@ -30586,13 +29590,6 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
30586
29590
|
* @export
|
|
30587
29591
|
*/
|
|
30588
29592
|
export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30589
|
-
/**
|
|
30590
|
-
* Fetches list of all Organizations
|
|
30591
|
-
* @summary Fetches list of all Organizations
|
|
30592
|
-
* @param {*} [options] Override http request option.
|
|
30593
|
-
* @throws {RequiredError}
|
|
30594
|
-
*/
|
|
30595
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrganizationsListResponse>;
|
|
30596
29593
|
/**
|
|
30597
29594
|
* Updates Orgnization information by ID.
|
|
30598
29595
|
* @summary Update an existing Orgnization
|
|
@@ -30635,14 +29632,6 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
30635
29632
|
* @extends {BaseAPI}
|
|
30636
29633
|
*/
|
|
30637
29634
|
export declare class OrganizationsApi extends BaseAPI {
|
|
30638
|
-
/**
|
|
30639
|
-
* Fetches list of all Organizations
|
|
30640
|
-
* @summary Fetches list of all Organizations
|
|
30641
|
-
* @param {*} [options] Override http request option.
|
|
30642
|
-
* @throws {RequiredError}
|
|
30643
|
-
* @memberof OrganizationsApi
|
|
30644
|
-
*/
|
|
30645
|
-
adminOrganizationsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrganizationsListResponse, any, {}>>;
|
|
30646
29635
|
/**
|
|
30647
29636
|
* Updates Orgnization information by ID.
|
|
30648
29637
|
* @summary Update an existing Orgnization
|
|
@@ -31389,13 +30378,6 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
31389
30378
|
* @export
|
|
31390
30379
|
*/
|
|
31391
30380
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31392
|
-
/**
|
|
31393
|
-
* Fetches list of all payments
|
|
31394
|
-
* @summary Fetches list of all payments
|
|
31395
|
-
* @param {*} [options] Override http request option.
|
|
31396
|
-
* @throws {RequiredError}
|
|
31397
|
-
*/
|
|
31398
|
-
adminPaymentsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31399
30381
|
/**
|
|
31400
30382
|
* Deletes a payment from the system by ID.
|
|
31401
30383
|
* @summary Delete a payment
|
|
@@ -31435,13 +30417,6 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31435
30417
|
* @export
|
|
31436
30418
|
*/
|
|
31437
30419
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
31438
|
-
/**
|
|
31439
|
-
* Fetches list of all payments
|
|
31440
|
-
* @summary Fetches list of all payments
|
|
31441
|
-
* @param {*} [options] Override http request option.
|
|
31442
|
-
* @throws {RequiredError}
|
|
31443
|
-
*/
|
|
31444
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentsListResponse>>;
|
|
31445
30420
|
/**
|
|
31446
30421
|
* Deletes a payment from the system by ID.
|
|
31447
30422
|
* @summary Delete a payment
|
|
@@ -31481,13 +30456,6 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
31481
30456
|
* @export
|
|
31482
30457
|
*/
|
|
31483
30458
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31484
|
-
/**
|
|
31485
|
-
* Fetches list of all payments
|
|
31486
|
-
* @summary Fetches list of all payments
|
|
31487
|
-
* @param {*} [options] Override http request option.
|
|
31488
|
-
* @throws {RequiredError}
|
|
31489
|
-
*/
|
|
31490
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentsListResponse>;
|
|
31491
30459
|
/**
|
|
31492
30460
|
* Deletes a payment from the system by ID.
|
|
31493
30461
|
* @summary Delete a payment
|
|
@@ -31529,14 +30497,6 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
31529
30497
|
* @extends {BaseAPI}
|
|
31530
30498
|
*/
|
|
31531
30499
|
export declare class PaymentsApi extends BaseAPI {
|
|
31532
|
-
/**
|
|
31533
|
-
* Fetches list of all payments
|
|
31534
|
-
* @summary Fetches list of all payments
|
|
31535
|
-
* @param {*} [options] Override http request option.
|
|
31536
|
-
* @throws {RequiredError}
|
|
31537
|
-
* @memberof PaymentsApi
|
|
31538
|
-
*/
|
|
31539
|
-
adminPaymentsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentsListResponse, any, {}>>;
|
|
31540
30500
|
/**
|
|
31541
30501
|
* Deletes a payment from the system by ID.
|
|
31542
30502
|
* @summary Delete a payment
|
|
@@ -31580,13 +30540,6 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
31580
30540
|
* @export
|
|
31581
30541
|
*/
|
|
31582
30542
|
export declare const PlansApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31583
|
-
/**
|
|
31584
|
-
* Fetches list of all Plans
|
|
31585
|
-
* @summary Fetches list of all Plans
|
|
31586
|
-
* @param {*} [options] Override http request option.
|
|
31587
|
-
* @throws {RequiredError}
|
|
31588
|
-
*/
|
|
31589
|
-
miscPlansGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31590
30543
|
/**
|
|
31591
30544
|
* Fetches plan by id
|
|
31592
30545
|
* @summary Fetches plan by id
|
|
@@ -31627,13 +30580,6 @@ export declare const PlansApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
31627
30580
|
* @export
|
|
31628
30581
|
*/
|
|
31629
30582
|
export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
31630
|
-
/**
|
|
31631
|
-
* Fetches list of all Plans
|
|
31632
|
-
* @summary Fetches list of all Plans
|
|
31633
|
-
* @param {*} [options] Override http request option.
|
|
31634
|
-
* @throws {RequiredError}
|
|
31635
|
-
*/
|
|
31636
|
-
miscPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPlansListResponse>>;
|
|
31637
30583
|
/**
|
|
31638
30584
|
* Fetches plan by id
|
|
31639
30585
|
* @summary Fetches plan by id
|
|
@@ -31674,13 +30620,6 @@ export declare const PlansApiFp: (configuration?: Configuration) => {
|
|
|
31674
30620
|
* @export
|
|
31675
30621
|
*/
|
|
31676
30622
|
export declare const PlansApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31677
|
-
/**
|
|
31678
|
-
* Fetches list of all Plans
|
|
31679
|
-
* @summary Fetches list of all Plans
|
|
31680
|
-
* @param {*} [options] Override http request option.
|
|
31681
|
-
* @throws {RequiredError}
|
|
31682
|
-
*/
|
|
31683
|
-
miscPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPlansListResponse>;
|
|
31684
30623
|
/**
|
|
31685
30624
|
* Fetches plan by id
|
|
31686
30625
|
* @summary Fetches plan by id
|
|
@@ -31723,14 +30662,6 @@ export declare const PlansApiFactory: (configuration?: Configuration, basePath?:
|
|
|
31723
30662
|
* @extends {BaseAPI}
|
|
31724
30663
|
*/
|
|
31725
30664
|
export declare class PlansApi extends BaseAPI {
|
|
31726
|
-
/**
|
|
31727
|
-
* Fetches list of all Plans
|
|
31728
|
-
* @summary Fetches list of all Plans
|
|
31729
|
-
* @param {*} [options] Override http request option.
|
|
31730
|
-
* @throws {RequiredError}
|
|
31731
|
-
* @memberof PlansApi
|
|
31732
|
-
*/
|
|
31733
|
-
miscPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPlansListResponse, any, {}>>;
|
|
31734
30665
|
/**
|
|
31735
30666
|
* Fetches plan by id
|
|
31736
30667
|
* @summary Fetches plan by id
|
|
@@ -34065,13 +32996,6 @@ export declare class RegisterApi extends BaseAPI {
|
|
|
34065
32996
|
* @export
|
|
34066
32997
|
*/
|
|
34067
32998
|
export declare const RequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34068
|
-
/**
|
|
34069
|
-
* Fetches list of all ServiceRequest
|
|
34070
|
-
* @summary Fetches list of all ServiceRequest
|
|
34071
|
-
* @param {*} [options] Override http request option.
|
|
34072
|
-
* @throws {RequiredError}
|
|
34073
|
-
*/
|
|
34074
|
-
miscRequestsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34075
32999
|
/**
|
|
34076
33000
|
* Updates ServiceRequest information by ID.
|
|
34077
33001
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34120,13 +33044,6 @@ export declare const RequestsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
34120
33044
|
* @export
|
|
34121
33045
|
*/
|
|
34122
33046
|
export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
34123
|
-
/**
|
|
34124
|
-
* Fetches list of all ServiceRequest
|
|
34125
|
-
* @summary Fetches list of all ServiceRequest
|
|
34126
|
-
* @param {*} [options] Override http request option.
|
|
34127
|
-
* @throws {RequiredError}
|
|
34128
|
-
*/
|
|
34129
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesServiceRequestsListResponse>>;
|
|
34130
33047
|
/**
|
|
34131
33048
|
* Updates ServiceRequest information by ID.
|
|
34132
33049
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34175,13 +33092,6 @@ export declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
|
34175
33092
|
* @export
|
|
34176
33093
|
*/
|
|
34177
33094
|
export declare const RequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34178
|
-
/**
|
|
34179
|
-
* Fetches list of all ServiceRequest
|
|
34180
|
-
* @summary Fetches list of all ServiceRequest
|
|
34181
|
-
* @param {*} [options] Override http request option.
|
|
34182
|
-
* @throws {RequiredError}
|
|
34183
|
-
*/
|
|
34184
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesServiceRequestsListResponse>;
|
|
34185
33095
|
/**
|
|
34186
33096
|
* Updates ServiceRequest information by ID.
|
|
34187
33097
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34232,14 +33142,6 @@ export declare const RequestsApiFactory: (configuration?: Configuration, basePat
|
|
|
34232
33142
|
* @extends {BaseAPI}
|
|
34233
33143
|
*/
|
|
34234
33144
|
export declare class RequestsApi extends BaseAPI {
|
|
34235
|
-
/**
|
|
34236
|
-
* Fetches list of all ServiceRequest
|
|
34237
|
-
* @summary Fetches list of all ServiceRequest
|
|
34238
|
-
* @param {*} [options] Override http request option.
|
|
34239
|
-
* @throws {RequiredError}
|
|
34240
|
-
* @memberof RequestsApi
|
|
34241
|
-
*/
|
|
34242
|
-
miscRequestsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesServiceRequestsListResponse, any, {}>>;
|
|
34243
33145
|
/**
|
|
34244
33146
|
* Updates ServiceRequest information by ID.
|
|
34245
33147
|
* @summary Deletes an existing ServiceRequest
|
|
@@ -34301,13 +33203,6 @@ export declare const RoleRightsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
34301
33203
|
* @throws {RequiredError}
|
|
34302
33204
|
*/
|
|
34303
33205
|
adminRolerightsBulkPost: (dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34304
|
-
/**
|
|
34305
|
-
* Fetches list of all roleright
|
|
34306
|
-
* @summary Fetches list of all roleright
|
|
34307
|
-
* @param {*} [options] Override http request option.
|
|
34308
|
-
* @throws {RequiredError}
|
|
34309
|
-
*/
|
|
34310
|
-
adminRolerightsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34311
33206
|
/**
|
|
34312
33207
|
* Fetches roleright by role id
|
|
34313
33208
|
* @summary Fetches roleright by role id
|
|
@@ -34371,13 +33266,6 @@ export declare const RoleRightsApiFp: (configuration?: Configuration) => {
|
|
|
34371
33266
|
* @throws {RequiredError}
|
|
34372
33267
|
*/
|
|
34373
33268
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
34374
|
-
/**
|
|
34375
|
-
* Fetches list of all roleright
|
|
34376
|
-
* @summary Fetches list of all roleright
|
|
34377
|
-
* @param {*} [options] Override http request option.
|
|
34378
|
-
* @throws {RequiredError}
|
|
34379
|
-
*/
|
|
34380
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRoleRightsListResponse>>;
|
|
34381
33269
|
/**
|
|
34382
33270
|
* Fetches roleright by role id
|
|
34383
33271
|
* @summary Fetches roleright by role id
|
|
@@ -34441,13 +33329,6 @@ export declare const RoleRightsApiFactory: (configuration?: Configuration, baseP
|
|
|
34441
33329
|
* @throws {RequiredError}
|
|
34442
33330
|
*/
|
|
34443
33331
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
34444
|
-
/**
|
|
34445
|
-
* Fetches list of all roleright
|
|
34446
|
-
* @summary Fetches list of all roleright
|
|
34447
|
-
* @param {*} [options] Override http request option.
|
|
34448
|
-
* @throws {RequiredError}
|
|
34449
|
-
*/
|
|
34450
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRoleRightsListResponse>;
|
|
34451
33332
|
/**
|
|
34452
33333
|
* Fetches roleright by role id
|
|
34453
33334
|
* @summary Fetches roleright by role id
|
|
@@ -34514,14 +33395,6 @@ export declare class RoleRightsApi extends BaseAPI {
|
|
|
34514
33395
|
* @memberof RoleRightsApi
|
|
34515
33396
|
*/
|
|
34516
33397
|
adminRolerightsBulkPost(dataTypesRoleRightRequestDto: Array<DataTypesRoleRightRequestDto>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
34517
|
-
/**
|
|
34518
|
-
* Fetches list of all roleright
|
|
34519
|
-
* @summary Fetches list of all roleright
|
|
34520
|
-
* @param {*} [options] Override http request option.
|
|
34521
|
-
* @throws {RequiredError}
|
|
34522
|
-
* @memberof RoleRightsApi
|
|
34523
|
-
*/
|
|
34524
|
-
adminRolerightsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRoleRightsListResponse, any, {}>>;
|
|
34525
33398
|
/**
|
|
34526
33399
|
* Fetches roleright by role id
|
|
34527
33400
|
* @summary Fetches roleright by role id
|
|
@@ -34600,14 +33473,6 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34600
33473
|
* @throws {RequiredError}
|
|
34601
33474
|
*/
|
|
34602
33475
|
adminRolesIdPut: (id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34603
|
-
/**
|
|
34604
|
-
* Fetches list of all roles
|
|
34605
|
-
* @summary Fetches list of all roles
|
|
34606
|
-
* @param {number} orgId Org ID
|
|
34607
|
-
* @param {*} [options] Override http request option.
|
|
34608
|
-
* @throws {RequiredError}
|
|
34609
|
-
*/
|
|
34610
|
-
adminRolesOrgIdGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34611
33476
|
/**
|
|
34612
33477
|
* Fetches role by id
|
|
34613
33478
|
* @summary Fetches role by id
|
|
@@ -34648,14 +33513,6 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
34648
33513
|
* @throws {RequiredError}
|
|
34649
33514
|
*/
|
|
34650
33515
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
34651
|
-
/**
|
|
34652
|
-
* Fetches list of all roles
|
|
34653
|
-
* @summary Fetches list of all roles
|
|
34654
|
-
* @param {number} orgId Org ID
|
|
34655
|
-
* @param {*} [options] Override http request option.
|
|
34656
|
-
* @throws {RequiredError}
|
|
34657
|
-
*/
|
|
34658
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRolesListResponse>>;
|
|
34659
33516
|
/**
|
|
34660
33517
|
* Fetches role by id
|
|
34661
33518
|
* @summary Fetches role by id
|
|
@@ -34696,14 +33553,6 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
34696
33553
|
* @throws {RequiredError}
|
|
34697
33554
|
*/
|
|
34698
33555
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
34699
|
-
/**
|
|
34700
|
-
* Fetches list of all roles
|
|
34701
|
-
* @summary Fetches list of all roles
|
|
34702
|
-
* @param {number} orgId Org ID
|
|
34703
|
-
* @param {*} [options] Override http request option.
|
|
34704
|
-
* @throws {RequiredError}
|
|
34705
|
-
*/
|
|
34706
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRolesListResponse>;
|
|
34707
33556
|
/**
|
|
34708
33557
|
* Fetches role by id
|
|
34709
33558
|
* @summary Fetches role by id
|
|
@@ -34748,15 +33597,6 @@ export declare class RolesApi extends BaseAPI {
|
|
|
34748
33597
|
* @memberof RolesApi
|
|
34749
33598
|
*/
|
|
34750
33599
|
adminRolesIdPut(id: number, dataTypesCreateRoleRequestDto: DataTypesCreateRoleRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
34751
|
-
/**
|
|
34752
|
-
* Fetches list of all roles
|
|
34753
|
-
* @summary Fetches list of all roles
|
|
34754
|
-
* @param {number} orgId Org ID
|
|
34755
|
-
* @param {*} [options] Override http request option.
|
|
34756
|
-
* @throws {RequiredError}
|
|
34757
|
-
* @memberof RolesApi
|
|
34758
|
-
*/
|
|
34759
|
-
adminRolesOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRolesListResponse, any, {}>>;
|
|
34760
33600
|
/**
|
|
34761
33601
|
* Fetches role by id
|
|
34762
33602
|
* @summary Fetches role by id
|
|
@@ -34834,16 +33674,6 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
34834
33674
|
* @throws {RequiredError}
|
|
34835
33675
|
*/
|
|
34836
33676
|
v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34837
|
-
/**
|
|
34838
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
34839
|
-
* @summary Public Search API
|
|
34840
|
-
* @param {string} xStoreid Store ID
|
|
34841
|
-
* @param {string} xStoresecret Store Secret
|
|
34842
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
34843
|
-
* @param {*} [options] Override http request option.
|
|
34844
|
-
* @throws {RequiredError}
|
|
34845
|
-
*/
|
|
34846
|
-
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34847
33677
|
};
|
|
34848
33678
|
/**
|
|
34849
33679
|
* SearchApi - functional programming interface
|
|
@@ -34902,16 +33732,6 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
34902
33732
|
* @throws {RequiredError}
|
|
34903
33733
|
*/
|
|
34904
33734
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
|
|
34905
|
-
/**
|
|
34906
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
34907
|
-
* @summary Public Search API
|
|
34908
|
-
* @param {string} xStoreid Store ID
|
|
34909
|
-
* @param {string} xStoresecret Store Secret
|
|
34910
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
34911
|
-
* @param {*} [options] Override http request option.
|
|
34912
|
-
* @throws {RequiredError}
|
|
34913
|
-
*/
|
|
34914
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
|
|
34915
33735
|
};
|
|
34916
33736
|
/**
|
|
34917
33737
|
* SearchApi - factory interface
|
|
@@ -34970,16 +33790,6 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
34970
33790
|
* @throws {RequiredError}
|
|
34971
33791
|
*/
|
|
34972
33792
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
|
|
34973
|
-
/**
|
|
34974
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
34975
|
-
* @summary Public Search API
|
|
34976
|
-
* @param {string} xStoreid Store ID
|
|
34977
|
-
* @param {string} xStoresecret Store Secret
|
|
34978
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
34979
|
-
* @param {*} [options] Override http request option.
|
|
34980
|
-
* @throws {RequiredError}
|
|
34981
|
-
*/
|
|
34982
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
|
|
34983
33793
|
};
|
|
34984
33794
|
/**
|
|
34985
33795
|
* SearchApi - object-oriented interface
|
|
@@ -35046,17 +33856,6 @@ export declare class SearchApi extends BaseAPI {
|
|
|
35046
33856
|
* @memberof SearchApi
|
|
35047
33857
|
*/
|
|
35048
33858
|
v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any, {}>>;
|
|
35049
|
-
/**
|
|
35050
|
-
* Search documents using store credentials with optional autocomplete suggestions and configurable stopwords/synonyms
|
|
35051
|
-
* @summary Public Search API
|
|
35052
|
-
* @param {string} xStoreid Store ID
|
|
35053
|
-
* @param {string} xStoresecret Store Secret
|
|
35054
|
-
* @param {DataTypesPublicSearchRequest} dataTypesPublicSearchRequest Search request with optional stopword_sets and synonym_sets for granular control
|
|
35055
|
-
* @param {*} [options] Override http request option.
|
|
35056
|
-
* @throws {RequiredError}
|
|
35057
|
-
* @memberof SearchApi
|
|
35058
|
-
*/
|
|
35059
|
-
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesPublicSearchRequest: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any, {}>>;
|
|
35060
33859
|
}
|
|
35061
33860
|
/**
|
|
35062
33861
|
* StopwordsApi - axios parameter creator
|
|
@@ -36639,13 +35438,6 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
36639
35438
|
* @throws {RequiredError}
|
|
36640
35439
|
*/
|
|
36641
35440
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut: (subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36642
|
-
/**
|
|
36643
|
-
* Fetches list of all Subscription
|
|
36644
|
-
* @summary Fetches list of all Subscription
|
|
36645
|
-
* @param {*} [options] Override http request option.
|
|
36646
|
-
* @throws {RequiredError}
|
|
36647
|
-
*/
|
|
36648
|
-
miscSubscriptionsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36649
35441
|
/**
|
|
36650
35442
|
* Adds a new Subscription to the system
|
|
36651
35443
|
* @summary Creates a new Subscription
|
|
@@ -36702,13 +35494,6 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
36702
35494
|
* @throws {RequiredError}
|
|
36703
35495
|
*/
|
|
36704
35496
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
36705
|
-
/**
|
|
36706
|
-
* Fetches list of all Subscription
|
|
36707
|
-
* @summary Fetches list of all Subscription
|
|
36708
|
-
* @param {*} [options] Override http request option.
|
|
36709
|
-
* @throws {RequiredError}
|
|
36710
|
-
*/
|
|
36711
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSubscriptionsListResponse>>;
|
|
36712
35497
|
/**
|
|
36713
35498
|
* Adds a new Subscription to the system
|
|
36714
35499
|
* @summary Creates a new Subscription
|
|
@@ -36765,13 +35550,6 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
36765
35550
|
* @throws {RequiredError}
|
|
36766
35551
|
*/
|
|
36767
35552
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36768
|
-
/**
|
|
36769
|
-
* Fetches list of all Subscription
|
|
36770
|
-
* @summary Fetches list of all Subscription
|
|
36771
|
-
* @param {*} [options] Override http request option.
|
|
36772
|
-
* @throws {RequiredError}
|
|
36773
|
-
*/
|
|
36774
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSubscriptionsListResponse>;
|
|
36775
35553
|
/**
|
|
36776
35554
|
* Adds a new Subscription to the system
|
|
36777
35555
|
* @summary Creates a new Subscription
|
|
@@ -36834,14 +35612,6 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
36834
35612
|
* @memberof SubscriptionsApi
|
|
36835
35613
|
*/
|
|
36836
35614
|
adminSubscriptionsUpdatestatusSubscriptionIDStatusPut(subscriptionID: number, status: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36837
|
-
/**
|
|
36838
|
-
* Fetches list of all Subscription
|
|
36839
|
-
* @summary Fetches list of all Subscription
|
|
36840
|
-
* @param {*} [options] Override http request option.
|
|
36841
|
-
* @throws {RequiredError}
|
|
36842
|
-
* @memberof SubscriptionsApi
|
|
36843
|
-
*/
|
|
36844
|
-
miscSubscriptionsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSubscriptionsListResponse, any, {}>>;
|
|
36845
35615
|
/**
|
|
36846
35616
|
* Adds a new Subscription to the system
|
|
36847
35617
|
* @summary Creates a new Subscription
|
|
@@ -37015,6 +35785,460 @@ export declare class TaxManagementApi extends BaseAPI {
|
|
|
37015
35785
|
*/
|
|
37016
35786
|
adminTaxValidateGstinPost(dataTypesGSTVerificationRequest: DataTypesGSTVerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesGSTVerificationResponse, any, {}>>;
|
|
37017
35787
|
}
|
|
35788
|
+
/**
|
|
35789
|
+
* TeamApi - axios parameter creator
|
|
35790
|
+
* @export
|
|
35791
|
+
*/
|
|
35792
|
+
export declare const TeamApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35793
|
+
/**
|
|
35794
|
+
* Cancels a pending invitation
|
|
35795
|
+
* @summary Cancel invitation
|
|
35796
|
+
* @param {number} invitationId Invitation ID
|
|
35797
|
+
* @param {*} [options] Override http request option.
|
|
35798
|
+
* @throws {RequiredError}
|
|
35799
|
+
*/
|
|
35800
|
+
apiV1InvitationsInvitationIdDelete: (invitationId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35801
|
+
/**
|
|
35802
|
+
* Accepts a team invitation using token
|
|
35803
|
+
* @summary Accept invitation
|
|
35804
|
+
* @param {string} token Invitation Token
|
|
35805
|
+
* @param {*} [options] Override http request option.
|
|
35806
|
+
* @throws {RequiredError}
|
|
35807
|
+
*/
|
|
35808
|
+
apiV1InvitationsTokenAcceptPost: (token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35809
|
+
/**
|
|
35810
|
+
* Retrieves all pending invitations for an organization
|
|
35811
|
+
* @summary Get pending invitations
|
|
35812
|
+
* @param {number} orgId Organization ID
|
|
35813
|
+
* @param {*} [options] Override http request option.
|
|
35814
|
+
* @throws {RequiredError}
|
|
35815
|
+
*/
|
|
35816
|
+
apiV1OrganizationsOrgIdInvitationsGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35817
|
+
/**
|
|
35818
|
+
* Retrieves all members of an organization with their details
|
|
35819
|
+
* @summary Get all members of an organization
|
|
35820
|
+
* @param {number} orgId Organization ID
|
|
35821
|
+
* @param {*} [options] Override http request option.
|
|
35822
|
+
* @throws {RequiredError}
|
|
35823
|
+
*/
|
|
35824
|
+
apiV1OrganizationsOrgIdMembersGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35825
|
+
/**
|
|
35826
|
+
* Sends an invitation to a user to join the organization
|
|
35827
|
+
* @summary Invite a member to join organization
|
|
35828
|
+
* @param {number} orgId Organization ID
|
|
35829
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35830
|
+
* @param {*} [options] Override http request option.
|
|
35831
|
+
* @throws {RequiredError}
|
|
35832
|
+
*/
|
|
35833
|
+
apiV1OrganizationsOrgIdMembersInvitePost: (orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35834
|
+
/**
|
|
35835
|
+
* Removes a member from the organization
|
|
35836
|
+
* @summary Remove member from organization
|
|
35837
|
+
* @param {number} orgId Organization ID
|
|
35838
|
+
* @param {number} memberId Member ID
|
|
35839
|
+
* @param {*} [options] Override http request option.
|
|
35840
|
+
* @throws {RequiredError}
|
|
35841
|
+
*/
|
|
35842
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete: (orgId: number, memberId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35843
|
+
/**
|
|
35844
|
+
* Updates the role of a member in the organization
|
|
35845
|
+
* @summary Update member role
|
|
35846
|
+
* @param {number} orgId Organization ID
|
|
35847
|
+
* @param {number} memberId Member ID
|
|
35848
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35849
|
+
* @param {*} [options] Override http request option.
|
|
35850
|
+
* @throws {RequiredError}
|
|
35851
|
+
*/
|
|
35852
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut: (orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35853
|
+
/**
|
|
35854
|
+
* Retrieves all users with access to a store
|
|
35855
|
+
* @summary Get store access list
|
|
35856
|
+
* @param {number} storeId Store ID
|
|
35857
|
+
* @param {*} [options] Override http request option.
|
|
35858
|
+
* @throws {RequiredError}
|
|
35859
|
+
*/
|
|
35860
|
+
apiV1StoresStoreIdAccessGet: (storeId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35861
|
+
/**
|
|
35862
|
+
* Grants a user access to a store
|
|
35863
|
+
* @summary Grant store access
|
|
35864
|
+
* @param {number} storeId Store ID
|
|
35865
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35866
|
+
* @param {*} [options] Override http request option.
|
|
35867
|
+
* @throws {RequiredError}
|
|
35868
|
+
*/
|
|
35869
|
+
apiV1StoresStoreIdAccessPost: (storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35870
|
+
/**
|
|
35871
|
+
* Revokes a user\'s access to a store
|
|
35872
|
+
* @summary Revoke store access
|
|
35873
|
+
* @param {number} storeId Store ID
|
|
35874
|
+
* @param {number} userId User ID
|
|
35875
|
+
* @param {*} [options] Override http request option.
|
|
35876
|
+
* @throws {RequiredError}
|
|
35877
|
+
*/
|
|
35878
|
+
apiV1StoresStoreIdAccessUserIdDelete: (storeId: number, userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35879
|
+
/**
|
|
35880
|
+
* Updates a user\'s access level to a store
|
|
35881
|
+
* @summary Update store access level
|
|
35882
|
+
* @param {number} storeId Store ID
|
|
35883
|
+
* @param {number} userId User ID
|
|
35884
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
35885
|
+
* @param {*} [options] Override http request option.
|
|
35886
|
+
* @throws {RequiredError}
|
|
35887
|
+
*/
|
|
35888
|
+
apiV1StoresStoreIdAccessUserIdPut: (storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35889
|
+
/**
|
|
35890
|
+
* Retrieves all stores accessible to a user
|
|
35891
|
+
* @summary Get user\'s accessible stores
|
|
35892
|
+
* @param {number} userId User ID
|
|
35893
|
+
* @param {*} [options] Override http request option.
|
|
35894
|
+
* @throws {RequiredError}
|
|
35895
|
+
*/
|
|
35896
|
+
apiV1UsersUserIdStoresGet: (userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
35897
|
+
};
|
|
35898
|
+
/**
|
|
35899
|
+
* TeamApi - functional programming interface
|
|
35900
|
+
* @export
|
|
35901
|
+
*/
|
|
35902
|
+
export declare const TeamApiFp: (configuration?: Configuration) => {
|
|
35903
|
+
/**
|
|
35904
|
+
* Cancels a pending invitation
|
|
35905
|
+
* @summary Cancel invitation
|
|
35906
|
+
* @param {number} invitationId Invitation ID
|
|
35907
|
+
* @param {*} [options] Override http request option.
|
|
35908
|
+
* @throws {RequiredError}
|
|
35909
|
+
*/
|
|
35910
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35911
|
+
/**
|
|
35912
|
+
* Accepts a team invitation using token
|
|
35913
|
+
* @summary Accept invitation
|
|
35914
|
+
* @param {string} token Invitation Token
|
|
35915
|
+
* @param {*} [options] Override http request option.
|
|
35916
|
+
* @throws {RequiredError}
|
|
35917
|
+
*/
|
|
35918
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35919
|
+
/**
|
|
35920
|
+
* Retrieves all pending invitations for an organization
|
|
35921
|
+
* @summary Get pending invitations
|
|
35922
|
+
* @param {number} orgId Organization ID
|
|
35923
|
+
* @param {*} [options] Override http request option.
|
|
35924
|
+
* @throws {RequiredError}
|
|
35925
|
+
*/
|
|
35926
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesTeamInvitationsResponse>>;
|
|
35927
|
+
/**
|
|
35928
|
+
* Retrieves all members of an organization with their details
|
|
35929
|
+
* @summary Get all members of an organization
|
|
35930
|
+
* @param {number} orgId Organization ID
|
|
35931
|
+
* @param {*} [options] Override http request option.
|
|
35932
|
+
* @throws {RequiredError}
|
|
35933
|
+
*/
|
|
35934
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOrgMembersResponse>>;
|
|
35935
|
+
/**
|
|
35936
|
+
* Sends an invitation to a user to join the organization
|
|
35937
|
+
* @summary Invite a member to join organization
|
|
35938
|
+
* @param {number} orgId Organization ID
|
|
35939
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
35940
|
+
* @param {*} [options] Override http request option.
|
|
35941
|
+
* @throws {RequiredError}
|
|
35942
|
+
*/
|
|
35943
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesInvitationCreatedResponse>>;
|
|
35944
|
+
/**
|
|
35945
|
+
* Removes a member from the organization
|
|
35946
|
+
* @summary Remove member from organization
|
|
35947
|
+
* @param {number} orgId Organization ID
|
|
35948
|
+
* @param {number} memberId Member ID
|
|
35949
|
+
* @param {*} [options] Override http request option.
|
|
35950
|
+
* @throws {RequiredError}
|
|
35951
|
+
*/
|
|
35952
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35953
|
+
/**
|
|
35954
|
+
* Updates the role of a member in the organization
|
|
35955
|
+
* @summary Update member role
|
|
35956
|
+
* @param {number} orgId Organization ID
|
|
35957
|
+
* @param {number} memberId Member ID
|
|
35958
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
35959
|
+
* @param {*} [options] Override http request option.
|
|
35960
|
+
* @throws {RequiredError}
|
|
35961
|
+
*/
|
|
35962
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35963
|
+
/**
|
|
35964
|
+
* Retrieves all users with access to a store
|
|
35965
|
+
* @summary Get store access list
|
|
35966
|
+
* @param {number} storeId Store ID
|
|
35967
|
+
* @param {*} [options] Override http request option.
|
|
35968
|
+
* @throws {RequiredError}
|
|
35969
|
+
*/
|
|
35970
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreAccessResponse>>;
|
|
35971
|
+
/**
|
|
35972
|
+
* Grants a user access to a store
|
|
35973
|
+
* @summary Grant store access
|
|
35974
|
+
* @param {number} storeId Store ID
|
|
35975
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
35976
|
+
* @param {*} [options] Override http request option.
|
|
35977
|
+
* @throws {RequiredError}
|
|
35978
|
+
*/
|
|
35979
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35980
|
+
/**
|
|
35981
|
+
* Revokes a user\'s access to a store
|
|
35982
|
+
* @summary Revoke store access
|
|
35983
|
+
* @param {number} storeId Store ID
|
|
35984
|
+
* @param {number} userId User ID
|
|
35985
|
+
* @param {*} [options] Override http request option.
|
|
35986
|
+
* @throws {RequiredError}
|
|
35987
|
+
*/
|
|
35988
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35989
|
+
/**
|
|
35990
|
+
* Updates a user\'s access level to a store
|
|
35991
|
+
* @summary Update store access level
|
|
35992
|
+
* @param {number} storeId Store ID
|
|
35993
|
+
* @param {number} userId User ID
|
|
35994
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
35995
|
+
* @param {*} [options] Override http request option.
|
|
35996
|
+
* @throws {RequiredError}
|
|
35997
|
+
*/
|
|
35998
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
35999
|
+
/**
|
|
36000
|
+
* Retrieves all stores accessible to a user
|
|
36001
|
+
* @summary Get user\'s accessible stores
|
|
36002
|
+
* @param {number} userId User ID
|
|
36003
|
+
* @param {*} [options] Override http request option.
|
|
36004
|
+
* @throws {RequiredError}
|
|
36005
|
+
*/
|
|
36006
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesUserStoresResponse>>;
|
|
36007
|
+
};
|
|
36008
|
+
/**
|
|
36009
|
+
* TeamApi - factory interface
|
|
36010
|
+
* @export
|
|
36011
|
+
*/
|
|
36012
|
+
export declare const TeamApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
36013
|
+
/**
|
|
36014
|
+
* Cancels a pending invitation
|
|
36015
|
+
* @summary Cancel invitation
|
|
36016
|
+
* @param {number} invitationId Invitation ID
|
|
36017
|
+
* @param {*} [options] Override http request option.
|
|
36018
|
+
* @throws {RequiredError}
|
|
36019
|
+
*/
|
|
36020
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36021
|
+
/**
|
|
36022
|
+
* Accepts a team invitation using token
|
|
36023
|
+
* @summary Accept invitation
|
|
36024
|
+
* @param {string} token Invitation Token
|
|
36025
|
+
* @param {*} [options] Override http request option.
|
|
36026
|
+
* @throws {RequiredError}
|
|
36027
|
+
*/
|
|
36028
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36029
|
+
/**
|
|
36030
|
+
* Retrieves all pending invitations for an organization
|
|
36031
|
+
* @summary Get pending invitations
|
|
36032
|
+
* @param {number} orgId Organization ID
|
|
36033
|
+
* @param {*} [options] Override http request option.
|
|
36034
|
+
* @throws {RequiredError}
|
|
36035
|
+
*/
|
|
36036
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesTeamInvitationsResponse>;
|
|
36037
|
+
/**
|
|
36038
|
+
* Retrieves all members of an organization with their details
|
|
36039
|
+
* @summary Get all members of an organization
|
|
36040
|
+
* @param {number} orgId Organization ID
|
|
36041
|
+
* @param {*} [options] Override http request option.
|
|
36042
|
+
* @throws {RequiredError}
|
|
36043
|
+
*/
|
|
36044
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOrgMembersResponse>;
|
|
36045
|
+
/**
|
|
36046
|
+
* Sends an invitation to a user to join the organization
|
|
36047
|
+
* @summary Invite a member to join organization
|
|
36048
|
+
* @param {number} orgId Organization ID
|
|
36049
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36050
|
+
* @param {*} [options] Override http request option.
|
|
36051
|
+
* @throws {RequiredError}
|
|
36052
|
+
*/
|
|
36053
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesInvitationCreatedResponse>;
|
|
36054
|
+
/**
|
|
36055
|
+
* Removes a member from the organization
|
|
36056
|
+
* @summary Remove member from organization
|
|
36057
|
+
* @param {number} orgId Organization ID
|
|
36058
|
+
* @param {number} memberId Member ID
|
|
36059
|
+
* @param {*} [options] Override http request option.
|
|
36060
|
+
* @throws {RequiredError}
|
|
36061
|
+
*/
|
|
36062
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36063
|
+
/**
|
|
36064
|
+
* Updates the role of a member in the organization
|
|
36065
|
+
* @summary Update member role
|
|
36066
|
+
* @param {number} orgId Organization ID
|
|
36067
|
+
* @param {number} memberId Member ID
|
|
36068
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36069
|
+
* @param {*} [options] Override http request option.
|
|
36070
|
+
* @throws {RequiredError}
|
|
36071
|
+
*/
|
|
36072
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36073
|
+
/**
|
|
36074
|
+
* Retrieves all users with access to a store
|
|
36075
|
+
* @summary Get store access list
|
|
36076
|
+
* @param {number} storeId Store ID
|
|
36077
|
+
* @param {*} [options] Override http request option.
|
|
36078
|
+
* @throws {RequiredError}
|
|
36079
|
+
*/
|
|
36080
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreAccessResponse>;
|
|
36081
|
+
/**
|
|
36082
|
+
* Grants a user access to a store
|
|
36083
|
+
* @summary Grant store access
|
|
36084
|
+
* @param {number} storeId Store ID
|
|
36085
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36086
|
+
* @param {*} [options] Override http request option.
|
|
36087
|
+
* @throws {RequiredError}
|
|
36088
|
+
*/
|
|
36089
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36090
|
+
/**
|
|
36091
|
+
* Revokes a user\'s access to a store
|
|
36092
|
+
* @summary Revoke store access
|
|
36093
|
+
* @param {number} storeId Store ID
|
|
36094
|
+
* @param {number} userId User ID
|
|
36095
|
+
* @param {*} [options] Override http request option.
|
|
36096
|
+
* @throws {RequiredError}
|
|
36097
|
+
*/
|
|
36098
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36099
|
+
/**
|
|
36100
|
+
* Updates a user\'s access level to a store
|
|
36101
|
+
* @summary Update store access level
|
|
36102
|
+
* @param {number} storeId Store ID
|
|
36103
|
+
* @param {number} userId User ID
|
|
36104
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36105
|
+
* @param {*} [options] Override http request option.
|
|
36106
|
+
* @throws {RequiredError}
|
|
36107
|
+
*/
|
|
36108
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
36109
|
+
/**
|
|
36110
|
+
* Retrieves all stores accessible to a user
|
|
36111
|
+
* @summary Get user\'s accessible stores
|
|
36112
|
+
* @param {number} userId User ID
|
|
36113
|
+
* @param {*} [options] Override http request option.
|
|
36114
|
+
* @throws {RequiredError}
|
|
36115
|
+
*/
|
|
36116
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesUserStoresResponse>;
|
|
36117
|
+
};
|
|
36118
|
+
/**
|
|
36119
|
+
* TeamApi - object-oriented interface
|
|
36120
|
+
* @export
|
|
36121
|
+
* @class TeamApi
|
|
36122
|
+
* @extends {BaseAPI}
|
|
36123
|
+
*/
|
|
36124
|
+
export declare class TeamApi extends BaseAPI {
|
|
36125
|
+
/**
|
|
36126
|
+
* Cancels a pending invitation
|
|
36127
|
+
* @summary Cancel invitation
|
|
36128
|
+
* @param {number} invitationId Invitation ID
|
|
36129
|
+
* @param {*} [options] Override http request option.
|
|
36130
|
+
* @throws {RequiredError}
|
|
36131
|
+
* @memberof TeamApi
|
|
36132
|
+
*/
|
|
36133
|
+
apiV1InvitationsInvitationIdDelete(invitationId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36134
|
+
/**
|
|
36135
|
+
* Accepts a team invitation using token
|
|
36136
|
+
* @summary Accept invitation
|
|
36137
|
+
* @param {string} token Invitation Token
|
|
36138
|
+
* @param {*} [options] Override http request option.
|
|
36139
|
+
* @throws {RequiredError}
|
|
36140
|
+
* @memberof TeamApi
|
|
36141
|
+
*/
|
|
36142
|
+
apiV1InvitationsTokenAcceptPost(token: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36143
|
+
/**
|
|
36144
|
+
* Retrieves all pending invitations for an organization
|
|
36145
|
+
* @summary Get pending invitations
|
|
36146
|
+
* @param {number} orgId Organization ID
|
|
36147
|
+
* @param {*} [options] Override http request option.
|
|
36148
|
+
* @throws {RequiredError}
|
|
36149
|
+
* @memberof TeamApi
|
|
36150
|
+
*/
|
|
36151
|
+
apiV1OrganizationsOrgIdInvitationsGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesTeamInvitationsResponse, any, {}>>;
|
|
36152
|
+
/**
|
|
36153
|
+
* Retrieves all members of an organization with their details
|
|
36154
|
+
* @summary Get all members of an organization
|
|
36155
|
+
* @param {number} orgId Organization ID
|
|
36156
|
+
* @param {*} [options] Override http request option.
|
|
36157
|
+
* @throws {RequiredError}
|
|
36158
|
+
* @memberof TeamApi
|
|
36159
|
+
*/
|
|
36160
|
+
apiV1OrganizationsOrgIdMembersGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOrgMembersResponse, any, {}>>;
|
|
36161
|
+
/**
|
|
36162
|
+
* Sends an invitation to a user to join the organization
|
|
36163
|
+
* @summary Invite a member to join organization
|
|
36164
|
+
* @param {number} orgId Organization ID
|
|
36165
|
+
* @param {DataTypesInviteMemberRequest} dataTypesInviteMemberRequest Invitation details
|
|
36166
|
+
* @param {*} [options] Override http request option.
|
|
36167
|
+
* @throws {RequiredError}
|
|
36168
|
+
* @memberof TeamApi
|
|
36169
|
+
*/
|
|
36170
|
+
apiV1OrganizationsOrgIdMembersInvitePost(orgId: number, dataTypesInviteMemberRequest: DataTypesInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesInvitationCreatedResponse, any, {}>>;
|
|
36171
|
+
/**
|
|
36172
|
+
* Removes a member from the organization
|
|
36173
|
+
* @summary Remove member from organization
|
|
36174
|
+
* @param {number} orgId Organization ID
|
|
36175
|
+
* @param {number} memberId Member ID
|
|
36176
|
+
* @param {*} [options] Override http request option.
|
|
36177
|
+
* @throws {RequiredError}
|
|
36178
|
+
* @memberof TeamApi
|
|
36179
|
+
*/
|
|
36180
|
+
apiV1OrganizationsOrgIdMembersMemberIdDelete(orgId: number, memberId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36181
|
+
/**
|
|
36182
|
+
* Updates the role of a member in the organization
|
|
36183
|
+
* @summary Update member role
|
|
36184
|
+
* @param {number} orgId Organization ID
|
|
36185
|
+
* @param {number} memberId Member ID
|
|
36186
|
+
* @param {DataTypesUpdateMemberRoleRequest} dataTypesUpdateMemberRoleRequest New role
|
|
36187
|
+
* @param {*} [options] Override http request option.
|
|
36188
|
+
* @throws {RequiredError}
|
|
36189
|
+
* @memberof TeamApi
|
|
36190
|
+
*/
|
|
36191
|
+
apiV1OrganizationsOrgIdMembersMemberIdRolePut(orgId: number, memberId: number, dataTypesUpdateMemberRoleRequest: DataTypesUpdateMemberRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36192
|
+
/**
|
|
36193
|
+
* Retrieves all users with access to a store
|
|
36194
|
+
* @summary Get store access list
|
|
36195
|
+
* @param {number} storeId Store ID
|
|
36196
|
+
* @param {*} [options] Override http request option.
|
|
36197
|
+
* @throws {RequiredError}
|
|
36198
|
+
* @memberof TeamApi
|
|
36199
|
+
*/
|
|
36200
|
+
apiV1StoresStoreIdAccessGet(storeId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreAccessResponse, any, {}>>;
|
|
36201
|
+
/**
|
|
36202
|
+
* Grants a user access to a store
|
|
36203
|
+
* @summary Grant store access
|
|
36204
|
+
* @param {number} storeId Store ID
|
|
36205
|
+
* @param {DataTypesGrantStoreAccessRequest} dataTypesGrantStoreAccessRequest Access details
|
|
36206
|
+
* @param {*} [options] Override http request option.
|
|
36207
|
+
* @throws {RequiredError}
|
|
36208
|
+
* @memberof TeamApi
|
|
36209
|
+
*/
|
|
36210
|
+
apiV1StoresStoreIdAccessPost(storeId: number, dataTypesGrantStoreAccessRequest: DataTypesGrantStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36211
|
+
/**
|
|
36212
|
+
* Revokes a user\'s access to a store
|
|
36213
|
+
* @summary Revoke store access
|
|
36214
|
+
* @param {number} storeId Store ID
|
|
36215
|
+
* @param {number} userId User ID
|
|
36216
|
+
* @param {*} [options] Override http request option.
|
|
36217
|
+
* @throws {RequiredError}
|
|
36218
|
+
* @memberof TeamApi
|
|
36219
|
+
*/
|
|
36220
|
+
apiV1StoresStoreIdAccessUserIdDelete(storeId: number, userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36221
|
+
/**
|
|
36222
|
+
* Updates a user\'s access level to a store
|
|
36223
|
+
* @summary Update store access level
|
|
36224
|
+
* @param {number} storeId Store ID
|
|
36225
|
+
* @param {number} userId User ID
|
|
36226
|
+
* @param {DataTypesUpdateStoreAccessRequest} dataTypesUpdateStoreAccessRequest New access level
|
|
36227
|
+
* @param {*} [options] Override http request option.
|
|
36228
|
+
* @throws {RequiredError}
|
|
36229
|
+
* @memberof TeamApi
|
|
36230
|
+
*/
|
|
36231
|
+
apiV1StoresStoreIdAccessUserIdPut(storeId: number, userId: number, dataTypesUpdateStoreAccessRequest: DataTypesUpdateStoreAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
36232
|
+
/**
|
|
36233
|
+
* Retrieves all stores accessible to a user
|
|
36234
|
+
* @summary Get user\'s accessible stores
|
|
36235
|
+
* @param {number} userId User ID
|
|
36236
|
+
* @param {*} [options] Override http request option.
|
|
36237
|
+
* @throws {RequiredError}
|
|
36238
|
+
* @memberof TeamApi
|
|
36239
|
+
*/
|
|
36240
|
+
apiV1UsersUserIdStoresGet(userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesUserStoresResponse, any, {}>>;
|
|
36241
|
+
}
|
|
37018
36242
|
/**
|
|
37019
36243
|
* UserApi - axios parameter creator
|
|
37020
36244
|
* @export
|