@seekora-ai/admin-api 1.1.82 → 1.1.83
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 +17 -2
- package/api.ts +721 -17
- package/dist/api.d.ts +725 -19
- package/dist/api.js +0 -1
- package/dist/esm/api.d.ts +725 -19
- package/dist/esm/api.js +0 -1
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.83.tgz +0 -0
- package/seekora-ai-admin-api-1.1.82.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -12461,7 +12461,6 @@ export interface DataTypesBillingAlertRequest {
|
|
|
12461
12461
|
}
|
|
12462
12462
|
export declare const DataTypesBillingAlertRequestAlertTypeEnum: {
|
|
12463
12463
|
readonly LowBalance: "low_balance";
|
|
12464
|
-
readonly ExpiringCredits: "expiring_credits";
|
|
12465
12464
|
readonly DaysRemaining: "days_remaining";
|
|
12466
12465
|
};
|
|
12467
12466
|
export type DataTypesBillingAlertRequestAlertTypeEnum = typeof DataTypesBillingAlertRequestAlertTypeEnum[keyof typeof DataTypesBillingAlertRequestAlertTypeEnum];
|
|
@@ -12526,6 +12525,86 @@ export interface DataTypesBillingOrderDetailsResponse {
|
|
|
12526
12525
|
*/
|
|
12527
12526
|
'transactions'?: Array<DataTypesOrderTransactionDisplay>;
|
|
12528
12527
|
}
|
|
12528
|
+
/**
|
|
12529
|
+
*
|
|
12530
|
+
* @export
|
|
12531
|
+
* @interface DataTypesBillingOverviewNewResponse
|
|
12532
|
+
*/
|
|
12533
|
+
export interface DataTypesBillingOverviewNewResponse {
|
|
12534
|
+
/**
|
|
12535
|
+
* Credit balance information
|
|
12536
|
+
* @type {DataTypesCreditBalanceInfo}
|
|
12537
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12538
|
+
*/
|
|
12539
|
+
'credit_balance'?: DataTypesCreditBalanceInfo;
|
|
12540
|
+
/**
|
|
12541
|
+
*
|
|
12542
|
+
* @type {string}
|
|
12543
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12544
|
+
*/
|
|
12545
|
+
'currency'?: string;
|
|
12546
|
+
/**
|
|
12547
|
+
* Current plan information
|
|
12548
|
+
* @type {DataTypesCurrentPlanInfo}
|
|
12549
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12550
|
+
*/
|
|
12551
|
+
'current_plan'?: DataTypesCurrentPlanInfo;
|
|
12552
|
+
/**
|
|
12553
|
+
* Next charge information (for subscriptions)
|
|
12554
|
+
* @type {DataTypesNextChargeInfo}
|
|
12555
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12556
|
+
*/
|
|
12557
|
+
'next_charge'?: DataTypesNextChargeInfo;
|
|
12558
|
+
/**
|
|
12559
|
+
* Projected runout information
|
|
12560
|
+
* @type {DataTypesProjectedRunoutInfo}
|
|
12561
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12562
|
+
*/
|
|
12563
|
+
'projected_runout'?: DataTypesProjectedRunoutInfo;
|
|
12564
|
+
/**
|
|
12565
|
+
* Total spent
|
|
12566
|
+
* @type {number}
|
|
12567
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12568
|
+
*/
|
|
12569
|
+
'total_spent'?: number;
|
|
12570
|
+
/**
|
|
12571
|
+
* Detailed usage metrics for ALL consumables
|
|
12572
|
+
* @type {DataTypesDetailedUsageMetrics}
|
|
12573
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12574
|
+
*/
|
|
12575
|
+
'usage_metrics'?: DataTypesDetailedUsageMetrics;
|
|
12576
|
+
/**
|
|
12577
|
+
* Usage summary for current period
|
|
12578
|
+
* @type {DataTypesUsageSummary}
|
|
12579
|
+
* @memberof DataTypesBillingOverviewNewResponse
|
|
12580
|
+
*/
|
|
12581
|
+
'usage_summary'?: DataTypesUsageSummary;
|
|
12582
|
+
}
|
|
12583
|
+
/**
|
|
12584
|
+
*
|
|
12585
|
+
* @export
|
|
12586
|
+
* @interface DataTypesBooleanFeatureMetric
|
|
12587
|
+
*/
|
|
12588
|
+
export interface DataTypesBooleanFeatureMetric {
|
|
12589
|
+
/**
|
|
12590
|
+
*
|
|
12591
|
+
* @type {string}
|
|
12592
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12593
|
+
*/
|
|
12594
|
+
'display_label'?: string;
|
|
12595
|
+
/**
|
|
12596
|
+
*
|
|
12597
|
+
* @type {boolean}
|
|
12598
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12599
|
+
*/
|
|
12600
|
+
'enabled'?: boolean;
|
|
12601
|
+
/**
|
|
12602
|
+
*
|
|
12603
|
+
* @type {string}
|
|
12604
|
+
* @memberof DataTypesBooleanFeatureMetric
|
|
12605
|
+
*/
|
|
12606
|
+
'feature_name'?: string;
|
|
12607
|
+
}
|
|
12529
12608
|
/**
|
|
12530
12609
|
*
|
|
12531
12610
|
* @export
|
|
@@ -13356,6 +13435,129 @@ export interface DataTypesConfigurationSchemaResponseWrapper {
|
|
|
13356
13435
|
*/
|
|
13357
13436
|
'status'?: number;
|
|
13358
13437
|
}
|
|
13438
|
+
/**
|
|
13439
|
+
*
|
|
13440
|
+
* @export
|
|
13441
|
+
* @interface DataTypesConsumableMetric
|
|
13442
|
+
*/
|
|
13443
|
+
export interface DataTypesConsumableMetric {
|
|
13444
|
+
/**
|
|
13445
|
+
*
|
|
13446
|
+
* @type {number}
|
|
13447
|
+
* @memberof DataTypesConsumableMetric
|
|
13448
|
+
*/
|
|
13449
|
+
'current_usage'?: number;
|
|
13450
|
+
/**
|
|
13451
|
+
*
|
|
13452
|
+
* @type {string}
|
|
13453
|
+
* @memberof DataTypesConsumableMetric
|
|
13454
|
+
*/
|
|
13455
|
+
'description'?: string;
|
|
13456
|
+
/**
|
|
13457
|
+
*
|
|
13458
|
+
* @type {string}
|
|
13459
|
+
* @memberof DataTypesConsumableMetric
|
|
13460
|
+
*/
|
|
13461
|
+
'display_label'?: string;
|
|
13462
|
+
/**
|
|
13463
|
+
*
|
|
13464
|
+
* @type {string}
|
|
13465
|
+
* @memberof DataTypesConsumableMetric
|
|
13466
|
+
*/
|
|
13467
|
+
'feature_name'?: string;
|
|
13468
|
+
/**
|
|
13469
|
+
*
|
|
13470
|
+
* @type {boolean}
|
|
13471
|
+
* @memberof DataTypesConsumableMetric
|
|
13472
|
+
*/
|
|
13473
|
+
'is_unlimited'?: boolean;
|
|
13474
|
+
/**
|
|
13475
|
+
*
|
|
13476
|
+
* @type {number}
|
|
13477
|
+
* @memberof DataTypesConsumableMetric
|
|
13478
|
+
*/
|
|
13479
|
+
'limit'?: number;
|
|
13480
|
+
/**
|
|
13481
|
+
*
|
|
13482
|
+
* @type {string}
|
|
13483
|
+
* @memberof DataTypesConsumableMetric
|
|
13484
|
+
*/
|
|
13485
|
+
'next_reset'?: string;
|
|
13486
|
+
/**
|
|
13487
|
+
*
|
|
13488
|
+
* @type {number}
|
|
13489
|
+
* @memberof DataTypesConsumableMetric
|
|
13490
|
+
*/
|
|
13491
|
+
'remaining'?: number;
|
|
13492
|
+
/**
|
|
13493
|
+
* \"monthly\", \"never\", etc.
|
|
13494
|
+
* @type {string}
|
|
13495
|
+
* @memberof DataTypesConsumableMetric
|
|
13496
|
+
*/
|
|
13497
|
+
'reset_period'?: string;
|
|
13498
|
+
/**
|
|
13499
|
+
*
|
|
13500
|
+
* @type {number}
|
|
13501
|
+
* @memberof DataTypesConsumableMetric
|
|
13502
|
+
*/
|
|
13503
|
+
'usage_percentage'?: number;
|
|
13504
|
+
/**
|
|
13505
|
+
* \"normal\", \"warning\", \"critical\"
|
|
13506
|
+
* @type {string}
|
|
13507
|
+
* @memberof DataTypesConsumableMetric
|
|
13508
|
+
*/
|
|
13509
|
+
'warning_level'?: string;
|
|
13510
|
+
}
|
|
13511
|
+
/**
|
|
13512
|
+
*
|
|
13513
|
+
* @export
|
|
13514
|
+
* @interface DataTypesConsumptionHistoryResponse
|
|
13515
|
+
*/
|
|
13516
|
+
export interface DataTypesConsumptionHistoryResponse {
|
|
13517
|
+
/**
|
|
13518
|
+
*
|
|
13519
|
+
* @type {Array<DataTypesCreditConsumption>}
|
|
13520
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13521
|
+
*/
|
|
13522
|
+
'consumptions'?: Array<DataTypesCreditConsumption>;
|
|
13523
|
+
/**
|
|
13524
|
+
*
|
|
13525
|
+
* @type {DataTypesPaginationInfo}
|
|
13526
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13527
|
+
*/
|
|
13528
|
+
'pagination'?: DataTypesPaginationInfo;
|
|
13529
|
+
/**
|
|
13530
|
+
*
|
|
13531
|
+
* @type {DataTypesConsumptionSummary}
|
|
13532
|
+
* @memberof DataTypesConsumptionHistoryResponse
|
|
13533
|
+
*/
|
|
13534
|
+
'summary'?: DataTypesConsumptionSummary;
|
|
13535
|
+
}
|
|
13536
|
+
/**
|
|
13537
|
+
*
|
|
13538
|
+
* @export
|
|
13539
|
+
* @interface DataTypesConsumptionSummary
|
|
13540
|
+
*/
|
|
13541
|
+
export interface DataTypesConsumptionSummary {
|
|
13542
|
+
/**
|
|
13543
|
+
*
|
|
13544
|
+
* @type {number}
|
|
13545
|
+
* @memberof DataTypesConsumptionSummary
|
|
13546
|
+
*/
|
|
13547
|
+
'total_consumptions'?: number;
|
|
13548
|
+
/**
|
|
13549
|
+
*
|
|
13550
|
+
* @type {number}
|
|
13551
|
+
* @memberof DataTypesConsumptionSummary
|
|
13552
|
+
*/
|
|
13553
|
+
'total_credits_used'?: number;
|
|
13554
|
+
/**
|
|
13555
|
+
*
|
|
13556
|
+
* @type {number}
|
|
13557
|
+
* @memberof DataTypesConsumptionSummary
|
|
13558
|
+
*/
|
|
13559
|
+
'unique_endpoints'?: number;
|
|
13560
|
+
}
|
|
13359
13561
|
/**
|
|
13360
13562
|
* Request payload for creating a new analytics rule
|
|
13361
13563
|
* @export
|
|
@@ -14634,6 +14836,142 @@ export interface DataTypesCreditAdjustmentDto {
|
|
|
14634
14836
|
*/
|
|
14635
14837
|
'status'?: string;
|
|
14636
14838
|
}
|
|
14839
|
+
/**
|
|
14840
|
+
*
|
|
14841
|
+
* @export
|
|
14842
|
+
* @interface DataTypesCreditBalanceInfo
|
|
14843
|
+
*/
|
|
14844
|
+
export interface DataTypesCreditBalanceInfo {
|
|
14845
|
+
/**
|
|
14846
|
+
*
|
|
14847
|
+
* @type {number}
|
|
14848
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14849
|
+
*/
|
|
14850
|
+
'subscription_credits_available'?: number;
|
|
14851
|
+
/**
|
|
14852
|
+
*
|
|
14853
|
+
* @type {number}
|
|
14854
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14855
|
+
*/
|
|
14856
|
+
'subscription_credits_consumed'?: number;
|
|
14857
|
+
/**
|
|
14858
|
+
*
|
|
14859
|
+
* @type {number}
|
|
14860
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14861
|
+
*/
|
|
14862
|
+
'subscription_credits_total'?: number;
|
|
14863
|
+
/**
|
|
14864
|
+
*
|
|
14865
|
+
* @type {number}
|
|
14866
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14867
|
+
*/
|
|
14868
|
+
'topup_credits_available'?: number;
|
|
14869
|
+
/**
|
|
14870
|
+
*
|
|
14871
|
+
* @type {number}
|
|
14872
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14873
|
+
*/
|
|
14874
|
+
'topup_credits_consumed'?: number;
|
|
14875
|
+
/**
|
|
14876
|
+
*
|
|
14877
|
+
* @type {number}
|
|
14878
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14879
|
+
*/
|
|
14880
|
+
'topup_credits_total'?: number;
|
|
14881
|
+
/**
|
|
14882
|
+
*
|
|
14883
|
+
* @type {number}
|
|
14884
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14885
|
+
*/
|
|
14886
|
+
'total_consumed_this_cycle'?: number;
|
|
14887
|
+
/**
|
|
14888
|
+
*
|
|
14889
|
+
* @type {number}
|
|
14890
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
14891
|
+
*/
|
|
14892
|
+
'total_credits'?: number;
|
|
14893
|
+
}
|
|
14894
|
+
/**
|
|
14895
|
+
*
|
|
14896
|
+
* @export
|
|
14897
|
+
* @interface DataTypesCreditConsumption
|
|
14898
|
+
*/
|
|
14899
|
+
export interface DataTypesCreditConsumption {
|
|
14900
|
+
/**
|
|
14901
|
+
*
|
|
14902
|
+
* @type {string}
|
|
14903
|
+
* @memberof DataTypesCreditConsumption
|
|
14904
|
+
*/
|
|
14905
|
+
'api_endpoint'?: string;
|
|
14906
|
+
/**
|
|
14907
|
+
*
|
|
14908
|
+
* @type {string}
|
|
14909
|
+
* @memberof DataTypesCreditConsumption
|
|
14910
|
+
*/
|
|
14911
|
+
'consumed_at'?: string;
|
|
14912
|
+
/**
|
|
14913
|
+
*
|
|
14914
|
+
* @type {number}
|
|
14915
|
+
* @memberof DataTypesCreditConsumption
|
|
14916
|
+
*/
|
|
14917
|
+
'consumption_id'?: number;
|
|
14918
|
+
/**
|
|
14919
|
+
*
|
|
14920
|
+
* @type {string}
|
|
14921
|
+
* @memberof DataTypesCreditConsumption
|
|
14922
|
+
*/
|
|
14923
|
+
'credit_source'?: string;
|
|
14924
|
+
/**
|
|
14925
|
+
*
|
|
14926
|
+
* @type {number}
|
|
14927
|
+
* @memberof DataTypesCreditConsumption
|
|
14928
|
+
*/
|
|
14929
|
+
'credits_consumed'?: number;
|
|
14930
|
+
/**
|
|
14931
|
+
*
|
|
14932
|
+
* @type {number}
|
|
14933
|
+
* @memberof DataTypesCreditConsumption
|
|
14934
|
+
*/
|
|
14935
|
+
'execution_time_ms'?: number;
|
|
14936
|
+
/**
|
|
14937
|
+
*
|
|
14938
|
+
* @type {{ [key: string]: any; }}
|
|
14939
|
+
* @memberof DataTypesCreditConsumption
|
|
14940
|
+
*/
|
|
14941
|
+
'fifo_details'?: {
|
|
14942
|
+
[key: string]: any;
|
|
14943
|
+
};
|
|
14944
|
+
/**
|
|
14945
|
+
*
|
|
14946
|
+
* @type {string}
|
|
14947
|
+
* @memberof DataTypesCreditConsumption
|
|
14948
|
+
*/
|
|
14949
|
+
'http_method'?: string;
|
|
14950
|
+
/**
|
|
14951
|
+
*
|
|
14952
|
+
* @type {number}
|
|
14953
|
+
* @memberof DataTypesCreditConsumption
|
|
14954
|
+
*/
|
|
14955
|
+
'org_id'?: number;
|
|
14956
|
+
/**
|
|
14957
|
+
*
|
|
14958
|
+
* @type {string}
|
|
14959
|
+
* @memberof DataTypesCreditConsumption
|
|
14960
|
+
*/
|
|
14961
|
+
'request_id'?: string;
|
|
14962
|
+
/**
|
|
14963
|
+
*
|
|
14964
|
+
* @type {number}
|
|
14965
|
+
* @memberof DataTypesCreditConsumption
|
|
14966
|
+
*/
|
|
14967
|
+
'response_status'?: number;
|
|
14968
|
+
/**
|
|
14969
|
+
*
|
|
14970
|
+
* @type {number}
|
|
14971
|
+
* @memberof DataTypesCreditConsumption
|
|
14972
|
+
*/
|
|
14973
|
+
'store_id'?: number;
|
|
14974
|
+
}
|
|
14637
14975
|
/**
|
|
14638
14976
|
*
|
|
14639
14977
|
* @export
|
|
@@ -14733,7 +15071,7 @@ export interface DataTypesCreditPlan {
|
|
|
14733
15071
|
*/
|
|
14734
15072
|
'price': number;
|
|
14735
15073
|
/**
|
|
14736
|
-
*
|
|
15074
|
+
* Deprecated: kept for DB compat, ignored
|
|
14737
15075
|
* @type {number}
|
|
14738
15076
|
* @memberof DataTypesCreditPlan
|
|
14739
15077
|
*/
|
|
@@ -15377,6 +15715,139 @@ export interface DataTypesDefaultMenu {
|
|
|
15377
15715
|
*/
|
|
15378
15716
|
'sortOrder'?: number;
|
|
15379
15717
|
}
|
|
15718
|
+
/**
|
|
15719
|
+
*
|
|
15720
|
+
* @export
|
|
15721
|
+
* @interface DataTypesDetailedUsageMetrics
|
|
15722
|
+
*/
|
|
15723
|
+
export interface DataTypesDetailedUsageMetrics {
|
|
15724
|
+
/**
|
|
15725
|
+
* Analytics
|
|
15726
|
+
* @type {DataTypesConsumableMetric}
|
|
15727
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15728
|
+
*/
|
|
15729
|
+
'analytics_events'?: DataTypesConsumableMetric;
|
|
15730
|
+
/**
|
|
15731
|
+
*
|
|
15732
|
+
* @type {DataTypesConsumableMetric}
|
|
15733
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15734
|
+
*/
|
|
15735
|
+
'analytics_events_total'?: DataTypesConsumableMetric;
|
|
15736
|
+
/**
|
|
15737
|
+
*
|
|
15738
|
+
* @type {DataTypesConsumableMetric}
|
|
15739
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15740
|
+
*/
|
|
15741
|
+
'analytics_history'?: DataTypesConsumableMetric;
|
|
15742
|
+
/**
|
|
15743
|
+
*
|
|
15744
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15745
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15746
|
+
*/
|
|
15747
|
+
'api_access'?: DataTypesBooleanFeatureMetric;
|
|
15748
|
+
/**
|
|
15749
|
+
*
|
|
15750
|
+
* @type {DataTypesConsumableMetric}
|
|
15751
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15752
|
+
*/
|
|
15753
|
+
'api_calls'?: DataTypesConsumableMetric;
|
|
15754
|
+
/**
|
|
15755
|
+
* Credits and API
|
|
15756
|
+
* @type {DataTypesConsumableMetric}
|
|
15757
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15758
|
+
*/
|
|
15759
|
+
'credits'?: DataTypesConsumableMetric;
|
|
15760
|
+
/**
|
|
15761
|
+
*
|
|
15762
|
+
* @type {DataTypesConsumableMetric}
|
|
15763
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15764
|
+
*/
|
|
15765
|
+
'credits_used'?: DataTypesConsumableMetric;
|
|
15766
|
+
/**
|
|
15767
|
+
* Boolean features
|
|
15768
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15769
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15770
|
+
*/
|
|
15771
|
+
'custom_domain'?: DataTypesBooleanFeatureMetric;
|
|
15772
|
+
/**
|
|
15773
|
+
*
|
|
15774
|
+
* @type {DataTypesConsumableMetric}
|
|
15775
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15776
|
+
*/
|
|
15777
|
+
'query_suggestions'?: DataTypesConsumableMetric;
|
|
15778
|
+
/**
|
|
15779
|
+
*
|
|
15780
|
+
* @type {DataTypesConsumableMetric}
|
|
15781
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15782
|
+
*/
|
|
15783
|
+
'record_size'?: DataTypesConsumableMetric;
|
|
15784
|
+
/**
|
|
15785
|
+
* Records/Documents
|
|
15786
|
+
* @type {DataTypesConsumableMetric}
|
|
15787
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15788
|
+
*/
|
|
15789
|
+
'records'?: DataTypesConsumableMetric;
|
|
15790
|
+
/**
|
|
15791
|
+
*
|
|
15792
|
+
* @type {DataTypesStringFeatureMetric}
|
|
15793
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15794
|
+
*/
|
|
15795
|
+
'reports'?: DataTypesStringFeatureMetric;
|
|
15796
|
+
/**
|
|
15797
|
+
*
|
|
15798
|
+
* @type {DataTypesConsumableMetric}
|
|
15799
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15800
|
+
*/
|
|
15801
|
+
'rules'?: DataTypesConsumableMetric;
|
|
15802
|
+
/**
|
|
15803
|
+
* Search features
|
|
15804
|
+
* @type {DataTypesConsumableMetric}
|
|
15805
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15806
|
+
*/
|
|
15807
|
+
'search_requests'?: DataTypesConsumableMetric;
|
|
15808
|
+
/**
|
|
15809
|
+
*
|
|
15810
|
+
* @type {DataTypesConsumableMetric}
|
|
15811
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15812
|
+
*/
|
|
15813
|
+
'stopwords'?: DataTypesConsumableMetric;
|
|
15814
|
+
/**
|
|
15815
|
+
* Store-related
|
|
15816
|
+
* @type {DataTypesConsumableMetric}
|
|
15817
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15818
|
+
*/
|
|
15819
|
+
'stores'?: DataTypesConsumableMetric;
|
|
15820
|
+
/**
|
|
15821
|
+
* String features
|
|
15822
|
+
* @type {DataTypesStringFeatureMetric}
|
|
15823
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15824
|
+
*/
|
|
15825
|
+
'support_level'?: DataTypesStringFeatureMetric;
|
|
15826
|
+
/**
|
|
15827
|
+
*
|
|
15828
|
+
* @type {DataTypesConsumableMetric}
|
|
15829
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15830
|
+
*/
|
|
15831
|
+
'synonyms'?: DataTypesConsumableMetric;
|
|
15832
|
+
/**
|
|
15833
|
+
* Team
|
|
15834
|
+
* @type {DataTypesConsumableMetric}
|
|
15835
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15836
|
+
*/
|
|
15837
|
+
'team_members'?: DataTypesConsumableMetric;
|
|
15838
|
+
/**
|
|
15839
|
+
*
|
|
15840
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15841
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15842
|
+
*/
|
|
15843
|
+
'webhooks'?: DataTypesBooleanFeatureMetric;
|
|
15844
|
+
/**
|
|
15845
|
+
*
|
|
15846
|
+
* @type {DataTypesBooleanFeatureMetric}
|
|
15847
|
+
* @memberof DataTypesDetailedUsageMetrics
|
|
15848
|
+
*/
|
|
15849
|
+
'white_labeling'?: DataTypesBooleanFeatureMetric;
|
|
15850
|
+
}
|
|
15380
15851
|
/**
|
|
15381
15852
|
*
|
|
15382
15853
|
* @export
|
|
@@ -18061,6 +18532,56 @@ export interface DataTypesGenericResponseDataTypesBillingOrderDetailsResponse {
|
|
|
18061
18532
|
*/
|
|
18062
18533
|
'status'?: number;
|
|
18063
18534
|
}
|
|
18535
|
+
/**
|
|
18536
|
+
*
|
|
18537
|
+
* @export
|
|
18538
|
+
* @interface DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18539
|
+
*/
|
|
18540
|
+
export interface DataTypesGenericResponseDataTypesBillingOverviewNewResponse {
|
|
18541
|
+
/**
|
|
18542
|
+
*
|
|
18543
|
+
* @type {DataTypesBillingOverviewNewResponse}
|
|
18544
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18545
|
+
*/
|
|
18546
|
+
'data'?: DataTypesBillingOverviewNewResponse;
|
|
18547
|
+
/**
|
|
18548
|
+
*
|
|
18549
|
+
* @type {string}
|
|
18550
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18551
|
+
*/
|
|
18552
|
+
'message'?: string;
|
|
18553
|
+
/**
|
|
18554
|
+
*
|
|
18555
|
+
* @type {number}
|
|
18556
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewNewResponse
|
|
18557
|
+
*/
|
|
18558
|
+
'status'?: number;
|
|
18559
|
+
}
|
|
18560
|
+
/**
|
|
18561
|
+
*
|
|
18562
|
+
* @export
|
|
18563
|
+
* @interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18564
|
+
*/
|
|
18565
|
+
export interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse {
|
|
18566
|
+
/**
|
|
18567
|
+
*
|
|
18568
|
+
* @type {DataTypesConsumptionHistoryResponse}
|
|
18569
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18570
|
+
*/
|
|
18571
|
+
'data'?: DataTypesConsumptionHistoryResponse;
|
|
18572
|
+
/**
|
|
18573
|
+
*
|
|
18574
|
+
* @type {string}
|
|
18575
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18576
|
+
*/
|
|
18577
|
+
'message'?: string;
|
|
18578
|
+
/**
|
|
18579
|
+
*
|
|
18580
|
+
* @type {number}
|
|
18581
|
+
* @memberof DataTypesGenericResponseDataTypesConsumptionHistoryResponse
|
|
18582
|
+
*/
|
|
18583
|
+
'status'?: number;
|
|
18584
|
+
}
|
|
18064
18585
|
/**
|
|
18065
18586
|
*
|
|
18066
18587
|
* @export
|
|
@@ -21563,6 +22084,43 @@ export interface DataTypesNewsLetterRequestsListResponse {
|
|
|
21563
22084
|
*/
|
|
21564
22085
|
'status'?: number;
|
|
21565
22086
|
}
|
|
22087
|
+
/**
|
|
22088
|
+
*
|
|
22089
|
+
* @export
|
|
22090
|
+
* @interface DataTypesNextChargeInfo
|
|
22091
|
+
*/
|
|
22092
|
+
export interface DataTypesNextChargeInfo {
|
|
22093
|
+
/**
|
|
22094
|
+
*
|
|
22095
|
+
* @type {number}
|
|
22096
|
+
* @memberof DataTypesNextChargeInfo
|
|
22097
|
+
*/
|
|
22098
|
+
'amount'?: number;
|
|
22099
|
+
/**
|
|
22100
|
+
*
|
|
22101
|
+
* @type {string}
|
|
22102
|
+
* @memberof DataTypesNextChargeInfo
|
|
22103
|
+
*/
|
|
22104
|
+
'charge_date'?: string;
|
|
22105
|
+
/**
|
|
22106
|
+
*
|
|
22107
|
+
* @type {string}
|
|
22108
|
+
* @memberof DataTypesNextChargeInfo
|
|
22109
|
+
*/
|
|
22110
|
+
'currency'?: string;
|
|
22111
|
+
/**
|
|
22112
|
+
*
|
|
22113
|
+
* @type {string}
|
|
22114
|
+
* @memberof DataTypesNextChargeInfo
|
|
22115
|
+
*/
|
|
22116
|
+
'description'?: string;
|
|
22117
|
+
/**
|
|
22118
|
+
*
|
|
22119
|
+
* @type {number}
|
|
22120
|
+
* @memberof DataTypesNextChargeInfo
|
|
22121
|
+
*/
|
|
22122
|
+
'subscription_id'?: number;
|
|
22123
|
+
}
|
|
21566
22124
|
/**
|
|
21567
22125
|
*
|
|
21568
22126
|
* @export
|
|
@@ -24120,6 +24678,37 @@ export interface DataTypesOverrideActions {
|
|
|
24120
24678
|
*/
|
|
24121
24679
|
'stop_processing'?: boolean;
|
|
24122
24680
|
}
|
|
24681
|
+
/**
|
|
24682
|
+
*
|
|
24683
|
+
* @export
|
|
24684
|
+
* @interface DataTypesPaginationInfo
|
|
24685
|
+
*/
|
|
24686
|
+
export interface DataTypesPaginationInfo {
|
|
24687
|
+
/**
|
|
24688
|
+
*
|
|
24689
|
+
* @type {number}
|
|
24690
|
+
* @memberof DataTypesPaginationInfo
|
|
24691
|
+
*/
|
|
24692
|
+
'limit'?: number;
|
|
24693
|
+
/**
|
|
24694
|
+
*
|
|
24695
|
+
* @type {number}
|
|
24696
|
+
* @memberof DataTypesPaginationInfo
|
|
24697
|
+
*/
|
|
24698
|
+
'page'?: number;
|
|
24699
|
+
/**
|
|
24700
|
+
*
|
|
24701
|
+
* @type {number}
|
|
24702
|
+
* @memberof DataTypesPaginationInfo
|
|
24703
|
+
*/
|
|
24704
|
+
'total'?: number;
|
|
24705
|
+
/**
|
|
24706
|
+
*
|
|
24707
|
+
* @type {number}
|
|
24708
|
+
* @memberof DataTypesPaginationInfo
|
|
24709
|
+
*/
|
|
24710
|
+
'total_pages'?: number;
|
|
24711
|
+
}
|
|
24123
24712
|
/**
|
|
24124
24713
|
*
|
|
24125
24714
|
* @export
|
|
@@ -25136,6 +25725,37 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
25136
25725
|
*/
|
|
25137
25726
|
'status'?: number;
|
|
25138
25727
|
}
|
|
25728
|
+
/**
|
|
25729
|
+
*
|
|
25730
|
+
* @export
|
|
25731
|
+
* @interface DataTypesProjectedRunoutInfo
|
|
25732
|
+
*/
|
|
25733
|
+
export interface DataTypesProjectedRunoutInfo {
|
|
25734
|
+
/**
|
|
25735
|
+
*
|
|
25736
|
+
* @type {number}
|
|
25737
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25738
|
+
*/
|
|
25739
|
+
'average_daily_consumption'?: number;
|
|
25740
|
+
/**
|
|
25741
|
+
*
|
|
25742
|
+
* @type {number}
|
|
25743
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25744
|
+
*/
|
|
25745
|
+
'days_remaining'?: number;
|
|
25746
|
+
/**
|
|
25747
|
+
*
|
|
25748
|
+
* @type {string}
|
|
25749
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25750
|
+
*/
|
|
25751
|
+
'projected_runout_date'?: string;
|
|
25752
|
+
/**
|
|
25753
|
+
* \"normal\", \"warning\", \"critical\"
|
|
25754
|
+
* @type {string}
|
|
25755
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
25756
|
+
*/
|
|
25757
|
+
'warning_level'?: string;
|
|
25758
|
+
}
|
|
25139
25759
|
/**
|
|
25140
25760
|
*
|
|
25141
25761
|
* @export
|
|
@@ -28755,6 +29375,31 @@ export interface DataTypesStoresListResponse {
|
|
|
28755
29375
|
*/
|
|
28756
29376
|
'status'?: number;
|
|
28757
29377
|
}
|
|
29378
|
+
/**
|
|
29379
|
+
*
|
|
29380
|
+
* @export
|
|
29381
|
+
* @interface DataTypesStringFeatureMetric
|
|
29382
|
+
*/
|
|
29383
|
+
export interface DataTypesStringFeatureMetric {
|
|
29384
|
+
/**
|
|
29385
|
+
*
|
|
29386
|
+
* @type {string}
|
|
29387
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29388
|
+
*/
|
|
29389
|
+
'display_label'?: string;
|
|
29390
|
+
/**
|
|
29391
|
+
*
|
|
29392
|
+
* @type {string}
|
|
29393
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29394
|
+
*/
|
|
29395
|
+
'feature_name'?: string;
|
|
29396
|
+
/**
|
|
29397
|
+
*
|
|
29398
|
+
* @type {string}
|
|
29399
|
+
* @memberof DataTypesStringFeatureMetric
|
|
29400
|
+
*/
|
|
29401
|
+
'value'?: string;
|
|
29402
|
+
}
|
|
28758
29403
|
/**
|
|
28759
29404
|
*
|
|
28760
29405
|
* @export
|
|
@@ -30994,6 +31639,43 @@ export interface DataTypesUsageBreakdownRow {
|
|
|
30994
31639
|
*/
|
|
30995
31640
|
'timestamp'?: string;
|
|
30996
31641
|
}
|
|
31642
|
+
/**
|
|
31643
|
+
*
|
|
31644
|
+
* @export
|
|
31645
|
+
* @interface DataTypesUsageSummary
|
|
31646
|
+
*/
|
|
31647
|
+
export interface DataTypesUsageSummary {
|
|
31648
|
+
/**
|
|
31649
|
+
* \"This month\", \"Last 30 days\", etc.
|
|
31650
|
+
* @type {string}
|
|
31651
|
+
* @memberof DataTypesUsageSummary
|
|
31652
|
+
*/
|
|
31653
|
+
'period'?: string;
|
|
31654
|
+
/**
|
|
31655
|
+
*
|
|
31656
|
+
* @type {number}
|
|
31657
|
+
* @memberof DataTypesUsageSummary
|
|
31658
|
+
*/
|
|
31659
|
+
'records'?: number;
|
|
31660
|
+
/**
|
|
31661
|
+
*
|
|
31662
|
+
* @type {number}
|
|
31663
|
+
* @memberof DataTypesUsageSummary
|
|
31664
|
+
*/
|
|
31665
|
+
'search_requests'?: number;
|
|
31666
|
+
/**
|
|
31667
|
+
*
|
|
31668
|
+
* @type {number}
|
|
31669
|
+
* @memberof DataTypesUsageSummary
|
|
31670
|
+
*/
|
|
31671
|
+
'store_count'?: number;
|
|
31672
|
+
/**
|
|
31673
|
+
*
|
|
31674
|
+
* @type {number}
|
|
31675
|
+
* @memberof DataTypesUsageSummary
|
|
31676
|
+
*/
|
|
31677
|
+
'total_credits_used'?: number;
|
|
31678
|
+
}
|
|
30997
31679
|
/**
|
|
30998
31680
|
*
|
|
30999
31681
|
* @export
|
|
@@ -32215,43 +32897,67 @@ export interface FeatureLimitServiceAPICallStatus {
|
|
|
32215
32897
|
*/
|
|
32216
32898
|
export interface FeatureLimitServiceCreditStatus {
|
|
32217
32899
|
/**
|
|
32218
|
-
*
|
|
32900
|
+
* Remaining in THIS cycle (total - consumed_this_cycle)
|
|
32219
32901
|
* @type {number}
|
|
32220
32902
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32221
32903
|
*/
|
|
32222
32904
|
'available'?: number;
|
|
32223
32905
|
/**
|
|
32224
|
-
*
|
|
32906
|
+
* Credits consumed in THIS billing cycle
|
|
32225
32907
|
* @type {number}
|
|
32226
32908
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32227
32909
|
*/
|
|
32228
|
-
'
|
|
32910
|
+
'consumed_this_cycle'?: number;
|
|
32229
32911
|
/**
|
|
32230
|
-
*
|
|
32231
|
-
* @type {
|
|
32912
|
+
* Billing cycle end date
|
|
32913
|
+
* @type {string}
|
|
32232
32914
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32233
32915
|
*/
|
|
32234
|
-
'
|
|
32916
|
+
'cycle_end'?: string;
|
|
32235
32917
|
/**
|
|
32236
|
-
*
|
|
32918
|
+
* Billing cycle start date
|
|
32237
32919
|
* @type {string}
|
|
32238
32920
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32239
32921
|
*/
|
|
32240
|
-
'
|
|
32922
|
+
'cycle_start'?: string;
|
|
32241
32923
|
/**
|
|
32242
|
-
*
|
|
32924
|
+
* True if actual balance (subscription + topup) <= 0
|
|
32243
32925
|
* @type {boolean}
|
|
32244
32926
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32245
32927
|
*/
|
|
32246
32928
|
'is_exhausted'?: boolean;
|
|
32247
32929
|
/**
|
|
32248
|
-
*
|
|
32930
|
+
* All-time consumed credits
|
|
32931
|
+
* @type {number}
|
|
32932
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32933
|
+
*/
|
|
32934
|
+
'lifetime_consumed'?: number;
|
|
32935
|
+
/**
|
|
32936
|
+
* All-time purchased credits
|
|
32937
|
+
* @type {number}
|
|
32938
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32939
|
+
*/
|
|
32940
|
+
'lifetime_purchased'?: number;
|
|
32941
|
+
/**
|
|
32942
|
+
* Actual subscription balance (includes rollover across cycles)
|
|
32943
|
+
* @type {number}
|
|
32944
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32945
|
+
*/
|
|
32946
|
+
'subscription_available'?: number;
|
|
32947
|
+
/**
|
|
32948
|
+
* Actual top-up balance (purchased credits, never expire)
|
|
32949
|
+
* @type {number}
|
|
32950
|
+
* @memberof FeatureLimitServiceCreditStatus
|
|
32951
|
+
*/
|
|
32952
|
+
'topup_available'?: number;
|
|
32953
|
+
/**
|
|
32954
|
+
* THIS cycle\'s allocated credits (e.g., 1,600,000/month)
|
|
32249
32955
|
* @type {number}
|
|
32250
32956
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32251
32957
|
*/
|
|
32252
32958
|
'total'?: number;
|
|
32253
32959
|
/**
|
|
32254
|
-
*
|
|
32960
|
+
* consumed_this_cycle / total * 100
|
|
32255
32961
|
* @type {number}
|
|
32256
32962
|
* @memberof FeatureLimitServiceCreditStatus
|
|
32257
32963
|
*/
|
|
@@ -44686,7 +45392,7 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
44686
45392
|
* @param {*} [options] Override http request option.
|
|
44687
45393
|
* @throws {RequiredError}
|
|
44688
45394
|
*/
|
|
44689
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45395
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewNewResponse>>;
|
|
44690
45396
|
/**
|
|
44691
45397
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
44692
45398
|
* @summary Get payment transactions
|
|
@@ -45080,7 +45786,7 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
45080
45786
|
* @param {*} [options] Override http request option.
|
|
45081
45787
|
* @throws {RequiredError}
|
|
45082
45788
|
*/
|
|
45083
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45789
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewNewResponse>;
|
|
45084
45790
|
/**
|
|
45085
45791
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
45086
45792
|
* @summary Get payment transactions
|
|
@@ -45502,7 +46208,7 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
45502
46208
|
* @throws {RequiredError}
|
|
45503
46209
|
* @memberof BillingDashboardApi
|
|
45504
46210
|
*/
|
|
45505
|
-
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
46211
|
+
adminBillingOverviewNewGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingOverviewNewResponse, any, {}>>;
|
|
45506
46212
|
/**
|
|
45507
46213
|
* Retrieves paginated list of payment transactions with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
45508
46214
|
* @summary Get payment transactions
|
|
@@ -47253,7 +47959,7 @@ export declare const CreditsApiFp: (configuration?: Configuration) => {
|
|
|
47253
47959
|
* @param {*} [options] Override http request option.
|
|
47254
47960
|
* @throws {RequiredError}
|
|
47255
47961
|
*/
|
|
47256
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
47962
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesConsumptionHistoryResponse>>;
|
|
47257
47963
|
/**
|
|
47258
47964
|
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47259
47965
|
* @summary Get available credit plans
|
|
@@ -47338,7 +48044,7 @@ export declare const CreditsApiFactory: (configuration?: Configuration, basePath
|
|
|
47338
48044
|
* @param {*} [options] Override http request option.
|
|
47339
48045
|
* @throws {RequiredError}
|
|
47340
48046
|
*/
|
|
47341
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
48047
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesConsumptionHistoryResponse>;
|
|
47342
48048
|
/**
|
|
47343
48049
|
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47344
48050
|
* @summary Get available credit plans
|
|
@@ -47431,7 +48137,7 @@ export declare class CreditsApi extends BaseAPI {
|
|
|
47431
48137
|
* @throws {RequiredError}
|
|
47432
48138
|
* @memberof CreditsApi
|
|
47433
48139
|
*/
|
|
47434
|
-
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
48140
|
+
creditsConsumptionHistoryGet(page?: number, limit?: number, endpoint?: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesConsumptionHistoryResponse, any, {}>>;
|
|
47435
48141
|
/**
|
|
47436
48142
|
* Returns all active credit plans with pricing and features. No authentication required. Use when displaying plan options to users (e.g. pricing page).
|
|
47437
48143
|
* @summary Get available credit plans
|