@seekora-ai/admin-api 1.0.76 → 1.0.78
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 -2
- package/api.ts +1457 -117
- package/dist/api.d.ts +1045 -32
- package/dist/api.js +608 -28
- package/dist/esm/api.d.ts +1045 -32
- package/dist/esm/api.js +603 -23
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.78.tgz +0 -0
- package/seekora-ai-admin-api-1.0.76.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -8340,6 +8340,178 @@ export interface DataTypesAutocompleteSuggestion {
|
|
|
8340
8340
|
*/
|
|
8341
8341
|
'text'?: string;
|
|
8342
8342
|
}
|
|
8343
|
+
/**
|
|
8344
|
+
*
|
|
8345
|
+
* @export
|
|
8346
|
+
* @interface DataTypesBillingAlert
|
|
8347
|
+
*/
|
|
8348
|
+
export interface DataTypesBillingAlert {
|
|
8349
|
+
/**
|
|
8350
|
+
*
|
|
8351
|
+
* @type {number}
|
|
8352
|
+
* @memberof DataTypesBillingAlert
|
|
8353
|
+
*/
|
|
8354
|
+
'alert_id'?: number;
|
|
8355
|
+
/**
|
|
8356
|
+
*
|
|
8357
|
+
* @type {string}
|
|
8358
|
+
* @memberof DataTypesBillingAlert
|
|
8359
|
+
*/
|
|
8360
|
+
'alert_type'?: string;
|
|
8361
|
+
/**
|
|
8362
|
+
*
|
|
8363
|
+
* @type {string}
|
|
8364
|
+
* @memberof DataTypesBillingAlert
|
|
8365
|
+
*/
|
|
8366
|
+
'created_at'?: string;
|
|
8367
|
+
/**
|
|
8368
|
+
*
|
|
8369
|
+
* @type {number}
|
|
8370
|
+
* @memberof DataTypesBillingAlert
|
|
8371
|
+
*/
|
|
8372
|
+
'created_by'?: number;
|
|
8373
|
+
/**
|
|
8374
|
+
*
|
|
8375
|
+
* @type {boolean}
|
|
8376
|
+
* @memberof DataTypesBillingAlert
|
|
8377
|
+
*/
|
|
8378
|
+
'is_enabled'?: boolean;
|
|
8379
|
+
/**
|
|
8380
|
+
*
|
|
8381
|
+
* @type {string}
|
|
8382
|
+
* @memberof DataTypesBillingAlert
|
|
8383
|
+
*/
|
|
8384
|
+
'last_triggered'?: string;
|
|
8385
|
+
/**
|
|
8386
|
+
*
|
|
8387
|
+
* @type {Array<string>}
|
|
8388
|
+
* @memberof DataTypesBillingAlert
|
|
8389
|
+
*/
|
|
8390
|
+
'notification_channels'?: Array<string>;
|
|
8391
|
+
/**
|
|
8392
|
+
*
|
|
8393
|
+
* @type {number}
|
|
8394
|
+
* @memberof DataTypesBillingAlert
|
|
8395
|
+
*/
|
|
8396
|
+
'org_id'?: number;
|
|
8397
|
+
/**
|
|
8398
|
+
* \"credits\", \"days\", \"percentage\"
|
|
8399
|
+
* @type {string}
|
|
8400
|
+
* @memberof DataTypesBillingAlert
|
|
8401
|
+
*/
|
|
8402
|
+
'threshold_unit'?: string;
|
|
8403
|
+
/**
|
|
8404
|
+
*
|
|
8405
|
+
* @type {number}
|
|
8406
|
+
* @memberof DataTypesBillingAlert
|
|
8407
|
+
*/
|
|
8408
|
+
'threshold_value'?: number;
|
|
8409
|
+
/**
|
|
8410
|
+
*
|
|
8411
|
+
* @type {string}
|
|
8412
|
+
* @memberof DataTypesBillingAlert
|
|
8413
|
+
*/
|
|
8414
|
+
'updated_at'?: string;
|
|
8415
|
+
}
|
|
8416
|
+
/**
|
|
8417
|
+
*
|
|
8418
|
+
* @export
|
|
8419
|
+
* @interface DataTypesBillingAlertRequest
|
|
8420
|
+
*/
|
|
8421
|
+
export interface DataTypesBillingAlertRequest {
|
|
8422
|
+
/**
|
|
8423
|
+
*
|
|
8424
|
+
* @type {string}
|
|
8425
|
+
* @memberof DataTypesBillingAlertRequest
|
|
8426
|
+
*/
|
|
8427
|
+
'alert_type': DataTypesBillingAlertRequestAlertTypeEnum;
|
|
8428
|
+
/**
|
|
8429
|
+
*
|
|
8430
|
+
* @type {boolean}
|
|
8431
|
+
* @memberof DataTypesBillingAlertRequest
|
|
8432
|
+
*/
|
|
8433
|
+
'is_enabled'?: boolean;
|
|
8434
|
+
/**
|
|
8435
|
+
* \"email\", \"webhook\", \"in_app\"
|
|
8436
|
+
* @type {Array<string>}
|
|
8437
|
+
* @memberof DataTypesBillingAlertRequest
|
|
8438
|
+
*/
|
|
8439
|
+
'notification_channels': Array<string>;
|
|
8440
|
+
/**
|
|
8441
|
+
*
|
|
8442
|
+
* @type {number}
|
|
8443
|
+
* @memberof DataTypesBillingAlertRequest
|
|
8444
|
+
*/
|
|
8445
|
+
'threshold_value': number;
|
|
8446
|
+
}
|
|
8447
|
+
export declare const DataTypesBillingAlertRequestAlertTypeEnum: {
|
|
8448
|
+
readonly LowBalance: "low_balance";
|
|
8449
|
+
readonly ExpiringCredits: "expiring_credits";
|
|
8450
|
+
readonly DaysRemaining: "days_remaining";
|
|
8451
|
+
};
|
|
8452
|
+
export type DataTypesBillingAlertRequestAlertTypeEnum = typeof DataTypesBillingAlertRequestAlertTypeEnum[keyof typeof DataTypesBillingAlertRequestAlertTypeEnum];
|
|
8453
|
+
/**
|
|
8454
|
+
*
|
|
8455
|
+
* @export
|
|
8456
|
+
* @interface DataTypesBillingAlertsResponse
|
|
8457
|
+
*/
|
|
8458
|
+
export interface DataTypesBillingAlertsResponse {
|
|
8459
|
+
/**
|
|
8460
|
+
*
|
|
8461
|
+
* @type {Array<DataTypesBillingAlert>}
|
|
8462
|
+
* @memberof DataTypesBillingAlertsResponse
|
|
8463
|
+
*/
|
|
8464
|
+
'alerts'?: Array<DataTypesBillingAlert>;
|
|
8465
|
+
/**
|
|
8466
|
+
*
|
|
8467
|
+
* @type {number}
|
|
8468
|
+
* @memberof DataTypesBillingAlertsResponse
|
|
8469
|
+
*/
|
|
8470
|
+
'total'?: number;
|
|
8471
|
+
}
|
|
8472
|
+
/**
|
|
8473
|
+
*
|
|
8474
|
+
* @export
|
|
8475
|
+
* @interface DataTypesBillingOverviewResponse
|
|
8476
|
+
*/
|
|
8477
|
+
export interface DataTypesBillingOverviewResponse {
|
|
8478
|
+
/**
|
|
8479
|
+
* Credit Balance Information
|
|
8480
|
+
* @type {DataTypesCreditBalanceInfo}
|
|
8481
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8482
|
+
*/
|
|
8483
|
+
'credit_balance'?: DataTypesCreditBalanceInfo;
|
|
8484
|
+
/**
|
|
8485
|
+
*
|
|
8486
|
+
* @type {string}
|
|
8487
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8488
|
+
*/
|
|
8489
|
+
'currency'?: string;
|
|
8490
|
+
/**
|
|
8491
|
+
* Current Plan Information
|
|
8492
|
+
* @type {DataTypesCurrentPlanInfo}
|
|
8493
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8494
|
+
*/
|
|
8495
|
+
'current_plan'?: DataTypesCurrentPlanInfo;
|
|
8496
|
+
/**
|
|
8497
|
+
*
|
|
8498
|
+
* @type {DataTypesNextChargeInfo}
|
|
8499
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8500
|
+
*/
|
|
8501
|
+
'next_charge'?: DataTypesNextChargeInfo;
|
|
8502
|
+
/**
|
|
8503
|
+
* Projected Usage
|
|
8504
|
+
* @type {DataTypesProjectedRunoutInfo}
|
|
8505
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8506
|
+
*/
|
|
8507
|
+
'projected_runout'?: DataTypesProjectedRunoutInfo;
|
|
8508
|
+
/**
|
|
8509
|
+
* Summary Stats
|
|
8510
|
+
* @type {number}
|
|
8511
|
+
* @memberof DataTypesBillingOverviewResponse
|
|
8512
|
+
*/
|
|
8513
|
+
'total_spent'?: number;
|
|
8514
|
+
}
|
|
8343
8515
|
/**
|
|
8344
8516
|
*
|
|
8345
8517
|
* @export
|
|
@@ -9015,6 +9187,12 @@ export interface DataTypesCreatePaymentOrderRequest {
|
|
|
9015
9187
|
* @memberof DataTypesCreatePaymentOrderRequest
|
|
9016
9188
|
*/
|
|
9017
9189
|
'currency': string;
|
|
9190
|
+
/**
|
|
9191
|
+
* Existing Razorpay customer ID
|
|
9192
|
+
* @type {string}
|
|
9193
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
9194
|
+
*/
|
|
9195
|
+
'customer_id'?: string;
|
|
9018
9196
|
/**
|
|
9019
9197
|
*
|
|
9020
9198
|
* @type {DataTypesCustomerInfoDto}
|
|
@@ -9077,6 +9255,12 @@ export interface DataTypesCreatePaymentOrderRequest {
|
|
|
9077
9255
|
* @memberof DataTypesCreatePaymentOrderRequest
|
|
9078
9256
|
*/
|
|
9079
9257
|
'return_url'?: string;
|
|
9258
|
+
/**
|
|
9259
|
+
* Fields for card tokenization
|
|
9260
|
+
* @type {boolean}
|
|
9261
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
9262
|
+
*/
|
|
9263
|
+
'save_card'?: boolean;
|
|
9080
9264
|
/**
|
|
9081
9265
|
* Required for generic payments
|
|
9082
9266
|
* @type {number}
|
|
@@ -9114,6 +9298,12 @@ export interface DataTypesCreatePaymentOrderResponse {
|
|
|
9114
9298
|
* @memberof DataTypesCreatePaymentOrderResponse
|
|
9115
9299
|
*/
|
|
9116
9300
|
'currency'?: string;
|
|
9301
|
+
/**
|
|
9302
|
+
* Razorpay customer ID for tokenization
|
|
9303
|
+
* @type {string}
|
|
9304
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
9305
|
+
*/
|
|
9306
|
+
'customer_id'?: string;
|
|
9117
9307
|
/**
|
|
9118
9308
|
* Customer prefill data for frontend
|
|
9119
9309
|
* @type {{ [key: string]: any; }}
|
|
@@ -10004,6 +10194,31 @@ export interface DataTypesCreditBalance {
|
|
|
10004
10194
|
*/
|
|
10005
10195
|
'store_id'?: number;
|
|
10006
10196
|
}
|
|
10197
|
+
/**
|
|
10198
|
+
*
|
|
10199
|
+
* @export
|
|
10200
|
+
* @interface DataTypesCreditBalanceInfo
|
|
10201
|
+
*/
|
|
10202
|
+
export interface DataTypesCreditBalanceInfo {
|
|
10203
|
+
/**
|
|
10204
|
+
*
|
|
10205
|
+
* @type {string}
|
|
10206
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
10207
|
+
*/
|
|
10208
|
+
'earliest_expiry'?: string;
|
|
10209
|
+
/**
|
|
10210
|
+
*
|
|
10211
|
+
* @type {Array<DataTypesExpiringCreditBatch>}
|
|
10212
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
10213
|
+
*/
|
|
10214
|
+
'expiring_credits'?: Array<DataTypesExpiringCreditBatch>;
|
|
10215
|
+
/**
|
|
10216
|
+
*
|
|
10217
|
+
* @type {number}
|
|
10218
|
+
* @memberof DataTypesCreditBalanceInfo
|
|
10219
|
+
*/
|
|
10220
|
+
'total_credits'?: number;
|
|
10221
|
+
}
|
|
10007
10222
|
/**
|
|
10008
10223
|
*
|
|
10009
10224
|
* @export
|
|
@@ -10361,6 +10576,61 @@ export declare const DataTypesCreditTransactionTransactionTypeEnum: {
|
|
|
10361
10576
|
readonly Expire: "expire";
|
|
10362
10577
|
};
|
|
10363
10578
|
export type DataTypesCreditTransactionTransactionTypeEnum = typeof DataTypesCreditTransactionTransactionTypeEnum[keyof typeof DataTypesCreditTransactionTransactionTypeEnum];
|
|
10579
|
+
/**
|
|
10580
|
+
*
|
|
10581
|
+
* @export
|
|
10582
|
+
* @interface DataTypesCurrentPlanInfo
|
|
10583
|
+
*/
|
|
10584
|
+
export interface DataTypesCurrentPlanInfo {
|
|
10585
|
+
/**
|
|
10586
|
+
*
|
|
10587
|
+
* @type {boolean}
|
|
10588
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10589
|
+
*/
|
|
10590
|
+
'auto_renewal'?: boolean;
|
|
10591
|
+
/**
|
|
10592
|
+
* \"monthly\", \"annual\", \"one-time\"
|
|
10593
|
+
* @type {string}
|
|
10594
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10595
|
+
*/
|
|
10596
|
+
'billing_cycle'?: string;
|
|
10597
|
+
/**
|
|
10598
|
+
*
|
|
10599
|
+
* @type {string}
|
|
10600
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10601
|
+
*/
|
|
10602
|
+
'end_date'?: string;
|
|
10603
|
+
/**
|
|
10604
|
+
*
|
|
10605
|
+
* @type {number}
|
|
10606
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10607
|
+
*/
|
|
10608
|
+
'plan_id'?: number;
|
|
10609
|
+
/**
|
|
10610
|
+
*
|
|
10611
|
+
* @type {string}
|
|
10612
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10613
|
+
*/
|
|
10614
|
+
'plan_name'?: string;
|
|
10615
|
+
/**
|
|
10616
|
+
* \"subscription\" or \"credit\"
|
|
10617
|
+
* @type {string}
|
|
10618
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10619
|
+
*/
|
|
10620
|
+
'plan_type'?: string;
|
|
10621
|
+
/**
|
|
10622
|
+
*
|
|
10623
|
+
* @type {string}
|
|
10624
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10625
|
+
*/
|
|
10626
|
+
'start_date'?: string;
|
|
10627
|
+
/**
|
|
10628
|
+
* \"active\", \"cancelled\", \"expired\"
|
|
10629
|
+
* @type {string}
|
|
10630
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
10631
|
+
*/
|
|
10632
|
+
'status'?: string;
|
|
10633
|
+
}
|
|
10364
10634
|
/**
|
|
10365
10635
|
*
|
|
10366
10636
|
* @export
|
|
@@ -11157,6 +11427,49 @@ export interface DataTypesExpirationWarningDto {
|
|
|
11157
11427
|
*/
|
|
11158
11428
|
'recommended_action'?: string;
|
|
11159
11429
|
}
|
|
11430
|
+
/**
|
|
11431
|
+
*
|
|
11432
|
+
* @export
|
|
11433
|
+
* @interface DataTypesExpiringCreditBatch
|
|
11434
|
+
*/
|
|
11435
|
+
export interface DataTypesExpiringCreditBatch {
|
|
11436
|
+
/**
|
|
11437
|
+
*
|
|
11438
|
+
* @type {string}
|
|
11439
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11440
|
+
*/
|
|
11441
|
+
'credit_type'?: string;
|
|
11442
|
+
/**
|
|
11443
|
+
*
|
|
11444
|
+
* @type {number}
|
|
11445
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11446
|
+
*/
|
|
11447
|
+
'credits'?: number;
|
|
11448
|
+
/**
|
|
11449
|
+
*
|
|
11450
|
+
* @type {number}
|
|
11451
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11452
|
+
*/
|
|
11453
|
+
'days_until_expiry'?: number;
|
|
11454
|
+
/**
|
|
11455
|
+
*
|
|
11456
|
+
* @type {string}
|
|
11457
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11458
|
+
*/
|
|
11459
|
+
'expires_at'?: string;
|
|
11460
|
+
/**
|
|
11461
|
+
*
|
|
11462
|
+
* @type {number}
|
|
11463
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11464
|
+
*/
|
|
11465
|
+
'ledger_id'?: number;
|
|
11466
|
+
/**
|
|
11467
|
+
*
|
|
11468
|
+
* @type {string}
|
|
11469
|
+
* @memberof DataTypesExpiringCreditBatch
|
|
11470
|
+
*/
|
|
11471
|
+
'purchase_date'?: string;
|
|
11472
|
+
}
|
|
11160
11473
|
/**
|
|
11161
11474
|
*
|
|
11162
11475
|
* @export
|
|
@@ -11393,6 +11706,31 @@ export interface DataTypesGatewayListResponse {
|
|
|
11393
11706
|
*/
|
|
11394
11707
|
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
11395
11708
|
}
|
|
11709
|
+
/**
|
|
11710
|
+
*
|
|
11711
|
+
* @export
|
|
11712
|
+
* @interface DataTypesGenericResponseAny
|
|
11713
|
+
*/
|
|
11714
|
+
export interface DataTypesGenericResponseAny {
|
|
11715
|
+
/**
|
|
11716
|
+
*
|
|
11717
|
+
* @type {any}
|
|
11718
|
+
* @memberof DataTypesGenericResponseAny
|
|
11719
|
+
*/
|
|
11720
|
+
'data'?: any;
|
|
11721
|
+
/**
|
|
11722
|
+
*
|
|
11723
|
+
* @type {string}
|
|
11724
|
+
* @memberof DataTypesGenericResponseAny
|
|
11725
|
+
*/
|
|
11726
|
+
'message'?: string;
|
|
11727
|
+
/**
|
|
11728
|
+
*
|
|
11729
|
+
* @type {number}
|
|
11730
|
+
* @memberof DataTypesGenericResponseAny
|
|
11731
|
+
*/
|
|
11732
|
+
'status'?: number;
|
|
11733
|
+
}
|
|
11396
11734
|
/**
|
|
11397
11735
|
*
|
|
11398
11736
|
* @export
|
|
@@ -11643,6 +11981,81 @@ export interface DataTypesGenericResponseBillingServiceBillingOverview {
|
|
|
11643
11981
|
*/
|
|
11644
11982
|
'status'?: number;
|
|
11645
11983
|
}
|
|
11984
|
+
/**
|
|
11985
|
+
*
|
|
11986
|
+
* @export
|
|
11987
|
+
* @interface DataTypesGenericResponseDataTypesBillingAlert
|
|
11988
|
+
*/
|
|
11989
|
+
export interface DataTypesGenericResponseDataTypesBillingAlert {
|
|
11990
|
+
/**
|
|
11991
|
+
*
|
|
11992
|
+
* @type {DataTypesBillingAlert}
|
|
11993
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlert
|
|
11994
|
+
*/
|
|
11995
|
+
'data'?: DataTypesBillingAlert;
|
|
11996
|
+
/**
|
|
11997
|
+
*
|
|
11998
|
+
* @type {string}
|
|
11999
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlert
|
|
12000
|
+
*/
|
|
12001
|
+
'message'?: string;
|
|
12002
|
+
/**
|
|
12003
|
+
*
|
|
12004
|
+
* @type {number}
|
|
12005
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlert
|
|
12006
|
+
*/
|
|
12007
|
+
'status'?: number;
|
|
12008
|
+
}
|
|
12009
|
+
/**
|
|
12010
|
+
*
|
|
12011
|
+
* @export
|
|
12012
|
+
* @interface DataTypesGenericResponseDataTypesBillingAlertsResponse
|
|
12013
|
+
*/
|
|
12014
|
+
export interface DataTypesGenericResponseDataTypesBillingAlertsResponse {
|
|
12015
|
+
/**
|
|
12016
|
+
*
|
|
12017
|
+
* @type {DataTypesBillingAlertsResponse}
|
|
12018
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlertsResponse
|
|
12019
|
+
*/
|
|
12020
|
+
'data'?: DataTypesBillingAlertsResponse;
|
|
12021
|
+
/**
|
|
12022
|
+
*
|
|
12023
|
+
* @type {string}
|
|
12024
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlertsResponse
|
|
12025
|
+
*/
|
|
12026
|
+
'message'?: string;
|
|
12027
|
+
/**
|
|
12028
|
+
*
|
|
12029
|
+
* @type {number}
|
|
12030
|
+
* @memberof DataTypesGenericResponseDataTypesBillingAlertsResponse
|
|
12031
|
+
*/
|
|
12032
|
+
'status'?: number;
|
|
12033
|
+
}
|
|
12034
|
+
/**
|
|
12035
|
+
*
|
|
12036
|
+
* @export
|
|
12037
|
+
* @interface DataTypesGenericResponseDataTypesBillingOverviewResponse
|
|
12038
|
+
*/
|
|
12039
|
+
export interface DataTypesGenericResponseDataTypesBillingOverviewResponse {
|
|
12040
|
+
/**
|
|
12041
|
+
*
|
|
12042
|
+
* @type {DataTypesBillingOverviewResponse}
|
|
12043
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewResponse
|
|
12044
|
+
*/
|
|
12045
|
+
'data'?: DataTypesBillingOverviewResponse;
|
|
12046
|
+
/**
|
|
12047
|
+
*
|
|
12048
|
+
* @type {string}
|
|
12049
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewResponse
|
|
12050
|
+
*/
|
|
12051
|
+
'message'?: string;
|
|
12052
|
+
/**
|
|
12053
|
+
*
|
|
12054
|
+
* @type {number}
|
|
12055
|
+
* @memberof DataTypesGenericResponseDataTypesBillingOverviewResponse
|
|
12056
|
+
*/
|
|
12057
|
+
'status'?: number;
|
|
12058
|
+
}
|
|
11646
12059
|
/**
|
|
11647
12060
|
*
|
|
11648
12061
|
* @export
|
|
@@ -11943,6 +12356,31 @@ export interface DataTypesGenericResponseDataTypesRegenerateXStoreSecretResponse
|
|
|
11943
12356
|
*/
|
|
11944
12357
|
'status'?: number;
|
|
11945
12358
|
}
|
|
12359
|
+
/**
|
|
12360
|
+
*
|
|
12361
|
+
* @export
|
|
12362
|
+
* @interface DataTypesGenericResponseDataTypesSavedCardsResponse
|
|
12363
|
+
*/
|
|
12364
|
+
export interface DataTypesGenericResponseDataTypesSavedCardsResponse {
|
|
12365
|
+
/**
|
|
12366
|
+
*
|
|
12367
|
+
* @type {DataTypesSavedCardsResponse}
|
|
12368
|
+
* @memberof DataTypesGenericResponseDataTypesSavedCardsResponse
|
|
12369
|
+
*/
|
|
12370
|
+
'data'?: DataTypesSavedCardsResponse;
|
|
12371
|
+
/**
|
|
12372
|
+
*
|
|
12373
|
+
* @type {string}
|
|
12374
|
+
* @memberof DataTypesGenericResponseDataTypesSavedCardsResponse
|
|
12375
|
+
*/
|
|
12376
|
+
'message'?: string;
|
|
12377
|
+
/**
|
|
12378
|
+
*
|
|
12379
|
+
* @type {number}
|
|
12380
|
+
* @memberof DataTypesGenericResponseDataTypesSavedCardsResponse
|
|
12381
|
+
*/
|
|
12382
|
+
'status'?: number;
|
|
12383
|
+
}
|
|
11946
12384
|
/**
|
|
11947
12385
|
*
|
|
11948
12386
|
* @export
|
|
@@ -13549,6 +13987,43 @@ export interface DataTypesNewsLetterRequestsListResponse {
|
|
|
13549
13987
|
*/
|
|
13550
13988
|
'status'?: number;
|
|
13551
13989
|
}
|
|
13990
|
+
/**
|
|
13991
|
+
*
|
|
13992
|
+
* @export
|
|
13993
|
+
* @interface DataTypesNextChargeInfo
|
|
13994
|
+
*/
|
|
13995
|
+
export interface DataTypesNextChargeInfo {
|
|
13996
|
+
/**
|
|
13997
|
+
*
|
|
13998
|
+
* @type {number}
|
|
13999
|
+
* @memberof DataTypesNextChargeInfo
|
|
14000
|
+
*/
|
|
14001
|
+
'amount'?: number;
|
|
14002
|
+
/**
|
|
14003
|
+
*
|
|
14004
|
+
* @type {string}
|
|
14005
|
+
* @memberof DataTypesNextChargeInfo
|
|
14006
|
+
*/
|
|
14007
|
+
'charge_date'?: string;
|
|
14008
|
+
/**
|
|
14009
|
+
*
|
|
14010
|
+
* @type {string}
|
|
14011
|
+
* @memberof DataTypesNextChargeInfo
|
|
14012
|
+
*/
|
|
14013
|
+
'currency'?: string;
|
|
14014
|
+
/**
|
|
14015
|
+
*
|
|
14016
|
+
* @type {string}
|
|
14017
|
+
* @memberof DataTypesNextChargeInfo
|
|
14018
|
+
*/
|
|
14019
|
+
'description'?: string;
|
|
14020
|
+
/**
|
|
14021
|
+
*
|
|
14022
|
+
* @type {number}
|
|
14023
|
+
* @memberof DataTypesNextChargeInfo
|
|
14024
|
+
*/
|
|
14025
|
+
'subscription_id'?: number;
|
|
14026
|
+
}
|
|
13552
14027
|
/**
|
|
13553
14028
|
*
|
|
13554
14029
|
* @export
|
|
@@ -13729,6 +14204,12 @@ export interface DataTypesOnboardingResponse {
|
|
|
13729
14204
|
* @memberof DataTypesOnboardingResponse
|
|
13730
14205
|
*/
|
|
13731
14206
|
'jobId'?: string;
|
|
14207
|
+
/**
|
|
14208
|
+
* Organization ID (available after orgDetails step)
|
|
14209
|
+
* @type {number}
|
|
14210
|
+
* @memberof DataTypesOnboardingResponse
|
|
14211
|
+
*/
|
|
14212
|
+
'orgId'?: number;
|
|
13732
14213
|
/**
|
|
13733
14214
|
*
|
|
13734
14215
|
* @type {{ [key: string]: any; }}
|
|
@@ -15034,6 +15515,37 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
15034
15515
|
*/
|
|
15035
15516
|
'status'?: number;
|
|
15036
15517
|
}
|
|
15518
|
+
/**
|
|
15519
|
+
*
|
|
15520
|
+
* @export
|
|
15521
|
+
* @interface DataTypesProjectedRunoutInfo
|
|
15522
|
+
*/
|
|
15523
|
+
export interface DataTypesProjectedRunoutInfo {
|
|
15524
|
+
/**
|
|
15525
|
+
*
|
|
15526
|
+
* @type {number}
|
|
15527
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
15528
|
+
*/
|
|
15529
|
+
'average_daily_consumption'?: number;
|
|
15530
|
+
/**
|
|
15531
|
+
*
|
|
15532
|
+
* @type {number}
|
|
15533
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
15534
|
+
*/
|
|
15535
|
+
'days_remaining'?: number;
|
|
15536
|
+
/**
|
|
15537
|
+
*
|
|
15538
|
+
* @type {string}
|
|
15539
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
15540
|
+
*/
|
|
15541
|
+
'projected_runout_date'?: string;
|
|
15542
|
+
/**
|
|
15543
|
+
* \"critical\", \"warning\", \"normal\"
|
|
15544
|
+
* @type {string}
|
|
15545
|
+
* @memberof DataTypesProjectedRunoutInfo
|
|
15546
|
+
*/
|
|
15547
|
+
'warning_level'?: string;
|
|
15548
|
+
}
|
|
15037
15549
|
/**
|
|
15038
15550
|
*
|
|
15039
15551
|
* @export
|
|
@@ -16477,35 +16989,141 @@ export interface DataTypesSampleDatasetResponse {
|
|
|
16477
16989
|
'storeName'?: string;
|
|
16478
16990
|
/**
|
|
16479
16991
|
*
|
|
16480
|
-
* @type {Array<string>}
|
|
16481
|
-
* @memberof DataTypesSampleDatasetResponse
|
|
16992
|
+
* @type {Array<string>}
|
|
16993
|
+
* @memberof DataTypesSampleDatasetResponse
|
|
16994
|
+
*/
|
|
16995
|
+
'tags'?: Array<string>;
|
|
16996
|
+
}
|
|
16997
|
+
/**
|
|
16998
|
+
*
|
|
16999
|
+
* @export
|
|
17000
|
+
* @interface DataTypesSampleDatasetsResponseWrapper
|
|
17001
|
+
*/
|
|
17002
|
+
export interface DataTypesSampleDatasetsResponseWrapper {
|
|
17003
|
+
/**
|
|
17004
|
+
*
|
|
17005
|
+
* @type {Array<DataTypesSampleDatasetResponse>}
|
|
17006
|
+
* @memberof DataTypesSampleDatasetsResponseWrapper
|
|
17007
|
+
*/
|
|
17008
|
+
'data'?: Array<DataTypesSampleDatasetResponse>;
|
|
17009
|
+
/**
|
|
17010
|
+
*
|
|
17011
|
+
* @type {string}
|
|
17012
|
+
* @memberof DataTypesSampleDatasetsResponseWrapper
|
|
17013
|
+
*/
|
|
17014
|
+
'message'?: string;
|
|
17015
|
+
/**
|
|
17016
|
+
*
|
|
17017
|
+
* @type {number}
|
|
17018
|
+
* @memberof DataTypesSampleDatasetsResponseWrapper
|
|
17019
|
+
*/
|
|
17020
|
+
'status'?: number;
|
|
17021
|
+
}
|
|
17022
|
+
/**
|
|
17023
|
+
*
|
|
17024
|
+
* @export
|
|
17025
|
+
* @interface DataTypesSavedCard
|
|
17026
|
+
*/
|
|
17027
|
+
export interface DataTypesSavedCard {
|
|
17028
|
+
/**
|
|
17029
|
+
* \"Visa\", \"Mastercard\", etc.
|
|
17030
|
+
* @type {string}
|
|
17031
|
+
* @memberof DataTypesSavedCard
|
|
17032
|
+
*/
|
|
17033
|
+
'card_network'?: string;
|
|
17034
|
+
/**
|
|
17035
|
+
* Masked, e.g., \"XXXX XXXX XXXX 1234\"
|
|
17036
|
+
* @type {string}
|
|
17037
|
+
* @memberof DataTypesSavedCard
|
|
17038
|
+
*/
|
|
17039
|
+
'card_number'?: string;
|
|
17040
|
+
/**
|
|
17041
|
+
* \"credit\", \"debit\"
|
|
17042
|
+
* @type {string}
|
|
17043
|
+
* @memberof DataTypesSavedCard
|
|
17044
|
+
*/
|
|
17045
|
+
'card_type'?: string;
|
|
17046
|
+
/**
|
|
17047
|
+
*
|
|
17048
|
+
* @type {string}
|
|
17049
|
+
* @memberof DataTypesSavedCard
|
|
17050
|
+
*/
|
|
17051
|
+
'created_at'?: string;
|
|
17052
|
+
/**
|
|
17053
|
+
*
|
|
17054
|
+
* @type {string}
|
|
17055
|
+
* @memberof DataTypesSavedCard
|
|
17056
|
+
*/
|
|
17057
|
+
'expiry_month'?: string;
|
|
17058
|
+
/**
|
|
17059
|
+
*
|
|
17060
|
+
* @type {string}
|
|
17061
|
+
* @memberof DataTypesSavedCard
|
|
17062
|
+
*/
|
|
17063
|
+
'expiry_year'?: string;
|
|
17064
|
+
/**
|
|
17065
|
+
*
|
|
17066
|
+
* @type {boolean}
|
|
17067
|
+
* @memberof DataTypesSavedCard
|
|
17068
|
+
*/
|
|
17069
|
+
'is_default'?: boolean;
|
|
17070
|
+
/**
|
|
17071
|
+
*
|
|
17072
|
+
* @type {boolean}
|
|
17073
|
+
* @memberof DataTypesSavedCard
|
|
17074
|
+
*/
|
|
17075
|
+
'is_expired'?: boolean;
|
|
17076
|
+
/**
|
|
17077
|
+
*
|
|
17078
|
+
* @type {string}
|
|
17079
|
+
* @memberof DataTypesSavedCard
|
|
17080
|
+
*/
|
|
17081
|
+
'issuer'?: string;
|
|
17082
|
+
/**
|
|
17083
|
+
*
|
|
17084
|
+
* @type {string}
|
|
17085
|
+
* @memberof DataTypesSavedCard
|
|
17086
|
+
*/
|
|
17087
|
+
'last_used_at'?: string;
|
|
17088
|
+
/**
|
|
17089
|
+
*
|
|
17090
|
+
* @type {{ [key: string]: any; }}
|
|
17091
|
+
* @memberof DataTypesSavedCard
|
|
17092
|
+
*/
|
|
17093
|
+
'metadata'?: {
|
|
17094
|
+
[key: string]: any;
|
|
17095
|
+
};
|
|
17096
|
+
/**
|
|
17097
|
+
*
|
|
17098
|
+
* @type {string}
|
|
17099
|
+
* @memberof DataTypesSavedCard
|
|
16482
17100
|
*/
|
|
16483
|
-
'
|
|
17101
|
+
'token_id'?: string;
|
|
16484
17102
|
}
|
|
16485
17103
|
/**
|
|
16486
17104
|
*
|
|
16487
17105
|
* @export
|
|
16488
|
-
* @interface
|
|
17106
|
+
* @interface DataTypesSavedCardsResponse
|
|
16489
17107
|
*/
|
|
16490
|
-
export interface
|
|
17108
|
+
export interface DataTypesSavedCardsResponse {
|
|
16491
17109
|
/**
|
|
16492
17110
|
*
|
|
16493
|
-
* @type {Array<
|
|
16494
|
-
* @memberof
|
|
17111
|
+
* @type {Array<DataTypesSavedCard>}
|
|
17112
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16495
17113
|
*/
|
|
16496
|
-
'
|
|
17114
|
+
'cards'?: Array<DataTypesSavedCard>;
|
|
16497
17115
|
/**
|
|
16498
17116
|
*
|
|
16499
17117
|
* @type {string}
|
|
16500
|
-
* @memberof
|
|
17118
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16501
17119
|
*/
|
|
16502
|
-
'
|
|
17120
|
+
'customer_id'?: string;
|
|
16503
17121
|
/**
|
|
16504
17122
|
*
|
|
16505
17123
|
* @type {number}
|
|
16506
|
-
* @memberof
|
|
17124
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16507
17125
|
*/
|
|
16508
|
-
'
|
|
17126
|
+
'total_cards'?: number;
|
|
16509
17127
|
}
|
|
16510
17128
|
/**
|
|
16511
17129
|
*
|
|
@@ -16675,6 +17293,121 @@ export interface DataTypesSearchResultResponse {
|
|
|
16675
17293
|
*/
|
|
16676
17294
|
'status'?: number;
|
|
16677
17295
|
}
|
|
17296
|
+
/**
|
|
17297
|
+
* Individual item from Typesense collection that can be pinned/hidden in rules (same structure as admin search API)
|
|
17298
|
+
* @export
|
|
17299
|
+
* @interface DataTypesSearchRuleItem
|
|
17300
|
+
*/
|
|
17301
|
+
export interface DataTypesSearchRuleItem {
|
|
17302
|
+
/**
|
|
17303
|
+
* Full document data for reference
|
|
17304
|
+
* @type {{ [key: string]: any; }}
|
|
17305
|
+
* @memberof DataTypesSearchRuleItem
|
|
17306
|
+
*/
|
|
17307
|
+
'document'?: {
|
|
17308
|
+
[key: string]: any;
|
|
17309
|
+
};
|
|
17310
|
+
/**
|
|
17311
|
+
* Search highlights
|
|
17312
|
+
* @type {{ [key: string]: any; }}
|
|
17313
|
+
* @memberof DataTypesSearchRuleItem
|
|
17314
|
+
*/
|
|
17315
|
+
'highlight'?: {
|
|
17316
|
+
[key: string]: any;
|
|
17317
|
+
};
|
|
17318
|
+
/**
|
|
17319
|
+
* Document ID (required for pin/hide)
|
|
17320
|
+
* @type {string}
|
|
17321
|
+
* @memberof DataTypesSearchRuleItem
|
|
17322
|
+
*/
|
|
17323
|
+
'id'?: string;
|
|
17324
|
+
/**
|
|
17325
|
+
* Relevance score
|
|
17326
|
+
* @type {number}
|
|
17327
|
+
* @memberof DataTypesSearchRuleItem
|
|
17328
|
+
*/
|
|
17329
|
+
'score'?: number;
|
|
17330
|
+
/**
|
|
17331
|
+
* Widget display data (same as admin search API)
|
|
17332
|
+
* @type {DataTypesWidgetSearchResult}
|
|
17333
|
+
* @memberof DataTypesSearchRuleItem
|
|
17334
|
+
*/
|
|
17335
|
+
'widget'?: DataTypesWidgetSearchResult;
|
|
17336
|
+
}
|
|
17337
|
+
/**
|
|
17338
|
+
* Request parameters for searching items in the store\'s Typesense collection
|
|
17339
|
+
* @export
|
|
17340
|
+
* @interface DataTypesSearchRuleItemsRequest
|
|
17341
|
+
*/
|
|
17342
|
+
export interface DataTypesSearchRuleItemsRequest {
|
|
17343
|
+
/**
|
|
17344
|
+
* Optional Typesense filter
|
|
17345
|
+
* @type {string}
|
|
17346
|
+
* @memberof DataTypesSearchRuleItemsRequest
|
|
17347
|
+
*/
|
|
17348
|
+
'filter'?: string;
|
|
17349
|
+
/**
|
|
17350
|
+
* Page number (default: 1)
|
|
17351
|
+
* @type {number}
|
|
17352
|
+
* @memberof DataTypesSearchRuleItemsRequest
|
|
17353
|
+
*/
|
|
17354
|
+
'page'?: number;
|
|
17355
|
+
/**
|
|
17356
|
+
* Results per page (default: 20, max: 100)
|
|
17357
|
+
* @type {number}
|
|
17358
|
+
* @memberof DataTypesSearchRuleItemsRequest
|
|
17359
|
+
*/
|
|
17360
|
+
'per_page'?: number;
|
|
17361
|
+
/**
|
|
17362
|
+
* Search query
|
|
17363
|
+
* @type {string}
|
|
17364
|
+
* @memberof DataTypesSearchRuleItemsRequest
|
|
17365
|
+
*/
|
|
17366
|
+
'query': string;
|
|
17367
|
+
}
|
|
17368
|
+
/**
|
|
17369
|
+
* Response containing searchable items from the collection with pagination
|
|
17370
|
+
* @export
|
|
17371
|
+
* @interface DataTypesSearchRuleItemsResponse
|
|
17372
|
+
*/
|
|
17373
|
+
export interface DataTypesSearchRuleItemsResponse {
|
|
17374
|
+
/**
|
|
17375
|
+
*
|
|
17376
|
+
* @type {Array<DataTypesSearchRuleItem>}
|
|
17377
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17378
|
+
*/
|
|
17379
|
+
'items'?: Array<DataTypesSearchRuleItem>;
|
|
17380
|
+
/**
|
|
17381
|
+
*
|
|
17382
|
+
* @type {number}
|
|
17383
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17384
|
+
*/
|
|
17385
|
+
'page'?: number;
|
|
17386
|
+
/**
|
|
17387
|
+
*
|
|
17388
|
+
* @type {number}
|
|
17389
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17390
|
+
*/
|
|
17391
|
+
'per_page'?: number;
|
|
17392
|
+
/**
|
|
17393
|
+
* Fields searched (for reference)
|
|
17394
|
+
* @type {Array<string>}
|
|
17395
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17396
|
+
*/
|
|
17397
|
+
'query_by'?: Array<string>;
|
|
17398
|
+
/**
|
|
17399
|
+
* Total matching documents
|
|
17400
|
+
* @type {number}
|
|
17401
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17402
|
+
*/
|
|
17403
|
+
'total_found'?: number;
|
|
17404
|
+
/**
|
|
17405
|
+
*
|
|
17406
|
+
* @type {number}
|
|
17407
|
+
* @memberof DataTypesSearchRuleItemsResponse
|
|
17408
|
+
*/
|
|
17409
|
+
'total_pages'?: number;
|
|
17410
|
+
}
|
|
16678
17411
|
/**
|
|
16679
17412
|
*
|
|
16680
17413
|
* @export
|
|
@@ -22326,6 +23059,26 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22326
23059
|
* @throws {RequiredError}
|
|
22327
23060
|
*/
|
|
22328
23061
|
apiAdminV1AnalyticsRulesSyncPost: (authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23062
|
+
/**
|
|
23063
|
+
* Retrieve a specific item by its ID from the Typesense collection. Useful for fetching details of items already in rules or for direct item selection by ID. Uses Redis caching for fast performance.
|
|
23064
|
+
* @summary Get Item by ID for Rule Management
|
|
23065
|
+
* @param {string} authorization Bearer JWT token
|
|
23066
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23067
|
+
* @param {string} itemId Item ID to retrieve
|
|
23068
|
+
* @param {*} [options] Override http request option.
|
|
23069
|
+
* @throws {RequiredError}
|
|
23070
|
+
*/
|
|
23071
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet: (authorization: string, xStoreID: string, itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23072
|
+
/**
|
|
23073
|
+
* Search through all items in the store\'s Typesense collection to find items that can be pinned or hidden in rules. Searches across ALL searchable attributes by analyzing Typesense schema. Uses Redis caching for fast performance (same as admin search API).
|
|
23074
|
+
* @summary Search Items for Rule Management
|
|
23075
|
+
* @param {string} authorization Bearer JWT token
|
|
23076
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23077
|
+
* @param {DataTypesSearchRuleItemsRequest} dataTypesSearchRuleItemsRequest Search parameters (query, page, per_page, filter)
|
|
23078
|
+
* @param {*} [options] Override http request option.
|
|
23079
|
+
* @throws {RequiredError}
|
|
23080
|
+
*/
|
|
23081
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesSearchItemsPost: (authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22329
23082
|
/**
|
|
22330
23083
|
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
22331
23084
|
* @summary List Analytics Rules
|
|
@@ -22468,6 +23221,26 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22468
23221
|
* @throws {RequiredError}
|
|
22469
23222
|
*/
|
|
22470
23223
|
apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleSyncResponse>>;
|
|
23224
|
+
/**
|
|
23225
|
+
* Retrieve a specific item by its ID from the Typesense collection. Useful for fetching details of items already in rules or for direct item selection by ID. Uses Redis caching for fast performance.
|
|
23226
|
+
* @summary Get Item by ID for Rule Management
|
|
23227
|
+
* @param {string} authorization Bearer JWT token
|
|
23228
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23229
|
+
* @param {string} itemId Item ID to retrieve
|
|
23230
|
+
* @param {*} [options] Override http request option.
|
|
23231
|
+
* @throws {RequiredError}
|
|
23232
|
+
*/
|
|
23233
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(authorization: string, xStoreID: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchRuleItem>>;
|
|
23234
|
+
/**
|
|
23235
|
+
* Search through all items in the store\'s Typesense collection to find items that can be pinned or hidden in rules. Searches across ALL searchable attributes by analyzing Typesense schema. Uses Redis caching for fast performance (same as admin search API).
|
|
23236
|
+
* @summary Search Items for Rule Management
|
|
23237
|
+
* @param {string} authorization Bearer JWT token
|
|
23238
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23239
|
+
* @param {DataTypesSearchRuleItemsRequest} dataTypesSearchRuleItemsRequest Search parameters (query, page, per_page, filter)
|
|
23240
|
+
* @param {*} [options] Override http request option.
|
|
23241
|
+
* @throws {RequiredError}
|
|
23242
|
+
*/
|
|
23243
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchRuleItemsResponse>>;
|
|
22471
23244
|
/**
|
|
22472
23245
|
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
22473
23246
|
* @summary List Analytics Rules
|
|
@@ -22612,6 +23385,26 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22612
23385
|
* @throws {RequiredError}
|
|
22613
23386
|
*/
|
|
22614
23387
|
apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleSyncResponse>;
|
|
23388
|
+
/**
|
|
23389
|
+
* Retrieve a specific item by its ID from the Typesense collection. Useful for fetching details of items already in rules or for direct item selection by ID. Uses Redis caching for fast performance.
|
|
23390
|
+
* @summary Get Item by ID for Rule Management
|
|
23391
|
+
* @param {string} authorization Bearer JWT token
|
|
23392
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23393
|
+
* @param {string} itemId Item ID to retrieve
|
|
23394
|
+
* @param {*} [options] Override http request option.
|
|
23395
|
+
* @throws {RequiredError}
|
|
23396
|
+
*/
|
|
23397
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(authorization: string, xStoreID: string, itemId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchRuleItem>;
|
|
23398
|
+
/**
|
|
23399
|
+
* Search through all items in the store\'s Typesense collection to find items that can be pinned or hidden in rules. Searches across ALL searchable attributes by analyzing Typesense schema. Uses Redis caching for fast performance (same as admin search API).
|
|
23400
|
+
* @summary Search Items for Rule Management
|
|
23401
|
+
* @param {string} authorization Bearer JWT token
|
|
23402
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23403
|
+
* @param {DataTypesSearchRuleItemsRequest} dataTypesSearchRuleItemsRequest Search parameters (query, page, per_page, filter)
|
|
23404
|
+
* @param {*} [options] Override http request option.
|
|
23405
|
+
* @throws {RequiredError}
|
|
23406
|
+
*/
|
|
23407
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchRuleItemsResponse>;
|
|
22615
23408
|
/**
|
|
22616
23409
|
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
22617
23410
|
* @summary List Analytics Rules
|
|
@@ -22764,6 +23557,28 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22764
23557
|
* @memberof AnalyticsRulesApi
|
|
22765
23558
|
*/
|
|
22766
23559
|
apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleSyncResponse, any, {}>>;
|
|
23560
|
+
/**
|
|
23561
|
+
* Retrieve a specific item by its ID from the Typesense collection. Useful for fetching details of items already in rules or for direct item selection by ID. Uses Redis caching for fast performance.
|
|
23562
|
+
* @summary Get Item by ID for Rule Management
|
|
23563
|
+
* @param {string} authorization Bearer JWT token
|
|
23564
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23565
|
+
* @param {string} itemId Item ID to retrieve
|
|
23566
|
+
* @param {*} [options] Override http request option.
|
|
23567
|
+
* @throws {RequiredError}
|
|
23568
|
+
* @memberof AnalyticsRulesApi
|
|
23569
|
+
*/
|
|
23570
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(authorization: string, xStoreID: string, itemId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchRuleItem, any, {}>>;
|
|
23571
|
+
/**
|
|
23572
|
+
* Search through all items in the store\'s Typesense collection to find items that can be pinned or hidden in rules. Searches across ALL searchable attributes by analyzing Typesense schema. Uses Redis caching for fast performance (same as admin search API).
|
|
23573
|
+
* @summary Search Items for Rule Management
|
|
23574
|
+
* @param {string} authorization Bearer JWT token
|
|
23575
|
+
* @param {string} xStoreID X-Store ID (same format as admin search API)
|
|
23576
|
+
* @param {DataTypesSearchRuleItemsRequest} dataTypesSearchRuleItemsRequest Search parameters (query, page, per_page, filter)
|
|
23577
|
+
* @param {*} [options] Override http request option.
|
|
23578
|
+
* @throws {RequiredError}
|
|
23579
|
+
* @memberof AnalyticsRulesApi
|
|
23580
|
+
*/
|
|
23581
|
+
apiAdminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchRuleItemsResponse, any, {}>>;
|
|
22767
23582
|
/**
|
|
22768
23583
|
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
22769
23584
|
* @summary List Analytics Rules
|
|
@@ -23248,18 +24063,52 @@ export declare class AutomatedRefundManagementApi extends BaseAPI {
|
|
|
23248
24063
|
* @export
|
|
23249
24064
|
*/
|
|
23250
24065
|
export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24066
|
+
/**
|
|
24067
|
+
* Returns all billing alerts configured for the organization
|
|
24068
|
+
* @summary Get billing alerts
|
|
24069
|
+
* @param {*} [options] Override http request option.
|
|
24070
|
+
* @throws {RequiredError}
|
|
24071
|
+
*/
|
|
24072
|
+
adminBillingAlertsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24073
|
+
/**
|
|
24074
|
+
* Deletes a billing alert configuration
|
|
24075
|
+
* @summary Delete billing alert
|
|
24076
|
+
* @param {number} id Alert ID
|
|
24077
|
+
* @param {*} [options] Override http request option.
|
|
24078
|
+
* @throws {RequiredError}
|
|
24079
|
+
*/
|
|
24080
|
+
adminBillingAlertsIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24081
|
+
/**
|
|
24082
|
+
* Updates an existing billing alert configuration
|
|
24083
|
+
* @summary Update billing alert
|
|
24084
|
+
* @param {number} id Alert ID
|
|
24085
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Updated alert configuration
|
|
24086
|
+
* @param {*} [options] Override http request option.
|
|
24087
|
+
* @throws {RequiredError}
|
|
24088
|
+
*/
|
|
24089
|
+
adminBillingAlertsIdPut: (id: number, dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24090
|
+
/**
|
|
24091
|
+
* Creates a new billing alert configuration for the organization
|
|
24092
|
+
* @summary Create billing alert
|
|
24093
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Alert configuration
|
|
24094
|
+
* @param {*} [options] Override http request option.
|
|
24095
|
+
* @throws {RequiredError}
|
|
24096
|
+
*/
|
|
24097
|
+
adminBillingAlertsPost: (dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23251
24098
|
/**
|
|
23252
24099
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23253
24100
|
* @summary Get credit consumption
|
|
23254
24101
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23255
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23256
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23257
|
-
* @param {number} [
|
|
23258
|
-
* @param {number} [
|
|
24102
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format, defaults to 7 days ago)
|
|
24103
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format, defaults to now)
|
|
24104
|
+
* @param {number} [page] Page number (default: 1)
|
|
24105
|
+
* @param {number} [pageSize] Number of results per page (default: 20, max: 100)
|
|
24106
|
+
* @param {number} [limit] Alternative: Number of results (default: 20, max: 100)
|
|
24107
|
+
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
23259
24108
|
* @param {*} [options] Override http request option.
|
|
23260
24109
|
* @throws {RequiredError}
|
|
23261
24110
|
*/
|
|
23262
|
-
adminBillingCreditConsumptionGet: (orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24111
|
+
adminBillingCreditConsumptionGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23263
24112
|
/**
|
|
23264
24113
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23265
24114
|
* @summary Get credit ledger
|
|
@@ -23308,6 +24157,13 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
23308
24157
|
* @throws {RequiredError}
|
|
23309
24158
|
*/
|
|
23310
24159
|
adminBillingOrdersGet: (orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24160
|
+
/**
|
|
24161
|
+
* Returns comprehensive billing overview including plan, next charge, balance, and projected runout for org admins
|
|
24162
|
+
* @summary Get org admin billing overview
|
|
24163
|
+
* @param {*} [options] Override http request option.
|
|
24164
|
+
* @throws {RequiredError}
|
|
24165
|
+
*/
|
|
24166
|
+
adminBillingOrgOverviewGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23311
24167
|
/**
|
|
23312
24168
|
* Retrieves billing summary for all organizations with filtering options
|
|
23313
24169
|
* @summary Get organization billing summary
|
|
@@ -23342,24 +24198,65 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
23342
24198
|
* @throws {RequiredError}
|
|
23343
24199
|
*/
|
|
23344
24200
|
adminBillingPaymentTransactionsGet: (orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24201
|
+
/**
|
|
24202
|
+
* Returns saved payment cards from Razorpay for the organization
|
|
24203
|
+
* @summary Get saved payment cards
|
|
24204
|
+
* @param {*} [options] Override http request option.
|
|
24205
|
+
* @throws {RequiredError}
|
|
24206
|
+
*/
|
|
24207
|
+
adminBillingSavedCardsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23345
24208
|
};
|
|
23346
24209
|
/**
|
|
23347
24210
|
* BillingDashboardApi - functional programming interface
|
|
23348
24211
|
* @export
|
|
23349
24212
|
*/
|
|
23350
24213
|
export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
24214
|
+
/**
|
|
24215
|
+
* Returns all billing alerts configured for the organization
|
|
24216
|
+
* @summary Get billing alerts
|
|
24217
|
+
* @param {*} [options] Override http request option.
|
|
24218
|
+
* @throws {RequiredError}
|
|
24219
|
+
*/
|
|
24220
|
+
adminBillingAlertsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingAlertsResponse>>;
|
|
24221
|
+
/**
|
|
24222
|
+
* Deletes a billing alert configuration
|
|
24223
|
+
* @summary Delete billing alert
|
|
24224
|
+
* @param {number} id Alert ID
|
|
24225
|
+
* @param {*} [options] Override http request option.
|
|
24226
|
+
* @throws {RequiredError}
|
|
24227
|
+
*/
|
|
24228
|
+
adminBillingAlertsIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseAny>>;
|
|
24229
|
+
/**
|
|
24230
|
+
* Updates an existing billing alert configuration
|
|
24231
|
+
* @summary Update billing alert
|
|
24232
|
+
* @param {number} id Alert ID
|
|
24233
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Updated alert configuration
|
|
24234
|
+
* @param {*} [options] Override http request option.
|
|
24235
|
+
* @throws {RequiredError}
|
|
24236
|
+
*/
|
|
24237
|
+
adminBillingAlertsIdPut(id: number, dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingAlert>>;
|
|
24238
|
+
/**
|
|
24239
|
+
* Creates a new billing alert configuration for the organization
|
|
24240
|
+
* @summary Create billing alert
|
|
24241
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Alert configuration
|
|
24242
|
+
* @param {*} [options] Override http request option.
|
|
24243
|
+
* @throws {RequiredError}
|
|
24244
|
+
*/
|
|
24245
|
+
adminBillingAlertsPost(dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingAlert>>;
|
|
23351
24246
|
/**
|
|
23352
24247
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23353
24248
|
* @summary Get credit consumption
|
|
23354
24249
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23355
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23356
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23357
|
-
* @param {number} [
|
|
23358
|
-
* @param {number} [
|
|
24250
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format, defaults to 7 days ago)
|
|
24251
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format, defaults to now)
|
|
24252
|
+
* @param {number} [page] Page number (default: 1)
|
|
24253
|
+
* @param {number} [pageSize] Number of results per page (default: 20, max: 100)
|
|
24254
|
+
* @param {number} [limit] Alternative: Number of results (default: 20, max: 100)
|
|
24255
|
+
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
23359
24256
|
* @param {*} [options] Override http request option.
|
|
23360
24257
|
* @throws {RequiredError}
|
|
23361
24258
|
*/
|
|
23362
|
-
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary>>;
|
|
24259
|
+
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary>>;
|
|
23363
24260
|
/**
|
|
23364
24261
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23365
24262
|
* @summary Get credit ledger
|
|
@@ -23408,6 +24305,13 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
23408
24305
|
* @throws {RequiredError}
|
|
23409
24306
|
*/
|
|
23410
24307
|
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServiceOrderSummary>>;
|
|
24308
|
+
/**
|
|
24309
|
+
* Returns comprehensive billing overview including plan, next charge, balance, and projected runout for org admins
|
|
24310
|
+
* @summary Get org admin billing overview
|
|
24311
|
+
* @param {*} [options] Override http request option.
|
|
24312
|
+
* @throws {RequiredError}
|
|
24313
|
+
*/
|
|
24314
|
+
adminBillingOrgOverviewGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewResponse>>;
|
|
23411
24315
|
/**
|
|
23412
24316
|
* Retrieves billing summary for all organizations with filtering options
|
|
23413
24317
|
* @summary Get organization billing summary
|
|
@@ -23442,24 +24346,65 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
23442
24346
|
* @throws {RequiredError}
|
|
23443
24347
|
*/
|
|
23444
24348
|
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseArrayBillingServicePaymentTransactionSummary>>;
|
|
24349
|
+
/**
|
|
24350
|
+
* Returns saved payment cards from Razorpay for the organization
|
|
24351
|
+
* @summary Get saved payment cards
|
|
24352
|
+
* @param {*} [options] Override http request option.
|
|
24353
|
+
* @throws {RequiredError}
|
|
24354
|
+
*/
|
|
24355
|
+
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesSavedCardsResponse>>;
|
|
23445
24356
|
};
|
|
23446
24357
|
/**
|
|
23447
24358
|
* BillingDashboardApi - factory interface
|
|
23448
24359
|
* @export
|
|
23449
24360
|
*/
|
|
23450
24361
|
export declare const BillingDashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24362
|
+
/**
|
|
24363
|
+
* Returns all billing alerts configured for the organization
|
|
24364
|
+
* @summary Get billing alerts
|
|
24365
|
+
* @param {*} [options] Override http request option.
|
|
24366
|
+
* @throws {RequiredError}
|
|
24367
|
+
*/
|
|
24368
|
+
adminBillingAlertsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingAlertsResponse>;
|
|
24369
|
+
/**
|
|
24370
|
+
* Deletes a billing alert configuration
|
|
24371
|
+
* @summary Delete billing alert
|
|
24372
|
+
* @param {number} id Alert ID
|
|
24373
|
+
* @param {*} [options] Override http request option.
|
|
24374
|
+
* @throws {RequiredError}
|
|
24375
|
+
*/
|
|
24376
|
+
adminBillingAlertsIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseAny>;
|
|
24377
|
+
/**
|
|
24378
|
+
* Updates an existing billing alert configuration
|
|
24379
|
+
* @summary Update billing alert
|
|
24380
|
+
* @param {number} id Alert ID
|
|
24381
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Updated alert configuration
|
|
24382
|
+
* @param {*} [options] Override http request option.
|
|
24383
|
+
* @throws {RequiredError}
|
|
24384
|
+
*/
|
|
24385
|
+
adminBillingAlertsIdPut(id: number, dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingAlert>;
|
|
24386
|
+
/**
|
|
24387
|
+
* Creates a new billing alert configuration for the organization
|
|
24388
|
+
* @summary Create billing alert
|
|
24389
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Alert configuration
|
|
24390
|
+
* @param {*} [options] Override http request option.
|
|
24391
|
+
* @throws {RequiredError}
|
|
24392
|
+
*/
|
|
24393
|
+
adminBillingAlertsPost(dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingAlert>;
|
|
23451
24394
|
/**
|
|
23452
24395
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23453
24396
|
* @summary Get credit consumption
|
|
23454
24397
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23455
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23456
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23457
|
-
* @param {number} [
|
|
23458
|
-
* @param {number} [
|
|
24398
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format, defaults to 7 days ago)
|
|
24399
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format, defaults to now)
|
|
24400
|
+
* @param {number} [page] Page number (default: 1)
|
|
24401
|
+
* @param {number} [pageSize] Number of results per page (default: 20, max: 100)
|
|
24402
|
+
* @param {number} [limit] Alternative: Number of results (default: 20, max: 100)
|
|
24403
|
+
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
23459
24404
|
* @param {*} [options] Override http request option.
|
|
23460
24405
|
* @throws {RequiredError}
|
|
23461
24406
|
*/
|
|
23462
|
-
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary>;
|
|
24407
|
+
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary>;
|
|
23463
24408
|
/**
|
|
23464
24409
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23465
24410
|
* @summary Get credit ledger
|
|
@@ -23508,6 +24453,13 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23508
24453
|
* @throws {RequiredError}
|
|
23509
24454
|
*/
|
|
23510
24455
|
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServiceOrderSummary>;
|
|
24456
|
+
/**
|
|
24457
|
+
* Returns comprehensive billing overview including plan, next charge, balance, and projected runout for org admins
|
|
24458
|
+
* @summary Get org admin billing overview
|
|
24459
|
+
* @param {*} [options] Override http request option.
|
|
24460
|
+
* @throws {RequiredError}
|
|
24461
|
+
*/
|
|
24462
|
+
adminBillingOrgOverviewGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBillingOverviewResponse>;
|
|
23511
24463
|
/**
|
|
23512
24464
|
* Retrieves billing summary for all organizations with filtering options
|
|
23513
24465
|
* @summary Get organization billing summary
|
|
@@ -23542,6 +24494,13 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23542
24494
|
* @throws {RequiredError}
|
|
23543
24495
|
*/
|
|
23544
24496
|
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseArrayBillingServicePaymentTransactionSummary>;
|
|
24497
|
+
/**
|
|
24498
|
+
* Returns saved payment cards from Razorpay for the organization
|
|
24499
|
+
* @summary Get saved payment cards
|
|
24500
|
+
* @param {*} [options] Override http request option.
|
|
24501
|
+
* @throws {RequiredError}
|
|
24502
|
+
*/
|
|
24503
|
+
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesSavedCardsResponse>;
|
|
23545
24504
|
};
|
|
23546
24505
|
/**
|
|
23547
24506
|
* BillingDashboardApi - object-oriented interface
|
|
@@ -23550,19 +24509,57 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23550
24509
|
* @extends {BaseAPI}
|
|
23551
24510
|
*/
|
|
23552
24511
|
export declare class BillingDashboardApi extends BaseAPI {
|
|
24512
|
+
/**
|
|
24513
|
+
* Returns all billing alerts configured for the organization
|
|
24514
|
+
* @summary Get billing alerts
|
|
24515
|
+
* @param {*} [options] Override http request option.
|
|
24516
|
+
* @throws {RequiredError}
|
|
24517
|
+
* @memberof BillingDashboardApi
|
|
24518
|
+
*/
|
|
24519
|
+
adminBillingAlertsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingAlertsResponse, any, {}>>;
|
|
24520
|
+
/**
|
|
24521
|
+
* Deletes a billing alert configuration
|
|
24522
|
+
* @summary Delete billing alert
|
|
24523
|
+
* @param {number} id Alert ID
|
|
24524
|
+
* @param {*} [options] Override http request option.
|
|
24525
|
+
* @throws {RequiredError}
|
|
24526
|
+
* @memberof BillingDashboardApi
|
|
24527
|
+
*/
|
|
24528
|
+
adminBillingAlertsIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseAny, any, {}>>;
|
|
24529
|
+
/**
|
|
24530
|
+
* Updates an existing billing alert configuration
|
|
24531
|
+
* @summary Update billing alert
|
|
24532
|
+
* @param {number} id Alert ID
|
|
24533
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Updated alert configuration
|
|
24534
|
+
* @param {*} [options] Override http request option.
|
|
24535
|
+
* @throws {RequiredError}
|
|
24536
|
+
* @memberof BillingDashboardApi
|
|
24537
|
+
*/
|
|
24538
|
+
adminBillingAlertsIdPut(id: number, dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingAlert, any, {}>>;
|
|
24539
|
+
/**
|
|
24540
|
+
* Creates a new billing alert configuration for the organization
|
|
24541
|
+
* @summary Create billing alert
|
|
24542
|
+
* @param {DataTypesBillingAlertRequest} dataTypesBillingAlertRequest Alert configuration
|
|
24543
|
+
* @param {*} [options] Override http request option.
|
|
24544
|
+
* @throws {RequiredError}
|
|
24545
|
+
* @memberof BillingDashboardApi
|
|
24546
|
+
*/
|
|
24547
|
+
adminBillingAlertsPost(dataTypesBillingAlertRequest: DataTypesBillingAlertRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingAlert, any, {}>>;
|
|
23553
24548
|
/**
|
|
23554
24549
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23555
24550
|
* @summary Get credit consumption
|
|
23556
24551
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23557
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23558
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23559
|
-
* @param {number} [
|
|
23560
|
-
* @param {number} [
|
|
24552
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format, defaults to 7 days ago)
|
|
24553
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format, defaults to now)
|
|
24554
|
+
* @param {number} [page] Page number (default: 1)
|
|
24555
|
+
* @param {number} [pageSize] Number of results per page (default: 20, max: 100)
|
|
24556
|
+
* @param {number} [limit] Alternative: Number of results (default: 20, max: 100)
|
|
24557
|
+
* @param {number} [offset] Alternative: Number of results to skip (default: 0)
|
|
23561
24558
|
* @param {*} [options] Override http request option.
|
|
23562
24559
|
* @throws {RequiredError}
|
|
23563
24560
|
* @memberof BillingDashboardApi
|
|
23564
24561
|
*/
|
|
23565
|
-
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary, any, {}>>;
|
|
24562
|
+
adminBillingCreditConsumptionGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServiceCreditConsumptionSummary, any, {}>>;
|
|
23566
24563
|
/**
|
|
23567
24564
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23568
24565
|
* @summary Get credit ledger
|
|
@@ -23615,6 +24612,14 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
23615
24612
|
* @memberof BillingDashboardApi
|
|
23616
24613
|
*/
|
|
23617
24614
|
adminBillingOrdersGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServiceOrderSummary, any, {}>>;
|
|
24615
|
+
/**
|
|
24616
|
+
* Returns comprehensive billing overview including plan, next charge, balance, and projected runout for org admins
|
|
24617
|
+
* @summary Get org admin billing overview
|
|
24618
|
+
* @param {*} [options] Override http request option.
|
|
24619
|
+
* @throws {RequiredError}
|
|
24620
|
+
* @memberof BillingDashboardApi
|
|
24621
|
+
*/
|
|
24622
|
+
adminBillingOrgOverviewGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBillingOverviewResponse, any, {}>>;
|
|
23618
24623
|
/**
|
|
23619
24624
|
* Retrieves billing summary for all organizations with filtering options
|
|
23620
24625
|
* @summary Get organization billing summary
|
|
@@ -23652,6 +24657,14 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
23652
24657
|
* @memberof BillingDashboardApi
|
|
23653
24658
|
*/
|
|
23654
24659
|
adminBillingPaymentTransactionsGet(orgId?: number, startDate?: string, endDate?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseArrayBillingServicePaymentTransactionSummary, any, {}>>;
|
|
24660
|
+
/**
|
|
24661
|
+
* Returns saved payment cards from Razorpay for the organization
|
|
24662
|
+
* @summary Get saved payment cards
|
|
24663
|
+
* @param {*} [options] Override http request option.
|
|
24664
|
+
* @throws {RequiredError}
|
|
24665
|
+
* @memberof BillingDashboardApi
|
|
24666
|
+
*/
|
|
24667
|
+
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesSavedCardsResponse, any, {}>>;
|
|
23655
24668
|
}
|
|
23656
24669
|
/**
|
|
23657
24670
|
* CommonApi - axios parameter creator
|