@seekora-ai/admin-api 1.0.71 → 1.0.72
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 +54 -2
- package/api.ts +4290 -952
- package/dist/api.d.ts +3278 -830
- package/dist/api.js +1813 -180
- package/dist/esm/api.d.ts +3278 -830
- package/dist/esm/api.js +1799 -174
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.72.tgz +0 -0
- package/seekora-ai-admin-api-1.0.71.tgz +0 -0
package/dist/api.js
CHANGED
|
@@ -22,11 +22,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.
|
|
29
|
-
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = void 0;
|
|
25
|
+
exports.AdminAnalyticsStoreXStoreIDKpiGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDGeoGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersEffectivenessGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = exports.AnalyticsApi = exports.AnalyticsApiFactory = exports.AnalyticsApiFp = exports.AnalyticsApiAxiosParamCreator = exports.AccountSettingsApi = exports.AccountSettingsApiFactory = exports.AccountSettingsApiFp = exports.AccountSettingsApiAxiosParamCreator = exports.APICallsApi = exports.APICallsApiFactory = exports.APICallsApiFp = exports.APICallsApiAxiosParamCreator = exports.RefundRefundPreviewRequestDtoRefundTypeEnum = exports.DataTypesUpdateWordStatusRequestWordTypeEnum = exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = exports.DataTypesRefundCalculationRequestDtoRefundTypeEnum = exports.DataTypesRefundApprovalDtoActionEnum = exports.DataTypesProcessRefundRequestDtoRefundTypeEnum = exports.DataTypesCreditTransactionTransactionTypeEnum = exports.DataTypesCreateTaskRequestTypeEnum = exports.DataTypesCreateTaskRequestIndexingStrategyEnum = exports.DataTypesCreateTaskRequestFrequencyEnum = exports.DataTypesCreateRefundRequestDtoRefundTypeEnum = exports.DataTypesCreatePluralDeclensionRequestTypeEnum = exports.DataTypesCreatePaymentOrderRequestPaymentTypeEnum = exports.DataTypesCreateCustomWordListRequestTypeEnum = exports.AnalyticsRuleType = exports.AnalyticsQuerySuggestionStatus = exports.AnalyticsQuerySuggestionSource = exports.AnalyticsBulkOperation = exports.AnalyticsBannedMatchType = void 0;
|
|
26
|
+
exports.CommonApiFp = exports.CommonApiAxiosParamCreator = exports.BillingDashboardApi = exports.BillingDashboardApiFactory = exports.BillingDashboardApiFp = exports.BillingDashboardApiAxiosParamCreator = exports.AutomatedRefundManagementApi = exports.AutomatedRefundManagementApiFactory = exports.AutomatedRefundManagementApiFp = exports.AutomatedRefundManagementApiAxiosParamCreator = exports.AuthApi = exports.AuthApiFactory = exports.AuthApiFp = exports.AuthApiAxiosParamCreator = exports.ArticlesApi = exports.ArticlesApiFactory = exports.ArticlesApiFp = exports.ArticlesApiAxiosParamCreator = exports.AnalyticsRulesApi = exports.AnalyticsRulesApiFactory = exports.AnalyticsRulesApiFp = exports.AnalyticsRulesApiAxiosParamCreator = exports.AnalyticsEventsApi = exports.AnalyticsEventsApiFactory = exports.AnalyticsEventsApiFp = exports.AnalyticsEventsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsSummaryGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDTagsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDKpiGetCompareTagsMatchModeEnum = void 0;
|
|
27
|
+
exports.MongoDbApiAxiosParamCreator = exports.ModulesApi = exports.ModulesApiFactory = exports.ModulesApiFp = exports.ModulesApiAxiosParamCreator = exports.MenusApi = exports.MenusApiFactory = exports.MenusApiFp = exports.MenusApiAxiosParamCreator = exports.LimitsApi = exports.LimitsApiFactory = exports.LimitsApiFp = exports.LimitsApiAxiosParamCreator = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDQueriesItemPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsTrendsGetGranularityEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsPerformanceGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetGroupByEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetCompareTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsItemIdInsightsGetTagsMatchModeEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsGetSortByEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortOrderEnum = exports.AdminAnalyticsStoreXStoreIDItemsDiscoveryGetSortByEnum = exports.ItemAnalyticsApi = exports.ItemAnalyticsApiFactory = exports.ItemAnalyticsApiFp = exports.ItemAnalyticsApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.CustomStopwordsApi = exports.CustomStopwordsApiFactory = exports.CustomStopwordsApiFp = exports.CustomStopwordsApiAxiosParamCreator = exports.ApiCreditsTransactionsGetTypeEnum = exports.CreditsApi = exports.CreditsApiFactory = exports.CreditsApiFp = exports.CreditsApiAxiosParamCreator = exports.ConnectorsApi = exports.ConnectorsApiFactory = exports.ConnectorsApiFp = exports.ConnectorsApiAxiosParamCreator = exports.CommonApi = exports.CommonApiFactory = void 0;
|
|
28
|
+
exports.RegisterApiAxiosParamCreator = exports.RefundManagementApi = exports.RefundManagementApiFactory = exports.RefundManagementApiFp = exports.RefundManagementApiAxiosParamCreator = exports.QuerySuggestionsManagementApi = exports.QuerySuggestionsManagementApiFactory = exports.QuerySuggestionsManagementApiFp = exports.QuerySuggestionsManagementApiAxiosParamCreator = exports.V1SuggestionsQueriesGetTimeRangeEnum = exports.V1SuggestionsQueriesGetTagsMatchModeEnum = exports.QuerySuggestionsApi = exports.QuerySuggestionsApiFactory = exports.QuerySuggestionsApiFp = exports.QuerySuggestionsApiAxiosParamCreator = exports.PluralsDeclensionsApi = exports.PluralsDeclensionsApiFactory = exports.PluralsDeclensionsApiFp = exports.PluralsDeclensionsApiAxiosParamCreator = exports.PlansApi = exports.PlansApiFactory = exports.PlansApiFp = exports.PlansApiAxiosParamCreator = exports.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = exports.PaymentGatewayApi = exports.PaymentGatewayApiFactory = exports.PaymentGatewayApiFp = exports.PaymentGatewayApiAxiosParamCreator = exports.ParentMenusApi = exports.ParentMenusApiFactory = exports.ParentMenusApiFp = exports.ParentMenusApiAxiosParamCreator = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.OnboardingApi = exports.OnboardingApiFactory = exports.OnboardingApiFp = exports.OnboardingApiAxiosParamCreator = exports.NewsLettersApi = exports.NewsLettersApiFactory = exports.NewsLettersApiFp = exports.NewsLettersApiAxiosParamCreator = exports.MongoDbApi = exports.MongoDbApiFactory = exports.MongoDbApiFp = void 0;
|
|
29
|
+
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsApi = exports.SubscriptionsApiFactory = exports.SubscriptionsApiFp = exports.SubscriptionsApiAxiosParamCreator = exports.StoresApi = exports.StoresApiFactory = exports.StoresApiFp = exports.StoresApiAxiosParamCreator = exports.StoreDocumentsApi = exports.StoreDocumentsApiFactory = exports.StoreDocumentsApiFp = exports.StoreDocumentsApiAxiosParamCreator = exports.StopwordsApi = exports.StopwordsApiFactory = exports.StopwordsApiFp = exports.StopwordsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = exports.RoleRightsApi = exports.RoleRightsApiFactory = exports.RoleRightsApiFp = exports.RoleRightsApiAxiosParamCreator = exports.RequestsApi = exports.RequestsApiFactory = exports.RequestsApiFp = exports.RequestsApiAxiosParamCreator = exports.RegisterApi = exports.RegisterApiFactory = exports.RegisterApiFp = void 0;
|
|
30
30
|
const axios_1 = require("axios");
|
|
31
31
|
// Some imports not used depending on template conditions
|
|
32
32
|
// @ts-ignore
|
|
@@ -129,10 +129,20 @@ exports.DataTypesCreditTransactionTransactionTypeEnum = {
|
|
|
129
129
|
Bonus: 'bonus',
|
|
130
130
|
Expire: 'expire'
|
|
131
131
|
};
|
|
132
|
+
exports.DataTypesProcessRefundRequestDtoRefundTypeEnum = {
|
|
133
|
+
Full: 'full',
|
|
134
|
+
Partial: 'partial',
|
|
135
|
+
RemainingCredits: 'remaining_credits'
|
|
136
|
+
};
|
|
132
137
|
exports.DataTypesRefundApprovalDtoActionEnum = {
|
|
133
138
|
Approve: 'approve',
|
|
134
139
|
Reject: 'reject'
|
|
135
140
|
};
|
|
141
|
+
exports.DataTypesRefundCalculationRequestDtoRefundTypeEnum = {
|
|
142
|
+
Full: 'full',
|
|
143
|
+
Partial: 'partial',
|
|
144
|
+
RemainingCredits: 'remaining_credits'
|
|
145
|
+
};
|
|
136
146
|
exports.DataTypesUpdatePluralDeclensionRequestTypeEnum = {
|
|
137
147
|
Custom: 'custom',
|
|
138
148
|
Default: 'default'
|
|
@@ -142,6 +152,11 @@ exports.DataTypesUpdateWordStatusRequestWordTypeEnum = {
|
|
|
142
152
|
StoreLanguage: 'store_language',
|
|
143
153
|
Custom: 'custom'
|
|
144
154
|
};
|
|
155
|
+
exports.RefundRefundPreviewRequestDtoRefundTypeEnum = {
|
|
156
|
+
Full: 'full',
|
|
157
|
+
Partial: 'partial',
|
|
158
|
+
RemainingCredits: 'remaining_credits'
|
|
159
|
+
};
|
|
145
160
|
/**
|
|
146
161
|
* APICallsApi - axios parameter creator
|
|
147
162
|
* @export
|
|
@@ -4921,34 +4936,74 @@ class AnalyticsEventsApi extends base_1.BaseAPI {
|
|
|
4921
4936
|
}
|
|
4922
4937
|
exports.AnalyticsEventsApi = AnalyticsEventsApi;
|
|
4923
4938
|
/**
|
|
4924
|
-
*
|
|
4939
|
+
* AnalyticsRulesApi - axios parameter creator
|
|
4925
4940
|
* @export
|
|
4926
4941
|
*/
|
|
4927
|
-
const
|
|
4942
|
+
const AnalyticsRulesApiAxiosParamCreator = function (configuration) {
|
|
4928
4943
|
return {
|
|
4929
4944
|
/**
|
|
4930
|
-
*
|
|
4931
|
-
* @summary
|
|
4932
|
-
* @param {string}
|
|
4945
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
4946
|
+
* @summary List Analytics Rules
|
|
4947
|
+
* @param {string} authorization Bearer JWT token
|
|
4948
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
4949
|
+
* @param {string} [collectionName] Filter by collection name
|
|
4950
|
+
* @param {boolean} [isActive] Filter by active status
|
|
4951
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
4952
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
4953
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
4954
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
4955
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
4956
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
4957
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
4933
4958
|
* @param {*} [options] Override http request option.
|
|
4934
4959
|
* @throws {RequiredError}
|
|
4935
4960
|
*/
|
|
4936
|
-
|
|
4937
|
-
// verify required parameter '
|
|
4938
|
-
(0, common_1.assertParamExists)('
|
|
4939
|
-
const localVarPath = `/admin/
|
|
4940
|
-
.replace(`{${"articleID"}}`, encodeURIComponent(String(articleID)));
|
|
4961
|
+
apiAdminV1AnalyticsRulesGet: (authorization_1, storeId_1, collectionName_1, isActive_1, page_1, pageSize_1, limit_1, offset_1, sortBy_1, sortOrder_1, searchQuery_1, ...args_1) => __awaiter(this, [authorization_1, storeId_1, collectionName_1, isActive_1, page_1, pageSize_1, limit_1, offset_1, sortBy_1, sortOrder_1, searchQuery_1, ...args_1], void 0, function* (authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options = {}) {
|
|
4962
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
4963
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesGet', 'authorization', authorization);
|
|
4964
|
+
const localVarPath = `/api/admin/v1/analytics/rules`;
|
|
4941
4965
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4942
4966
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4943
4967
|
let baseOptions;
|
|
4944
4968
|
if (configuration) {
|
|
4945
4969
|
baseOptions = configuration.baseOptions;
|
|
4946
4970
|
}
|
|
4947
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
4971
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4948
4972
|
const localVarHeaderParameter = {};
|
|
4949
4973
|
const localVarQueryParameter = {};
|
|
4950
|
-
|
|
4951
|
-
|
|
4974
|
+
if (storeId !== undefined) {
|
|
4975
|
+
localVarQueryParameter['store_id'] = storeId;
|
|
4976
|
+
}
|
|
4977
|
+
if (collectionName !== undefined) {
|
|
4978
|
+
localVarQueryParameter['collection_name'] = collectionName;
|
|
4979
|
+
}
|
|
4980
|
+
if (isActive !== undefined) {
|
|
4981
|
+
localVarQueryParameter['is_active'] = isActive;
|
|
4982
|
+
}
|
|
4983
|
+
if (page !== undefined) {
|
|
4984
|
+
localVarQueryParameter['page'] = page;
|
|
4985
|
+
}
|
|
4986
|
+
if (pageSize !== undefined) {
|
|
4987
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
4988
|
+
}
|
|
4989
|
+
if (limit !== undefined) {
|
|
4990
|
+
localVarQueryParameter['limit'] = limit;
|
|
4991
|
+
}
|
|
4992
|
+
if (offset !== undefined) {
|
|
4993
|
+
localVarQueryParameter['offset'] = offset;
|
|
4994
|
+
}
|
|
4995
|
+
if (sortBy !== undefined) {
|
|
4996
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
4997
|
+
}
|
|
4998
|
+
if (sortOrder !== undefined) {
|
|
4999
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
5000
|
+
}
|
|
5001
|
+
if (searchQuery !== undefined) {
|
|
5002
|
+
localVarQueryParameter['search_query'] = searchQuery;
|
|
5003
|
+
}
|
|
5004
|
+
if (authorization != null) {
|
|
5005
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5006
|
+
}
|
|
4952
5007
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4953
5008
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4954
5009
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -4958,80 +5013,91 @@ const ArticlesApiAxiosParamCreator = function (configuration) {
|
|
|
4958
5013
|
};
|
|
4959
5014
|
}),
|
|
4960
5015
|
/**
|
|
4961
|
-
*
|
|
4962
|
-
* @summary
|
|
4963
|
-
* @param {
|
|
5016
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5017
|
+
* @summary Create Analytics Rule
|
|
5018
|
+
* @param {string} authorization Bearer JWT token
|
|
5019
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
4964
5020
|
* @param {*} [options] Override http request option.
|
|
4965
5021
|
* @throws {RequiredError}
|
|
4966
5022
|
*/
|
|
4967
|
-
|
|
4968
|
-
// verify required parameter '
|
|
4969
|
-
(0, common_1.assertParamExists)('
|
|
4970
|
-
|
|
4971
|
-
|
|
5023
|
+
apiAdminV1AnalyticsRulesPost: (authorization_1, dataTypesCreateAnalyticsRuleRequest_1, ...args_1) => __awaiter(this, [authorization_1, dataTypesCreateAnalyticsRuleRequest_1, ...args_1], void 0, function* (authorization, dataTypesCreateAnalyticsRuleRequest, options = {}) {
|
|
5024
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5025
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesPost', 'authorization', authorization);
|
|
5026
|
+
// verify required parameter 'dataTypesCreateAnalyticsRuleRequest' is not null or undefined
|
|
5027
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesPost', 'dataTypesCreateAnalyticsRuleRequest', dataTypesCreateAnalyticsRuleRequest);
|
|
5028
|
+
const localVarPath = `/api/admin/v1/analytics/rules`;
|
|
4972
5029
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4973
5030
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4974
5031
|
let baseOptions;
|
|
4975
5032
|
if (configuration) {
|
|
4976
5033
|
baseOptions = configuration.baseOptions;
|
|
4977
5034
|
}
|
|
4978
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
5035
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
4979
5036
|
const localVarHeaderParameter = {};
|
|
4980
5037
|
const localVarQueryParameter = {};
|
|
4981
|
-
|
|
4982
|
-
|
|
5038
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5039
|
+
if (authorization != null) {
|
|
5040
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5041
|
+
}
|
|
4983
5042
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4984
5043
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4985
5044
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5045
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesCreateAnalyticsRuleRequest, localVarRequestOptions, configuration);
|
|
4986
5046
|
return {
|
|
4987
5047
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4988
5048
|
options: localVarRequestOptions,
|
|
4989
5049
|
};
|
|
4990
5050
|
}),
|
|
4991
5051
|
/**
|
|
4992
|
-
*
|
|
4993
|
-
* @summary
|
|
4994
|
-
* @param {
|
|
4995
|
-
* @param {
|
|
5052
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5053
|
+
* @summary Delete Analytics Rule
|
|
5054
|
+
* @param {string} authorization Bearer JWT token
|
|
5055
|
+
* @param {string} ruleId Rule ID
|
|
4996
5056
|
* @param {*} [options] Override http request option.
|
|
4997
5057
|
* @throws {RequiredError}
|
|
4998
5058
|
*/
|
|
4999
|
-
|
|
5000
|
-
// verify required parameter '
|
|
5001
|
-
(0, common_1.assertParamExists)('
|
|
5002
|
-
// verify required parameter '
|
|
5003
|
-
(0, common_1.assertParamExists)('
|
|
5004
|
-
const localVarPath = `/admin/
|
|
5005
|
-
.replace(`{${"
|
|
5059
|
+
apiAdminV1AnalyticsRulesRuleIdDelete: (authorization_1, ruleId_1, ...args_1) => __awaiter(this, [authorization_1, ruleId_1, ...args_1], void 0, function* (authorization, ruleId, options = {}) {
|
|
5060
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5061
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdDelete', 'authorization', authorization);
|
|
5062
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5063
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdDelete', 'ruleId', ruleId);
|
|
5064
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
5065
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5006
5066
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5007
5067
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5008
5068
|
let baseOptions;
|
|
5009
5069
|
if (configuration) {
|
|
5010
5070
|
baseOptions = configuration.baseOptions;
|
|
5011
5071
|
}
|
|
5012
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
5072
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
5013
5073
|
const localVarHeaderParameter = {};
|
|
5014
5074
|
const localVarQueryParameter = {};
|
|
5015
|
-
|
|
5016
|
-
|
|
5017
|
-
|
|
5075
|
+
if (authorization != null) {
|
|
5076
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5077
|
+
}
|
|
5018
5078
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5019
5079
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5020
5080
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5021
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mgDocumentTypesCreateArticleRequestDto, localVarRequestOptions, configuration);
|
|
5022
5081
|
return {
|
|
5023
5082
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5024
5083
|
options: localVarRequestOptions,
|
|
5025
5084
|
};
|
|
5026
5085
|
}),
|
|
5027
5086
|
/**
|
|
5028
|
-
*
|
|
5029
|
-
* @summary
|
|
5087
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5088
|
+
* @summary Get Analytics Rule
|
|
5089
|
+
* @param {string} authorization Bearer JWT token
|
|
5090
|
+
* @param {string} ruleId Rule ID
|
|
5030
5091
|
* @param {*} [options] Override http request option.
|
|
5031
5092
|
* @throws {RequiredError}
|
|
5032
5093
|
*/
|
|
5033
|
-
|
|
5034
|
-
|
|
5094
|
+
apiAdminV1AnalyticsRulesRuleIdGet: (authorization_1, ruleId_1, ...args_1) => __awaiter(this, [authorization_1, ruleId_1, ...args_1], void 0, function* (authorization, ruleId, options = {}) {
|
|
5095
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5096
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdGet', 'authorization', authorization);
|
|
5097
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5098
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdGet', 'ruleId', ruleId);
|
|
5099
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
5100
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5035
5101
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5036
5102
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5037
5103
|
let baseOptions;
|
|
@@ -5041,8 +5107,9 @@ const ArticlesApiAxiosParamCreator = function (configuration) {
|
|
|
5041
5107
|
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5042
5108
|
const localVarHeaderParameter = {};
|
|
5043
5109
|
const localVarQueryParameter = {};
|
|
5044
|
-
|
|
5045
|
-
|
|
5110
|
+
if (authorization != null) {
|
|
5111
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5112
|
+
}
|
|
5046
5113
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5047
5114
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5048
5115
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -5052,119 +5119,1193 @@ const ArticlesApiAxiosParamCreator = function (configuration) {
|
|
|
5052
5119
|
};
|
|
5053
5120
|
}),
|
|
5054
5121
|
/**
|
|
5055
|
-
*
|
|
5056
|
-
* @summary
|
|
5057
|
-
* @param {
|
|
5122
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5123
|
+
* @summary Update Analytics Rule
|
|
5124
|
+
* @param {string} authorization Bearer JWT token
|
|
5125
|
+
* @param {string} ruleId Rule ID
|
|
5126
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5058
5127
|
* @param {*} [options] Override http request option.
|
|
5059
5128
|
* @throws {RequiredError}
|
|
5060
5129
|
*/
|
|
5061
|
-
|
|
5062
|
-
// verify required parameter '
|
|
5063
|
-
(0, common_1.assertParamExists)('
|
|
5064
|
-
|
|
5130
|
+
apiAdminV1AnalyticsRulesRuleIdPut: (authorization_1, ruleId_1, dataTypesUpdateAnalyticsRuleRequest_1, ...args_1) => __awaiter(this, [authorization_1, ruleId_1, dataTypesUpdateAnalyticsRuleRequest_1, ...args_1], void 0, function* (authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options = {}) {
|
|
5131
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5132
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdPut', 'authorization', authorization);
|
|
5133
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5134
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdPut', 'ruleId', ruleId);
|
|
5135
|
+
// verify required parameter 'dataTypesUpdateAnalyticsRuleRequest' is not null or undefined
|
|
5136
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesRuleIdPut', 'dataTypesUpdateAnalyticsRuleRequest', dataTypesUpdateAnalyticsRuleRequest);
|
|
5137
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
5138
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5065
5139
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5066
5140
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5067
5141
|
let baseOptions;
|
|
5068
5142
|
if (configuration) {
|
|
5069
5143
|
baseOptions = configuration.baseOptions;
|
|
5070
5144
|
}
|
|
5071
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
5145
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
5072
5146
|
const localVarHeaderParameter = {};
|
|
5073
5147
|
const localVarQueryParameter = {};
|
|
5074
|
-
// authentication BearerAuth required
|
|
5075
|
-
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
5076
5148
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5149
|
+
if (authorization != null) {
|
|
5150
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5151
|
+
}
|
|
5077
5152
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5078
5153
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5079
5154
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5080
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
5155
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesUpdateAnalyticsRuleRequest, localVarRequestOptions, configuration);
|
|
5081
5156
|
return {
|
|
5082
5157
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5083
5158
|
options: localVarRequestOptions,
|
|
5084
5159
|
};
|
|
5085
5160
|
}),
|
|
5086
|
-
};
|
|
5087
|
-
};
|
|
5088
|
-
exports.ArticlesApiAxiosParamCreator = ArticlesApiAxiosParamCreator;
|
|
5089
|
-
/**
|
|
5090
|
-
* ArticlesApi - functional programming interface
|
|
5091
|
-
* @export
|
|
5092
|
-
*/
|
|
5093
|
-
const ArticlesApiFp = function (configuration) {
|
|
5094
|
-
const localVarAxiosParamCreator = (0, exports.ArticlesApiAxiosParamCreator)(configuration);
|
|
5095
|
-
return {
|
|
5096
5161
|
/**
|
|
5097
|
-
*
|
|
5098
|
-
* @summary
|
|
5099
|
-
* @param {string}
|
|
5162
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5163
|
+
* @summary Sync Rules to Typesense
|
|
5164
|
+
* @param {string} authorization Bearer JWT token
|
|
5165
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5100
5166
|
* @param {*} [options] Override http request option.
|
|
5101
5167
|
* @throws {RequiredError}
|
|
5102
5168
|
*/
|
|
5103
|
-
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
|
|
5107
|
-
|
|
5108
|
-
|
|
5109
|
-
|
|
5110
|
-
|
|
5111
|
-
|
|
5169
|
+
apiAdminV1AnalyticsRulesSyncPost: (authorization_1, dataTypesAnalyticsRuleSyncRequest_1, ...args_1) => __awaiter(this, [authorization_1, dataTypesAnalyticsRuleSyncRequest_1, ...args_1], void 0, function* (authorization, dataTypesAnalyticsRuleSyncRequest, options = {}) {
|
|
5170
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5171
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesSyncPost', 'authorization', authorization);
|
|
5172
|
+
// verify required parameter 'dataTypesAnalyticsRuleSyncRequest' is not null or undefined
|
|
5173
|
+
(0, common_1.assertParamExists)('apiAdminV1AnalyticsRulesSyncPost', 'dataTypesAnalyticsRuleSyncRequest', dataTypesAnalyticsRuleSyncRequest);
|
|
5174
|
+
const localVarPath = `/api/admin/v1/analytics/rules/sync`;
|
|
5175
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5176
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5177
|
+
let baseOptions;
|
|
5178
|
+
if (configuration) {
|
|
5179
|
+
baseOptions = configuration.baseOptions;
|
|
5180
|
+
}
|
|
5181
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
5182
|
+
const localVarHeaderParameter = {};
|
|
5183
|
+
const localVarQueryParameter = {};
|
|
5184
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5185
|
+
if (authorization != null) {
|
|
5186
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5187
|
+
}
|
|
5188
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5189
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5190
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5191
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesAnalyticsRuleSyncRequest, localVarRequestOptions, configuration);
|
|
5192
|
+
return {
|
|
5193
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5194
|
+
options: localVarRequestOptions,
|
|
5195
|
+
};
|
|
5196
|
+
}),
|
|
5112
5197
|
/**
|
|
5113
|
-
*
|
|
5114
|
-
* @summary
|
|
5115
|
-
* @param {
|
|
5198
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5199
|
+
* @summary List Analytics Rules
|
|
5200
|
+
* @param {string} authorization Bearer JWT token
|
|
5201
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5202
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5203
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5204
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5205
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5206
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5207
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5208
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5209
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5210
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5211
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5116
5212
|
* @param {*} [options] Override http request option.
|
|
5117
5213
|
* @throws {RequiredError}
|
|
5118
5214
|
*/
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
|
|
5122
|
-
|
|
5123
|
-
|
|
5124
|
-
|
|
5125
|
-
|
|
5126
|
-
|
|
5127
|
-
|
|
5215
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet: (authorization_1, xstoreid_1, storeId_1, collectionName_1, isActive_1, page_1, pageSize_1, limit_1, offset_1, sortBy_1, sortOrder_1, searchQuery_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, storeId_1, collectionName_1, isActive_1, page_1, pageSize_1, limit_1, offset_1, sortBy_1, sortOrder_1, searchQuery_1, ...args_1], void 0, function* (authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options = {}) {
|
|
5216
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5217
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesGet', 'authorization', authorization);
|
|
5218
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5219
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesGet', 'xstoreid', xstoreid);
|
|
5220
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules`
|
|
5221
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
5222
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5223
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5224
|
+
let baseOptions;
|
|
5225
|
+
if (configuration) {
|
|
5226
|
+
baseOptions = configuration.baseOptions;
|
|
5227
|
+
}
|
|
5228
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5229
|
+
const localVarHeaderParameter = {};
|
|
5230
|
+
const localVarQueryParameter = {};
|
|
5231
|
+
if (storeId !== undefined) {
|
|
5232
|
+
localVarQueryParameter['store_id'] = storeId;
|
|
5233
|
+
}
|
|
5234
|
+
if (collectionName !== undefined) {
|
|
5235
|
+
localVarQueryParameter['collection_name'] = collectionName;
|
|
5236
|
+
}
|
|
5237
|
+
if (isActive !== undefined) {
|
|
5238
|
+
localVarQueryParameter['is_active'] = isActive;
|
|
5239
|
+
}
|
|
5240
|
+
if (page !== undefined) {
|
|
5241
|
+
localVarQueryParameter['page'] = page;
|
|
5242
|
+
}
|
|
5243
|
+
if (pageSize !== undefined) {
|
|
5244
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
5245
|
+
}
|
|
5246
|
+
if (limit !== undefined) {
|
|
5247
|
+
localVarQueryParameter['limit'] = limit;
|
|
5248
|
+
}
|
|
5249
|
+
if (offset !== undefined) {
|
|
5250
|
+
localVarQueryParameter['offset'] = offset;
|
|
5251
|
+
}
|
|
5252
|
+
if (sortBy !== undefined) {
|
|
5253
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
5254
|
+
}
|
|
5255
|
+
if (sortOrder !== undefined) {
|
|
5256
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
5257
|
+
}
|
|
5258
|
+
if (searchQuery !== undefined) {
|
|
5259
|
+
localVarQueryParameter['search_query'] = searchQuery;
|
|
5260
|
+
}
|
|
5261
|
+
if (authorization != null) {
|
|
5262
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5263
|
+
}
|
|
5264
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5265
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5266
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5267
|
+
return {
|
|
5268
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5269
|
+
options: localVarRequestOptions,
|
|
5270
|
+
};
|
|
5271
|
+
}),
|
|
5128
5272
|
/**
|
|
5129
|
-
*
|
|
5130
|
-
* @summary
|
|
5131
|
-
* @param {
|
|
5132
|
-
* @param {
|
|
5273
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5274
|
+
* @summary Create Analytics Rule
|
|
5275
|
+
* @param {string} authorization Bearer JWT token
|
|
5276
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5277
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5133
5278
|
* @param {*} [options] Override http request option.
|
|
5134
5279
|
* @throws {RequiredError}
|
|
5135
5280
|
*/
|
|
5136
|
-
|
|
5137
|
-
|
|
5138
|
-
|
|
5139
|
-
|
|
5140
|
-
|
|
5141
|
-
|
|
5142
|
-
|
|
5143
|
-
}
|
|
5144
|
-
|
|
5281
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost: (authorization_1, xstoreid_1, dataTypesCreateAnalyticsRuleRequest_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, dataTypesCreateAnalyticsRuleRequest_1, ...args_1], void 0, function* (authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options = {}) {
|
|
5282
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5283
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'authorization', authorization);
|
|
5284
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5285
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'xstoreid', xstoreid);
|
|
5286
|
+
// verify required parameter 'dataTypesCreateAnalyticsRuleRequest' is not null or undefined
|
|
5287
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'dataTypesCreateAnalyticsRuleRequest', dataTypesCreateAnalyticsRuleRequest);
|
|
5288
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules`
|
|
5289
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
5290
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5291
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5292
|
+
let baseOptions;
|
|
5293
|
+
if (configuration) {
|
|
5294
|
+
baseOptions = configuration.baseOptions;
|
|
5295
|
+
}
|
|
5296
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
5297
|
+
const localVarHeaderParameter = {};
|
|
5298
|
+
const localVarQueryParameter = {};
|
|
5299
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5300
|
+
if (authorization != null) {
|
|
5301
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5302
|
+
}
|
|
5303
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5304
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5305
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5306
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesCreateAnalyticsRuleRequest, localVarRequestOptions, configuration);
|
|
5307
|
+
return {
|
|
5308
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5309
|
+
options: localVarRequestOptions,
|
|
5310
|
+
};
|
|
5311
|
+
}),
|
|
5145
5312
|
/**
|
|
5146
|
-
*
|
|
5147
|
-
* @summary
|
|
5313
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5314
|
+
* @summary Delete Analytics Rule
|
|
5315
|
+
* @param {string} authorization Bearer JWT token
|
|
5316
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5317
|
+
* @param {string} ruleId Rule ID
|
|
5148
5318
|
* @param {*} [options] Override http request option.
|
|
5149
5319
|
* @throws {RequiredError}
|
|
5150
5320
|
*/
|
|
5151
|
-
|
|
5152
|
-
|
|
5153
|
-
|
|
5154
|
-
|
|
5155
|
-
|
|
5156
|
-
|
|
5157
|
-
|
|
5158
|
-
}
|
|
5159
|
-
|
|
5321
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete: (authorization_1, xstoreid_1, ruleId_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, ruleId_1, ...args_1], void 0, function* (authorization, xstoreid, ruleId, options = {}) {
|
|
5322
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5323
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'authorization', authorization);
|
|
5324
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5325
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'xstoreid', xstoreid);
|
|
5326
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5327
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'ruleId', ruleId);
|
|
5328
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
5329
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
5330
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5331
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5332
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5333
|
+
let baseOptions;
|
|
5334
|
+
if (configuration) {
|
|
5335
|
+
baseOptions = configuration.baseOptions;
|
|
5336
|
+
}
|
|
5337
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
5338
|
+
const localVarHeaderParameter = {};
|
|
5339
|
+
const localVarQueryParameter = {};
|
|
5340
|
+
if (authorization != null) {
|
|
5341
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5342
|
+
}
|
|
5343
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5344
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5345
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5346
|
+
return {
|
|
5347
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5348
|
+
options: localVarRequestOptions,
|
|
5349
|
+
};
|
|
5350
|
+
}),
|
|
5160
5351
|
/**
|
|
5161
|
-
*
|
|
5162
|
-
* @summary
|
|
5163
|
-
* @param {
|
|
5352
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5353
|
+
* @summary Get Analytics Rule
|
|
5354
|
+
* @param {string} authorization Bearer JWT token
|
|
5355
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5356
|
+
* @param {string} ruleId Rule ID
|
|
5164
5357
|
* @param {*} [options] Override http request option.
|
|
5165
5358
|
* @throws {RequiredError}
|
|
5166
5359
|
*/
|
|
5167
|
-
|
|
5360
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet: (authorization_1, xstoreid_1, ruleId_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, ruleId_1, ...args_1], void 0, function* (authorization, xstoreid, ruleId, options = {}) {
|
|
5361
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5362
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'authorization', authorization);
|
|
5363
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5364
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'xstoreid', xstoreid);
|
|
5365
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5366
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'ruleId', ruleId);
|
|
5367
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
5368
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
5369
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5370
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5371
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5372
|
+
let baseOptions;
|
|
5373
|
+
if (configuration) {
|
|
5374
|
+
baseOptions = configuration.baseOptions;
|
|
5375
|
+
}
|
|
5376
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5377
|
+
const localVarHeaderParameter = {};
|
|
5378
|
+
const localVarQueryParameter = {};
|
|
5379
|
+
if (authorization != null) {
|
|
5380
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5381
|
+
}
|
|
5382
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5383
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5384
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5385
|
+
return {
|
|
5386
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5387
|
+
options: localVarRequestOptions,
|
|
5388
|
+
};
|
|
5389
|
+
}),
|
|
5390
|
+
/**
|
|
5391
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5392
|
+
* @summary Update Analytics Rule
|
|
5393
|
+
* @param {string} authorization Bearer JWT token
|
|
5394
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5395
|
+
* @param {string} ruleId Rule ID
|
|
5396
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5397
|
+
* @param {*} [options] Override http request option.
|
|
5398
|
+
* @throws {RequiredError}
|
|
5399
|
+
*/
|
|
5400
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut: (authorization_1, xstoreid_1, ruleId_1, dataTypesUpdateAnalyticsRuleRequest_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, ruleId_1, dataTypesUpdateAnalyticsRuleRequest_1, ...args_1], void 0, function* (authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options = {}) {
|
|
5401
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5402
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'authorization', authorization);
|
|
5403
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5404
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'xstoreid', xstoreid);
|
|
5405
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
5406
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'ruleId', ruleId);
|
|
5407
|
+
// verify required parameter 'dataTypesUpdateAnalyticsRuleRequest' is not null or undefined
|
|
5408
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'dataTypesUpdateAnalyticsRuleRequest', dataTypesUpdateAnalyticsRuleRequest);
|
|
5409
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
5410
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
5411
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
5412
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5413
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5414
|
+
let baseOptions;
|
|
5415
|
+
if (configuration) {
|
|
5416
|
+
baseOptions = configuration.baseOptions;
|
|
5417
|
+
}
|
|
5418
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
5419
|
+
const localVarHeaderParameter = {};
|
|
5420
|
+
const localVarQueryParameter = {};
|
|
5421
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5422
|
+
if (authorization != null) {
|
|
5423
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5424
|
+
}
|
|
5425
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5426
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5427
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5428
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesUpdateAnalyticsRuleRequest, localVarRequestOptions, configuration);
|
|
5429
|
+
return {
|
|
5430
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5431
|
+
options: localVarRequestOptions,
|
|
5432
|
+
};
|
|
5433
|
+
}),
|
|
5434
|
+
/**
|
|
5435
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5436
|
+
* @summary Sync Rules to Typesense
|
|
5437
|
+
* @param {string} authorization Bearer JWT token
|
|
5438
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5439
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5440
|
+
* @param {*} [options] Override http request option.
|
|
5441
|
+
* @throws {RequiredError}
|
|
5442
|
+
*/
|
|
5443
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost: (authorization_1, xstoreid_1, dataTypesAnalyticsRuleSyncRequest_1, ...args_1) => __awaiter(this, [authorization_1, xstoreid_1, dataTypesAnalyticsRuleSyncRequest_1, ...args_1], void 0, function* (authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options = {}) {
|
|
5444
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
5445
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'authorization', authorization);
|
|
5446
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
5447
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'xstoreid', xstoreid);
|
|
5448
|
+
// verify required parameter 'dataTypesAnalyticsRuleSyncRequest' is not null or undefined
|
|
5449
|
+
(0, common_1.assertParamExists)('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'dataTypesAnalyticsRuleSyncRequest', dataTypesAnalyticsRuleSyncRequest);
|
|
5450
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/sync`
|
|
5451
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
5452
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5453
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
5454
|
+
let baseOptions;
|
|
5455
|
+
if (configuration) {
|
|
5456
|
+
baseOptions = configuration.baseOptions;
|
|
5457
|
+
}
|
|
5458
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
5459
|
+
const localVarHeaderParameter = {};
|
|
5460
|
+
const localVarQueryParameter = {};
|
|
5461
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5462
|
+
if (authorization != null) {
|
|
5463
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
5464
|
+
}
|
|
5465
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5466
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5467
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5468
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesAnalyticsRuleSyncRequest, localVarRequestOptions, configuration);
|
|
5469
|
+
return {
|
|
5470
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
5471
|
+
options: localVarRequestOptions,
|
|
5472
|
+
};
|
|
5473
|
+
}),
|
|
5474
|
+
};
|
|
5475
|
+
};
|
|
5476
|
+
exports.AnalyticsRulesApiAxiosParamCreator = AnalyticsRulesApiAxiosParamCreator;
|
|
5477
|
+
/**
|
|
5478
|
+
* AnalyticsRulesApi - functional programming interface
|
|
5479
|
+
* @export
|
|
5480
|
+
*/
|
|
5481
|
+
const AnalyticsRulesApiFp = function (configuration) {
|
|
5482
|
+
const localVarAxiosParamCreator = (0, exports.AnalyticsRulesApiAxiosParamCreator)(configuration);
|
|
5483
|
+
return {
|
|
5484
|
+
/**
|
|
5485
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5486
|
+
* @summary List Analytics Rules
|
|
5487
|
+
* @param {string} authorization Bearer JWT token
|
|
5488
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5489
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5490
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5491
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5492
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5493
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5494
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5495
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5496
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5497
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5498
|
+
* @param {*} [options] Override http request option.
|
|
5499
|
+
* @throws {RequiredError}
|
|
5500
|
+
*/
|
|
5501
|
+
apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5502
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5503
|
+
var _a, _b, _c;
|
|
5504
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options);
|
|
5505
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5506
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5507
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5508
|
+
});
|
|
5509
|
+
},
|
|
5510
|
+
/**
|
|
5511
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5512
|
+
* @summary Create Analytics Rule
|
|
5513
|
+
* @param {string} authorization Bearer JWT token
|
|
5514
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5515
|
+
* @param {*} [options] Override http request option.
|
|
5516
|
+
* @throws {RequiredError}
|
|
5517
|
+
*/
|
|
5518
|
+
apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
5519
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5520
|
+
var _a, _b, _c;
|
|
5521
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options);
|
|
5522
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5523
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5524
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5525
|
+
});
|
|
5526
|
+
},
|
|
5527
|
+
/**
|
|
5528
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5529
|
+
* @summary Delete Analytics Rule
|
|
5530
|
+
* @param {string} authorization Bearer JWT token
|
|
5531
|
+
* @param {string} ruleId Rule ID
|
|
5532
|
+
* @param {*} [options] Override http request option.
|
|
5533
|
+
* @throws {RequiredError}
|
|
5534
|
+
*/
|
|
5535
|
+
apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options) {
|
|
5536
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5537
|
+
var _a, _b, _c;
|
|
5538
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options);
|
|
5539
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5540
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5541
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5542
|
+
});
|
|
5543
|
+
},
|
|
5544
|
+
/**
|
|
5545
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5546
|
+
* @summary Get Analytics Rule
|
|
5547
|
+
* @param {string} authorization Bearer JWT token
|
|
5548
|
+
* @param {string} ruleId Rule ID
|
|
5549
|
+
* @param {*} [options] Override http request option.
|
|
5550
|
+
* @throws {RequiredError}
|
|
5551
|
+
*/
|
|
5552
|
+
apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options) {
|
|
5553
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5554
|
+
var _a, _b, _c;
|
|
5555
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options);
|
|
5556
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5557
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5558
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5559
|
+
});
|
|
5560
|
+
},
|
|
5561
|
+
/**
|
|
5562
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5563
|
+
* @summary Update Analytics Rule
|
|
5564
|
+
* @param {string} authorization Bearer JWT token
|
|
5565
|
+
* @param {string} ruleId Rule ID
|
|
5566
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5567
|
+
* @param {*} [options] Override http request option.
|
|
5568
|
+
* @throws {RequiredError}
|
|
5569
|
+
*/
|
|
5570
|
+
apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
5571
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5572
|
+
var _a, _b, _c;
|
|
5573
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options);
|
|
5574
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5575
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5576
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5577
|
+
});
|
|
5578
|
+
},
|
|
5579
|
+
/**
|
|
5580
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5581
|
+
* @summary Sync Rules to Typesense
|
|
5582
|
+
* @param {string} authorization Bearer JWT token
|
|
5583
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5584
|
+
* @param {*} [options] Override http request option.
|
|
5585
|
+
* @throws {RequiredError}
|
|
5586
|
+
*/
|
|
5587
|
+
apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
5588
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5589
|
+
var _a, _b, _c;
|
|
5590
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options);
|
|
5591
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5592
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesSyncPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5593
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5594
|
+
});
|
|
5595
|
+
},
|
|
5596
|
+
/**
|
|
5597
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5598
|
+
* @summary List Analytics Rules
|
|
5599
|
+
* @param {string} authorization Bearer JWT token
|
|
5600
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5601
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5602
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5603
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5604
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5605
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5606
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5607
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5608
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5609
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5610
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5611
|
+
* @param {*} [options] Override http request option.
|
|
5612
|
+
* @throws {RequiredError}
|
|
5613
|
+
*/
|
|
5614
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5615
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5616
|
+
var _a, _b, _c;
|
|
5617
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options);
|
|
5618
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5619
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5620
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5621
|
+
});
|
|
5622
|
+
},
|
|
5623
|
+
/**
|
|
5624
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5625
|
+
* @summary Create Analytics Rule
|
|
5626
|
+
* @param {string} authorization Bearer JWT token
|
|
5627
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5628
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5629
|
+
* @param {*} [options] Override http request option.
|
|
5630
|
+
* @throws {RequiredError}
|
|
5631
|
+
*/
|
|
5632
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
5633
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5634
|
+
var _a, _b, _c;
|
|
5635
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options);
|
|
5636
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5637
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5638
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5639
|
+
});
|
|
5640
|
+
},
|
|
5641
|
+
/**
|
|
5642
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5643
|
+
* @summary Delete Analytics Rule
|
|
5644
|
+
* @param {string} authorization Bearer JWT token
|
|
5645
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5646
|
+
* @param {string} ruleId Rule ID
|
|
5647
|
+
* @param {*} [options] Override http request option.
|
|
5648
|
+
* @throws {RequiredError}
|
|
5649
|
+
*/
|
|
5650
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options) {
|
|
5651
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5652
|
+
var _a, _b, _c;
|
|
5653
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options);
|
|
5654
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5655
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5656
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5657
|
+
});
|
|
5658
|
+
},
|
|
5659
|
+
/**
|
|
5660
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5661
|
+
* @summary Get Analytics Rule
|
|
5662
|
+
* @param {string} authorization Bearer JWT token
|
|
5663
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5664
|
+
* @param {string} ruleId Rule ID
|
|
5665
|
+
* @param {*} [options] Override http request option.
|
|
5666
|
+
* @throws {RequiredError}
|
|
5667
|
+
*/
|
|
5668
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options) {
|
|
5669
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5670
|
+
var _a, _b, _c;
|
|
5671
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options);
|
|
5672
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5673
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5674
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5675
|
+
});
|
|
5676
|
+
},
|
|
5677
|
+
/**
|
|
5678
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5679
|
+
* @summary Update Analytics Rule
|
|
5680
|
+
* @param {string} authorization Bearer JWT token
|
|
5681
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5682
|
+
* @param {string} ruleId Rule ID
|
|
5683
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5684
|
+
* @param {*} [options] Override http request option.
|
|
5685
|
+
* @throws {RequiredError}
|
|
5686
|
+
*/
|
|
5687
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
5688
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5689
|
+
var _a, _b, _c;
|
|
5690
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options);
|
|
5691
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5692
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5693
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5694
|
+
});
|
|
5695
|
+
},
|
|
5696
|
+
/**
|
|
5697
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5698
|
+
* @summary Sync Rules to Typesense
|
|
5699
|
+
* @param {string} authorization Bearer JWT token
|
|
5700
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5701
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5702
|
+
* @param {*} [options] Override http request option.
|
|
5703
|
+
* @throws {RequiredError}
|
|
5704
|
+
*/
|
|
5705
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
5706
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5707
|
+
var _a, _b, _c;
|
|
5708
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options);
|
|
5709
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5710
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5711
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5712
|
+
});
|
|
5713
|
+
},
|
|
5714
|
+
};
|
|
5715
|
+
};
|
|
5716
|
+
exports.AnalyticsRulesApiFp = AnalyticsRulesApiFp;
|
|
5717
|
+
/**
|
|
5718
|
+
* AnalyticsRulesApi - factory interface
|
|
5719
|
+
* @export
|
|
5720
|
+
*/
|
|
5721
|
+
const AnalyticsRulesApiFactory = function (configuration, basePath, axios) {
|
|
5722
|
+
const localVarFp = (0, exports.AnalyticsRulesApiFp)(configuration);
|
|
5723
|
+
return {
|
|
5724
|
+
/**
|
|
5725
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5726
|
+
* @summary List Analytics Rules
|
|
5727
|
+
* @param {string} authorization Bearer JWT token
|
|
5728
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5729
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5730
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5731
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5732
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5733
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5734
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5735
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5736
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5737
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5738
|
+
* @param {*} [options] Override http request option.
|
|
5739
|
+
* @throws {RequiredError}
|
|
5740
|
+
*/
|
|
5741
|
+
apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5742
|
+
return localVarFp.apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(axios, basePath));
|
|
5743
|
+
},
|
|
5744
|
+
/**
|
|
5745
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5746
|
+
* @summary Create Analytics Rule
|
|
5747
|
+
* @param {string} authorization Bearer JWT token
|
|
5748
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5749
|
+
* @param {*} [options] Override http request option.
|
|
5750
|
+
* @throws {RequiredError}
|
|
5751
|
+
*/
|
|
5752
|
+
apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
5753
|
+
return localVarFp.apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
5754
|
+
},
|
|
5755
|
+
/**
|
|
5756
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5757
|
+
* @summary Delete Analytics Rule
|
|
5758
|
+
* @param {string} authorization Bearer JWT token
|
|
5759
|
+
* @param {string} ruleId Rule ID
|
|
5760
|
+
* @param {*} [options] Override http request option.
|
|
5761
|
+
* @throws {RequiredError}
|
|
5762
|
+
*/
|
|
5763
|
+
apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options) {
|
|
5764
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options).then((request) => request(axios, basePath));
|
|
5765
|
+
},
|
|
5766
|
+
/**
|
|
5767
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5768
|
+
* @summary Get Analytics Rule
|
|
5769
|
+
* @param {string} authorization Bearer JWT token
|
|
5770
|
+
* @param {string} ruleId Rule ID
|
|
5771
|
+
* @param {*} [options] Override http request option.
|
|
5772
|
+
* @throws {RequiredError}
|
|
5773
|
+
*/
|
|
5774
|
+
apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options) {
|
|
5775
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options).then((request) => request(axios, basePath));
|
|
5776
|
+
},
|
|
5777
|
+
/**
|
|
5778
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5779
|
+
* @summary Update Analytics Rule
|
|
5780
|
+
* @param {string} authorization Bearer JWT token
|
|
5781
|
+
* @param {string} ruleId Rule ID
|
|
5782
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5783
|
+
* @param {*} [options] Override http request option.
|
|
5784
|
+
* @throws {RequiredError}
|
|
5785
|
+
*/
|
|
5786
|
+
apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
5787
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
5788
|
+
},
|
|
5789
|
+
/**
|
|
5790
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5791
|
+
* @summary Sync Rules to Typesense
|
|
5792
|
+
* @param {string} authorization Bearer JWT token
|
|
5793
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5794
|
+
* @param {*} [options] Override http request option.
|
|
5795
|
+
* @throws {RequiredError}
|
|
5796
|
+
*/
|
|
5797
|
+
apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
5798
|
+
return localVarFp.apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(axios, basePath));
|
|
5799
|
+
},
|
|
5800
|
+
/**
|
|
5801
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5802
|
+
* @summary List Analytics Rules
|
|
5803
|
+
* @param {string} authorization Bearer JWT token
|
|
5804
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5805
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5806
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5807
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5808
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5809
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5810
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5811
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5812
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5813
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5814
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5815
|
+
* @param {*} [options] Override http request option.
|
|
5816
|
+
* @throws {RequiredError}
|
|
5817
|
+
*/
|
|
5818
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5819
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(axios, basePath));
|
|
5820
|
+
},
|
|
5821
|
+
/**
|
|
5822
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5823
|
+
* @summary Create Analytics Rule
|
|
5824
|
+
* @param {string} authorization Bearer JWT token
|
|
5825
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5826
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5827
|
+
* @param {*} [options] Override http request option.
|
|
5828
|
+
* @throws {RequiredError}
|
|
5829
|
+
*/
|
|
5830
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
5831
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
5832
|
+
},
|
|
5833
|
+
/**
|
|
5834
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5835
|
+
* @summary Delete Analytics Rule
|
|
5836
|
+
* @param {string} authorization Bearer JWT token
|
|
5837
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5838
|
+
* @param {string} ruleId Rule ID
|
|
5839
|
+
* @param {*} [options] Override http request option.
|
|
5840
|
+
* @throws {RequiredError}
|
|
5841
|
+
*/
|
|
5842
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options) {
|
|
5843
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options).then((request) => request(axios, basePath));
|
|
5844
|
+
},
|
|
5845
|
+
/**
|
|
5846
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5847
|
+
* @summary Get Analytics Rule
|
|
5848
|
+
* @param {string} authorization Bearer JWT token
|
|
5849
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5850
|
+
* @param {string} ruleId Rule ID
|
|
5851
|
+
* @param {*} [options] Override http request option.
|
|
5852
|
+
* @throws {RequiredError}
|
|
5853
|
+
*/
|
|
5854
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options) {
|
|
5855
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options).then((request) => request(axios, basePath));
|
|
5856
|
+
},
|
|
5857
|
+
/**
|
|
5858
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5859
|
+
* @summary Update Analytics Rule
|
|
5860
|
+
* @param {string} authorization Bearer JWT token
|
|
5861
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5862
|
+
* @param {string} ruleId Rule ID
|
|
5863
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5864
|
+
* @param {*} [options] Override http request option.
|
|
5865
|
+
* @throws {RequiredError}
|
|
5866
|
+
*/
|
|
5867
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
5868
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
5869
|
+
},
|
|
5870
|
+
/**
|
|
5871
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5872
|
+
* @summary Sync Rules to Typesense
|
|
5873
|
+
* @param {string} authorization Bearer JWT token
|
|
5874
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5875
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5876
|
+
* @param {*} [options] Override http request option.
|
|
5877
|
+
* @throws {RequiredError}
|
|
5878
|
+
*/
|
|
5879
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
5880
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(axios, basePath));
|
|
5881
|
+
},
|
|
5882
|
+
};
|
|
5883
|
+
};
|
|
5884
|
+
exports.AnalyticsRulesApiFactory = AnalyticsRulesApiFactory;
|
|
5885
|
+
/**
|
|
5886
|
+
* AnalyticsRulesApi - object-oriented interface
|
|
5887
|
+
* @export
|
|
5888
|
+
* @class AnalyticsRulesApi
|
|
5889
|
+
* @extends {BaseAPI}
|
|
5890
|
+
*/
|
|
5891
|
+
class AnalyticsRulesApi extends base_1.BaseAPI {
|
|
5892
|
+
/**
|
|
5893
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5894
|
+
* @summary List Analytics Rules
|
|
5895
|
+
* @param {string} authorization Bearer JWT token
|
|
5896
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5897
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5898
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5899
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5900
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5901
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5902
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5903
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5904
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5905
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5906
|
+
* @param {*} [options] Override http request option.
|
|
5907
|
+
* @throws {RequiredError}
|
|
5908
|
+
* @memberof AnalyticsRulesApi
|
|
5909
|
+
*/
|
|
5910
|
+
apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5911
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(this.axios, this.basePath));
|
|
5912
|
+
}
|
|
5913
|
+
/**
|
|
5914
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5915
|
+
* @summary Create Analytics Rule
|
|
5916
|
+
* @param {string} authorization Bearer JWT token
|
|
5917
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
5918
|
+
* @param {*} [options] Override http request option.
|
|
5919
|
+
* @throws {RequiredError}
|
|
5920
|
+
* @memberof AnalyticsRulesApi
|
|
5921
|
+
*/
|
|
5922
|
+
apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
5923
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5924
|
+
}
|
|
5925
|
+
/**
|
|
5926
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
5927
|
+
* @summary Delete Analytics Rule
|
|
5928
|
+
* @param {string} authorization Bearer JWT token
|
|
5929
|
+
* @param {string} ruleId Rule ID
|
|
5930
|
+
* @param {*} [options] Override http request option.
|
|
5931
|
+
* @throws {RequiredError}
|
|
5932
|
+
* @memberof AnalyticsRulesApi
|
|
5933
|
+
*/
|
|
5934
|
+
apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options) {
|
|
5935
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
5936
|
+
}
|
|
5937
|
+
/**
|
|
5938
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
5939
|
+
* @summary Get Analytics Rule
|
|
5940
|
+
* @param {string} authorization Bearer JWT token
|
|
5941
|
+
* @param {string} ruleId Rule ID
|
|
5942
|
+
* @param {*} [options] Override http request option.
|
|
5943
|
+
* @throws {RequiredError}
|
|
5944
|
+
* @memberof AnalyticsRulesApi
|
|
5945
|
+
*/
|
|
5946
|
+
apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options) {
|
|
5947
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
5948
|
+
}
|
|
5949
|
+
/**
|
|
5950
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
5951
|
+
* @summary Update Analytics Rule
|
|
5952
|
+
* @param {string} authorization Bearer JWT token
|
|
5953
|
+
* @param {string} ruleId Rule ID
|
|
5954
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
5955
|
+
* @param {*} [options] Override http request option.
|
|
5956
|
+
* @throws {RequiredError}
|
|
5957
|
+
* @memberof AnalyticsRulesApi
|
|
5958
|
+
*/
|
|
5959
|
+
apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
5960
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5961
|
+
}
|
|
5962
|
+
/**
|
|
5963
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
5964
|
+
* @summary Sync Rules to Typesense
|
|
5965
|
+
* @param {string} authorization Bearer JWT token
|
|
5966
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
5967
|
+
* @param {*} [options] Override http request option.
|
|
5968
|
+
* @throws {RequiredError}
|
|
5969
|
+
* @memberof AnalyticsRulesApi
|
|
5970
|
+
*/
|
|
5971
|
+
apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
5972
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5973
|
+
}
|
|
5974
|
+
/**
|
|
5975
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
5976
|
+
* @summary List Analytics Rules
|
|
5977
|
+
* @param {string} authorization Bearer JWT token
|
|
5978
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
5979
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
5980
|
+
* @param {string} [collectionName] Filter by collection name
|
|
5981
|
+
* @param {boolean} [isActive] Filter by active status
|
|
5982
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
5983
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
5984
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
5985
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
5986
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
5987
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
5988
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
5989
|
+
* @param {*} [options] Override http request option.
|
|
5990
|
+
* @throws {RequiredError}
|
|
5991
|
+
* @memberof AnalyticsRulesApi
|
|
5992
|
+
*/
|
|
5993
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options) {
|
|
5994
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(this.axios, this.basePath));
|
|
5995
|
+
}
|
|
5996
|
+
/**
|
|
5997
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
5998
|
+
* @summary Create Analytics Rule
|
|
5999
|
+
* @param {string} authorization Bearer JWT token
|
|
6000
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
6001
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
6002
|
+
* @param {*} [options] Override http request option.
|
|
6003
|
+
* @throws {RequiredError}
|
|
6004
|
+
* @memberof AnalyticsRulesApi
|
|
6005
|
+
*/
|
|
6006
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options) {
|
|
6007
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6008
|
+
}
|
|
6009
|
+
/**
|
|
6010
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
6011
|
+
* @summary Delete Analytics Rule
|
|
6012
|
+
* @param {string} authorization Bearer JWT token
|
|
6013
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
6014
|
+
* @param {string} ruleId Rule ID
|
|
6015
|
+
* @param {*} [options] Override http request option.
|
|
6016
|
+
* @throws {RequiredError}
|
|
6017
|
+
* @memberof AnalyticsRulesApi
|
|
6018
|
+
*/
|
|
6019
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options) {
|
|
6020
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
6021
|
+
}
|
|
6022
|
+
/**
|
|
6023
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
6024
|
+
* @summary Get Analytics Rule
|
|
6025
|
+
* @param {string} authorization Bearer JWT token
|
|
6026
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
6027
|
+
* @param {string} ruleId Rule ID
|
|
6028
|
+
* @param {*} [options] Override http request option.
|
|
6029
|
+
* @throws {RequiredError}
|
|
6030
|
+
* @memberof AnalyticsRulesApi
|
|
6031
|
+
*/
|
|
6032
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options) {
|
|
6033
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
6034
|
+
}
|
|
6035
|
+
/**
|
|
6036
|
+
* Update an existing analytics rule. Supports partial updates. When is_active is set to false, the rule is removed from Typesense. When is_active is set to true, the rule is synced to Typesense.
|
|
6037
|
+
* @summary Update Analytics Rule
|
|
6038
|
+
* @param {string} authorization Bearer JWT token
|
|
6039
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
6040
|
+
* @param {string} ruleId Rule ID
|
|
6041
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
6042
|
+
* @param {*} [options] Override http request option.
|
|
6043
|
+
* @throws {RequiredError}
|
|
6044
|
+
* @memberof AnalyticsRulesApi
|
|
6045
|
+
*/
|
|
6046
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options) {
|
|
6047
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6048
|
+
}
|
|
6049
|
+
/**
|
|
6050
|
+
* Manually synchronize analytics rules to Typesense. This endpoint can be used to force a sync of all active rules or specific rules to Typesense collections.
|
|
6051
|
+
* @summary Sync Rules to Typesense
|
|
6052
|
+
* @param {string} authorization Bearer JWT token
|
|
6053
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
6054
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
6055
|
+
* @param {*} [options] Override http request option.
|
|
6056
|
+
* @throws {RequiredError}
|
|
6057
|
+
* @memberof AnalyticsRulesApi
|
|
6058
|
+
*/
|
|
6059
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options) {
|
|
6060
|
+
return (0, exports.AnalyticsRulesApiFp)(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6061
|
+
}
|
|
6062
|
+
}
|
|
6063
|
+
exports.AnalyticsRulesApi = AnalyticsRulesApi;
|
|
6064
|
+
/**
|
|
6065
|
+
* ArticlesApi - axios parameter creator
|
|
6066
|
+
* @export
|
|
6067
|
+
*/
|
|
6068
|
+
const ArticlesApiAxiosParamCreator = function (configuration) {
|
|
6069
|
+
return {
|
|
6070
|
+
/**
|
|
6071
|
+
* Delete an article by its ID.
|
|
6072
|
+
* @summary Delete an existing Article
|
|
6073
|
+
* @param {string} articleID Article ID
|
|
6074
|
+
* @param {*} [options] Override http request option.
|
|
6075
|
+
* @throws {RequiredError}
|
|
6076
|
+
*/
|
|
6077
|
+
adminArticlesArticleIDDelete: (articleID_1, ...args_1) => __awaiter(this, [articleID_1, ...args_1], void 0, function* (articleID, options = {}) {
|
|
6078
|
+
// verify required parameter 'articleID' is not null or undefined
|
|
6079
|
+
(0, common_1.assertParamExists)('adminArticlesArticleIDDelete', 'articleID', articleID);
|
|
6080
|
+
const localVarPath = `/admin/Articles/{articleID}`
|
|
6081
|
+
.replace(`{${"articleID"}}`, encodeURIComponent(String(articleID)));
|
|
6082
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6083
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6084
|
+
let baseOptions;
|
|
6085
|
+
if (configuration) {
|
|
6086
|
+
baseOptions = configuration.baseOptions;
|
|
6087
|
+
}
|
|
6088
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
6089
|
+
const localVarHeaderParameter = {};
|
|
6090
|
+
const localVarQueryParameter = {};
|
|
6091
|
+
// authentication BearerAuth required
|
|
6092
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6093
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6094
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6095
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6096
|
+
return {
|
|
6097
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6098
|
+
options: localVarRequestOptions,
|
|
6099
|
+
};
|
|
6100
|
+
}),
|
|
6101
|
+
/**
|
|
6102
|
+
* Fetches article by id
|
|
6103
|
+
* @summary Fetches article by id
|
|
6104
|
+
* @param {number} articleID Article ID
|
|
6105
|
+
* @param {*} [options] Override http request option.
|
|
6106
|
+
* @throws {RequiredError}
|
|
6107
|
+
*/
|
|
6108
|
+
adminArticlesArticleIDGet: (articleID_1, ...args_1) => __awaiter(this, [articleID_1, ...args_1], void 0, function* (articleID, options = {}) {
|
|
6109
|
+
// verify required parameter 'articleID' is not null or undefined
|
|
6110
|
+
(0, common_1.assertParamExists)('adminArticlesArticleIDGet', 'articleID', articleID);
|
|
6111
|
+
const localVarPath = `/admin/Articles/{articleID}`
|
|
6112
|
+
.replace(`{${"articleID"}}`, encodeURIComponent(String(articleID)));
|
|
6113
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6114
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6115
|
+
let baseOptions;
|
|
6116
|
+
if (configuration) {
|
|
6117
|
+
baseOptions = configuration.baseOptions;
|
|
6118
|
+
}
|
|
6119
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
6120
|
+
const localVarHeaderParameter = {};
|
|
6121
|
+
const localVarQueryParameter = {};
|
|
6122
|
+
// authentication BearerAuth required
|
|
6123
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6124
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6125
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6126
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6127
|
+
return {
|
|
6128
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6129
|
+
options: localVarRequestOptions,
|
|
6130
|
+
};
|
|
6131
|
+
}),
|
|
6132
|
+
/**
|
|
6133
|
+
* Update article information by ID.
|
|
6134
|
+
* @summary Update an existing Article
|
|
6135
|
+
* @param {number} articleID Article ID
|
|
6136
|
+
* @param {MgDocumentTypesCreateArticleRequestDto} mgDocumentTypesCreateArticleRequestDto Article data to update
|
|
6137
|
+
* @param {*} [options] Override http request option.
|
|
6138
|
+
* @throws {RequiredError}
|
|
6139
|
+
*/
|
|
6140
|
+
adminArticlesArticleIDPut: (articleID_1, mgDocumentTypesCreateArticleRequestDto_1, ...args_1) => __awaiter(this, [articleID_1, mgDocumentTypesCreateArticleRequestDto_1, ...args_1], void 0, function* (articleID, mgDocumentTypesCreateArticleRequestDto, options = {}) {
|
|
6141
|
+
// verify required parameter 'articleID' is not null or undefined
|
|
6142
|
+
(0, common_1.assertParamExists)('adminArticlesArticleIDPut', 'articleID', articleID);
|
|
6143
|
+
// verify required parameter 'mgDocumentTypesCreateArticleRequestDto' is not null or undefined
|
|
6144
|
+
(0, common_1.assertParamExists)('adminArticlesArticleIDPut', 'mgDocumentTypesCreateArticleRequestDto', mgDocumentTypesCreateArticleRequestDto);
|
|
6145
|
+
const localVarPath = `/admin/Articles/{articleID}`
|
|
6146
|
+
.replace(`{${"articleID"}}`, encodeURIComponent(String(articleID)));
|
|
6147
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6148
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6149
|
+
let baseOptions;
|
|
6150
|
+
if (configuration) {
|
|
6151
|
+
baseOptions = configuration.baseOptions;
|
|
6152
|
+
}
|
|
6153
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
6154
|
+
const localVarHeaderParameter = {};
|
|
6155
|
+
const localVarQueryParameter = {};
|
|
6156
|
+
// authentication BearerAuth required
|
|
6157
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6158
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6159
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6160
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6161
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6162
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mgDocumentTypesCreateArticleRequestDto, localVarRequestOptions, configuration);
|
|
6163
|
+
return {
|
|
6164
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6165
|
+
options: localVarRequestOptions,
|
|
6166
|
+
};
|
|
6167
|
+
}),
|
|
6168
|
+
/**
|
|
6169
|
+
* Fetches list of all Articles
|
|
6170
|
+
* @summary Fetches list of all Articles
|
|
6171
|
+
* @param {*} [options] Override http request option.
|
|
6172
|
+
* @throws {RequiredError}
|
|
6173
|
+
*/
|
|
6174
|
+
adminArticlesGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
6175
|
+
const localVarPath = `/admin/Articles`;
|
|
6176
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6177
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6178
|
+
let baseOptions;
|
|
6179
|
+
if (configuration) {
|
|
6180
|
+
baseOptions = configuration.baseOptions;
|
|
6181
|
+
}
|
|
6182
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
6183
|
+
const localVarHeaderParameter = {};
|
|
6184
|
+
const localVarQueryParameter = {};
|
|
6185
|
+
// authentication BearerAuth required
|
|
6186
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6187
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6188
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6189
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6190
|
+
return {
|
|
6191
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6192
|
+
options: localVarRequestOptions,
|
|
6193
|
+
};
|
|
6194
|
+
}),
|
|
6195
|
+
/**
|
|
6196
|
+
* Adds a new article to the system
|
|
6197
|
+
* @summary Creates a new article
|
|
6198
|
+
* @param {MgDocumentTypesCreateArticleRequestDto} mgDocumentTypesCreateArticleRequestDto data
|
|
6199
|
+
* @param {*} [options] Override http request option.
|
|
6200
|
+
* @throws {RequiredError}
|
|
6201
|
+
*/
|
|
6202
|
+
adminArticlesPost: (mgDocumentTypesCreateArticleRequestDto_1, ...args_1) => __awaiter(this, [mgDocumentTypesCreateArticleRequestDto_1, ...args_1], void 0, function* (mgDocumentTypesCreateArticleRequestDto, options = {}) {
|
|
6203
|
+
// verify required parameter 'mgDocumentTypesCreateArticleRequestDto' is not null or undefined
|
|
6204
|
+
(0, common_1.assertParamExists)('adminArticlesPost', 'mgDocumentTypesCreateArticleRequestDto', mgDocumentTypesCreateArticleRequestDto);
|
|
6205
|
+
const localVarPath = `/admin/Articles`;
|
|
6206
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6207
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6208
|
+
let baseOptions;
|
|
6209
|
+
if (configuration) {
|
|
6210
|
+
baseOptions = configuration.baseOptions;
|
|
6211
|
+
}
|
|
6212
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
6213
|
+
const localVarHeaderParameter = {};
|
|
6214
|
+
const localVarQueryParameter = {};
|
|
6215
|
+
// authentication BearerAuth required
|
|
6216
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6217
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6218
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6219
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6220
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6221
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(mgDocumentTypesCreateArticleRequestDto, localVarRequestOptions, configuration);
|
|
6222
|
+
return {
|
|
6223
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6224
|
+
options: localVarRequestOptions,
|
|
6225
|
+
};
|
|
6226
|
+
}),
|
|
6227
|
+
};
|
|
6228
|
+
};
|
|
6229
|
+
exports.ArticlesApiAxiosParamCreator = ArticlesApiAxiosParamCreator;
|
|
6230
|
+
/**
|
|
6231
|
+
* ArticlesApi - functional programming interface
|
|
6232
|
+
* @export
|
|
6233
|
+
*/
|
|
6234
|
+
const ArticlesApiFp = function (configuration) {
|
|
6235
|
+
const localVarAxiosParamCreator = (0, exports.ArticlesApiAxiosParamCreator)(configuration);
|
|
6236
|
+
return {
|
|
6237
|
+
/**
|
|
6238
|
+
* Delete an article by its ID.
|
|
6239
|
+
* @summary Delete an existing Article
|
|
6240
|
+
* @param {string} articleID Article ID
|
|
6241
|
+
* @param {*} [options] Override http request option.
|
|
6242
|
+
* @throws {RequiredError}
|
|
6243
|
+
*/
|
|
6244
|
+
adminArticlesArticleIDDelete(articleID, options) {
|
|
6245
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6246
|
+
var _a, _b, _c;
|
|
6247
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminArticlesArticleIDDelete(articleID, options);
|
|
6248
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6249
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArticlesApi.adminArticlesArticleIDDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6250
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6251
|
+
});
|
|
6252
|
+
},
|
|
6253
|
+
/**
|
|
6254
|
+
* Fetches article by id
|
|
6255
|
+
* @summary Fetches article by id
|
|
6256
|
+
* @param {number} articleID Article ID
|
|
6257
|
+
* @param {*} [options] Override http request option.
|
|
6258
|
+
* @throws {RequiredError}
|
|
6259
|
+
*/
|
|
6260
|
+
adminArticlesArticleIDGet(articleID, options) {
|
|
6261
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6262
|
+
var _a, _b, _c;
|
|
6263
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminArticlesArticleIDGet(articleID, options);
|
|
6264
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6265
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArticlesApi.adminArticlesArticleIDGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6266
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6267
|
+
});
|
|
6268
|
+
},
|
|
6269
|
+
/**
|
|
6270
|
+
* Update article information by ID.
|
|
6271
|
+
* @summary Update an existing Article
|
|
6272
|
+
* @param {number} articleID Article ID
|
|
6273
|
+
* @param {MgDocumentTypesCreateArticleRequestDto} mgDocumentTypesCreateArticleRequestDto Article data to update
|
|
6274
|
+
* @param {*} [options] Override http request option.
|
|
6275
|
+
* @throws {RequiredError}
|
|
6276
|
+
*/
|
|
6277
|
+
adminArticlesArticleIDPut(articleID, mgDocumentTypesCreateArticleRequestDto, options) {
|
|
6278
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6279
|
+
var _a, _b, _c;
|
|
6280
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminArticlesArticleIDPut(articleID, mgDocumentTypesCreateArticleRequestDto, options);
|
|
6281
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6282
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArticlesApi.adminArticlesArticleIDPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6283
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6284
|
+
});
|
|
6285
|
+
},
|
|
6286
|
+
/**
|
|
6287
|
+
* Fetches list of all Articles
|
|
6288
|
+
* @summary Fetches list of all Articles
|
|
6289
|
+
* @param {*} [options] Override http request option.
|
|
6290
|
+
* @throws {RequiredError}
|
|
6291
|
+
*/
|
|
6292
|
+
adminArticlesGet(options) {
|
|
6293
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6294
|
+
var _a, _b, _c;
|
|
6295
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminArticlesGet(options);
|
|
6296
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6297
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArticlesApi.adminArticlesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6298
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6299
|
+
});
|
|
6300
|
+
},
|
|
6301
|
+
/**
|
|
6302
|
+
* Adds a new article to the system
|
|
6303
|
+
* @summary Creates a new article
|
|
6304
|
+
* @param {MgDocumentTypesCreateArticleRequestDto} mgDocumentTypesCreateArticleRequestDto data
|
|
6305
|
+
* @param {*} [options] Override http request option.
|
|
6306
|
+
* @throws {RequiredError}
|
|
6307
|
+
*/
|
|
6308
|
+
adminArticlesPost(mgDocumentTypesCreateArticleRequestDto, options) {
|
|
5168
6309
|
return __awaiter(this, void 0, void 0, function* () {
|
|
5169
6310
|
var _a, _b, _c;
|
|
5170
6311
|
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminArticlesPost(mgDocumentTypesCreateArticleRequestDto, options);
|
|
@@ -5420,111 +6561,287 @@ const AuthApiFp = function (configuration) {
|
|
|
5420
6561
|
* @param {*} [options] Override http request option.
|
|
5421
6562
|
* @throws {RequiredError}
|
|
5422
6563
|
*/
|
|
5423
|
-
authLogoutPost(options) {
|
|
6564
|
+
authLogoutPost(options) {
|
|
6565
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6566
|
+
var _a, _b, _c;
|
|
6567
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.authLogoutPost(options);
|
|
6568
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6569
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AuthApi.authLogoutPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6570
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6571
|
+
});
|
|
6572
|
+
},
|
|
6573
|
+
/**
|
|
6574
|
+
* Returns refreshed session data for authenticated user
|
|
6575
|
+
* @summary Get current auth session
|
|
6576
|
+
* @param {*} [options] Override http request option.
|
|
6577
|
+
* @throws {RequiredError}
|
|
6578
|
+
*/
|
|
6579
|
+
authSessionGet(options) {
|
|
6580
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6581
|
+
var _a, _b, _c;
|
|
6582
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.authSessionGet(options);
|
|
6583
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6584
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AuthApi.authSessionGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6585
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6586
|
+
});
|
|
6587
|
+
},
|
|
6588
|
+
};
|
|
6589
|
+
};
|
|
6590
|
+
exports.AuthApiFp = AuthApiFp;
|
|
6591
|
+
/**
|
|
6592
|
+
* AuthApi - factory interface
|
|
6593
|
+
* @export
|
|
6594
|
+
*/
|
|
6595
|
+
const AuthApiFactory = function (configuration, basePath, axios) {
|
|
6596
|
+
const localVarFp = (0, exports.AuthApiFp)(configuration);
|
|
6597
|
+
return {
|
|
6598
|
+
/**
|
|
6599
|
+
* Authenticates a user with username and password
|
|
6600
|
+
* @summary Login a user
|
|
6601
|
+
* @param {DataTypesLoginRequest} dataTypesLoginRequest Login credentials
|
|
6602
|
+
* @param {*} [options] Override http request option.
|
|
6603
|
+
* @throws {RequiredError}
|
|
6604
|
+
*/
|
|
6605
|
+
authLoginPost(dataTypesLoginRequest, options) {
|
|
6606
|
+
return localVarFp.authLoginPost(dataTypesLoginRequest, options).then((request) => request(axios, basePath));
|
|
6607
|
+
},
|
|
6608
|
+
/**
|
|
6609
|
+
* Logs out the authenticated user
|
|
6610
|
+
* @summary Logout a user
|
|
6611
|
+
* @param {*} [options] Override http request option.
|
|
6612
|
+
* @throws {RequiredError}
|
|
6613
|
+
*/
|
|
6614
|
+
authLogoutPost(options) {
|
|
6615
|
+
return localVarFp.authLogoutPost(options).then((request) => request(axios, basePath));
|
|
6616
|
+
},
|
|
6617
|
+
/**
|
|
6618
|
+
* Returns refreshed session data for authenticated user
|
|
6619
|
+
* @summary Get current auth session
|
|
6620
|
+
* @param {*} [options] Override http request option.
|
|
6621
|
+
* @throws {RequiredError}
|
|
6622
|
+
*/
|
|
6623
|
+
authSessionGet(options) {
|
|
6624
|
+
return localVarFp.authSessionGet(options).then((request) => request(axios, basePath));
|
|
6625
|
+
},
|
|
6626
|
+
};
|
|
6627
|
+
};
|
|
6628
|
+
exports.AuthApiFactory = AuthApiFactory;
|
|
6629
|
+
/**
|
|
6630
|
+
* AuthApi - object-oriented interface
|
|
6631
|
+
* @export
|
|
6632
|
+
* @class AuthApi
|
|
6633
|
+
* @extends {BaseAPI}
|
|
6634
|
+
*/
|
|
6635
|
+
class AuthApi extends base_1.BaseAPI {
|
|
6636
|
+
/**
|
|
6637
|
+
* Authenticates a user with username and password
|
|
6638
|
+
* @summary Login a user
|
|
6639
|
+
* @param {DataTypesLoginRequest} dataTypesLoginRequest Login credentials
|
|
6640
|
+
* @param {*} [options] Override http request option.
|
|
6641
|
+
* @throws {RequiredError}
|
|
6642
|
+
* @memberof AuthApi
|
|
6643
|
+
*/
|
|
6644
|
+
authLoginPost(dataTypesLoginRequest, options) {
|
|
6645
|
+
return (0, exports.AuthApiFp)(this.configuration).authLoginPost(dataTypesLoginRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6646
|
+
}
|
|
6647
|
+
/**
|
|
6648
|
+
* Logs out the authenticated user
|
|
6649
|
+
* @summary Logout a user
|
|
6650
|
+
* @param {*} [options] Override http request option.
|
|
6651
|
+
* @throws {RequiredError}
|
|
6652
|
+
* @memberof AuthApi
|
|
6653
|
+
*/
|
|
6654
|
+
authLogoutPost(options) {
|
|
6655
|
+
return (0, exports.AuthApiFp)(this.configuration).authLogoutPost(options).then((request) => request(this.axios, this.basePath));
|
|
6656
|
+
}
|
|
6657
|
+
/**
|
|
6658
|
+
* Returns refreshed session data for authenticated user
|
|
6659
|
+
* @summary Get current auth session
|
|
6660
|
+
* @param {*} [options] Override http request option.
|
|
6661
|
+
* @throws {RequiredError}
|
|
6662
|
+
* @memberof AuthApi
|
|
6663
|
+
*/
|
|
6664
|
+
authSessionGet(options) {
|
|
6665
|
+
return (0, exports.AuthApiFp)(this.configuration).authSessionGet(options).then((request) => request(this.axios, this.basePath));
|
|
6666
|
+
}
|
|
6667
|
+
}
|
|
6668
|
+
exports.AuthApi = AuthApi;
|
|
6669
|
+
/**
|
|
6670
|
+
* AutomatedRefundManagementApi - axios parameter creator
|
|
6671
|
+
* @export
|
|
6672
|
+
*/
|
|
6673
|
+
const AutomatedRefundManagementApiAxiosParamCreator = function (configuration) {
|
|
6674
|
+
return {
|
|
6675
|
+
/**
|
|
6676
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
6677
|
+
* @summary Preview automated refund
|
|
6678
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
6679
|
+
* @param {*} [options] Override http request option.
|
|
6680
|
+
* @throws {RequiredError}
|
|
6681
|
+
*/
|
|
6682
|
+
apiRefundAutomatedPreviewPost: (refundRefundPreviewRequestDto_1, ...args_1) => __awaiter(this, [refundRefundPreviewRequestDto_1, ...args_1], void 0, function* (refundRefundPreviewRequestDto, options = {}) {
|
|
6683
|
+
// verify required parameter 'refundRefundPreviewRequestDto' is not null or undefined
|
|
6684
|
+
(0, common_1.assertParamExists)('apiRefundAutomatedPreviewPost', 'refundRefundPreviewRequestDto', refundRefundPreviewRequestDto);
|
|
6685
|
+
const localVarPath = `/api/refund/automated/preview`;
|
|
6686
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6687
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6688
|
+
let baseOptions;
|
|
6689
|
+
if (configuration) {
|
|
6690
|
+
baseOptions = configuration.baseOptions;
|
|
6691
|
+
}
|
|
6692
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
6693
|
+
const localVarHeaderParameter = {};
|
|
6694
|
+
const localVarQueryParameter = {};
|
|
6695
|
+
// authentication BearerAuth required
|
|
6696
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6697
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6698
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6699
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6700
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6701
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(refundRefundPreviewRequestDto, localVarRequestOptions, configuration);
|
|
6702
|
+
return {
|
|
6703
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6704
|
+
options: localVarRequestOptions,
|
|
6705
|
+
};
|
|
6706
|
+
}),
|
|
6707
|
+
/**
|
|
6708
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
6709
|
+
* @summary Process automated refund
|
|
6710
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
6711
|
+
* @param {*} [options] Override http request option.
|
|
6712
|
+
* @throws {RequiredError}
|
|
6713
|
+
*/
|
|
6714
|
+
apiRefundAutomatedProcessPost: (refundRefundPreviewRequestDto_1, ...args_1) => __awaiter(this, [refundRefundPreviewRequestDto_1, ...args_1], void 0, function* (refundRefundPreviewRequestDto, options = {}) {
|
|
6715
|
+
// verify required parameter 'refundRefundPreviewRequestDto' is not null or undefined
|
|
6716
|
+
(0, common_1.assertParamExists)('apiRefundAutomatedProcessPost', 'refundRefundPreviewRequestDto', refundRefundPreviewRequestDto);
|
|
6717
|
+
const localVarPath = `/api/refund/automated/process`;
|
|
6718
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6719
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
6720
|
+
let baseOptions;
|
|
6721
|
+
if (configuration) {
|
|
6722
|
+
baseOptions = configuration.baseOptions;
|
|
6723
|
+
}
|
|
6724
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
6725
|
+
const localVarHeaderParameter = {};
|
|
6726
|
+
const localVarQueryParameter = {};
|
|
6727
|
+
// authentication BearerAuth required
|
|
6728
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
6729
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6730
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
6731
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6732
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6733
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(refundRefundPreviewRequestDto, localVarRequestOptions, configuration);
|
|
6734
|
+
return {
|
|
6735
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
6736
|
+
options: localVarRequestOptions,
|
|
6737
|
+
};
|
|
6738
|
+
}),
|
|
6739
|
+
};
|
|
6740
|
+
};
|
|
6741
|
+
exports.AutomatedRefundManagementApiAxiosParamCreator = AutomatedRefundManagementApiAxiosParamCreator;
|
|
6742
|
+
/**
|
|
6743
|
+
* AutomatedRefundManagementApi - functional programming interface
|
|
6744
|
+
* @export
|
|
6745
|
+
*/
|
|
6746
|
+
const AutomatedRefundManagementApiFp = function (configuration) {
|
|
6747
|
+
const localVarAxiosParamCreator = (0, exports.AutomatedRefundManagementApiAxiosParamCreator)(configuration);
|
|
6748
|
+
return {
|
|
6749
|
+
/**
|
|
6750
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
6751
|
+
* @summary Preview automated refund
|
|
6752
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
6753
|
+
* @param {*} [options] Override http request option.
|
|
6754
|
+
* @throws {RequiredError}
|
|
6755
|
+
*/
|
|
6756
|
+
apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options) {
|
|
5424
6757
|
return __awaiter(this, void 0, void 0, function* () {
|
|
5425
6758
|
var _a, _b, _c;
|
|
5426
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
6759
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options);
|
|
5427
6760
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5428
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
6761
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AutomatedRefundManagementApi.apiRefundAutomatedPreviewPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5429
6762
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5430
6763
|
});
|
|
5431
6764
|
},
|
|
5432
6765
|
/**
|
|
5433
|
-
*
|
|
5434
|
-
* @summary
|
|
6766
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
6767
|
+
* @summary Process automated refund
|
|
6768
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
5435
6769
|
* @param {*} [options] Override http request option.
|
|
5436
6770
|
* @throws {RequiredError}
|
|
5437
6771
|
*/
|
|
5438
|
-
|
|
6772
|
+
apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options) {
|
|
5439
6773
|
return __awaiter(this, void 0, void 0, function* () {
|
|
5440
6774
|
var _a, _b, _c;
|
|
5441
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
6775
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options);
|
|
5442
6776
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
5443
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['
|
|
6777
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AutomatedRefundManagementApi.apiRefundAutomatedProcessPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
5444
6778
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5445
6779
|
});
|
|
5446
6780
|
},
|
|
5447
6781
|
};
|
|
5448
6782
|
};
|
|
5449
|
-
exports.
|
|
6783
|
+
exports.AutomatedRefundManagementApiFp = AutomatedRefundManagementApiFp;
|
|
5450
6784
|
/**
|
|
5451
|
-
*
|
|
6785
|
+
* AutomatedRefundManagementApi - factory interface
|
|
5452
6786
|
* @export
|
|
5453
6787
|
*/
|
|
5454
|
-
const
|
|
5455
|
-
const localVarFp = (0, exports.
|
|
6788
|
+
const AutomatedRefundManagementApiFactory = function (configuration, basePath, axios) {
|
|
6789
|
+
const localVarFp = (0, exports.AutomatedRefundManagementApiFp)(configuration);
|
|
5456
6790
|
return {
|
|
5457
6791
|
/**
|
|
5458
|
-
*
|
|
5459
|
-
* @summary
|
|
5460
|
-
* @param {
|
|
5461
|
-
* @param {*} [options] Override http request option.
|
|
5462
|
-
* @throws {RequiredError}
|
|
5463
|
-
*/
|
|
5464
|
-
authLoginPost(dataTypesLoginRequest, options) {
|
|
5465
|
-
return localVarFp.authLoginPost(dataTypesLoginRequest, options).then((request) => request(axios, basePath));
|
|
5466
|
-
},
|
|
5467
|
-
/**
|
|
5468
|
-
* Logs out the authenticated user
|
|
5469
|
-
* @summary Logout a user
|
|
6792
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
6793
|
+
* @summary Preview automated refund
|
|
6794
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
5470
6795
|
* @param {*} [options] Override http request option.
|
|
5471
6796
|
* @throws {RequiredError}
|
|
5472
6797
|
*/
|
|
5473
|
-
|
|
5474
|
-
return localVarFp.
|
|
6798
|
+
apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options) {
|
|
6799
|
+
return localVarFp.apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options).then((request) => request(axios, basePath));
|
|
5475
6800
|
},
|
|
5476
6801
|
/**
|
|
5477
|
-
*
|
|
5478
|
-
* @summary
|
|
6802
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
6803
|
+
* @summary Process automated refund
|
|
6804
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
5479
6805
|
* @param {*} [options] Override http request option.
|
|
5480
6806
|
* @throws {RequiredError}
|
|
5481
6807
|
*/
|
|
5482
|
-
|
|
5483
|
-
return localVarFp.
|
|
6808
|
+
apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options) {
|
|
6809
|
+
return localVarFp.apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options).then((request) => request(axios, basePath));
|
|
5484
6810
|
},
|
|
5485
6811
|
};
|
|
5486
6812
|
};
|
|
5487
|
-
exports.
|
|
6813
|
+
exports.AutomatedRefundManagementApiFactory = AutomatedRefundManagementApiFactory;
|
|
5488
6814
|
/**
|
|
5489
|
-
*
|
|
6815
|
+
* AutomatedRefundManagementApi - object-oriented interface
|
|
5490
6816
|
* @export
|
|
5491
|
-
* @class
|
|
6817
|
+
* @class AutomatedRefundManagementApi
|
|
5492
6818
|
* @extends {BaseAPI}
|
|
5493
6819
|
*/
|
|
5494
|
-
class
|
|
5495
|
-
/**
|
|
5496
|
-
* Authenticates a user with username and password
|
|
5497
|
-
* @summary Login a user
|
|
5498
|
-
* @param {DataTypesLoginRequest} dataTypesLoginRequest Login credentials
|
|
5499
|
-
* @param {*} [options] Override http request option.
|
|
5500
|
-
* @throws {RequiredError}
|
|
5501
|
-
* @memberof AuthApi
|
|
5502
|
-
*/
|
|
5503
|
-
authLoginPost(dataTypesLoginRequest, options) {
|
|
5504
|
-
return (0, exports.AuthApiFp)(this.configuration).authLoginPost(dataTypesLoginRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5505
|
-
}
|
|
6820
|
+
class AutomatedRefundManagementApi extends base_1.BaseAPI {
|
|
5506
6821
|
/**
|
|
5507
|
-
*
|
|
5508
|
-
* @summary
|
|
6822
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
6823
|
+
* @summary Preview automated refund
|
|
6824
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
5509
6825
|
* @param {*} [options] Override http request option.
|
|
5510
6826
|
* @throws {RequiredError}
|
|
5511
|
-
* @memberof
|
|
6827
|
+
* @memberof AutomatedRefundManagementApi
|
|
5512
6828
|
*/
|
|
5513
|
-
|
|
5514
|
-
return (0, exports.
|
|
6829
|
+
apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options) {
|
|
6830
|
+
return (0, exports.AutomatedRefundManagementApiFp)(this.configuration).apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
5515
6831
|
}
|
|
5516
6832
|
/**
|
|
5517
|
-
*
|
|
5518
|
-
* @summary
|
|
6833
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
6834
|
+
* @summary Process automated refund
|
|
6835
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
5519
6836
|
* @param {*} [options] Override http request option.
|
|
5520
6837
|
* @throws {RequiredError}
|
|
5521
|
-
* @memberof
|
|
6838
|
+
* @memberof AutomatedRefundManagementApi
|
|
5522
6839
|
*/
|
|
5523
|
-
|
|
5524
|
-
return (0, exports.
|
|
6840
|
+
apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options) {
|
|
6841
|
+
return (0, exports.AutomatedRefundManagementApiFp)(this.configuration).apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
5525
6842
|
}
|
|
5526
6843
|
}
|
|
5527
|
-
exports.
|
|
6844
|
+
exports.AutomatedRefundManagementApi = AutomatedRefundManagementApi;
|
|
5528
6845
|
/**
|
|
5529
6846
|
* BillingDashboardApi - axios parameter creator
|
|
5530
6847
|
* @export
|
|
@@ -18734,6 +20051,156 @@ exports.QuerySuggestionsManagementApi = QuerySuggestionsManagementApi;
|
|
|
18734
20051
|
*/
|
|
18735
20052
|
const RefundManagementApiAxiosParamCreator = function (configuration) {
|
|
18736
20053
|
return {
|
|
20054
|
+
/**
|
|
20055
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
20056
|
+
* @summary Calculate refund amount
|
|
20057
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
20058
|
+
* @param {*} [options] Override http request option.
|
|
20059
|
+
* @throws {RequiredError}
|
|
20060
|
+
*/
|
|
20061
|
+
apiRefundCalculatePost: (dataTypesRefundCalculationRequestDto_1, ...args_1) => __awaiter(this, [dataTypesRefundCalculationRequestDto_1, ...args_1], void 0, function* (dataTypesRefundCalculationRequestDto, options = {}) {
|
|
20062
|
+
// verify required parameter 'dataTypesRefundCalculationRequestDto' is not null or undefined
|
|
20063
|
+
(0, common_1.assertParamExists)('apiRefundCalculatePost', 'dataTypesRefundCalculationRequestDto', dataTypesRefundCalculationRequestDto);
|
|
20064
|
+
const localVarPath = `/api/refund/calculate`;
|
|
20065
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20066
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
20067
|
+
let baseOptions;
|
|
20068
|
+
if (configuration) {
|
|
20069
|
+
baseOptions = configuration.baseOptions;
|
|
20070
|
+
}
|
|
20071
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
20072
|
+
const localVarHeaderParameter = {};
|
|
20073
|
+
const localVarQueryParameter = {};
|
|
20074
|
+
// authentication BearerAuth required
|
|
20075
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
20076
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20077
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
20078
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20079
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20080
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesRefundCalculationRequestDto, localVarRequestOptions, configuration);
|
|
20081
|
+
return {
|
|
20082
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
20083
|
+
options: localVarRequestOptions,
|
|
20084
|
+
};
|
|
20085
|
+
}),
|
|
20086
|
+
/**
|
|
20087
|
+
* Checks if a payment is eligible for refund
|
|
20088
|
+
* @summary Check refund eligibility
|
|
20089
|
+
* @param {number} paymentId Payment ID
|
|
20090
|
+
* @param {*} [options] Override http request option.
|
|
20091
|
+
* @throws {RequiredError}
|
|
20092
|
+
*/
|
|
20093
|
+
apiRefundEligibilityPaymentIdGet: (paymentId_1, ...args_1) => __awaiter(this, [paymentId_1, ...args_1], void 0, function* (paymentId, options = {}) {
|
|
20094
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
20095
|
+
(0, common_1.assertParamExists)('apiRefundEligibilityPaymentIdGet', 'paymentId', paymentId);
|
|
20096
|
+
const localVarPath = `/api/refund/eligibility/{payment_id}`
|
|
20097
|
+
.replace(`{${"payment_id"}}`, encodeURIComponent(String(paymentId)));
|
|
20098
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20099
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
20100
|
+
let baseOptions;
|
|
20101
|
+
if (configuration) {
|
|
20102
|
+
baseOptions = configuration.baseOptions;
|
|
20103
|
+
}
|
|
20104
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
20105
|
+
const localVarHeaderParameter = {};
|
|
20106
|
+
const localVarQueryParameter = {};
|
|
20107
|
+
// authentication BearerAuth required
|
|
20108
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
20109
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
20110
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20111
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20112
|
+
return {
|
|
20113
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
20114
|
+
options: localVarRequestOptions,
|
|
20115
|
+
};
|
|
20116
|
+
}),
|
|
20117
|
+
/**
|
|
20118
|
+
* Retrieves refund history for an organization with filtering options
|
|
20119
|
+
* @summary Get refund history
|
|
20120
|
+
* @param {number} [orgId] Organization ID
|
|
20121
|
+
* @param {number} [paymentId] Payment ID
|
|
20122
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
20123
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
20124
|
+
* @param {string} [status] Refund status
|
|
20125
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
20126
|
+
* @param {number} [offset] Offset (default 0)
|
|
20127
|
+
* @param {*} [options] Override http request option.
|
|
20128
|
+
* @throws {RequiredError}
|
|
20129
|
+
*/
|
|
20130
|
+
apiRefundHistoryGet: (orgId_1, paymentId_1, startDate_1, endDate_1, status_1, limit_1, offset_1, ...args_1) => __awaiter(this, [orgId_1, paymentId_1, startDate_1, endDate_1, status_1, limit_1, offset_1, ...args_1], void 0, function* (orgId, paymentId, startDate, endDate, status, limit, offset, options = {}) {
|
|
20131
|
+
const localVarPath = `/api/refund/history`;
|
|
20132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20133
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
20134
|
+
let baseOptions;
|
|
20135
|
+
if (configuration) {
|
|
20136
|
+
baseOptions = configuration.baseOptions;
|
|
20137
|
+
}
|
|
20138
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
20139
|
+
const localVarHeaderParameter = {};
|
|
20140
|
+
const localVarQueryParameter = {};
|
|
20141
|
+
// authentication BearerAuth required
|
|
20142
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
20143
|
+
if (orgId !== undefined) {
|
|
20144
|
+
localVarQueryParameter['org_id'] = orgId;
|
|
20145
|
+
}
|
|
20146
|
+
if (paymentId !== undefined) {
|
|
20147
|
+
localVarQueryParameter['payment_id'] = paymentId;
|
|
20148
|
+
}
|
|
20149
|
+
if (startDate !== undefined) {
|
|
20150
|
+
localVarQueryParameter['start_date'] = startDate;
|
|
20151
|
+
}
|
|
20152
|
+
if (endDate !== undefined) {
|
|
20153
|
+
localVarQueryParameter['end_date'] = endDate;
|
|
20154
|
+
}
|
|
20155
|
+
if (status !== undefined) {
|
|
20156
|
+
localVarQueryParameter['status'] = status;
|
|
20157
|
+
}
|
|
20158
|
+
if (limit !== undefined) {
|
|
20159
|
+
localVarQueryParameter['limit'] = limit;
|
|
20160
|
+
}
|
|
20161
|
+
if (offset !== undefined) {
|
|
20162
|
+
localVarQueryParameter['offset'] = offset;
|
|
20163
|
+
}
|
|
20164
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
20165
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20166
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20167
|
+
return {
|
|
20168
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
20169
|
+
options: localVarRequestOptions,
|
|
20170
|
+
};
|
|
20171
|
+
}),
|
|
20172
|
+
/**
|
|
20173
|
+
* Processes a refund request and executes credit adjustments
|
|
20174
|
+
* @summary Process refund
|
|
20175
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
20176
|
+
* @param {*} [options] Override http request option.
|
|
20177
|
+
* @throws {RequiredError}
|
|
20178
|
+
*/
|
|
20179
|
+
apiRefundProcessPost: (dataTypesProcessRefundRequestDto_1, ...args_1) => __awaiter(this, [dataTypesProcessRefundRequestDto_1, ...args_1], void 0, function* (dataTypesProcessRefundRequestDto, options = {}) {
|
|
20180
|
+
// verify required parameter 'dataTypesProcessRefundRequestDto' is not null or undefined
|
|
20181
|
+
(0, common_1.assertParamExists)('apiRefundProcessPost', 'dataTypesProcessRefundRequestDto', dataTypesProcessRefundRequestDto);
|
|
20182
|
+
const localVarPath = `/api/refund/process`;
|
|
20183
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20184
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
20185
|
+
let baseOptions;
|
|
20186
|
+
if (configuration) {
|
|
20187
|
+
baseOptions = configuration.baseOptions;
|
|
20188
|
+
}
|
|
20189
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
20190
|
+
const localVarHeaderParameter = {};
|
|
20191
|
+
const localVarQueryParameter = {};
|
|
20192
|
+
// authentication BearerAuth required
|
|
20193
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
20194
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20195
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
20196
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20197
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20198
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dataTypesProcessRefundRequestDto, localVarRequestOptions, configuration);
|
|
20199
|
+
return {
|
|
20200
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
20201
|
+
options: localVarRequestOptions,
|
|
20202
|
+
};
|
|
20203
|
+
}),
|
|
18737
20204
|
/**
|
|
18738
20205
|
* Approves or rejects a pending refund request
|
|
18739
20206
|
* @summary Process refund approval or rejection
|
|
@@ -18933,6 +20400,76 @@ exports.RefundManagementApiAxiosParamCreator = RefundManagementApiAxiosParamCrea
|
|
|
18933
20400
|
const RefundManagementApiFp = function (configuration) {
|
|
18934
20401
|
const localVarAxiosParamCreator = (0, exports.RefundManagementApiAxiosParamCreator)(configuration);
|
|
18935
20402
|
return {
|
|
20403
|
+
/**
|
|
20404
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
20405
|
+
* @summary Calculate refund amount
|
|
20406
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
20407
|
+
* @param {*} [options] Override http request option.
|
|
20408
|
+
* @throws {RequiredError}
|
|
20409
|
+
*/
|
|
20410
|
+
apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options) {
|
|
20411
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
20412
|
+
var _a, _b, _c;
|
|
20413
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options);
|
|
20414
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
20415
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RefundManagementApi.apiRefundCalculatePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
20416
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20417
|
+
});
|
|
20418
|
+
},
|
|
20419
|
+
/**
|
|
20420
|
+
* Checks if a payment is eligible for refund
|
|
20421
|
+
* @summary Check refund eligibility
|
|
20422
|
+
* @param {number} paymentId Payment ID
|
|
20423
|
+
* @param {*} [options] Override http request option.
|
|
20424
|
+
* @throws {RequiredError}
|
|
20425
|
+
*/
|
|
20426
|
+
apiRefundEligibilityPaymentIdGet(paymentId, options) {
|
|
20427
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
20428
|
+
var _a, _b, _c;
|
|
20429
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundEligibilityPaymentIdGet(paymentId, options);
|
|
20430
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
20431
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RefundManagementApi.apiRefundEligibilityPaymentIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
20432
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20433
|
+
});
|
|
20434
|
+
},
|
|
20435
|
+
/**
|
|
20436
|
+
* Retrieves refund history for an organization with filtering options
|
|
20437
|
+
* @summary Get refund history
|
|
20438
|
+
* @param {number} [orgId] Organization ID
|
|
20439
|
+
* @param {number} [paymentId] Payment ID
|
|
20440
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
20441
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
20442
|
+
* @param {string} [status] Refund status
|
|
20443
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
20444
|
+
* @param {number} [offset] Offset (default 0)
|
|
20445
|
+
* @param {*} [options] Override http request option.
|
|
20446
|
+
* @throws {RequiredError}
|
|
20447
|
+
*/
|
|
20448
|
+
apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options) {
|
|
20449
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
20450
|
+
var _a, _b, _c;
|
|
20451
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options);
|
|
20452
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
20453
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RefundManagementApi.apiRefundHistoryGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
20454
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20455
|
+
});
|
|
20456
|
+
},
|
|
20457
|
+
/**
|
|
20458
|
+
* Processes a refund request and executes credit adjustments
|
|
20459
|
+
* @summary Process refund
|
|
20460
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
20461
|
+
* @param {*} [options] Override http request option.
|
|
20462
|
+
* @throws {RequiredError}
|
|
20463
|
+
*/
|
|
20464
|
+
apiRefundProcessPost(dataTypesProcessRefundRequestDto, options) {
|
|
20465
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
20466
|
+
var _a, _b, _c;
|
|
20467
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiRefundProcessPost(dataTypesProcessRefundRequestDto, options);
|
|
20468
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
20469
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RefundManagementApi.apiRefundProcessPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
20470
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20471
|
+
});
|
|
20472
|
+
},
|
|
18936
20473
|
/**
|
|
18937
20474
|
* Approves or rejects a pending refund request
|
|
18938
20475
|
* @summary Process refund approval or rejection
|
|
@@ -19031,6 +20568,52 @@ exports.RefundManagementApiFp = RefundManagementApiFp;
|
|
|
19031
20568
|
const RefundManagementApiFactory = function (configuration, basePath, axios) {
|
|
19032
20569
|
const localVarFp = (0, exports.RefundManagementApiFp)(configuration);
|
|
19033
20570
|
return {
|
|
20571
|
+
/**
|
|
20572
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
20573
|
+
* @summary Calculate refund amount
|
|
20574
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
20575
|
+
* @param {*} [options] Override http request option.
|
|
20576
|
+
* @throws {RequiredError}
|
|
20577
|
+
*/
|
|
20578
|
+
apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options) {
|
|
20579
|
+
return localVarFp.apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options).then((request) => request(axios, basePath));
|
|
20580
|
+
},
|
|
20581
|
+
/**
|
|
20582
|
+
* Checks if a payment is eligible for refund
|
|
20583
|
+
* @summary Check refund eligibility
|
|
20584
|
+
* @param {number} paymentId Payment ID
|
|
20585
|
+
* @param {*} [options] Override http request option.
|
|
20586
|
+
* @throws {RequiredError}
|
|
20587
|
+
*/
|
|
20588
|
+
apiRefundEligibilityPaymentIdGet(paymentId, options) {
|
|
20589
|
+
return localVarFp.apiRefundEligibilityPaymentIdGet(paymentId, options).then((request) => request(axios, basePath));
|
|
20590
|
+
},
|
|
20591
|
+
/**
|
|
20592
|
+
* Retrieves refund history for an organization with filtering options
|
|
20593
|
+
* @summary Get refund history
|
|
20594
|
+
* @param {number} [orgId] Organization ID
|
|
20595
|
+
* @param {number} [paymentId] Payment ID
|
|
20596
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
20597
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
20598
|
+
* @param {string} [status] Refund status
|
|
20599
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
20600
|
+
* @param {number} [offset] Offset (default 0)
|
|
20601
|
+
* @param {*} [options] Override http request option.
|
|
20602
|
+
* @throws {RequiredError}
|
|
20603
|
+
*/
|
|
20604
|
+
apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options) {
|
|
20605
|
+
return localVarFp.apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options).then((request) => request(axios, basePath));
|
|
20606
|
+
},
|
|
20607
|
+
/**
|
|
20608
|
+
* Processes a refund request and executes credit adjustments
|
|
20609
|
+
* @summary Process refund
|
|
20610
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
20611
|
+
* @param {*} [options] Override http request option.
|
|
20612
|
+
* @throws {RequiredError}
|
|
20613
|
+
*/
|
|
20614
|
+
apiRefundProcessPost(dataTypesProcessRefundRequestDto, options) {
|
|
20615
|
+
return localVarFp.apiRefundProcessPost(dataTypesProcessRefundRequestDto, options).then((request) => request(axios, basePath));
|
|
20616
|
+
},
|
|
19034
20617
|
/**
|
|
19035
20618
|
* Approves or rejects a pending refund request
|
|
19036
20619
|
* @summary Process refund approval or rejection
|
|
@@ -19099,6 +20682,56 @@ exports.RefundManagementApiFactory = RefundManagementApiFactory;
|
|
|
19099
20682
|
* @extends {BaseAPI}
|
|
19100
20683
|
*/
|
|
19101
20684
|
class RefundManagementApi extends base_1.BaseAPI {
|
|
20685
|
+
/**
|
|
20686
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
20687
|
+
* @summary Calculate refund amount
|
|
20688
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
20689
|
+
* @param {*} [options] Override http request option.
|
|
20690
|
+
* @throws {RequiredError}
|
|
20691
|
+
* @memberof RefundManagementApi
|
|
20692
|
+
*/
|
|
20693
|
+
apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options) {
|
|
20694
|
+
return (0, exports.RefundManagementApiFp)(this.configuration).apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
20695
|
+
}
|
|
20696
|
+
/**
|
|
20697
|
+
* Checks if a payment is eligible for refund
|
|
20698
|
+
* @summary Check refund eligibility
|
|
20699
|
+
* @param {number} paymentId Payment ID
|
|
20700
|
+
* @param {*} [options] Override http request option.
|
|
20701
|
+
* @throws {RequiredError}
|
|
20702
|
+
* @memberof RefundManagementApi
|
|
20703
|
+
*/
|
|
20704
|
+
apiRefundEligibilityPaymentIdGet(paymentId, options) {
|
|
20705
|
+
return (0, exports.RefundManagementApiFp)(this.configuration).apiRefundEligibilityPaymentIdGet(paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
20706
|
+
}
|
|
20707
|
+
/**
|
|
20708
|
+
* Retrieves refund history for an organization with filtering options
|
|
20709
|
+
* @summary Get refund history
|
|
20710
|
+
* @param {number} [orgId] Organization ID
|
|
20711
|
+
* @param {number} [paymentId] Payment ID
|
|
20712
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
20713
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
20714
|
+
* @param {string} [status] Refund status
|
|
20715
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
20716
|
+
* @param {number} [offset] Offset (default 0)
|
|
20717
|
+
* @param {*} [options] Override http request option.
|
|
20718
|
+
* @throws {RequiredError}
|
|
20719
|
+
* @memberof RefundManagementApi
|
|
20720
|
+
*/
|
|
20721
|
+
apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options) {
|
|
20722
|
+
return (0, exports.RefundManagementApiFp)(this.configuration).apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
20723
|
+
}
|
|
20724
|
+
/**
|
|
20725
|
+
* Processes a refund request and executes credit adjustments
|
|
20726
|
+
* @summary Process refund
|
|
20727
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
20728
|
+
* @param {*} [options] Override http request option.
|
|
20729
|
+
* @throws {RequiredError}
|
|
20730
|
+
* @memberof RefundManagementApi
|
|
20731
|
+
*/
|
|
20732
|
+
apiRefundProcessPost(dataTypesProcessRefundRequestDto, options) {
|
|
20733
|
+
return (0, exports.RefundManagementApiFp)(this.configuration).apiRefundProcessPost(dataTypesProcessRefundRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
20734
|
+
}
|
|
19102
20735
|
/**
|
|
19103
20736
|
* Approves or rejects a pending refund request
|
|
19104
20737
|
* @summary Process refund approval or rejection
|