@seekora-ai/admin-api 1.1.23 → 1.1.25

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/dist/esm/api.d.ts CHANGED
@@ -28260,16 +28260,18 @@ export declare class AutomatedRefundManagementApi extends BaseAPI {
28260
28260
  */
28261
28261
  export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Configuration) => {
28262
28262
  /**
28263
- * Returns paginated billing alerts configured for the organization
28263
+ * 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.
28264
28264
  * @summary Get billing alerts
28265
28265
  * @param {number} [page] Page number (default: 1)
28266
28266
  * @param {number} [pageSize] Page size (default: 50, max: 100)
28267
- * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
28268
- * @param {number} [offset] Alternative: Number of results to skip (default: 0)
28267
+ * @param {number} [limit] Alternative limit (default: 50, max: 100)
28268
+ * @param {number} [offset] Alternative offset
28269
+ * @param {number} [storeId] Filter alerts by store
28270
+ * @param {string} [search] Search across alert fields, names, thresholds, org/store names, usernames, and JSON metadata
28269
28271
  * @param {*} [options] Override http request option.
28270
28272
  * @throws {RequiredError}
28271
28273
  */
28272
- adminBillingAlertsGet: (page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
28274
+ adminBillingAlertsGet: (page?: number, pageSize?: number, limit?: number, offset?: number, storeId?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
28273
28275
  /**
28274
28276
  * Deletes a billing alert configuration
28275
28277
  * @summary Delete billing alert
@@ -28447,20 +28449,20 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
28447
28449
  */
28448
28450
  adminBillingInvoicesInvoiceIdPayPost: (invoiceId: string, dataTypesPayInvoiceRequest?: DataTypesPayInvoiceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
28449
28451
  /**
28450
- * Retrieves paginated list of orders with filtering options for the authenticated user\'s organization. Supports both page/page_size and page/limit pagination like analytics APIs.
28452
+ * Retrieves paginated orders with full filtering, sorting, and search. The `search` field performs case-insensitive matching across: order ID, amount, status, payment type, gateway, currency, gateway order/payment IDs, organization name, and user name.
28451
28453
  * @summary Get orders
28452
28454
  * @param {number} [orgId] Organization ID (defaults to user\&#39;s org)
28453
- * @param {string} [startDate] Start date (YYYY-MM-DD format)
28454
- * @param {string} [endDate] End date (YYYY-MM-DD format)
28455
+ * @param {string} [startDate] Start date (YYYY-MM-DD)
28456
+ * @param {string} [endDate] End date (YYYY-MM-DD)
28455
28457
  * @param {number} [page] Page number (default: 1)
28456
28458
  * @param {number} [pageSize] Page size (default: 50, max: 100)
28457
- * @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
28458
- * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
28459
+ * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
28460
+ * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Sort field
28459
28461
  * @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
28460
- * @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
28461
- * @param {string} [status] Filter by order status (created, paid, failed, refunded)
28462
- * @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
28463
- * @param {string} [paymentType] Filter by payment type (subscription, credits, etc.)
28462
+ * @param {string} [search] Search across all major fields (ID, amount, status, gateway, org name, user name, etc.)
28463
+ * @param {string} [status] Filter by order status
28464
+ * @param {string} [gateway] Filter by payment gateway
28465
+ * @param {string} [paymentType] Filter by payment type
28464
28466
  * @param {*} [options] Override http request option.
28465
28467
  * @throws {RequiredError}
28466
28468
  */
@@ -28598,16 +28600,18 @@ export declare const BillingDashboardApiAxiosParamCreator: (configuration?: Conf
28598
28600
  */
28599
28601
  export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
28600
28602
  /**
28601
- * Returns paginated billing alerts configured for the organization
28603
+ * 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.
28602
28604
  * @summary Get billing alerts
28603
28605
  * @param {number} [page] Page number (default: 1)
28604
28606
  * @param {number} [pageSize] Page size (default: 50, max: 100)
28605
- * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
28606
- * @param {number} [offset] Alternative: Number of results to skip (default: 0)
28607
+ * @param {number} [limit] Alternative limit (default: 50, max: 100)
28608
+ * @param {number} [offset] Alternative offset
28609
+ * @param {number} [storeId] Filter alerts by store
28610
+ * @param {string} [search] Search across alert fields, names, thresholds, org/store names, usernames, and JSON metadata
28607
28611
  * @param {*} [options] Override http request option.
28608
28612
  * @throws {RequiredError}
28609
28613
  */
28610
- adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
28614
+ adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, storeId?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
28611
28615
  /**
28612
28616
  * Deletes a billing alert configuration
28613
28617
  * @summary Delete billing alert
@@ -28785,20 +28789,20 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
28785
28789
  */
28786
28790
  adminBillingInvoicesInvoiceIdPayPost(invoiceId: string, dataTypesPayInvoiceRequest?: DataTypesPayInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesPayInvoiceResponse>>;
28787
28791
  /**
28788
- * Retrieves paginated list of orders with filtering options for the authenticated user\'s organization. Supports both page/page_size and page/limit pagination like analytics APIs.
28792
+ * Retrieves paginated orders with full filtering, sorting, and search. The `search` field performs case-insensitive matching across: order ID, amount, status, payment type, gateway, currency, gateway order/payment IDs, organization name, and user name.
28789
28793
  * @summary Get orders
28790
28794
  * @param {number} [orgId] Organization ID (defaults to user\&#39;s org)
28791
- * @param {string} [startDate] Start date (YYYY-MM-DD format)
28792
- * @param {string} [endDate] End date (YYYY-MM-DD format)
28795
+ * @param {string} [startDate] Start date (YYYY-MM-DD)
28796
+ * @param {string} [endDate] End date (YYYY-MM-DD)
28793
28797
  * @param {number} [page] Page number (default: 1)
28794
28798
  * @param {number} [pageSize] Page size (default: 50, max: 100)
28795
- * @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
28796
- * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
28799
+ * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
28800
+ * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Sort field
28797
28801
  * @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
28798
- * @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
28799
- * @param {string} [status] Filter by order status (created, paid, failed, refunded)
28800
- * @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
28801
- * @param {string} [paymentType] Filter by payment type (subscription, credits, etc.)
28802
+ * @param {string} [search] Search across all major fields (ID, amount, status, gateway, org name, user name, etc.)
28803
+ * @param {string} [status] Filter by order status
28804
+ * @param {string} [gateway] Filter by payment gateway
28805
+ * @param {string} [paymentType] Filter by payment type
28802
28806
  * @param {*} [options] Override http request option.
28803
28807
  * @throws {RequiredError}
28804
28808
  */
@@ -28936,16 +28940,18 @@ export declare const BillingDashboardApiFp: (configuration?: Configuration) => {
28936
28940
  */
28937
28941
  export declare const BillingDashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
28938
28942
  /**
28939
- * Returns paginated billing alerts configured for the organization
28943
+ * 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.
28940
28944
  * @summary Get billing alerts
28941
28945
  * @param {number} [page] Page number (default: 1)
28942
28946
  * @param {number} [pageSize] Page size (default: 50, max: 100)
28943
- * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
28944
- * @param {number} [offset] Alternative: Number of results to skip (default: 0)
28947
+ * @param {number} [limit] Alternative limit (default: 50, max: 100)
28948
+ * @param {number} [offset] Alternative offset
28949
+ * @param {number} [storeId] Filter alerts by store
28950
+ * @param {string} [search] Search across alert fields, names, thresholds, org/store names, usernames, and JSON metadata
28945
28951
  * @param {*} [options] Override http request option.
28946
28952
  * @throws {RequiredError}
28947
28953
  */
28948
- adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
28954
+ adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, storeId?: number, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
28949
28955
  /**
28950
28956
  * Deletes a billing alert configuration
28951
28957
  * @summary Delete billing alert
@@ -29123,20 +29129,20 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
29123
29129
  */
29124
29130
  adminBillingInvoicesInvoiceIdPayPost(invoiceId: string, dataTypesPayInvoiceRequest?: DataTypesPayInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesPayInvoiceResponse>;
29125
29131
  /**
29126
- * Retrieves paginated list of orders with filtering options for the authenticated user\'s organization. Supports both page/page_size and page/limit pagination like analytics APIs.
29132
+ * Retrieves paginated orders with full filtering, sorting, and search. The `search` field performs case-insensitive matching across: order ID, amount, status, payment type, gateway, currency, gateway order/payment IDs, organization name, and user name.
29127
29133
  * @summary Get orders
29128
29134
  * @param {number} [orgId] Organization ID (defaults to user\&#39;s org)
29129
- * @param {string} [startDate] Start date (YYYY-MM-DD format)
29130
- * @param {string} [endDate] End date (YYYY-MM-DD format)
29135
+ * @param {string} [startDate] Start date (YYYY-MM-DD)
29136
+ * @param {string} [endDate] End date (YYYY-MM-DD)
29131
29137
  * @param {number} [page] Page number (default: 1)
29132
29138
  * @param {number} [pageSize] Page size (default: 50, max: 100)
29133
- * @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
29134
- * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
29139
+ * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
29140
+ * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Sort field
29135
29141
  * @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
29136
- * @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
29137
- * @param {string} [status] Filter by order status (created, paid, failed, refunded)
29138
- * @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
29139
- * @param {string} [paymentType] Filter by payment type (subscription, credits, etc.)
29142
+ * @param {string} [search] Search across all major fields (ID, amount, status, gateway, org name, user name, etc.)
29143
+ * @param {string} [status] Filter by order status
29144
+ * @param {string} [gateway] Filter by payment gateway
29145
+ * @param {string} [paymentType] Filter by payment type
29140
29146
  * @param {*} [options] Override http request option.
29141
29147
  * @throws {RequiredError}
29142
29148
  */
@@ -29276,17 +29282,19 @@ export declare const BillingDashboardApiFactory: (configuration?: Configuration,
29276
29282
  */
29277
29283
  export declare class BillingDashboardApi extends BaseAPI {
29278
29284
  /**
29279
- * Returns paginated billing alerts configured for the organization
29285
+ * 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.
29280
29286
  * @summary Get billing alerts
29281
29287
  * @param {number} [page] Page number (default: 1)
29282
29288
  * @param {number} [pageSize] Page size (default: 50, max: 100)
29283
- * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
29284
- * @param {number} [offset] Alternative: Number of results to skip (default: 0)
29289
+ * @param {number} [limit] Alternative limit (default: 50, max: 100)
29290
+ * @param {number} [offset] Alternative offset
29291
+ * @param {number} [storeId] Filter alerts by store
29292
+ * @param {string} [search] Search across alert fields, names, thresholds, org/store names, usernames, and JSON metadata
29285
29293
  * @param {*} [options] Override http request option.
29286
29294
  * @throws {RequiredError}
29287
29295
  * @memberof BillingDashboardApi
29288
29296
  */
29289
- adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
29297
+ adminBillingAlertsGet(page?: number, pageSize?: number, limit?: number, offset?: number, storeId?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
29290
29298
  /**
29291
29299
  * Deletes a billing alert configuration
29292
29300
  * @summary Delete billing alert
@@ -29481,20 +29489,20 @@ export declare class BillingDashboardApi extends BaseAPI {
29481
29489
  */
29482
29490
  adminBillingInvoicesInvoiceIdPayPost(invoiceId: string, dataTypesPayInvoiceRequest?: DataTypesPayInvoiceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesPayInvoiceResponse, any, {}>>;
29483
29491
  /**
29484
- * Retrieves paginated list of orders with filtering options for the authenticated user\'s organization. Supports both page/page_size and page/limit pagination like analytics APIs.
29492
+ * Retrieves paginated orders with full filtering, sorting, and search. The `search` field performs case-insensitive matching across: order ID, amount, status, payment type, gateway, currency, gateway order/payment IDs, organization name, and user name.
29485
29493
  * @summary Get orders
29486
29494
  * @param {number} [orgId] Organization ID (defaults to user\&#39;s org)
29487
- * @param {string} [startDate] Start date (YYYY-MM-DD format)
29488
- * @param {string} [endDate] End date (YYYY-MM-DD format)
29495
+ * @param {string} [startDate] Start date (YYYY-MM-DD)
29496
+ * @param {string} [endDate] End date (YYYY-MM-DD)
29489
29497
  * @param {number} [page] Page number (default: 1)
29490
29498
  * @param {number} [pageSize] Page size (default: 50, max: 100)
29491
- * @param {number} [limit] Alternative: Number of results per page (default: 50, max: 100)
29492
- * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Field to sort by
29499
+ * @param {number} [limit] Alternative: Number of results (default: 50, max: 100)
29500
+ * @param {AdminBillingOrdersGetSortByEnum} [sortBy] Sort field
29493
29501
  * @param {AdminBillingOrdersGetSortOrderEnum} [sortOrder] Sort direction
29494
- * @param {string} [search] Search in order ID, gateway order ID, gateway payment ID
29495
- * @param {string} [status] Filter by order status (created, paid, failed, refunded)
29496
- * @param {string} [gateway] Filter by payment gateway (razorpay, stripe, etc.)
29497
- * @param {string} [paymentType] Filter by payment type (subscription, credits, etc.)
29502
+ * @param {string} [search] Search across all major fields (ID, amount, status, gateway, org name, user name, etc.)
29503
+ * @param {string} [status] Filter by order status
29504
+ * @param {string} [gateway] Filter by payment gateway
29505
+ * @param {string} [paymentType] Filter by payment type
29498
29506
  * @param {*} [options] Override http request option.
29499
29507
  * @throws {RequiredError}
29500
29508
  * @memberof BillingDashboardApi
@@ -29735,6 +29743,9 @@ export declare const AdminBillingOrdersGetSortByEnum: {
29735
29743
  readonly CreatedAt: "created_at";
29736
29744
  readonly UpdatedAt: "updated_at";
29737
29745
  readonly Status: "status";
29746
+ readonly OrgId: "org_id";
29747
+ readonly UserId: "user_id";
29748
+ readonly Gateway: "gateway";
29738
29749
  };
29739
29750
  export type AdminBillingOrdersGetSortByEnum = typeof AdminBillingOrdersGetSortByEnum[keyof typeof AdminBillingOrdersGetSortByEnum];
29740
29751
  /**
@@ -31634,12 +31645,13 @@ export declare const FeatureLimitsAdminApiAxiosParamCreator: (configuration?: Co
31634
31645
  */
31635
31646
  adminFeatureLimitsCacheInvalidatePost: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31636
31647
  /**
31637
- * Recalculates and syncs all metrics for the organization from source tables to database and Redis
31648
+ * Recalculates and syncs all metrics for the organization from source tables to database and Redis. For increment-based metrics (api_calls, analytics_events), only syncs if Redis is empty unless force=true
31638
31649
  * @summary Sync all metrics (Admin)
31650
+ * @param {boolean} [force] Force sync increment-based metrics even if Redis has values
31639
31651
  * @param {*} [options] Override http request option.
31640
31652
  * @throws {RequiredError}
31641
31653
  */
31642
- adminFeatureLimitsMetricsSyncPost: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31654
+ adminFeatureLimitsMetricsSyncPost: (force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31643
31655
  /**
31644
31656
  * Resets usage counter for a specific feature (admin only)
31645
31657
  * @summary Reset feature usage (Admin)
@@ -31662,12 +31674,13 @@ export declare const FeatureLimitsAdminApiFp: (configuration?: Configuration) =>
31662
31674
  */
31663
31675
  adminFeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
31664
31676
  /**
31665
- * Recalculates and syncs all metrics for the organization from source tables to database and Redis
31677
+ * Recalculates and syncs all metrics for the organization from source tables to database and Redis. For increment-based metrics (api_calls, analytics_events), only syncs if Redis is empty unless force=true
31666
31678
  * @summary Sync all metrics (Admin)
31679
+ * @param {boolean} [force] Force sync increment-based metrics even if Redis has values
31667
31680
  * @param {*} [options] Override http request option.
31668
31681
  * @throws {RequiredError}
31669
31682
  */
31670
- adminFeatureLimitsMetricsSyncPost(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
31683
+ adminFeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
31671
31684
  /**
31672
31685
  * Resets usage counter for a specific feature (admin only)
31673
31686
  * @summary Reset feature usage (Admin)
@@ -31690,12 +31703,13 @@ export declare const FeatureLimitsAdminApiFactory: (configuration?: Configuratio
31690
31703
  */
31691
31704
  adminFeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
31692
31705
  /**
31693
- * Recalculates and syncs all metrics for the organization from source tables to database and Redis
31706
+ * Recalculates and syncs all metrics for the organization from source tables to database and Redis. For increment-based metrics (api_calls, analytics_events), only syncs if Redis is empty unless force=true
31694
31707
  * @summary Sync all metrics (Admin)
31708
+ * @param {boolean} [force] Force sync increment-based metrics even if Redis has values
31695
31709
  * @param {*} [options] Override http request option.
31696
31710
  * @throws {RequiredError}
31697
31711
  */
31698
- adminFeatureLimitsMetricsSyncPost(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
31712
+ adminFeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
31699
31713
  /**
31700
31714
  * Resets usage counter for a specific feature (admin only)
31701
31715
  * @summary Reset feature usage (Admin)
@@ -31721,13 +31735,14 @@ export declare class FeatureLimitsAdminApi extends BaseAPI {
31721
31735
  */
31722
31736
  adminFeatureLimitsCacheInvalidatePost(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
31723
31737
  /**
31724
- * Recalculates and syncs all metrics for the organization from source tables to database and Redis
31738
+ * Recalculates and syncs all metrics for the organization from source tables to database and Redis. For increment-based metrics (api_calls, analytics_events), only syncs if Redis is empty unless force=true
31725
31739
  * @summary Sync all metrics (Admin)
31740
+ * @param {boolean} [force] Force sync increment-based metrics even if Redis has values
31726
31741
  * @param {*} [options] Override http request option.
31727
31742
  * @throws {RequiredError}
31728
31743
  * @memberof FeatureLimitsAdminApi
31729
31744
  */
31730
- adminFeatureLimitsMetricsSyncPost(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
31745
+ adminFeatureLimitsMetricsSyncPost(force?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
31731
31746
  /**
31732
31747
  * Resets usage counter for a specific feature (admin only)
31733
31748
  * @summary Reset feature usage (Admin)