@seekora-ai/admin-api 1.2.4 → 1.2.6
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 +23 -2
- package/api.ts +1448 -8
- package/dist/api.d.ts +798 -4
- package/dist/api.js +1124 -14
- package/dist/esm/api.d.ts +798 -4
- package/dist/esm/api.js +1118 -8
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.2.6.tgz +0 -0
- package/seekora-ai-admin-api-1.2.4.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -13059,6 +13059,12 @@ export interface DataTypesBillingAlertRequest {
|
|
|
13059
13059
|
* @memberof DataTypesBillingAlertRequest
|
|
13060
13060
|
*/
|
|
13061
13061
|
'alert_type'?: DataTypesBillingAlertRequestAlertTypeEnum;
|
|
13062
|
+
/**
|
|
13063
|
+
*
|
|
13064
|
+
* @type {boolean}
|
|
13065
|
+
* @memberof DataTypesBillingAlertRequest
|
|
13066
|
+
*/
|
|
13067
|
+
'applies_to_all_stores'?: boolean;
|
|
13062
13068
|
/**
|
|
13063
13069
|
* Minutes between alerts (default: 60)
|
|
13064
13070
|
* @type {number}
|
|
@@ -13087,6 +13093,12 @@ export interface DataTypesBillingAlertRequest {
|
|
|
13087
13093
|
'notification_channels'?: {
|
|
13088
13094
|
[key: string]: any;
|
|
13089
13095
|
};
|
|
13096
|
+
/**
|
|
13097
|
+
*
|
|
13098
|
+
* @type {number}
|
|
13099
|
+
* @memberof DataTypesBillingAlertRequest
|
|
13100
|
+
*/
|
|
13101
|
+
'rolling_days'?: number;
|
|
13090
13102
|
/**
|
|
13091
13103
|
* Percentage threshold 0-100 (exclusive with threshold_value)
|
|
13092
13104
|
* @type {number}
|
|
@@ -13105,6 +13117,12 @@ export interface DataTypesBillingAlertRequest {
|
|
|
13105
13117
|
* @memberof DataTypesBillingAlertRequest
|
|
13106
13118
|
*/
|
|
13107
13119
|
'threshold_value'?: number;
|
|
13120
|
+
/**
|
|
13121
|
+
*
|
|
13122
|
+
* @type {string}
|
|
13123
|
+
* @memberof DataTypesBillingAlertRequest
|
|
13124
|
+
*/
|
|
13125
|
+
'window_type'?: string;
|
|
13108
13126
|
/**
|
|
13109
13127
|
* Alternative to store_id - will be converted to store_id
|
|
13110
13128
|
* @type {string}
|
|
@@ -14969,6 +14987,7 @@ export declare const DataTypesCreatePaymentOrderRequestPaymentTypeEnum: {
|
|
|
14969
14987
|
readonly Generic: "generic";
|
|
14970
14988
|
readonly Subscription: "subscription";
|
|
14971
14989
|
readonly CreditTopup: "credit_topup";
|
|
14990
|
+
readonly PlanChange: "plan_change";
|
|
14972
14991
|
};
|
|
14973
14992
|
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
14974
14993
|
/**
|
|
@@ -16099,6 +16118,12 @@ export interface DataTypesCurrentPlanInfo {
|
|
|
16099
16118
|
* @memberof DataTypesCurrentPlanInfo
|
|
16100
16119
|
*/
|
|
16101
16120
|
'billing_cycle'?: string;
|
|
16121
|
+
/**
|
|
16122
|
+
* Currency of the subscription (INR, USD)
|
|
16123
|
+
* @type {string}
|
|
16124
|
+
* @memberof DataTypesCurrentPlanInfo
|
|
16125
|
+
*/
|
|
16126
|
+
'currency_code'?: string;
|
|
16102
16127
|
/**
|
|
16103
16128
|
*
|
|
16104
16129
|
* @type {string}
|
|
@@ -22377,6 +22402,18 @@ export interface DataTypesInvoice {
|
|
|
22377
22402
|
* @memberof DataTypesInvoice
|
|
22378
22403
|
*/
|
|
22379
22404
|
'created_at'?: string;
|
|
22405
|
+
/**
|
|
22406
|
+
*
|
|
22407
|
+
* @type {string}
|
|
22408
|
+
* @memberof DataTypesInvoice
|
|
22409
|
+
*/
|
|
22410
|
+
'credit_note_reason'?: string;
|
|
22411
|
+
/**
|
|
22412
|
+
*
|
|
22413
|
+
* @type {string}
|
|
22414
|
+
* @memberof DataTypesInvoice
|
|
22415
|
+
*/
|
|
22416
|
+
'credit_note_status'?: string;
|
|
22380
22417
|
/**
|
|
22381
22418
|
*
|
|
22382
22419
|
* @type {string}
|
|
@@ -22413,6 +22450,12 @@ export interface DataTypesInvoice {
|
|
|
22413
22450
|
* @memberof DataTypesInvoice
|
|
22414
22451
|
*/
|
|
22415
22452
|
'invoice_pdf_url'?: string;
|
|
22453
|
+
/**
|
|
22454
|
+
* Credit note fields (only populated when invoice_type = \'credit_note\')
|
|
22455
|
+
* @type {string}
|
|
22456
|
+
* @memberof DataTypesInvoice
|
|
22457
|
+
*/
|
|
22458
|
+
'invoice_type'?: string;
|
|
22416
22459
|
/**
|
|
22417
22460
|
*
|
|
22418
22461
|
* @type {string}
|
|
@@ -22453,6 +22496,18 @@ export interface DataTypesInvoice {
|
|
|
22453
22496
|
* @memberof DataTypesInvoice
|
|
22454
22497
|
*/
|
|
22455
22498
|
'org_name'?: string;
|
|
22499
|
+
/**
|
|
22500
|
+
*
|
|
22501
|
+
* @type {string}
|
|
22502
|
+
* @memberof DataTypesInvoice
|
|
22503
|
+
*/
|
|
22504
|
+
'original_invoice_id'?: string;
|
|
22505
|
+
/**
|
|
22506
|
+
*
|
|
22507
|
+
* @type {string}
|
|
22508
|
+
* @memberof DataTypesInvoice
|
|
22509
|
+
*/
|
|
22510
|
+
'original_invoice_number'?: string;
|
|
22456
22511
|
/**
|
|
22457
22512
|
*
|
|
22458
22513
|
* @type {string}
|
|
@@ -22495,6 +22550,12 @@ export interface DataTypesInvoice {
|
|
|
22495
22550
|
* @memberof DataTypesInvoice
|
|
22496
22551
|
*/
|
|
22497
22552
|
'receipt_pdf_url'?: string;
|
|
22553
|
+
/**
|
|
22554
|
+
*
|
|
22555
|
+
* @type {number}
|
|
22556
|
+
* @memberof DataTypesInvoice
|
|
22557
|
+
*/
|
|
22558
|
+
'refund_request_id'?: number;
|
|
22498
22559
|
/**
|
|
22499
22560
|
* \"draft\", \"sent\", \"paid\", \"overdue\", \"cancelled\"
|
|
22500
22561
|
* @type {string}
|
|
@@ -22531,6 +22592,12 @@ export interface DataTypesInvoice {
|
|
|
22531
22592
|
* @memberof DataTypesInvoice
|
|
22532
22593
|
*/
|
|
22533
22594
|
'updated_at'?: string;
|
|
22595
|
+
/**
|
|
22596
|
+
*
|
|
22597
|
+
* @type {string}
|
|
22598
|
+
* @memberof DataTypesInvoice
|
|
22599
|
+
*/
|
|
22600
|
+
'voided_at'?: string;
|
|
22534
22601
|
}
|
|
22535
22602
|
/**
|
|
22536
22603
|
*
|
|
@@ -30063,6 +30130,93 @@ export interface DataTypesSendNotificationResponse {
|
|
|
30063
30130
|
*/
|
|
30064
30131
|
'status'?: number;
|
|
30065
30132
|
}
|
|
30133
|
+
/**
|
|
30134
|
+
*
|
|
30135
|
+
* @export
|
|
30136
|
+
* @interface DataTypesSendOrgNotificationData
|
|
30137
|
+
*/
|
|
30138
|
+
export interface DataTypesSendOrgNotificationData {
|
|
30139
|
+
/**
|
|
30140
|
+
*
|
|
30141
|
+
* @type {string}
|
|
30142
|
+
* @memberof DataTypesSendOrgNotificationData
|
|
30143
|
+
*/
|
|
30144
|
+
'scope'?: string;
|
|
30145
|
+
/**
|
|
30146
|
+
*
|
|
30147
|
+
* @type {number}
|
|
30148
|
+
* @memberof DataTypesSendOrgNotificationData
|
|
30149
|
+
*/
|
|
30150
|
+
'sent_count'?: number;
|
|
30151
|
+
}
|
|
30152
|
+
/**
|
|
30153
|
+
*
|
|
30154
|
+
* @export
|
|
30155
|
+
* @interface DataTypesSendOrgNotificationRequest
|
|
30156
|
+
*/
|
|
30157
|
+
export interface DataTypesSendOrgNotificationRequest {
|
|
30158
|
+
/**
|
|
30159
|
+
*
|
|
30160
|
+
* @type {Array<DataTypesNotificationChannel>}
|
|
30161
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30162
|
+
*/
|
|
30163
|
+
'channels'?: Array<DataTypesNotificationChannel>;
|
|
30164
|
+
/**
|
|
30165
|
+
*
|
|
30166
|
+
* @type {string}
|
|
30167
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30168
|
+
*/
|
|
30169
|
+
'message'?: string;
|
|
30170
|
+
/**
|
|
30171
|
+
*
|
|
30172
|
+
* @type {DataTypesNotificationPriority}
|
|
30173
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30174
|
+
*/
|
|
30175
|
+
'priority'?: DataTypesNotificationPriority;
|
|
30176
|
+
/**
|
|
30177
|
+
* \"all\" | \"owners_admins\"
|
|
30178
|
+
* @type {string}
|
|
30179
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30180
|
+
*/
|
|
30181
|
+
'scope'?: string;
|
|
30182
|
+
/**
|
|
30183
|
+
*
|
|
30184
|
+
* @type {string}
|
|
30185
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30186
|
+
*/
|
|
30187
|
+
'title'?: string;
|
|
30188
|
+
/**
|
|
30189
|
+
*
|
|
30190
|
+
* @type {DataTypesNotificationType}
|
|
30191
|
+
* @memberof DataTypesSendOrgNotificationRequest
|
|
30192
|
+
*/
|
|
30193
|
+
'type'?: DataTypesNotificationType;
|
|
30194
|
+
}
|
|
30195
|
+
/**
|
|
30196
|
+
*
|
|
30197
|
+
* @export
|
|
30198
|
+
* @interface DataTypesSendOrgNotificationResponse
|
|
30199
|
+
*/
|
|
30200
|
+
export interface DataTypesSendOrgNotificationResponse {
|
|
30201
|
+
/**
|
|
30202
|
+
*
|
|
30203
|
+
* @type {DataTypesSendOrgNotificationData}
|
|
30204
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30205
|
+
*/
|
|
30206
|
+
'data'?: DataTypesSendOrgNotificationData;
|
|
30207
|
+
/**
|
|
30208
|
+
*
|
|
30209
|
+
* @type {string}
|
|
30210
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30211
|
+
*/
|
|
30212
|
+
'message'?: string;
|
|
30213
|
+
/**
|
|
30214
|
+
*
|
|
30215
|
+
* @type {number}
|
|
30216
|
+
* @memberof DataTypesSendOrgNotificationResponse
|
|
30217
|
+
*/
|
|
30218
|
+
'status'?: number;
|
|
30219
|
+
}
|
|
30066
30220
|
/**
|
|
30067
30221
|
*
|
|
30068
30222
|
* @export
|
|
@@ -32095,6 +32249,49 @@ export interface DataTypesStoreLevelMenuRightWithMenu {
|
|
|
32095
32249
|
*/
|
|
32096
32250
|
'xStoreId'?: string;
|
|
32097
32251
|
}
|
|
32252
|
+
/**
|
|
32253
|
+
*
|
|
32254
|
+
* @export
|
|
32255
|
+
* @interface DataTypesStoreQuotaRequest
|
|
32256
|
+
*/
|
|
32257
|
+
export interface DataTypesStoreQuotaRequest {
|
|
32258
|
+
/**
|
|
32259
|
+
*
|
|
32260
|
+
* @type {string}
|
|
32261
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32262
|
+
*/
|
|
32263
|
+
'enforcement_mode'?: string;
|
|
32264
|
+
/**
|
|
32265
|
+
*
|
|
32266
|
+
* @type {boolean}
|
|
32267
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32268
|
+
*/
|
|
32269
|
+
'is_enabled'?: boolean;
|
|
32270
|
+
/**
|
|
32271
|
+
*
|
|
32272
|
+
* @type {number}
|
|
32273
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32274
|
+
*/
|
|
32275
|
+
'quota_amount'?: number;
|
|
32276
|
+
/**
|
|
32277
|
+
*
|
|
32278
|
+
* @type {number}
|
|
32279
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32280
|
+
*/
|
|
32281
|
+
'rolling_days'?: number;
|
|
32282
|
+
/**
|
|
32283
|
+
*
|
|
32284
|
+
* @type {string}
|
|
32285
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32286
|
+
*/
|
|
32287
|
+
'store_id'?: string;
|
|
32288
|
+
/**
|
|
32289
|
+
*
|
|
32290
|
+
* @type {string}
|
|
32291
|
+
* @memberof DataTypesStoreQuotaRequest
|
|
32292
|
+
*/
|
|
32293
|
+
'window_type'?: string;
|
|
32294
|
+
}
|
|
32098
32295
|
/**
|
|
32099
32296
|
*
|
|
32100
32297
|
* @export
|
|
@@ -40506,6 +40703,31 @@ export interface SubscriptionRouteCancelProcessRequest {
|
|
|
40506
40703
|
*/
|
|
40507
40704
|
'subscription_id'?: string;
|
|
40508
40705
|
}
|
|
40706
|
+
/**
|
|
40707
|
+
*
|
|
40708
|
+
* @export
|
|
40709
|
+
* @interface SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40710
|
+
*/
|
|
40711
|
+
export interface SubscriptionRouteImmediatePlanChangeOrderHTTPRequest {
|
|
40712
|
+
/**
|
|
40713
|
+
*
|
|
40714
|
+
* @type {string}
|
|
40715
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40716
|
+
*/
|
|
40717
|
+
'billing_cycle'?: string;
|
|
40718
|
+
/**
|
|
40719
|
+
*
|
|
40720
|
+
* @type {string}
|
|
40721
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40722
|
+
*/
|
|
40723
|
+
'currency'?: string;
|
|
40724
|
+
/**
|
|
40725
|
+
*
|
|
40726
|
+
* @type {string}
|
|
40727
|
+
* @memberof SubscriptionRouteImmediatePlanChangeOrderHTTPRequest
|
|
40728
|
+
*/
|
|
40729
|
+
'new_plan_identifier'?: string;
|
|
40730
|
+
}
|
|
40509
40731
|
/**
|
|
40510
40732
|
*
|
|
40511
40733
|
* @export
|
|
@@ -40537,6 +40759,31 @@ export interface SubscriptionRoutePlanChangePreviewHTTPRequest {
|
|
|
40537
40759
|
*/
|
|
40538
40760
|
'new_plan_identifier'?: string;
|
|
40539
40761
|
}
|
|
40762
|
+
/**
|
|
40763
|
+
*
|
|
40764
|
+
* @export
|
|
40765
|
+
* @interface SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40766
|
+
*/
|
|
40767
|
+
export interface SubscriptionRouteSchedulePlanChangeHTTPRequest {
|
|
40768
|
+
/**
|
|
40769
|
+
*
|
|
40770
|
+
* @type {string}
|
|
40771
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40772
|
+
*/
|
|
40773
|
+
'billing_cycle'?: string;
|
|
40774
|
+
/**
|
|
40775
|
+
*
|
|
40776
|
+
* @type {string}
|
|
40777
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40778
|
+
*/
|
|
40779
|
+
'currency'?: string;
|
|
40780
|
+
/**
|
|
40781
|
+
*
|
|
40782
|
+
* @type {string}
|
|
40783
|
+
* @memberof SubscriptionRouteSchedulePlanChangeHTTPRequest
|
|
40784
|
+
*/
|
|
40785
|
+
'new_plan_identifier'?: string;
|
|
40786
|
+
}
|
|
40540
40787
|
/**
|
|
40541
40788
|
*
|
|
40542
40789
|
* @export
|
|
@@ -41563,6 +41810,14 @@ export declare const AdminNotificationsApiAxiosParamCreator: (configuration?: Co
|
|
|
41563
41810
|
* @throws {RequiredError}
|
|
41564
41811
|
*/
|
|
41565
41812
|
v1AdminNotificationsSendBulkPost: (dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41813
|
+
/**
|
|
41814
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
41815
|
+
* @summary Send org-wide notification (Admin)
|
|
41816
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
41817
|
+
* @param {*} [options] Override http request option.
|
|
41818
|
+
* @throws {RequiredError}
|
|
41819
|
+
*/
|
|
41820
|
+
v1AdminNotificationsSendOrgPost: (dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41566
41821
|
/**
|
|
41567
41822
|
* Sends a notification to specified users (requires admin privileges)
|
|
41568
41823
|
* @summary Send notification (Admin)
|
|
@@ -41658,6 +41913,14 @@ export declare const AdminNotificationsApiFp: (configuration?: Configuration) =>
|
|
|
41658
41913
|
* @throws {RequiredError}
|
|
41659
41914
|
*/
|
|
41660
41915
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSendBulkNotificationResponse>>;
|
|
41916
|
+
/**
|
|
41917
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
41918
|
+
* @summary Send org-wide notification (Admin)
|
|
41919
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
41920
|
+
* @param {*} [options] Override http request option.
|
|
41921
|
+
* @throws {RequiredError}
|
|
41922
|
+
*/
|
|
41923
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSendOrgNotificationResponse>>;
|
|
41661
41924
|
/**
|
|
41662
41925
|
* Sends a notification to specified users (requires admin privileges)
|
|
41663
41926
|
* @summary Send notification (Admin)
|
|
@@ -41753,6 +42016,14 @@ export declare const AdminNotificationsApiFactory: (configuration?: Configuratio
|
|
|
41753
42016
|
* @throws {RequiredError}
|
|
41754
42017
|
*/
|
|
41755
42018
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSendBulkNotificationResponse>;
|
|
42019
|
+
/**
|
|
42020
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
42021
|
+
* @summary Send org-wide notification (Admin)
|
|
42022
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
42023
|
+
* @param {*} [options] Override http request option.
|
|
42024
|
+
* @throws {RequiredError}
|
|
42025
|
+
*/
|
|
42026
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSendOrgNotificationResponse>;
|
|
41756
42027
|
/**
|
|
41757
42028
|
* Sends a notification to specified users (requires admin privileges)
|
|
41758
42029
|
* @summary Send notification (Admin)
|
|
@@ -41857,6 +42128,15 @@ export declare class AdminNotificationsApi extends BaseAPI {
|
|
|
41857
42128
|
* @memberof AdminNotificationsApi
|
|
41858
42129
|
*/
|
|
41859
42130
|
v1AdminNotificationsSendBulkPost(dataTypesNotificationBatch: DataTypesNotificationBatch, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSendBulkNotificationResponse, any, {}>>;
|
|
42131
|
+
/**
|
|
42132
|
+
* Sends a notification to all active members of the caller\'s organization. The caller must be an org owner or admin. Scope \"all\" includes every member; \"owners_admins\" targets owners and admins only.
|
|
42133
|
+
* @summary Send org-wide notification (Admin)
|
|
42134
|
+
* @param {DataTypesSendOrgNotificationRequest} dataTypesSendOrgNotificationRequest Org notification details
|
|
42135
|
+
* @param {*} [options] Override http request option.
|
|
42136
|
+
* @throws {RequiredError}
|
|
42137
|
+
* @memberof AdminNotificationsApi
|
|
42138
|
+
*/
|
|
42139
|
+
v1AdminNotificationsSendOrgPost(dataTypesSendOrgNotificationRequest: DataTypesSendOrgNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSendOrgNotificationResponse, any, {}>>;
|
|
41860
42140
|
/**
|
|
41861
42141
|
* Sends a notification to specified users (requires admin privileges)
|
|
41862
42142
|
* @summary Send notification (Admin)
|
|
@@ -48239,6 +48519,20 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48239
48519
|
* @throws {RequiredError}
|
|
48240
48520
|
*/
|
|
48241
48521
|
adminBillingActivePlanGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48522
|
+
/**
|
|
48523
|
+
* Returns paginated alert trigger history with optional filters
|
|
48524
|
+
* @summary Get alert trigger history
|
|
48525
|
+
* @param {string} [storeId] Filter by store xStoreID
|
|
48526
|
+
* @param {string} [from] Start date (YYYY-MM-DD)
|
|
48527
|
+
* @param {string} [to] End date (YYYY-MM-DD)
|
|
48528
|
+
* @param {string} [alertType] Filter by alert type (store_usage_threshold, store_usage_approaching, quota_hard_block)
|
|
48529
|
+
* @param {string} [status] Filter by status (resolved, unresolved)
|
|
48530
|
+
* @param {number} [page] Page number
|
|
48531
|
+
* @param {number} [perPage] Items per page
|
|
48532
|
+
* @param {*} [options] Override http request option.
|
|
48533
|
+
* @throws {RequiredError}
|
|
48534
|
+
*/
|
|
48535
|
+
adminBillingAlertHistoryGet: (storeId?: string, from?: string, to?: string, alertType?: string, status?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48242
48536
|
/**
|
|
48243
48537
|
* Retrieves paginated billing alerts with store filtering and full-text search across: alert ID, alert name, alert type, threshold values, units, org/store name, created by name, emails, and JSON fields.
|
|
48244
48538
|
* @summary Get billing alerts
|
|
@@ -48314,6 +48608,16 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48314
48608
|
* @throws {RequiredError}
|
|
48315
48609
|
*/
|
|
48316
48610
|
adminBillingCreditLedgerGet: (orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48611
|
+
/**
|
|
48612
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
48613
|
+
* @summary Export credit notes for GSTR-1
|
|
48614
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
48615
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
48616
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
48617
|
+
* @param {*} [options] Override http request option.
|
|
48618
|
+
* @throws {RequiredError}
|
|
48619
|
+
*/
|
|
48620
|
+
adminBillingCreditNotesExportGet: (startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48317
48621
|
/**
|
|
48318
48622
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
48319
48623
|
* @summary Get credit purchases
|
|
@@ -48382,10 +48686,11 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48382
48686
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
48383
48687
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
48384
48688
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
48689
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
48385
48690
|
* @param {*} [options] Override http request option.
|
|
48386
48691
|
* @throws {RequiredError}
|
|
48387
48692
|
*/
|
|
48388
|
-
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48693
|
+
adminBillingInvoicesGet: (orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48389
48694
|
/**
|
|
48390
48695
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
48391
48696
|
* @summary Delete invoice
|
|
@@ -48427,6 +48732,14 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48427
48732
|
* @throws {RequiredError}
|
|
48428
48733
|
*/
|
|
48429
48734
|
adminBillingInvoicesIdPut: (id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48735
|
+
/**
|
|
48736
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
48737
|
+
* @summary Void a credit note
|
|
48738
|
+
* @param {string} id Invoice ID (UUID)
|
|
48739
|
+
* @param {*} [options] Override http request option.
|
|
48740
|
+
* @throws {RequiredError}
|
|
48741
|
+
*/
|
|
48742
|
+
adminBillingInvoicesIdVoidPost: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48430
48743
|
/**
|
|
48431
48744
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
48432
48745
|
* @summary Pay a pending invoice
|
|
@@ -48572,6 +48885,66 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
|
|
|
48572
48885
|
* @throws {RequiredError}
|
|
48573
48886
|
*/
|
|
48574
48887
|
adminBillingSavedCardsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48888
|
+
/**
|
|
48889
|
+
* Returns paginated list of per-store credit quotas for the organization
|
|
48890
|
+
* @summary List store credit quotas
|
|
48891
|
+
* @param {number} [page] Page number
|
|
48892
|
+
* @param {number} [perPage] Items per page
|
|
48893
|
+
* @param {string} [search] Search by store name
|
|
48894
|
+
* @param {*} [options] Override http request option.
|
|
48895
|
+
* @throws {RequiredError}
|
|
48896
|
+
*/
|
|
48897
|
+
adminBillingStoreQuotasGet: (page?: number, perPage?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48898
|
+
/**
|
|
48899
|
+
* Creates a per-store credit quota with configurable window and enforcement
|
|
48900
|
+
* @summary Create store credit quota
|
|
48901
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Quota configuration
|
|
48902
|
+
* @param {*} [options] Override http request option.
|
|
48903
|
+
* @throws {RequiredError}
|
|
48904
|
+
*/
|
|
48905
|
+
adminBillingStoreQuotasPost: (dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48906
|
+
/**
|
|
48907
|
+
* Deletes a per-store credit quota by UUID
|
|
48908
|
+
* @summary Delete store credit quota
|
|
48909
|
+
* @param {string} quotaUuid Quota UUID
|
|
48910
|
+
* @param {*} [options] Override http request option.
|
|
48911
|
+
* @throws {RequiredError}
|
|
48912
|
+
*/
|
|
48913
|
+
adminBillingStoreQuotasQuotaUuidDelete: (quotaUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48914
|
+
/**
|
|
48915
|
+
* Returns a single store credit quota by UUID
|
|
48916
|
+
* @summary Get store credit quota
|
|
48917
|
+
* @param {string} quotaUuid Quota UUID
|
|
48918
|
+
* @param {*} [options] Override http request option.
|
|
48919
|
+
* @throws {RequiredError}
|
|
48920
|
+
*/
|
|
48921
|
+
adminBillingStoreQuotasQuotaUuidGet: (quotaUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48922
|
+
/**
|
|
48923
|
+
* Updates an existing per-store credit quota
|
|
48924
|
+
* @summary Update store credit quota
|
|
48925
|
+
* @param {string} quotaUuid Quota UUID
|
|
48926
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Updated quota configuration
|
|
48927
|
+
* @param {*} [options] Override http request option.
|
|
48928
|
+
* @throws {RequiredError}
|
|
48929
|
+
*/
|
|
48930
|
+
adminBillingStoreQuotasQuotaUuidPut: (quotaUuid: string, dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48931
|
+
/**
|
|
48932
|
+
* Returns paginated usage summary for all stores in the organization
|
|
48933
|
+
* @summary Get all stores usage summary
|
|
48934
|
+
* @param {number} [page] Page number
|
|
48935
|
+
* @param {number} [perPage] Items per page
|
|
48936
|
+
* @param {*} [options] Override http request option.
|
|
48937
|
+
* @throws {RequiredError}
|
|
48938
|
+
*/
|
|
48939
|
+
adminBillingStoreUsageGet: (page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48940
|
+
/**
|
|
48941
|
+
* Returns detailed usage breakdown for a single store
|
|
48942
|
+
* @summary Get single store usage detail
|
|
48943
|
+
* @param {string} xStoreId Store external ID
|
|
48944
|
+
* @param {*} [options] Override http request option.
|
|
48945
|
+
* @throws {RequiredError}
|
|
48946
|
+
*/
|
|
48947
|
+
adminBillingStoreUsageXStoreIdGet: (xStoreId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48575
48948
|
/**
|
|
48576
48949
|
* Returns detailed usage information with charts and breakdown, supports time granularity and pagination
|
|
48577
48950
|
* @summary Get usage details with granularity and pagination
|
|
@@ -48633,6 +49006,20 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48633
49006
|
* @throws {RequiredError}
|
|
48634
49007
|
*/
|
|
48635
49008
|
adminBillingActivePlanGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesCurrentPlanInfo>>;
|
|
49009
|
+
/**
|
|
49010
|
+
* Returns paginated alert trigger history with optional filters
|
|
49011
|
+
* @summary Get alert trigger history
|
|
49012
|
+
* @param {string} [storeId] Filter by store xStoreID
|
|
49013
|
+
* @param {string} [from] Start date (YYYY-MM-DD)
|
|
49014
|
+
* @param {string} [to] End date (YYYY-MM-DD)
|
|
49015
|
+
* @param {string} [alertType] Filter by alert type (store_usage_threshold, store_usage_approaching, quota_hard_block)
|
|
49016
|
+
* @param {string} [status] Filter by status (resolved, unresolved)
|
|
49017
|
+
* @param {number} [page] Page number
|
|
49018
|
+
* @param {number} [perPage] Items per page
|
|
49019
|
+
* @param {*} [options] Override http request option.
|
|
49020
|
+
* @throws {RequiredError}
|
|
49021
|
+
*/
|
|
49022
|
+
adminBillingAlertHistoryGet(storeId?: string, from?: string, to?: string, alertType?: string, status?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48636
49023
|
/**
|
|
48637
49024
|
* Retrieves paginated billing alerts with store filtering and full-text search across: alert ID, alert name, alert type, threshold values, units, org/store name, created by name, emails, and JSON fields.
|
|
48638
49025
|
* @summary Get billing alerts
|
|
@@ -48708,6 +49095,16 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48708
49095
|
* @throws {RequiredError}
|
|
48709
49096
|
*/
|
|
48710
49097
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49098
|
+
/**
|
|
49099
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
49100
|
+
* @summary Export credit notes for GSTR-1
|
|
49101
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
49102
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
49103
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
49104
|
+
* @param {*} [options] Override http request option.
|
|
49105
|
+
* @throws {RequiredError}
|
|
49106
|
+
*/
|
|
49107
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
48711
49108
|
/**
|
|
48712
49109
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
48713
49110
|
* @summary Get credit purchases
|
|
@@ -48776,10 +49173,11 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48776
49173
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
48777
49174
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
48778
49175
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
49176
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
48779
49177
|
* @param {*} [options] Override http request option.
|
|
48780
49178
|
* @throws {RequiredError}
|
|
48781
49179
|
*/
|
|
48782
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49180
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48783
49181
|
/**
|
|
48784
49182
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
48785
49183
|
* @summary Delete invoice
|
|
@@ -48821,6 +49219,14 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48821
49219
|
* @throws {RequiredError}
|
|
48822
49220
|
*/
|
|
48823
49221
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49222
|
+
/**
|
|
49223
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
49224
|
+
* @summary Void a credit note
|
|
49225
|
+
* @param {string} id Invoice ID (UUID)
|
|
49226
|
+
* @param {*} [options] Override http request option.
|
|
49227
|
+
* @throws {RequiredError}
|
|
49228
|
+
*/
|
|
49229
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48824
49230
|
/**
|
|
48825
49231
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
48826
49232
|
* @summary Pay a pending invoice
|
|
@@ -48966,6 +49372,66 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
|
|
|
48966
49372
|
* @throws {RequiredError}
|
|
48967
49373
|
*/
|
|
48968
49374
|
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49375
|
+
/**
|
|
49376
|
+
* Returns paginated list of per-store credit quotas for the organization
|
|
49377
|
+
* @summary List store credit quotas
|
|
49378
|
+
* @param {number} [page] Page number
|
|
49379
|
+
* @param {number} [perPage] Items per page
|
|
49380
|
+
* @param {string} [search] Search by store name
|
|
49381
|
+
* @param {*} [options] Override http request option.
|
|
49382
|
+
* @throws {RequiredError}
|
|
49383
|
+
*/
|
|
49384
|
+
adminBillingStoreQuotasGet(page?: number, perPage?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49385
|
+
/**
|
|
49386
|
+
* Creates a per-store credit quota with configurable window and enforcement
|
|
49387
|
+
* @summary Create store credit quota
|
|
49388
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Quota configuration
|
|
49389
|
+
* @param {*} [options] Override http request option.
|
|
49390
|
+
* @throws {RequiredError}
|
|
49391
|
+
*/
|
|
49392
|
+
adminBillingStoreQuotasPost(dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49393
|
+
/**
|
|
49394
|
+
* Deletes a per-store credit quota by UUID
|
|
49395
|
+
* @summary Delete store credit quota
|
|
49396
|
+
* @param {string} quotaUuid Quota UUID
|
|
49397
|
+
* @param {*} [options] Override http request option.
|
|
49398
|
+
* @throws {RequiredError}
|
|
49399
|
+
*/
|
|
49400
|
+
adminBillingStoreQuotasQuotaUuidDelete(quotaUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49401
|
+
/**
|
|
49402
|
+
* Returns a single store credit quota by UUID
|
|
49403
|
+
* @summary Get store credit quota
|
|
49404
|
+
* @param {string} quotaUuid Quota UUID
|
|
49405
|
+
* @param {*} [options] Override http request option.
|
|
49406
|
+
* @throws {RequiredError}
|
|
49407
|
+
*/
|
|
49408
|
+
adminBillingStoreQuotasQuotaUuidGet(quotaUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49409
|
+
/**
|
|
49410
|
+
* Updates an existing per-store credit quota
|
|
49411
|
+
* @summary Update store credit quota
|
|
49412
|
+
* @param {string} quotaUuid Quota UUID
|
|
49413
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Updated quota configuration
|
|
49414
|
+
* @param {*} [options] Override http request option.
|
|
49415
|
+
* @throws {RequiredError}
|
|
49416
|
+
*/
|
|
49417
|
+
adminBillingStoreQuotasQuotaUuidPut(quotaUuid: string, dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49418
|
+
/**
|
|
49419
|
+
* Returns paginated usage summary for all stores in the organization
|
|
49420
|
+
* @summary Get all stores usage summary
|
|
49421
|
+
* @param {number} [page] Page number
|
|
49422
|
+
* @param {number} [perPage] Items per page
|
|
49423
|
+
* @param {*} [options] Override http request option.
|
|
49424
|
+
* @throws {RequiredError}
|
|
49425
|
+
*/
|
|
49426
|
+
adminBillingStoreUsageGet(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
49427
|
+
/**
|
|
49428
|
+
* Returns detailed usage breakdown for a single store
|
|
49429
|
+
* @summary Get single store usage detail
|
|
49430
|
+
* @param {string} xStoreId Store external ID
|
|
49431
|
+
* @param {*} [options] Override http request option.
|
|
49432
|
+
* @throws {RequiredError}
|
|
49433
|
+
*/
|
|
49434
|
+
adminBillingStoreUsageXStoreIdGet(xStoreId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48969
49435
|
/**
|
|
48970
49436
|
* Returns detailed usage information with charts and breakdown, supports time granularity and pagination
|
|
48971
49437
|
* @summary Get usage details with granularity and pagination
|
|
@@ -49027,6 +49493,20 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49027
49493
|
* @throws {RequiredError}
|
|
49028
49494
|
*/
|
|
49029
49495
|
adminBillingActivePlanGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesCurrentPlanInfo>;
|
|
49496
|
+
/**
|
|
49497
|
+
* Returns paginated alert trigger history with optional filters
|
|
49498
|
+
* @summary Get alert trigger history
|
|
49499
|
+
* @param {string} [storeId] Filter by store xStoreID
|
|
49500
|
+
* @param {string} [from] Start date (YYYY-MM-DD)
|
|
49501
|
+
* @param {string} [to] End date (YYYY-MM-DD)
|
|
49502
|
+
* @param {string} [alertType] Filter by alert type (store_usage_threshold, store_usage_approaching, quota_hard_block)
|
|
49503
|
+
* @param {string} [status] Filter by status (resolved, unresolved)
|
|
49504
|
+
* @param {number} [page] Page number
|
|
49505
|
+
* @param {number} [perPage] Items per page
|
|
49506
|
+
* @param {*} [options] Override http request option.
|
|
49507
|
+
* @throws {RequiredError}
|
|
49508
|
+
*/
|
|
49509
|
+
adminBillingAlertHistoryGet(storeId?: string, from?: string, to?: string, alertType?: string, status?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49030
49510
|
/**
|
|
49031
49511
|
* Retrieves paginated billing alerts with store filtering and full-text search across: alert ID, alert name, alert type, threshold values, units, org/store name, created by name, emails, and JSON fields.
|
|
49032
49512
|
* @summary Get billing alerts
|
|
@@ -49102,6 +49582,16 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49102
49582
|
* @throws {RequiredError}
|
|
49103
49583
|
*/
|
|
49104
49584
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49585
|
+
/**
|
|
49586
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
49587
|
+
* @summary Export credit notes for GSTR-1
|
|
49588
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
49589
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
49590
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
49591
|
+
* @param {*} [options] Override http request option.
|
|
49592
|
+
* @throws {RequiredError}
|
|
49593
|
+
*/
|
|
49594
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
49105
49595
|
/**
|
|
49106
49596
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
49107
49597
|
* @summary Get credit purchases
|
|
@@ -49170,10 +49660,11 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49170
49660
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
49171
49661
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
49172
49662
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
49663
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
49173
49664
|
* @param {*} [options] Override http request option.
|
|
49174
49665
|
* @throws {RequiredError}
|
|
49175
49666
|
*/
|
|
49176
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49667
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49177
49668
|
/**
|
|
49178
49669
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
49179
49670
|
* @summary Delete invoice
|
|
@@ -49215,6 +49706,14 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49215
49706
|
* @throws {RequiredError}
|
|
49216
49707
|
*/
|
|
49217
49708
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49709
|
+
/**
|
|
49710
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
49711
|
+
* @summary Void a credit note
|
|
49712
|
+
* @param {string} id Invoice ID (UUID)
|
|
49713
|
+
* @param {*} [options] Override http request option.
|
|
49714
|
+
* @throws {RequiredError}
|
|
49715
|
+
*/
|
|
49716
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49218
49717
|
/**
|
|
49219
49718
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
49220
49719
|
* @summary Pay a pending invoice
|
|
@@ -49360,6 +49859,66 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
|
|
|
49360
49859
|
* @throws {RequiredError}
|
|
49361
49860
|
*/
|
|
49362
49861
|
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49862
|
+
/**
|
|
49863
|
+
* Returns paginated list of per-store credit quotas for the organization
|
|
49864
|
+
* @summary List store credit quotas
|
|
49865
|
+
* @param {number} [page] Page number
|
|
49866
|
+
* @param {number} [perPage] Items per page
|
|
49867
|
+
* @param {string} [search] Search by store name
|
|
49868
|
+
* @param {*} [options] Override http request option.
|
|
49869
|
+
* @throws {RequiredError}
|
|
49870
|
+
*/
|
|
49871
|
+
adminBillingStoreQuotasGet(page?: number, perPage?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49872
|
+
/**
|
|
49873
|
+
* Creates a per-store credit quota with configurable window and enforcement
|
|
49874
|
+
* @summary Create store credit quota
|
|
49875
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Quota configuration
|
|
49876
|
+
* @param {*} [options] Override http request option.
|
|
49877
|
+
* @throws {RequiredError}
|
|
49878
|
+
*/
|
|
49879
|
+
adminBillingStoreQuotasPost(dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49880
|
+
/**
|
|
49881
|
+
* Deletes a per-store credit quota by UUID
|
|
49882
|
+
* @summary Delete store credit quota
|
|
49883
|
+
* @param {string} quotaUuid Quota UUID
|
|
49884
|
+
* @param {*} [options] Override http request option.
|
|
49885
|
+
* @throws {RequiredError}
|
|
49886
|
+
*/
|
|
49887
|
+
adminBillingStoreQuotasQuotaUuidDelete(quotaUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49888
|
+
/**
|
|
49889
|
+
* Returns a single store credit quota by UUID
|
|
49890
|
+
* @summary Get store credit quota
|
|
49891
|
+
* @param {string} quotaUuid Quota UUID
|
|
49892
|
+
* @param {*} [options] Override http request option.
|
|
49893
|
+
* @throws {RequiredError}
|
|
49894
|
+
*/
|
|
49895
|
+
adminBillingStoreQuotasQuotaUuidGet(quotaUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49896
|
+
/**
|
|
49897
|
+
* Updates an existing per-store credit quota
|
|
49898
|
+
* @summary Update store credit quota
|
|
49899
|
+
* @param {string} quotaUuid Quota UUID
|
|
49900
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Updated quota configuration
|
|
49901
|
+
* @param {*} [options] Override http request option.
|
|
49902
|
+
* @throws {RequiredError}
|
|
49903
|
+
*/
|
|
49904
|
+
adminBillingStoreQuotasQuotaUuidPut(quotaUuid: string, dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49905
|
+
/**
|
|
49906
|
+
* Returns paginated usage summary for all stores in the organization
|
|
49907
|
+
* @summary Get all stores usage summary
|
|
49908
|
+
* @param {number} [page] Page number
|
|
49909
|
+
* @param {number} [perPage] Items per page
|
|
49910
|
+
* @param {*} [options] Override http request option.
|
|
49911
|
+
* @throws {RequiredError}
|
|
49912
|
+
*/
|
|
49913
|
+
adminBillingStoreUsageGet(page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49914
|
+
/**
|
|
49915
|
+
* Returns detailed usage breakdown for a single store
|
|
49916
|
+
* @summary Get single store usage detail
|
|
49917
|
+
* @param {string} xStoreId Store external ID
|
|
49918
|
+
* @param {*} [options] Override http request option.
|
|
49919
|
+
* @throws {RequiredError}
|
|
49920
|
+
*/
|
|
49921
|
+
adminBillingStoreUsageXStoreIdGet(xStoreId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
49363
49922
|
/**
|
|
49364
49923
|
* Returns detailed usage information with charts and breakdown, supports time granularity and pagination
|
|
49365
49924
|
* @summary Get usage details with granularity and pagination
|
|
@@ -49424,6 +49983,21 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49424
49983
|
* @memberof BillingDashboardApi
|
|
49425
49984
|
*/
|
|
49426
49985
|
adminBillingActivePlanGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesCurrentPlanInfo, any, {}>>;
|
|
49986
|
+
/**
|
|
49987
|
+
* Returns paginated alert trigger history with optional filters
|
|
49988
|
+
* @summary Get alert trigger history
|
|
49989
|
+
* @param {string} [storeId] Filter by store xStoreID
|
|
49990
|
+
* @param {string} [from] Start date (YYYY-MM-DD)
|
|
49991
|
+
* @param {string} [to] End date (YYYY-MM-DD)
|
|
49992
|
+
* @param {string} [alertType] Filter by alert type (store_usage_threshold, store_usage_approaching, quota_hard_block)
|
|
49993
|
+
* @param {string} [status] Filter by status (resolved, unresolved)
|
|
49994
|
+
* @param {number} [page] Page number
|
|
49995
|
+
* @param {number} [perPage] Items per page
|
|
49996
|
+
* @param {*} [options] Override http request option.
|
|
49997
|
+
* @throws {RequiredError}
|
|
49998
|
+
* @memberof BillingDashboardApi
|
|
49999
|
+
*/
|
|
50000
|
+
adminBillingAlertHistoryGet(storeId?: string, from?: string, to?: string, alertType?: string, status?: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49427
50001
|
/**
|
|
49428
50002
|
* Retrieves paginated billing alerts with store filtering and full-text search across: alert ID, alert name, alert type, threshold values, units, org/store name, created by name, emails, and JSON fields.
|
|
49429
50003
|
* @summary Get billing alerts
|
|
@@ -49506,6 +50080,17 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49506
50080
|
* @memberof BillingDashboardApi
|
|
49507
50081
|
*/
|
|
49508
50082
|
adminBillingCreditLedgerGet(orgId?: number, startDate?: string, endDate?: string, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: AdminBillingCreditLedgerGetSortByEnum, sortOrder?: AdminBillingCreditLedgerGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50083
|
+
/**
|
|
50084
|
+
* Exports credit notes as a CSV file formatted for GSTR-1 filing. Includes credit note number, original invoice reference, GST breakdown, and SAC code.
|
|
50085
|
+
* @summary Export credit notes for GSTR-1
|
|
50086
|
+
* @param {string} [startDate] Start date (YYYY-MM-DD format)
|
|
50087
|
+
* @param {string} [endDate] End date (YYYY-MM-DD format)
|
|
50088
|
+
* @param {string} [fiscalYear] Fiscal year (e.g., 2526)
|
|
50089
|
+
* @param {*} [options] Override http request option.
|
|
50090
|
+
* @throws {RequiredError}
|
|
50091
|
+
* @memberof BillingDashboardApi
|
|
50092
|
+
*/
|
|
50093
|
+
adminBillingCreditNotesExportGet(startDate?: string, endDate?: string, fiscalYear?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
49509
50094
|
/**
|
|
49510
50095
|
* Retrieves paginated list of credit purchases with filtering options for the authenticated user\'s organization. Uses page/page_size pagination like analytics APIs.
|
|
49511
50096
|
* @summary Get credit purchases
|
|
@@ -49579,11 +50164,12 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49579
50164
|
* @param {number} [limit] Number of results per page (default: 20, max: 100) - alternative to page_size
|
|
49580
50165
|
* @param {AdminBillingInvoicesGetSortByEnum} [sortBy] Field to sort by
|
|
49581
50166
|
* @param {AdminBillingInvoicesGetSortOrderEnum} [sortOrder] Sort direction
|
|
50167
|
+
* @param {AdminBillingInvoicesGetInvoiceTypeEnum} [invoiceType] Filter by invoice type
|
|
49582
50168
|
* @param {*} [options] Override http request option.
|
|
49583
50169
|
* @throws {RequiredError}
|
|
49584
50170
|
* @memberof BillingDashboardApi
|
|
49585
50171
|
*/
|
|
49586
|
-
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50172
|
+
adminBillingInvoicesGet(orgId?: number, status?: string, startDate?: string, endDate?: string, search?: string, page?: number, pageSize?: number, limit?: number, sortBy?: AdminBillingInvoicesGetSortByEnum, sortOrder?: AdminBillingInvoicesGetSortOrderEnum, invoiceType?: AdminBillingInvoicesGetInvoiceTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49587
50173
|
/**
|
|
49588
50174
|
* Deletes an invoice (soft delete by setting status to cancelled)
|
|
49589
50175
|
* @summary Delete invoice
|
|
@@ -49630,6 +50216,15 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49630
50216
|
* @memberof BillingDashboardApi
|
|
49631
50217
|
*/
|
|
49632
50218
|
adminBillingInvoicesIdPut(id: string, dataTypesUpdateInvoiceRequest: DataTypesUpdateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50219
|
+
/**
|
|
50220
|
+
* Voids an issued credit note by setting credit_note_status to \'voided\'. Only credit notes with status \'issued\' can be voided.
|
|
50221
|
+
* @summary Void a credit note
|
|
50222
|
+
* @param {string} id Invoice ID (UUID)
|
|
50223
|
+
* @param {*} [options] Override http request option.
|
|
50224
|
+
* @throws {RequiredError}
|
|
50225
|
+
* @memberof BillingDashboardApi
|
|
50226
|
+
*/
|
|
50227
|
+
adminBillingInvoicesIdVoidPost(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49633
50228
|
/**
|
|
49634
50229
|
* Initiates payment for a pending invoice (for subscription orders with failed auto-payments)
|
|
49635
50230
|
* @summary Pay a pending invoice
|
|
@@ -49790,6 +50385,73 @@ export declare class BillingDashboardApi extends BaseAPI {
|
|
|
49790
50385
|
* @memberof BillingDashboardApi
|
|
49791
50386
|
*/
|
|
49792
50387
|
adminBillingSavedCardsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50388
|
+
/**
|
|
50389
|
+
* Returns paginated list of per-store credit quotas for the organization
|
|
50390
|
+
* @summary List store credit quotas
|
|
50391
|
+
* @param {number} [page] Page number
|
|
50392
|
+
* @param {number} [perPage] Items per page
|
|
50393
|
+
* @param {string} [search] Search by store name
|
|
50394
|
+
* @param {*} [options] Override http request option.
|
|
50395
|
+
* @throws {RequiredError}
|
|
50396
|
+
* @memberof BillingDashboardApi
|
|
50397
|
+
*/
|
|
50398
|
+
adminBillingStoreQuotasGet(page?: number, perPage?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50399
|
+
/**
|
|
50400
|
+
* Creates a per-store credit quota with configurable window and enforcement
|
|
50401
|
+
* @summary Create store credit quota
|
|
50402
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Quota configuration
|
|
50403
|
+
* @param {*} [options] Override http request option.
|
|
50404
|
+
* @throws {RequiredError}
|
|
50405
|
+
* @memberof BillingDashboardApi
|
|
50406
|
+
*/
|
|
50407
|
+
adminBillingStoreQuotasPost(dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50408
|
+
/**
|
|
50409
|
+
* Deletes a per-store credit quota by UUID
|
|
50410
|
+
* @summary Delete store credit quota
|
|
50411
|
+
* @param {string} quotaUuid Quota UUID
|
|
50412
|
+
* @param {*} [options] Override http request option.
|
|
50413
|
+
* @throws {RequiredError}
|
|
50414
|
+
* @memberof BillingDashboardApi
|
|
50415
|
+
*/
|
|
50416
|
+
adminBillingStoreQuotasQuotaUuidDelete(quotaUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50417
|
+
/**
|
|
50418
|
+
* Returns a single store credit quota by UUID
|
|
50419
|
+
* @summary Get store credit quota
|
|
50420
|
+
* @param {string} quotaUuid Quota UUID
|
|
50421
|
+
* @param {*} [options] Override http request option.
|
|
50422
|
+
* @throws {RequiredError}
|
|
50423
|
+
* @memberof BillingDashboardApi
|
|
50424
|
+
*/
|
|
50425
|
+
adminBillingStoreQuotasQuotaUuidGet(quotaUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50426
|
+
/**
|
|
50427
|
+
* Updates an existing per-store credit quota
|
|
50428
|
+
* @summary Update store credit quota
|
|
50429
|
+
* @param {string} quotaUuid Quota UUID
|
|
50430
|
+
* @param {DataTypesStoreQuotaRequest} dataTypesStoreQuotaRequest Updated quota configuration
|
|
50431
|
+
* @param {*} [options] Override http request option.
|
|
50432
|
+
* @throws {RequiredError}
|
|
50433
|
+
* @memberof BillingDashboardApi
|
|
50434
|
+
*/
|
|
50435
|
+
adminBillingStoreQuotasQuotaUuidPut(quotaUuid: string, dataTypesStoreQuotaRequest: DataTypesStoreQuotaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50436
|
+
/**
|
|
50437
|
+
* Returns paginated usage summary for all stores in the organization
|
|
50438
|
+
* @summary Get all stores usage summary
|
|
50439
|
+
* @param {number} [page] Page number
|
|
50440
|
+
* @param {number} [perPage] Items per page
|
|
50441
|
+
* @param {*} [options] Override http request option.
|
|
50442
|
+
* @throws {RequiredError}
|
|
50443
|
+
* @memberof BillingDashboardApi
|
|
50444
|
+
*/
|
|
50445
|
+
adminBillingStoreUsageGet(page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
50446
|
+
/**
|
|
50447
|
+
* Returns detailed usage breakdown for a single store
|
|
50448
|
+
* @summary Get single store usage detail
|
|
50449
|
+
* @param {string} xStoreId Store external ID
|
|
50450
|
+
* @param {*} [options] Override http request option.
|
|
50451
|
+
* @throws {RequiredError}
|
|
50452
|
+
* @memberof BillingDashboardApi
|
|
50453
|
+
*/
|
|
50454
|
+
adminBillingStoreUsageXStoreIdGet(xStoreId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
49793
50455
|
/**
|
|
49794
50456
|
* Returns detailed usage information with charts and breakdown, supports time granularity and pagination
|
|
49795
50457
|
* @summary Get usage details with granularity and pagination
|
|
@@ -49930,6 +50592,14 @@ export declare const AdminBillingInvoicesGetSortOrderEnum: {
|
|
|
49930
50592
|
readonly Desc2: "DESC";
|
|
49931
50593
|
};
|
|
49932
50594
|
export type AdminBillingInvoicesGetSortOrderEnum = typeof AdminBillingInvoicesGetSortOrderEnum[keyof typeof AdminBillingInvoicesGetSortOrderEnum];
|
|
50595
|
+
/**
|
|
50596
|
+
* @export
|
|
50597
|
+
*/
|
|
50598
|
+
export declare const AdminBillingInvoicesGetInvoiceTypeEnum: {
|
|
50599
|
+
readonly TaxInvoice: "tax_invoice";
|
|
50600
|
+
readonly CreditNote: "credit_note";
|
|
50601
|
+
};
|
|
50602
|
+
export type AdminBillingInvoicesGetInvoiceTypeEnum = typeof AdminBillingInvoicesGetInvoiceTypeEnum[keyof typeof AdminBillingInvoicesGetInvoiceTypeEnum];
|
|
49933
50603
|
/**
|
|
49934
50604
|
* @export
|
|
49935
50605
|
*/
|
|
@@ -66914,6 +67584,14 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
66914
67584
|
* @throws {RequiredError}
|
|
66915
67585
|
*/
|
|
66916
67586
|
adminSubscriptionsCancelProcessPost: (subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67587
|
+
/**
|
|
67588
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67589
|
+
* @summary Create an immediate plan change order
|
|
67590
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67591
|
+
* @param {*} [options] Override http request option.
|
|
67592
|
+
* @throws {RequiredError}
|
|
67593
|
+
*/
|
|
67594
|
+
adminSubscriptionsPlanChangeImmediateOrderPost: (subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66917
67595
|
/**
|
|
66918
67596
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
66919
67597
|
* @summary Preview plan change details
|
|
@@ -66922,6 +67600,28 @@ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
66922
67600
|
* @throws {RequiredError}
|
|
66923
67601
|
*/
|
|
66924
67602
|
adminSubscriptionsPlanChangePreviewPost: (subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67603
|
+
/**
|
|
67604
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67605
|
+
* @summary Cancel a scheduled plan change
|
|
67606
|
+
* @param {*} [options] Override http request option.
|
|
67607
|
+
* @throws {RequiredError}
|
|
67608
|
+
*/
|
|
67609
|
+
adminSubscriptionsPlanChangeScheduleDelete: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67610
|
+
/**
|
|
67611
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67612
|
+
* @summary Get pending scheduled plan change
|
|
67613
|
+
* @param {*} [options] Override http request option.
|
|
67614
|
+
* @throws {RequiredError}
|
|
67615
|
+
*/
|
|
67616
|
+
adminSubscriptionsPlanChangeScheduleGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67617
|
+
/**
|
|
67618
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67619
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67620
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67621
|
+
* @param {*} [options] Override http request option.
|
|
67622
|
+
* @throws {RequiredError}
|
|
67623
|
+
*/
|
|
67624
|
+
adminSubscriptionsPlanChangeSchedulePost: (subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66925
67625
|
/**
|
|
66926
67626
|
* Updates Subscription information by ID.
|
|
66927
67627
|
* @summary Update an existing Subscription
|
|
@@ -66985,6 +67685,14 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
66985
67685
|
* @throws {RequiredError}
|
|
66986
67686
|
*/
|
|
66987
67687
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67688
|
+
/**
|
|
67689
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67690
|
+
* @summary Create an immediate plan change order
|
|
67691
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67692
|
+
* @param {*} [options] Override http request option.
|
|
67693
|
+
* @throws {RequiredError}
|
|
67694
|
+
*/
|
|
67695
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
66988
67696
|
/**
|
|
66989
67697
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
66990
67698
|
* @summary Preview plan change details
|
|
@@ -66993,6 +67701,28 @@ export declare const SubscriptionsApiFp: (configuration?: Configuration) => {
|
|
|
66993
67701
|
* @throws {RequiredError}
|
|
66994
67702
|
*/
|
|
66995
67703
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67704
|
+
/**
|
|
67705
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67706
|
+
* @summary Cancel a scheduled plan change
|
|
67707
|
+
* @param {*} [options] Override http request option.
|
|
67708
|
+
* @throws {RequiredError}
|
|
67709
|
+
*/
|
|
67710
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67711
|
+
/**
|
|
67712
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67713
|
+
* @summary Get pending scheduled plan change
|
|
67714
|
+
* @param {*} [options] Override http request option.
|
|
67715
|
+
* @throws {RequiredError}
|
|
67716
|
+
*/
|
|
67717
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
67718
|
+
/**
|
|
67719
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67720
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67721
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67722
|
+
* @param {*} [options] Override http request option.
|
|
67723
|
+
* @throws {RequiredError}
|
|
67724
|
+
*/
|
|
67725
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
66996
67726
|
/**
|
|
66997
67727
|
* Updates Subscription information by ID.
|
|
66998
67728
|
* @summary Update an existing Subscription
|
|
@@ -67056,6 +67786,14 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
67056
67786
|
* @throws {RequiredError}
|
|
67057
67787
|
*/
|
|
67058
67788
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67789
|
+
/**
|
|
67790
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67791
|
+
* @summary Create an immediate plan change order
|
|
67792
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67793
|
+
* @param {*} [options] Override http request option.
|
|
67794
|
+
* @throws {RequiredError}
|
|
67795
|
+
*/
|
|
67796
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67059
67797
|
/**
|
|
67060
67798
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
67061
67799
|
* @summary Preview plan change details
|
|
@@ -67064,6 +67802,28 @@ export declare const SubscriptionsApiFactory: (configuration?: Configuration, ba
|
|
|
67064
67802
|
* @throws {RequiredError}
|
|
67065
67803
|
*/
|
|
67066
67804
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67805
|
+
/**
|
|
67806
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67807
|
+
* @summary Cancel a scheduled plan change
|
|
67808
|
+
* @param {*} [options] Override http request option.
|
|
67809
|
+
* @throws {RequiredError}
|
|
67810
|
+
*/
|
|
67811
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67812
|
+
/**
|
|
67813
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67814
|
+
* @summary Get pending scheduled plan change
|
|
67815
|
+
* @param {*} [options] Override http request option.
|
|
67816
|
+
* @throws {RequiredError}
|
|
67817
|
+
*/
|
|
67818
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67819
|
+
/**
|
|
67820
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67821
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67822
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67823
|
+
* @param {*} [options] Override http request option.
|
|
67824
|
+
* @throws {RequiredError}
|
|
67825
|
+
*/
|
|
67826
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
67067
67827
|
/**
|
|
67068
67828
|
* Updates Subscription information by ID.
|
|
67069
67829
|
* @summary Update an existing Subscription
|
|
@@ -67131,6 +67891,15 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
67131
67891
|
* @memberof SubscriptionsApi
|
|
67132
67892
|
*/
|
|
67133
67893
|
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67894
|
+
/**
|
|
67895
|
+
* Creates a one-time Razorpay order for the net charge amount (new_plan_price - prorated_refund). Frontend opens Razorpay checkout. On payment.captured, the existing subscription is patched to the new plan.
|
|
67896
|
+
* @summary Create an immediate plan change order
|
|
67897
|
+
* @param {SubscriptionRouteImmediatePlanChangeOrderHTTPRequest} subscriptionRouteImmediatePlanChangeOrderHTTPRequest Immediate plan change order request
|
|
67898
|
+
* @param {*} [options] Override http request option.
|
|
67899
|
+
* @throws {RequiredError}
|
|
67900
|
+
* @memberof SubscriptionsApi
|
|
67901
|
+
*/
|
|
67902
|
+
adminSubscriptionsPlanChangeImmediateOrderPost(subscriptionRouteImmediatePlanChangeOrderHTTPRequest: SubscriptionRouteImmediatePlanChangeOrderHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67134
67903
|
/**
|
|
67135
67904
|
* Shows a read-only preview of what happens when changing plans: refund for current plan, credits removed/added, new plan cost. Org ID is automatically extracted from JWT session.
|
|
67136
67905
|
* @summary Preview plan change details
|
|
@@ -67140,6 +67909,31 @@ export declare class SubscriptionsApi extends BaseAPI {
|
|
|
67140
67909
|
* @memberof SubscriptionsApi
|
|
67141
67910
|
*/
|
|
67142
67911
|
adminSubscriptionsPlanChangePreviewPost(subscriptionRoutePlanChangePreviewHTTPRequest: SubscriptionRoutePlanChangePreviewHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67912
|
+
/**
|
|
67913
|
+
* Cancels a pending scheduled plan change, reverting the Razorpay subscription to the original plan.
|
|
67914
|
+
* @summary Cancel a scheduled plan change
|
|
67915
|
+
* @param {*} [options] Override http request option.
|
|
67916
|
+
* @throws {RequiredError}
|
|
67917
|
+
* @memberof SubscriptionsApi
|
|
67918
|
+
*/
|
|
67919
|
+
adminSubscriptionsPlanChangeScheduleDelete(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67920
|
+
/**
|
|
67921
|
+
* Returns the pending scheduled plan change for the organization, or null if none.
|
|
67922
|
+
* @summary Get pending scheduled plan change
|
|
67923
|
+
* @param {*} [options] Override http request option.
|
|
67924
|
+
* @throws {RequiredError}
|
|
67925
|
+
* @memberof SubscriptionsApi
|
|
67926
|
+
*/
|
|
67927
|
+
adminSubscriptionsPlanChangeScheduleGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67928
|
+
/**
|
|
67929
|
+
* Creates a one-time Razorpay order for the net charge amount. Payment is collected now; plan activation is deferred to cycle end. Returns 409 if a pending scheduled change already exists. For free switches (proration covers full cost), schedules directly without payment.
|
|
67930
|
+
* @summary Schedule a plan change at end of billing cycle
|
|
67931
|
+
* @param {SubscriptionRouteSchedulePlanChangeHTTPRequest} subscriptionRouteSchedulePlanChangeHTTPRequest Schedule plan change request
|
|
67932
|
+
* @param {*} [options] Override http request option.
|
|
67933
|
+
* @throws {RequiredError}
|
|
67934
|
+
* @memberof SubscriptionsApi
|
|
67935
|
+
*/
|
|
67936
|
+
adminSubscriptionsPlanChangeSchedulePost(subscriptionRouteSchedulePlanChangeHTTPRequest: SubscriptionRouteSchedulePlanChangeHTTPRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
67143
67937
|
/**
|
|
67144
67938
|
* Updates Subscription information by ID.
|
|
67145
67939
|
* @summary Update an existing Subscription
|