@seekora-ai/admin-api 1.0.77 → 1.0.79
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 +41 -14
- package/api.ts +1597 -221
- package/dist/api.d.ts +1087 -80
- package/dist/api.js +774 -166
- package/dist/esm/api.d.ts +1087 -80
- package/dist/esm/api.js +769 -161
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.79.tgz +0 -0
- package/seekora-ai-admin-api-1.0.77.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
|
|
@@ -15040,6 +15515,37 @@ export interface DataTypesProfileResponseWrapper {
|
|
|
15040
15515
|
*/
|
|
15041
15516
|
'status'?: number;
|
|
15042
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
|
+
}
|
|
15043
15549
|
/**
|
|
15044
15550
|
*
|
|
15045
15551
|
* @export
|
|
@@ -16483,35 +16989,141 @@ export interface DataTypesSampleDatasetResponse {
|
|
|
16483
16989
|
'storeName'?: string;
|
|
16484
16990
|
/**
|
|
16485
16991
|
*
|
|
16486
|
-
* @type {Array<string>}
|
|
16487
|
-
* @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
|
|
16488
17100
|
*/
|
|
16489
|
-
'
|
|
17101
|
+
'token_id'?: string;
|
|
16490
17102
|
}
|
|
16491
17103
|
/**
|
|
16492
17104
|
*
|
|
16493
17105
|
* @export
|
|
16494
|
-
* @interface
|
|
17106
|
+
* @interface DataTypesSavedCardsResponse
|
|
16495
17107
|
*/
|
|
16496
|
-
export interface
|
|
17108
|
+
export interface DataTypesSavedCardsResponse {
|
|
16497
17109
|
/**
|
|
16498
17110
|
*
|
|
16499
|
-
* @type {Array<
|
|
16500
|
-
* @memberof
|
|
17111
|
+
* @type {Array<DataTypesSavedCard>}
|
|
17112
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16501
17113
|
*/
|
|
16502
|
-
'
|
|
17114
|
+
'cards'?: Array<DataTypesSavedCard>;
|
|
16503
17115
|
/**
|
|
16504
17116
|
*
|
|
16505
17117
|
* @type {string}
|
|
16506
|
-
* @memberof
|
|
17118
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16507
17119
|
*/
|
|
16508
|
-
'
|
|
17120
|
+
'customer_id'?: string;
|
|
16509
17121
|
/**
|
|
16510
17122
|
*
|
|
16511
17123
|
* @type {number}
|
|
16512
|
-
* @memberof
|
|
17124
|
+
* @memberof DataTypesSavedCardsResponse
|
|
16513
17125
|
*/
|
|
16514
|
-
'
|
|
17126
|
+
'total_cards'?: number;
|
|
16515
17127
|
}
|
|
16516
17128
|
/**
|
|
16517
17129
|
*
|
|
@@ -16681,6 +17293,121 @@ export interface DataTypesSearchResultResponse {
|
|
|
16681
17293
|
*/
|
|
16682
17294
|
'status'?: number;
|
|
16683
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
|
+
}
|
|
16684
17411
|
/**
|
|
16685
17412
|
*
|
|
16686
17413
|
* @export
|
|
@@ -22285,7 +23012,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22285
23012
|
* @param {*} [options] Override http request option.
|
|
22286
23013
|
* @throws {RequiredError}
|
|
22287
23014
|
*/
|
|
22288
|
-
|
|
23015
|
+
adminV1AnalyticsRulesGet: (authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22289
23016
|
/**
|
|
22290
23017
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22291
23018
|
* @summary Create Analytics Rule
|
|
@@ -22294,7 +23021,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22294
23021
|
* @param {*} [options] Override http request option.
|
|
22295
23022
|
* @throws {RequiredError}
|
|
22296
23023
|
*/
|
|
22297
|
-
|
|
23024
|
+
adminV1AnalyticsRulesPost: (authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22298
23025
|
/**
|
|
22299
23026
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22300
23027
|
* @summary Delete Analytics Rule
|
|
@@ -22303,7 +23030,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22303
23030
|
* @param {*} [options] Override http request option.
|
|
22304
23031
|
* @throws {RequiredError}
|
|
22305
23032
|
*/
|
|
22306
|
-
|
|
23033
|
+
adminV1AnalyticsRulesRuleIdDelete: (authorization: string, ruleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22307
23034
|
/**
|
|
22308
23035
|
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
22309
23036
|
* @summary Get Analytics Rule
|
|
@@ -22312,7 +23039,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22312
23039
|
* @param {*} [options] Override http request option.
|
|
22313
23040
|
* @throws {RequiredError}
|
|
22314
23041
|
*/
|
|
22315
|
-
|
|
23042
|
+
adminV1AnalyticsRulesRuleIdGet: (authorization: string, ruleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22316
23043
|
/**
|
|
22317
23044
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22318
23045
|
* @summary Update Analytics Rule
|
|
@@ -22322,7 +23049,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22322
23049
|
* @param {*} [options] Override http request option.
|
|
22323
23050
|
* @throws {RequiredError}
|
|
22324
23051
|
*/
|
|
22325
|
-
|
|
23052
|
+
adminV1AnalyticsRulesRuleIdPut: (authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22326
23053
|
/**
|
|
22327
23054
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22328
23055
|
* @summary Sync Rules to Typesense
|
|
@@ -22331,7 +23058,27 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22331
23058
|
* @param {*} [options] Override http request option.
|
|
22332
23059
|
* @throws {RequiredError}
|
|
22333
23060
|
*/
|
|
22334
|
-
|
|
23061
|
+
adminV1AnalyticsRulesSyncPost: (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
|
+
adminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet: (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
|
+
adminV1StoresXStoreIDAnalyticsRulesSearchItemsPost: (authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22335
23082
|
/**
|
|
22336
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.
|
|
22337
23084
|
* @summary List Analytics Rules
|
|
@@ -22350,7 +23097,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22350
23097
|
* @param {*} [options] Override http request option.
|
|
22351
23098
|
* @throws {RequiredError}
|
|
22352
23099
|
*/
|
|
22353
|
-
|
|
23100
|
+
adminV1StoresXstoreidAnalyticsRulesGet: (authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22354
23101
|
/**
|
|
22355
23102
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22356
23103
|
* @summary Create Analytics Rule
|
|
@@ -22360,7 +23107,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22360
23107
|
* @param {*} [options] Override http request option.
|
|
22361
23108
|
* @throws {RequiredError}
|
|
22362
23109
|
*/
|
|
22363
|
-
|
|
23110
|
+
adminV1StoresXstoreidAnalyticsRulesPost: (authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22364
23111
|
/**
|
|
22365
23112
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22366
23113
|
* @summary Delete Analytics Rule
|
|
@@ -22370,7 +23117,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22370
23117
|
* @param {*} [options] Override http request option.
|
|
22371
23118
|
* @throws {RequiredError}
|
|
22372
23119
|
*/
|
|
22373
|
-
|
|
23120
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdDelete: (authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22374
23121
|
/**
|
|
22375
23122
|
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
22376
23123
|
* @summary Get Analytics Rule
|
|
@@ -22380,7 +23127,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22380
23127
|
* @param {*} [options] Override http request option.
|
|
22381
23128
|
* @throws {RequiredError}
|
|
22382
23129
|
*/
|
|
22383
|
-
|
|
23130
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdGet: (authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22384
23131
|
/**
|
|
22385
23132
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22386
23133
|
* @summary Update Analytics Rule
|
|
@@ -22391,7 +23138,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22391
23138
|
* @param {*} [options] Override http request option.
|
|
22392
23139
|
* @throws {RequiredError}
|
|
22393
23140
|
*/
|
|
22394
|
-
|
|
23141
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdPut: (authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22395
23142
|
/**
|
|
22396
23143
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22397
23144
|
* @summary Sync Rules to Typesense
|
|
@@ -22401,7 +23148,7 @@ export declare const AnalyticsRulesApiAxiosParamCreator: (configuration?: Config
|
|
|
22401
23148
|
* @param {*} [options] Override http request option.
|
|
22402
23149
|
* @throws {RequiredError}
|
|
22403
23150
|
*/
|
|
22404
|
-
|
|
23151
|
+
adminV1StoresXstoreidAnalyticsRulesSyncPost: (authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22405
23152
|
};
|
|
22406
23153
|
/**
|
|
22407
23154
|
* AnalyticsRulesApi - functional programming interface
|
|
@@ -22425,7 +23172,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22425
23172
|
* @param {*} [options] Override http request option.
|
|
22426
23173
|
* @throws {RequiredError}
|
|
22427
23174
|
*/
|
|
22428
|
-
|
|
23175
|
+
adminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleListResponse>>;
|
|
22429
23176
|
/**
|
|
22430
23177
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22431
23178
|
* @summary Create Analytics Rule
|
|
@@ -22434,7 +23181,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22434
23181
|
* @param {*} [options] Override http request option.
|
|
22435
23182
|
* @throws {RequiredError}
|
|
22436
23183
|
*/
|
|
22437
|
-
|
|
23184
|
+
adminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22438
23185
|
/**
|
|
22439
23186
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22440
23187
|
* @summary Delete Analytics Rule
|
|
@@ -22443,7 +23190,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22443
23190
|
* @param {*} [options] Override http request option.
|
|
22444
23191
|
* @throws {RequiredError}
|
|
22445
23192
|
*/
|
|
22446
|
-
|
|
23193
|
+
adminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
22447
23194
|
[key: string]: any;
|
|
22448
23195
|
}>>;
|
|
22449
23196
|
/**
|
|
@@ -22454,7 +23201,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22454
23201
|
* @param {*} [options] Override http request option.
|
|
22455
23202
|
* @throws {RequiredError}
|
|
22456
23203
|
*/
|
|
22457
|
-
|
|
23204
|
+
adminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22458
23205
|
/**
|
|
22459
23206
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22460
23207
|
* @summary Update Analytics Rule
|
|
@@ -22464,7 +23211,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22464
23211
|
* @param {*} [options] Override http request option.
|
|
22465
23212
|
* @throws {RequiredError}
|
|
22466
23213
|
*/
|
|
22467
|
-
|
|
23214
|
+
adminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22468
23215
|
/**
|
|
22469
23216
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22470
23217
|
* @summary Sync Rules to Typesense
|
|
@@ -22473,7 +23220,27 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22473
23220
|
* @param {*} [options] Override http request option.
|
|
22474
23221
|
* @throws {RequiredError}
|
|
22475
23222
|
*/
|
|
22476
|
-
|
|
23223
|
+
adminV1AnalyticsRulesSyncPost(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
|
+
adminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(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
|
+
adminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchRuleItemsResponse>>;
|
|
22477
23244
|
/**
|
|
22478
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.
|
|
22479
23246
|
* @summary List Analytics Rules
|
|
@@ -22492,7 +23259,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22492
23259
|
* @param {*} [options] Override http request option.
|
|
22493
23260
|
* @throws {RequiredError}
|
|
22494
23261
|
*/
|
|
22495
|
-
|
|
23262
|
+
adminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleListResponse>>;
|
|
22496
23263
|
/**
|
|
22497
23264
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22498
23265
|
* @summary Create Analytics Rule
|
|
@@ -22502,7 +23269,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22502
23269
|
* @param {*} [options] Override http request option.
|
|
22503
23270
|
* @throws {RequiredError}
|
|
22504
23271
|
*/
|
|
22505
|
-
|
|
23272
|
+
adminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22506
23273
|
/**
|
|
22507
23274
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22508
23275
|
* @summary Delete Analytics Rule
|
|
@@ -22512,7 +23279,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22512
23279
|
* @param {*} [options] Override http request option.
|
|
22513
23280
|
* @throws {RequiredError}
|
|
22514
23281
|
*/
|
|
22515
|
-
|
|
23282
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
22516
23283
|
[key: string]: any;
|
|
22517
23284
|
}>>;
|
|
22518
23285
|
/**
|
|
@@ -22524,7 +23291,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22524
23291
|
* @param {*} [options] Override http request option.
|
|
22525
23292
|
* @throws {RequiredError}
|
|
22526
23293
|
*/
|
|
22527
|
-
|
|
23294
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22528
23295
|
/**
|
|
22529
23296
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22530
23297
|
* @summary Update Analytics Rule
|
|
@@ -22535,7 +23302,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22535
23302
|
* @param {*} [options] Override http request option.
|
|
22536
23303
|
* @throws {RequiredError}
|
|
22537
23304
|
*/
|
|
22538
|
-
|
|
23305
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>>;
|
|
22539
23306
|
/**
|
|
22540
23307
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22541
23308
|
* @summary Sync Rules to Typesense
|
|
@@ -22545,7 +23312,7 @@ export declare const AnalyticsRulesApiFp: (configuration?: Configuration) => {
|
|
|
22545
23312
|
* @param {*} [options] Override http request option.
|
|
22546
23313
|
* @throws {RequiredError}
|
|
22547
23314
|
*/
|
|
22548
|
-
|
|
23315
|
+
adminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleSyncResponse>>;
|
|
22549
23316
|
};
|
|
22550
23317
|
/**
|
|
22551
23318
|
* AnalyticsRulesApi - factory interface
|
|
@@ -22569,7 +23336,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22569
23336
|
* @param {*} [options] Override http request option.
|
|
22570
23337
|
* @throws {RequiredError}
|
|
22571
23338
|
*/
|
|
22572
|
-
|
|
23339
|
+
adminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleListResponse>;
|
|
22573
23340
|
/**
|
|
22574
23341
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22575
23342
|
* @summary Create Analytics Rule
|
|
@@ -22578,7 +23345,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22578
23345
|
* @param {*} [options] Override http request option.
|
|
22579
23346
|
* @throws {RequiredError}
|
|
22580
23347
|
*/
|
|
22581
|
-
|
|
23348
|
+
adminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22582
23349
|
/**
|
|
22583
23350
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22584
23351
|
* @summary Delete Analytics Rule
|
|
@@ -22587,7 +23354,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22587
23354
|
* @param {*} [options] Override http request option.
|
|
22588
23355
|
* @throws {RequiredError}
|
|
22589
23356
|
*/
|
|
22590
|
-
|
|
23357
|
+
adminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
22591
23358
|
[key: string]: any;
|
|
22592
23359
|
}>;
|
|
22593
23360
|
/**
|
|
@@ -22598,7 +23365,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22598
23365
|
* @param {*} [options] Override http request option.
|
|
22599
23366
|
* @throws {RequiredError}
|
|
22600
23367
|
*/
|
|
22601
|
-
|
|
23368
|
+
adminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22602
23369
|
/**
|
|
22603
23370
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22604
23371
|
* @summary Update Analytics Rule
|
|
@@ -22608,7 +23375,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22608
23375
|
* @param {*} [options] Override http request option.
|
|
22609
23376
|
* @throws {RequiredError}
|
|
22610
23377
|
*/
|
|
22611
|
-
|
|
23378
|
+
adminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22612
23379
|
/**
|
|
22613
23380
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22614
23381
|
* @summary Sync Rules to Typesense
|
|
@@ -22617,7 +23384,27 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22617
23384
|
* @param {*} [options] Override http request option.
|
|
22618
23385
|
* @throws {RequiredError}
|
|
22619
23386
|
*/
|
|
22620
|
-
|
|
23387
|
+
adminV1AnalyticsRulesSyncPost(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
|
+
adminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(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
|
+
adminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchRuleItemsResponse>;
|
|
22621
23408
|
/**
|
|
22622
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.
|
|
22623
23410
|
* @summary List Analytics Rules
|
|
@@ -22636,7 +23423,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22636
23423
|
* @param {*} [options] Override http request option.
|
|
22637
23424
|
* @throws {RequiredError}
|
|
22638
23425
|
*/
|
|
22639
|
-
|
|
23426
|
+
adminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleListResponse>;
|
|
22640
23427
|
/**
|
|
22641
23428
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22642
23429
|
* @summary Create Analytics Rule
|
|
@@ -22646,7 +23433,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22646
23433
|
* @param {*} [options] Override http request option.
|
|
22647
23434
|
* @throws {RequiredError}
|
|
22648
23435
|
*/
|
|
22649
|
-
|
|
23436
|
+
adminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22650
23437
|
/**
|
|
22651
23438
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22652
23439
|
* @summary Delete Analytics Rule
|
|
@@ -22656,7 +23443,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22656
23443
|
* @param {*} [options] Override http request option.
|
|
22657
23444
|
* @throws {RequiredError}
|
|
22658
23445
|
*/
|
|
22659
|
-
|
|
23446
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
22660
23447
|
[key: string]: any;
|
|
22661
23448
|
}>;
|
|
22662
23449
|
/**
|
|
@@ -22668,7 +23455,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22668
23455
|
* @param {*} [options] Override http request option.
|
|
22669
23456
|
* @throws {RequiredError}
|
|
22670
23457
|
*/
|
|
22671
|
-
|
|
23458
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22672
23459
|
/**
|
|
22673
23460
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22674
23461
|
* @summary Update Analytics Rule
|
|
@@ -22679,7 +23466,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22679
23466
|
* @param {*} [options] Override http request option.
|
|
22680
23467
|
* @throws {RequiredError}
|
|
22681
23468
|
*/
|
|
22682
|
-
|
|
23469
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse>;
|
|
22683
23470
|
/**
|
|
22684
23471
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22685
23472
|
* @summary Sync Rules to Typesense
|
|
@@ -22689,7 +23476,7 @@ export declare const AnalyticsRulesApiFactory: (configuration?: Configuration, b
|
|
|
22689
23476
|
* @param {*} [options] Override http request option.
|
|
22690
23477
|
* @throws {RequiredError}
|
|
22691
23478
|
*/
|
|
22692
|
-
|
|
23479
|
+
adminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleSyncResponse>;
|
|
22693
23480
|
};
|
|
22694
23481
|
/**
|
|
22695
23482
|
* AnalyticsRulesApi - object-oriented interface
|
|
@@ -22716,7 +23503,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22716
23503
|
* @throws {RequiredError}
|
|
22717
23504
|
* @memberof AnalyticsRulesApi
|
|
22718
23505
|
*/
|
|
22719
|
-
|
|
23506
|
+
adminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleListResponse, any, {}>>;
|
|
22720
23507
|
/**
|
|
22721
23508
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22722
23509
|
* @summary Create Analytics Rule
|
|
@@ -22726,7 +23513,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22726
23513
|
* @throws {RequiredError}
|
|
22727
23514
|
* @memberof AnalyticsRulesApi
|
|
22728
23515
|
*/
|
|
22729
|
-
|
|
23516
|
+
adminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22730
23517
|
/**
|
|
22731
23518
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22732
23519
|
* @summary Delete Analytics Rule
|
|
@@ -22736,7 +23523,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22736
23523
|
* @throws {RequiredError}
|
|
22737
23524
|
* @memberof AnalyticsRulesApi
|
|
22738
23525
|
*/
|
|
22739
|
-
|
|
23526
|
+
adminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
22740
23527
|
[key: string]: any;
|
|
22741
23528
|
}, any, {}>>;
|
|
22742
23529
|
/**
|
|
@@ -22748,7 +23535,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22748
23535
|
* @throws {RequiredError}
|
|
22749
23536
|
* @memberof AnalyticsRulesApi
|
|
22750
23537
|
*/
|
|
22751
|
-
|
|
23538
|
+
adminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22752
23539
|
/**
|
|
22753
23540
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22754
23541
|
* @summary Update Analytics Rule
|
|
@@ -22759,7 +23546,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22759
23546
|
* @throws {RequiredError}
|
|
22760
23547
|
* @memberof AnalyticsRulesApi
|
|
22761
23548
|
*/
|
|
22762
|
-
|
|
23549
|
+
adminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22763
23550
|
/**
|
|
22764
23551
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22765
23552
|
* @summary Sync Rules to Typesense
|
|
@@ -22769,7 +23556,29 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22769
23556
|
* @throws {RequiredError}
|
|
22770
23557
|
* @memberof AnalyticsRulesApi
|
|
22771
23558
|
*/
|
|
22772
|
-
|
|
23559
|
+
adminV1AnalyticsRulesSyncPost(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
|
+
adminV1StoresXStoreIDAnalyticsRulesItemsItemIdGet(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
|
+
adminV1StoresXStoreIDAnalyticsRulesSearchItemsPost(authorization: string, xStoreID: string, dataTypesSearchRuleItemsRequest: DataTypesSearchRuleItemsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchRuleItemsResponse, any, {}>>;
|
|
22773
23582
|
/**
|
|
22774
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.
|
|
22775
23584
|
* @summary List Analytics Rules
|
|
@@ -22789,7 +23598,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22789
23598
|
* @throws {RequiredError}
|
|
22790
23599
|
* @memberof AnalyticsRulesApi
|
|
22791
23600
|
*/
|
|
22792
|
-
|
|
23601
|
+
adminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleListResponse, any, {}>>;
|
|
22793
23602
|
/**
|
|
22794
23603
|
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
22795
23604
|
* @summary Create Analytics Rule
|
|
@@ -22800,7 +23609,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22800
23609
|
* @throws {RequiredError}
|
|
22801
23610
|
* @memberof AnalyticsRulesApi
|
|
22802
23611
|
*/
|
|
22803
|
-
|
|
23612
|
+
adminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22804
23613
|
/**
|
|
22805
23614
|
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
22806
23615
|
* @summary Delete Analytics Rule
|
|
@@ -22811,7 +23620,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22811
23620
|
* @throws {RequiredError}
|
|
22812
23621
|
* @memberof AnalyticsRulesApi
|
|
22813
23622
|
*/
|
|
22814
|
-
|
|
23623
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
22815
23624
|
[key: string]: any;
|
|
22816
23625
|
}, any, {}>>;
|
|
22817
23626
|
/**
|
|
@@ -22824,7 +23633,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22824
23633
|
* @throws {RequiredError}
|
|
22825
23634
|
* @memberof AnalyticsRulesApi
|
|
22826
23635
|
*/
|
|
22827
|
-
|
|
23636
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22828
23637
|
/**
|
|
22829
23638
|
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
22830
23639
|
* @summary Update Analytics Rule
|
|
@@ -22836,7 +23645,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22836
23645
|
* @throws {RequiredError}
|
|
22837
23646
|
* @memberof AnalyticsRulesApi
|
|
22838
23647
|
*/
|
|
22839
|
-
|
|
23648
|
+
adminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleResponse, any, {}>>;
|
|
22840
23649
|
/**
|
|
22841
23650
|
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
22842
23651
|
* @summary Sync Rules to Typesense
|
|
@@ -22847,7 +23656,7 @@ export declare class AnalyticsRulesApi extends BaseAPI {
|
|
|
22847
23656
|
* @throws {RequiredError}
|
|
22848
23657
|
* @memberof AnalyticsRulesApi
|
|
22849
23658
|
*/
|
|
22850
|
-
|
|
23659
|
+
adminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesAnalyticsRuleSyncResponse, any, {}>>;
|
|
22851
23660
|
}
|
|
22852
23661
|
/**
|
|
22853
23662
|
* ArticlesApi - axios parameter creator
|
|
@@ -23254,18 +24063,52 @@ export declare class AutomatedRefundManagementApi extends BaseAPI {
|
|
|
23254
24063
|
* @export
|
|
23255
24064
|
*/
|
|
23256
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>;
|
|
23257
24098
|
/**
|
|
23258
24099
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23259
24100
|
* @summary Get credit consumption
|
|
23260
24101
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23261
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23262
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23263
|
-
* @param {number} [
|
|
23264
|
-
* @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)
|
|
23265
24108
|
* @param {*} [options] Override http request option.
|
|
23266
24109
|
* @throws {RequiredError}
|
|
23267
24110
|
*/
|
|
23268
|
-
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>;
|
|
23269
24112
|
/**
|
|
23270
24113
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23271
24114
|
* @summary Get credit ledger
|
|
@@ -23314,6 +24157,13 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
23314
24157
|
* @throws {RequiredError}
|
|
23315
24158
|
*/
|
|
23316
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>;
|
|
23317
24167
|
/**
|
|
23318
24168
|
* Retrieves billing summary for all organizations with filtering options
|
|
23319
24169
|
* @summary Get organization billing summary
|
|
@@ -23348,24 +24198,65 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
23348
24198
|
* @throws {RequiredError}
|
|
23349
24199
|
*/
|
|
23350
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>;
|
|
23351
24208
|
};
|
|
23352
24209
|
/**
|
|
23353
24210
|
* BillingDashboardApi - functional programming interface
|
|
23354
24211
|
* @export
|
|
23355
24212
|
*/
|
|
23356
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>>;
|
|
23357
24246
|
/**
|
|
23358
24247
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23359
24248
|
* @summary Get credit consumption
|
|
23360
24249
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23361
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23362
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23363
|
-
* @param {number} [
|
|
23364
|
-
* @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)
|
|
23365
24256
|
* @param {*} [options] Override http request option.
|
|
23366
24257
|
* @throws {RequiredError}
|
|
23367
24258
|
*/
|
|
23368
|
-
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>>;
|
|
23369
24260
|
/**
|
|
23370
24261
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23371
24262
|
* @summary Get credit ledger
|
|
@@ -23414,6 +24305,13 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
23414
24305
|
* @throws {RequiredError}
|
|
23415
24306
|
*/
|
|
23416
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>>;
|
|
23417
24315
|
/**
|
|
23418
24316
|
* Retrieves billing summary for all organizations with filtering options
|
|
23419
24317
|
* @summary Get organization billing summary
|
|
@@ -23448,24 +24346,65 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
23448
24346
|
* @throws {RequiredError}
|
|
23449
24347
|
*/
|
|
23450
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>>;
|
|
23451
24356
|
};
|
|
23452
24357
|
/**
|
|
23453
24358
|
* BillingDashboardApi - factory interface
|
|
23454
24359
|
* @export
|
|
23455
24360
|
*/
|
|
23456
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>;
|
|
23457
24394
|
/**
|
|
23458
24395
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23459
24396
|
* @summary Get credit consumption
|
|
23460
24397
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23461
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23462
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23463
|
-
* @param {number} [
|
|
23464
|
-
* @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)
|
|
23465
24404
|
* @param {*} [options] Override http request option.
|
|
23466
24405
|
* @throws {RequiredError}
|
|
23467
24406
|
*/
|
|
23468
|
-
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>;
|
|
23469
24408
|
/**
|
|
23470
24409
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23471
24410
|
* @summary Get credit ledger
|
|
@@ -23514,6 +24453,13 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23514
24453
|
* @throws {RequiredError}
|
|
23515
24454
|
*/
|
|
23516
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>;
|
|
23517
24463
|
/**
|
|
23518
24464
|
* Retrieves billing summary for all organizations with filtering options
|
|
23519
24465
|
* @summary Get organization billing summary
|
|
@@ -23548,6 +24494,13 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23548
24494
|
* @throws {RequiredError}
|
|
23549
24495
|
*/
|
|
23550
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>;
|
|
23551
24504
|
};
|
|
23552
24505
|
/**
|
|
23553
24506
|
* BillingDashboardApi - object-oriented interface
|
|
@@ -23556,19 +24509,57 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
23556
24509
|
* @extends {BaseAPI}
|
|
23557
24510
|
*/
|
|
23558
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, {}>>;
|
|
23559
24548
|
/**
|
|
23560
24549
|
* Retrieves paginated list of credit consumption records with filtering options for the authenticated user\'s organization
|
|
23561
24550
|
* @summary Get credit consumption
|
|
23562
24551
|
* @param {number} [orgId] Organization ID (defaults to user\'s org)
|
|
23563
|
-
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
23564
|
-
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
23565
|
-
* @param {number} [
|
|
23566
|
-
* @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)
|
|
23567
24558
|
* @param {*} [options] Override http request option.
|
|
23568
24559
|
* @throws {RequiredError}
|
|
23569
24560
|
* @memberof BillingDashboardApi
|
|
23570
24561
|
*/
|
|
23571
|
-
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, {}>>;
|
|
23572
24563
|
/**
|
|
23573
24564
|
* Retrieves paginated list of credit ledger entries with filtering options for the authenticated user\'s organization
|
|
23574
24565
|
* @summary Get credit ledger
|
|
@@ -23621,6 +24612,14 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
23621
24612
|
* @memberof BillingDashboardApi
|
|
23622
24613
|
*/
|
|
23623
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, {}>>;
|
|
23624
24623
|
/**
|
|
23625
24624
|
* Retrieves billing summary for all organizations with filtering options
|
|
23626
24625
|
* @summary Get organization billing summary
|
|
@@ -23658,6 +24657,14 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
23658
24657
|
* @memberof BillingDashboardApi
|
|
23659
24658
|
*/
|
|
23660
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, {}>>;
|
|
23661
24668
|
}
|
|
23662
24669
|
/**
|
|
23663
24670
|
* CommonApi - axios parameter creator
|