@seekora-ai/admin-api 1.0.71 → 1.0.73
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 +58 -2
- package/api.ts +3542 -0
- package/dist/api.d.ts +3535 -965
- package/dist/api.js +1895 -124
- package/dist/esm/api.d.ts +3535 -965
- package/dist/esm/api.js +1882 -119
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.73.tgz +0 -0
- package/seekora-ai-admin-api-1.0.71.tgz +0 -0
package/api.ts
CHANGED
|
@@ -8004,6 +8004,240 @@ export interface DataTypesAdminSearchRequest {
|
|
|
8004
8004
|
*/
|
|
8005
8005
|
'widget_mode'?: boolean;
|
|
8006
8006
|
}
|
|
8007
|
+
/**
|
|
8008
|
+
* Standard error response format for analytics rules API
|
|
8009
|
+
* @export
|
|
8010
|
+
* @interface DataTypesAnalyticsRuleErrorResponse
|
|
8011
|
+
*/
|
|
8012
|
+
export interface DataTypesAnalyticsRuleErrorResponse {
|
|
8013
|
+
/**
|
|
8014
|
+
*
|
|
8015
|
+
* @type {Array<DataTypesAnalyticsRuleValidationError>}
|
|
8016
|
+
* @memberof DataTypesAnalyticsRuleErrorResponse
|
|
8017
|
+
*/
|
|
8018
|
+
'details'?: Array<DataTypesAnalyticsRuleValidationError>;
|
|
8019
|
+
/**
|
|
8020
|
+
*
|
|
8021
|
+
* @type {string}
|
|
8022
|
+
* @memberof DataTypesAnalyticsRuleErrorResponse
|
|
8023
|
+
*/
|
|
8024
|
+
'error'?: string;
|
|
8025
|
+
}
|
|
8026
|
+
/**
|
|
8027
|
+
* Response containing paginated list of analytics rules with metadata
|
|
8028
|
+
* @export
|
|
8029
|
+
* @interface DataTypesAnalyticsRuleListResponse
|
|
8030
|
+
*/
|
|
8031
|
+
export interface DataTypesAnalyticsRuleListResponse {
|
|
8032
|
+
/**
|
|
8033
|
+
* Whether there are more results
|
|
8034
|
+
* @type {boolean}
|
|
8035
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8036
|
+
*/
|
|
8037
|
+
'has_more'?: boolean;
|
|
8038
|
+
/**
|
|
8039
|
+
* Number of results per page
|
|
8040
|
+
* @type {number}
|
|
8041
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8042
|
+
*/
|
|
8043
|
+
'limit'?: number;
|
|
8044
|
+
/**
|
|
8045
|
+
* Current offset
|
|
8046
|
+
* @type {number}
|
|
8047
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8048
|
+
*/
|
|
8049
|
+
'offset'?: number;
|
|
8050
|
+
/**
|
|
8051
|
+
* Page-based pagination metadata (alternative view)
|
|
8052
|
+
* @type {number}
|
|
8053
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8054
|
+
*/
|
|
8055
|
+
'page'?: number;
|
|
8056
|
+
/**
|
|
8057
|
+
* Number of results per page
|
|
8058
|
+
* @type {number}
|
|
8059
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8060
|
+
*/
|
|
8061
|
+
'page_size'?: number;
|
|
8062
|
+
/**
|
|
8063
|
+
*
|
|
8064
|
+
* @type {Array<DataTypesAnalyticsRuleResponse>}
|
|
8065
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8066
|
+
*/
|
|
8067
|
+
'rules'?: Array<DataTypesAnalyticsRuleResponse>;
|
|
8068
|
+
/**
|
|
8069
|
+
* Pagination metadata (like other analytics APIs)
|
|
8070
|
+
* @type {number}
|
|
8071
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8072
|
+
*/
|
|
8073
|
+
'total'?: number;
|
|
8074
|
+
/**
|
|
8075
|
+
* Total number of pages
|
|
8076
|
+
* @type {number}
|
|
8077
|
+
* @memberof DataTypesAnalyticsRuleListResponse
|
|
8078
|
+
*/
|
|
8079
|
+
'total_pages'?: number;
|
|
8080
|
+
}
|
|
8081
|
+
/**
|
|
8082
|
+
* API response model for analytics rules (excludes internal fields)
|
|
8083
|
+
* @export
|
|
8084
|
+
* @interface DataTypesAnalyticsRuleResponse
|
|
8085
|
+
*/
|
|
8086
|
+
export interface DataTypesAnalyticsRuleResponse {
|
|
8087
|
+
/**
|
|
8088
|
+
*
|
|
8089
|
+
* @type {string}
|
|
8090
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8091
|
+
*/
|
|
8092
|
+
'created_at'?: string;
|
|
8093
|
+
/**
|
|
8094
|
+
*
|
|
8095
|
+
* @type {string}
|
|
8096
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8097
|
+
*/
|
|
8098
|
+
'description'?: string;
|
|
8099
|
+
/**
|
|
8100
|
+
*
|
|
8101
|
+
* @type {number}
|
|
8102
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8103
|
+
*/
|
|
8104
|
+
'effective_from_ts'?: number;
|
|
8105
|
+
/**
|
|
8106
|
+
*
|
|
8107
|
+
* @type {number}
|
|
8108
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8109
|
+
*/
|
|
8110
|
+
'effective_to_ts'?: number;
|
|
8111
|
+
/**
|
|
8112
|
+
*
|
|
8113
|
+
* @type {number}
|
|
8114
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8115
|
+
*/
|
|
8116
|
+
'id'?: number;
|
|
8117
|
+
/**
|
|
8118
|
+
*
|
|
8119
|
+
* @type {boolean}
|
|
8120
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8121
|
+
*/
|
|
8122
|
+
'is_active'?: boolean;
|
|
8123
|
+
/**
|
|
8124
|
+
*
|
|
8125
|
+
* @type {string}
|
|
8126
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8127
|
+
*/
|
|
8128
|
+
'modified_at'?: string;
|
|
8129
|
+
/**
|
|
8130
|
+
*
|
|
8131
|
+
* @type {string}
|
|
8132
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8133
|
+
*/
|
|
8134
|
+
'name'?: string;
|
|
8135
|
+
/**
|
|
8136
|
+
*
|
|
8137
|
+
* @type {DataTypesOverrideActions}
|
|
8138
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8139
|
+
*/
|
|
8140
|
+
'override_actions'?: DataTypesOverrideActions;
|
|
8141
|
+
/**
|
|
8142
|
+
*
|
|
8143
|
+
* @type {DataTypesRuleConfig}
|
|
8144
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8145
|
+
*/
|
|
8146
|
+
'rule_config'?: DataTypesRuleConfig;
|
|
8147
|
+
/**
|
|
8148
|
+
*
|
|
8149
|
+
* @type {string}
|
|
8150
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8151
|
+
*/
|
|
8152
|
+
'rule_id'?: string;
|
|
8153
|
+
/**
|
|
8154
|
+
*
|
|
8155
|
+
* @type {number}
|
|
8156
|
+
* @memberof DataTypesAnalyticsRuleResponse
|
|
8157
|
+
*/
|
|
8158
|
+
'store_id'?: number;
|
|
8159
|
+
}
|
|
8160
|
+
/**
|
|
8161
|
+
* Request parameters for manually syncing analytics rules to Typesense
|
|
8162
|
+
* @export
|
|
8163
|
+
* @interface DataTypesAnalyticsRuleSyncRequest
|
|
8164
|
+
*/
|
|
8165
|
+
export interface DataTypesAnalyticsRuleSyncRequest {
|
|
8166
|
+
/**
|
|
8167
|
+
*
|
|
8168
|
+
* @type {string}
|
|
8169
|
+
* @memberof DataTypesAnalyticsRuleSyncRequest
|
|
8170
|
+
*/
|
|
8171
|
+
'collection_name'?: string;
|
|
8172
|
+
/**
|
|
8173
|
+
* If empty, sync all rules
|
|
8174
|
+
* @type {Array<string>}
|
|
8175
|
+
* @memberof DataTypesAnalyticsRuleSyncRequest
|
|
8176
|
+
*/
|
|
8177
|
+
'rule_ids'?: Array<string>;
|
|
8178
|
+
/**
|
|
8179
|
+
*
|
|
8180
|
+
* @type {number}
|
|
8181
|
+
* @memberof DataTypesAnalyticsRuleSyncRequest
|
|
8182
|
+
*/
|
|
8183
|
+
'store_id'?: number;
|
|
8184
|
+
}
|
|
8185
|
+
/**
|
|
8186
|
+
* Response containing sync operation results and statistics
|
|
8187
|
+
* @export
|
|
8188
|
+
* @interface DataTypesAnalyticsRuleSyncResponse
|
|
8189
|
+
*/
|
|
8190
|
+
export interface DataTypesAnalyticsRuleSyncResponse {
|
|
8191
|
+
/**
|
|
8192
|
+
*
|
|
8193
|
+
* @type {Array<string>}
|
|
8194
|
+
* @memberof DataTypesAnalyticsRuleSyncResponse
|
|
8195
|
+
*/
|
|
8196
|
+
'failed_rules'?: Array<string>;
|
|
8197
|
+
/**
|
|
8198
|
+
*
|
|
8199
|
+
* @type {string}
|
|
8200
|
+
* @memberof DataTypesAnalyticsRuleSyncResponse
|
|
8201
|
+
*/
|
|
8202
|
+
'sync_timestamp'?: string;
|
|
8203
|
+
/**
|
|
8204
|
+
*
|
|
8205
|
+
* @type {Array<string>}
|
|
8206
|
+
* @memberof DataTypesAnalyticsRuleSyncResponse
|
|
8207
|
+
*/
|
|
8208
|
+
'synced_rules'?: Array<string>;
|
|
8209
|
+
/**
|
|
8210
|
+
*
|
|
8211
|
+
* @type {number}
|
|
8212
|
+
* @memberof DataTypesAnalyticsRuleSyncResponse
|
|
8213
|
+
*/
|
|
8214
|
+
'total_failed'?: number;
|
|
8215
|
+
/**
|
|
8216
|
+
*
|
|
8217
|
+
* @type {number}
|
|
8218
|
+
* @memberof DataTypesAnalyticsRuleSyncResponse
|
|
8219
|
+
*/
|
|
8220
|
+
'total_synced'?: number;
|
|
8221
|
+
}
|
|
8222
|
+
/**
|
|
8223
|
+
*
|
|
8224
|
+
* @export
|
|
8225
|
+
* @interface DataTypesAnalyticsRuleValidationError
|
|
8226
|
+
*/
|
|
8227
|
+
export interface DataTypesAnalyticsRuleValidationError {
|
|
8228
|
+
/**
|
|
8229
|
+
*
|
|
8230
|
+
* @type {string}
|
|
8231
|
+
* @memberof DataTypesAnalyticsRuleValidationError
|
|
8232
|
+
*/
|
|
8233
|
+
'field'?: string;
|
|
8234
|
+
/**
|
|
8235
|
+
*
|
|
8236
|
+
* @type {string}
|
|
8237
|
+
* @memberof DataTypesAnalyticsRuleValidationError
|
|
8238
|
+
*/
|
|
8239
|
+
'message'?: string;
|
|
8240
|
+
}
|
|
8007
8241
|
/**
|
|
8008
8242
|
*
|
|
8009
8243
|
* @export
|
|
@@ -8409,6 +8643,67 @@ export interface DataTypesConsumptionSummary {
|
|
|
8409
8643
|
*/
|
|
8410
8644
|
'unique_endpoints'?: number;
|
|
8411
8645
|
}
|
|
8646
|
+
/**
|
|
8647
|
+
* Request payload for creating a new analytics rule
|
|
8648
|
+
* @export
|
|
8649
|
+
* @interface DataTypesCreateAnalyticsRuleRequest
|
|
8650
|
+
*/
|
|
8651
|
+
export interface DataTypesCreateAnalyticsRuleRequest {
|
|
8652
|
+
/**
|
|
8653
|
+
*
|
|
8654
|
+
* @type {string}
|
|
8655
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8656
|
+
*/
|
|
8657
|
+
'description'?: string;
|
|
8658
|
+
/**
|
|
8659
|
+
*
|
|
8660
|
+
* @type {number}
|
|
8661
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8662
|
+
*/
|
|
8663
|
+
'effective_from_ts'?: number;
|
|
8664
|
+
/**
|
|
8665
|
+
*
|
|
8666
|
+
* @type {number}
|
|
8667
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8668
|
+
*/
|
|
8669
|
+
'effective_to_ts'?: number;
|
|
8670
|
+
/**
|
|
8671
|
+
*
|
|
8672
|
+
* @type {boolean}
|
|
8673
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8674
|
+
*/
|
|
8675
|
+
'is_active'?: boolean;
|
|
8676
|
+
/**
|
|
8677
|
+
*
|
|
8678
|
+
* @type {string}
|
|
8679
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8680
|
+
*/
|
|
8681
|
+
'name': string;
|
|
8682
|
+
/**
|
|
8683
|
+
*
|
|
8684
|
+
* @type {DataTypesOverrideActions}
|
|
8685
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8686
|
+
*/
|
|
8687
|
+
'override_actions'?: DataTypesOverrideActions;
|
|
8688
|
+
/**
|
|
8689
|
+
*
|
|
8690
|
+
* @type {DataTypesRuleConfig}
|
|
8691
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8692
|
+
*/
|
|
8693
|
+
'rule_config': DataTypesRuleConfig;
|
|
8694
|
+
/**
|
|
8695
|
+
*
|
|
8696
|
+
* @type {string}
|
|
8697
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8698
|
+
*/
|
|
8699
|
+
'rule_id': string;
|
|
8700
|
+
/**
|
|
8701
|
+
*
|
|
8702
|
+
* @type {number}
|
|
8703
|
+
* @memberof DataTypesCreateAnalyticsRuleRequest
|
|
8704
|
+
*/
|
|
8705
|
+
'store_id'?: number;
|
|
8706
|
+
}
|
|
8412
8707
|
/**
|
|
8413
8708
|
*
|
|
8414
8709
|
* @export
|
|
@@ -9424,6 +9719,37 @@ export interface DataTypesCreateUserResponseWrapper {
|
|
|
9424
9719
|
*/
|
|
9425
9720
|
'status'?: number;
|
|
9426
9721
|
}
|
|
9722
|
+
/**
|
|
9723
|
+
*
|
|
9724
|
+
* @export
|
|
9725
|
+
* @interface DataTypesCreditAdjustmentDetailsDto
|
|
9726
|
+
*/
|
|
9727
|
+
export interface DataTypesCreditAdjustmentDetailsDto {
|
|
9728
|
+
/**
|
|
9729
|
+
*
|
|
9730
|
+
* @type {string}
|
|
9731
|
+
* @memberof DataTypesCreditAdjustmentDetailsDto
|
|
9732
|
+
*/
|
|
9733
|
+
'adjustment_reason'?: string;
|
|
9734
|
+
/**
|
|
9735
|
+
*
|
|
9736
|
+
* @type {number}
|
|
9737
|
+
* @memberof DataTypesCreditAdjustmentDetailsDto
|
|
9738
|
+
*/
|
|
9739
|
+
'credits_to_remove'?: number;
|
|
9740
|
+
/**
|
|
9741
|
+
*
|
|
9742
|
+
* @type {string}
|
|
9743
|
+
* @memberof DataTypesCreditAdjustmentDetailsDto
|
|
9744
|
+
*/
|
|
9745
|
+
'expiry_date'?: string;
|
|
9746
|
+
/**
|
|
9747
|
+
*
|
|
9748
|
+
* @type {number}
|
|
9749
|
+
* @memberof DataTypesCreditAdjustmentDetailsDto
|
|
9750
|
+
*/
|
|
9751
|
+
'ledger_id'?: number;
|
|
9752
|
+
}
|
|
9427
9753
|
/**
|
|
9428
9754
|
*
|
|
9429
9755
|
* @export
|
|
@@ -9637,6 +9963,49 @@ export interface DataTypesCreditBalance {
|
|
|
9637
9963
|
*/
|
|
9638
9964
|
'store_id'?: number;
|
|
9639
9965
|
}
|
|
9966
|
+
/**
|
|
9967
|
+
*
|
|
9968
|
+
* @export
|
|
9969
|
+
* @interface DataTypesCreditBatchDetailsDto
|
|
9970
|
+
*/
|
|
9971
|
+
export interface DataTypesCreditBatchDetailsDto {
|
|
9972
|
+
/**
|
|
9973
|
+
*
|
|
9974
|
+
* @type {number}
|
|
9975
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
9976
|
+
*/
|
|
9977
|
+
'days_to_expiry'?: number;
|
|
9978
|
+
/**
|
|
9979
|
+
*
|
|
9980
|
+
* @type {string}
|
|
9981
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
9982
|
+
*/
|
|
9983
|
+
'expiry_date'?: string;
|
|
9984
|
+
/**
|
|
9985
|
+
*
|
|
9986
|
+
* @type {boolean}
|
|
9987
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
9988
|
+
*/
|
|
9989
|
+
'is_expired'?: boolean;
|
|
9990
|
+
/**
|
|
9991
|
+
*
|
|
9992
|
+
* @type {number}
|
|
9993
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
9994
|
+
*/
|
|
9995
|
+
'ledger_id'?: number;
|
|
9996
|
+
/**
|
|
9997
|
+
*
|
|
9998
|
+
* @type {number}
|
|
9999
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
10000
|
+
*/
|
|
10001
|
+
'original_amount'?: number;
|
|
10002
|
+
/**
|
|
10003
|
+
*
|
|
10004
|
+
* @type {number}
|
|
10005
|
+
* @memberof DataTypesCreditBatchDetailsDto
|
|
10006
|
+
*/
|
|
10007
|
+
'remaining_credits'?: number;
|
|
10008
|
+
}
|
|
9640
10009
|
/**
|
|
9641
10010
|
*
|
|
9642
10011
|
* @export
|
|
@@ -10396,6 +10765,25 @@ export interface DataTypesDocumentListResponseWrapper {
|
|
|
10396
10765
|
*/
|
|
10397
10766
|
'status'?: number;
|
|
10398
10767
|
}
|
|
10768
|
+
/**
|
|
10769
|
+
*
|
|
10770
|
+
* @export
|
|
10771
|
+
* @interface DataTypesDocumentPosition
|
|
10772
|
+
*/
|
|
10773
|
+
export interface DataTypesDocumentPosition {
|
|
10774
|
+
/**
|
|
10775
|
+
*
|
|
10776
|
+
* @type {string}
|
|
10777
|
+
* @memberof DataTypesDocumentPosition
|
|
10778
|
+
*/
|
|
10779
|
+
'id'?: string;
|
|
10780
|
+
/**
|
|
10781
|
+
*
|
|
10782
|
+
* @type {number}
|
|
10783
|
+
* @memberof DataTypesDocumentPosition
|
|
10784
|
+
*/
|
|
10785
|
+
'position'?: number;
|
|
10786
|
+
}
|
|
10399
10787
|
/**
|
|
10400
10788
|
*
|
|
10401
10789
|
* @export
|
|
@@ -10690,6 +11078,31 @@ export interface DataTypesEventPayload {
|
|
|
10690
11078
|
*/
|
|
10691
11079
|
'value'?: number;
|
|
10692
11080
|
}
|
|
11081
|
+
/**
|
|
11082
|
+
*
|
|
11083
|
+
* @export
|
|
11084
|
+
* @interface DataTypesExpirationWarningDto
|
|
11085
|
+
*/
|
|
11086
|
+
export interface DataTypesExpirationWarningDto {
|
|
11087
|
+
/**
|
|
11088
|
+
*
|
|
11089
|
+
* @type {number}
|
|
11090
|
+
* @memberof DataTypesExpirationWarningDto
|
|
11091
|
+
*/
|
|
11092
|
+
'credits_expiring_in_30_days'?: number;
|
|
11093
|
+
/**
|
|
11094
|
+
*
|
|
11095
|
+
* @type {number}
|
|
11096
|
+
* @memberof DataTypesExpirationWarningDto
|
|
11097
|
+
*/
|
|
11098
|
+
'credits_expiring_in_7_days'?: number;
|
|
11099
|
+
/**
|
|
11100
|
+
*
|
|
11101
|
+
* @type {string}
|
|
11102
|
+
* @memberof DataTypesExpirationWarningDto
|
|
11103
|
+
*/
|
|
11104
|
+
'recommended_action'?: string;
|
|
11105
|
+
}
|
|
10693
11106
|
/**
|
|
10694
11107
|
*
|
|
10695
11108
|
* @export
|
|
@@ -11301,6 +11714,31 @@ export interface DataTypesGenericResponseDataTypesDetailedCreditBalanceResponse
|
|
|
11301
11714
|
*/
|
|
11302
11715
|
'status'?: number;
|
|
11303
11716
|
}
|
|
11717
|
+
/**
|
|
11718
|
+
*
|
|
11719
|
+
* @export
|
|
11720
|
+
* @interface DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto
|
|
11721
|
+
*/
|
|
11722
|
+
export interface DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto {
|
|
11723
|
+
/**
|
|
11724
|
+
*
|
|
11725
|
+
* @type {DataTypesGetRefundHistoryResponseDto}
|
|
11726
|
+
* @memberof DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto
|
|
11727
|
+
*/
|
|
11728
|
+
'data'?: DataTypesGetRefundHistoryResponseDto;
|
|
11729
|
+
/**
|
|
11730
|
+
*
|
|
11731
|
+
* @type {string}
|
|
11732
|
+
* @memberof DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto
|
|
11733
|
+
*/
|
|
11734
|
+
'message'?: string;
|
|
11735
|
+
/**
|
|
11736
|
+
*
|
|
11737
|
+
* @type {number}
|
|
11738
|
+
* @memberof DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto
|
|
11739
|
+
*/
|
|
11740
|
+
'status'?: number;
|
|
11741
|
+
}
|
|
11304
11742
|
/**
|
|
11305
11743
|
*
|
|
11306
11744
|
* @export
|
|
@@ -11326,6 +11764,31 @@ export interface DataTypesGenericResponseDataTypesPaginatedTransactionsResponse
|
|
|
11326
11764
|
*/
|
|
11327
11765
|
'status'?: number;
|
|
11328
11766
|
}
|
|
11767
|
+
/**
|
|
11768
|
+
*
|
|
11769
|
+
* @export
|
|
11770
|
+
* @interface DataTypesGenericResponseDataTypesProcessRefundResponseDto
|
|
11771
|
+
*/
|
|
11772
|
+
export interface DataTypesGenericResponseDataTypesProcessRefundResponseDto {
|
|
11773
|
+
/**
|
|
11774
|
+
*
|
|
11775
|
+
* @type {DataTypesProcessRefundResponseDto}
|
|
11776
|
+
* @memberof DataTypesGenericResponseDataTypesProcessRefundResponseDto
|
|
11777
|
+
*/
|
|
11778
|
+
'data'?: DataTypesProcessRefundResponseDto;
|
|
11779
|
+
/**
|
|
11780
|
+
*
|
|
11781
|
+
* @type {string}
|
|
11782
|
+
* @memberof DataTypesGenericResponseDataTypesProcessRefundResponseDto
|
|
11783
|
+
*/
|
|
11784
|
+
'message'?: string;
|
|
11785
|
+
/**
|
|
11786
|
+
*
|
|
11787
|
+
* @type {number}
|
|
11788
|
+
* @memberof DataTypesGenericResponseDataTypesProcessRefundResponseDto
|
|
11789
|
+
*/
|
|
11790
|
+
'status'?: number;
|
|
11791
|
+
}
|
|
11329
11792
|
/**
|
|
11330
11793
|
*
|
|
11331
11794
|
* @export
|
|
@@ -11351,6 +11814,56 @@ export interface DataTypesGenericResponseDataTypesPurchaseCreditsResponse {
|
|
|
11351
11814
|
*/
|
|
11352
11815
|
'status'?: number;
|
|
11353
11816
|
}
|
|
11817
|
+
/**
|
|
11818
|
+
*
|
|
11819
|
+
* @export
|
|
11820
|
+
* @interface DataTypesGenericResponseDataTypesRefundCalculationResponseDto
|
|
11821
|
+
*/
|
|
11822
|
+
export interface DataTypesGenericResponseDataTypesRefundCalculationResponseDto {
|
|
11823
|
+
/**
|
|
11824
|
+
*
|
|
11825
|
+
* @type {DataTypesRefundCalculationResponseDto}
|
|
11826
|
+
* @memberof DataTypesGenericResponseDataTypesRefundCalculationResponseDto
|
|
11827
|
+
*/
|
|
11828
|
+
'data'?: DataTypesRefundCalculationResponseDto;
|
|
11829
|
+
/**
|
|
11830
|
+
*
|
|
11831
|
+
* @type {string}
|
|
11832
|
+
* @memberof DataTypesGenericResponseDataTypesRefundCalculationResponseDto
|
|
11833
|
+
*/
|
|
11834
|
+
'message'?: string;
|
|
11835
|
+
/**
|
|
11836
|
+
*
|
|
11837
|
+
* @type {number}
|
|
11838
|
+
* @memberof DataTypesGenericResponseDataTypesRefundCalculationResponseDto
|
|
11839
|
+
*/
|
|
11840
|
+
'status'?: number;
|
|
11841
|
+
}
|
|
11842
|
+
/**
|
|
11843
|
+
*
|
|
11844
|
+
* @export
|
|
11845
|
+
* @interface DataTypesGenericResponseDataTypesRefundEligibilityDto
|
|
11846
|
+
*/
|
|
11847
|
+
export interface DataTypesGenericResponseDataTypesRefundEligibilityDto {
|
|
11848
|
+
/**
|
|
11849
|
+
*
|
|
11850
|
+
* @type {DataTypesRefundEligibilityDto}
|
|
11851
|
+
* @memberof DataTypesGenericResponseDataTypesRefundEligibilityDto
|
|
11852
|
+
*/
|
|
11853
|
+
'data'?: DataTypesRefundEligibilityDto;
|
|
11854
|
+
/**
|
|
11855
|
+
*
|
|
11856
|
+
* @type {string}
|
|
11857
|
+
* @memberof DataTypesGenericResponseDataTypesRefundEligibilityDto
|
|
11858
|
+
*/
|
|
11859
|
+
'message'?: string;
|
|
11860
|
+
/**
|
|
11861
|
+
*
|
|
11862
|
+
* @type {number}
|
|
11863
|
+
* @memberof DataTypesGenericResponseDataTypesRefundEligibilityDto
|
|
11864
|
+
*/
|
|
11865
|
+
'status'?: number;
|
|
11866
|
+
}
|
|
11354
11867
|
/**
|
|
11355
11868
|
*
|
|
11356
11869
|
* @export
|
|
@@ -11376,6 +11889,31 @@ export interface DataTypesGenericResponseDataTypesRegenerateXStoreSecretResponse
|
|
|
11376
11889
|
*/
|
|
11377
11890
|
'status'?: number;
|
|
11378
11891
|
}
|
|
11892
|
+
/**
|
|
11893
|
+
*
|
|
11894
|
+
* @export
|
|
11895
|
+
* @interface DataTypesGenericResponseRefundRefundPreviewResponseDto
|
|
11896
|
+
*/
|
|
11897
|
+
export interface DataTypesGenericResponseRefundRefundPreviewResponseDto {
|
|
11898
|
+
/**
|
|
11899
|
+
*
|
|
11900
|
+
* @type {RefundRefundPreviewResponseDto}
|
|
11901
|
+
* @memberof DataTypesGenericResponseRefundRefundPreviewResponseDto
|
|
11902
|
+
*/
|
|
11903
|
+
'data'?: RefundRefundPreviewResponseDto;
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @type {string}
|
|
11907
|
+
* @memberof DataTypesGenericResponseRefundRefundPreviewResponseDto
|
|
11908
|
+
*/
|
|
11909
|
+
'message'?: string;
|
|
11910
|
+
/**
|
|
11911
|
+
*
|
|
11912
|
+
* @type {number}
|
|
11913
|
+
* @memberof DataTypesGenericResponseRefundRefundPreviewResponseDto
|
|
11914
|
+
*/
|
|
11915
|
+
'status'?: number;
|
|
11916
|
+
}
|
|
11379
11917
|
/**
|
|
11380
11918
|
*
|
|
11381
11919
|
* @export
|
|
@@ -11401,6 +11939,37 @@ export interface DataTypesGenericStringArrayResponse {
|
|
|
11401
11939
|
*/
|
|
11402
11940
|
'status'?: number;
|
|
11403
11941
|
}
|
|
11942
|
+
/**
|
|
11943
|
+
*
|
|
11944
|
+
* @export
|
|
11945
|
+
* @interface DataTypesGetRefundHistoryResponseDto
|
|
11946
|
+
*/
|
|
11947
|
+
export interface DataTypesGetRefundHistoryResponseDto {
|
|
11948
|
+
/**
|
|
11949
|
+
*
|
|
11950
|
+
* @type {boolean}
|
|
11951
|
+
* @memberof DataTypesGetRefundHistoryResponseDto
|
|
11952
|
+
*/
|
|
11953
|
+
'has_more'?: boolean;
|
|
11954
|
+
/**
|
|
11955
|
+
*
|
|
11956
|
+
* @type {number}
|
|
11957
|
+
* @memberof DataTypesGetRefundHistoryResponseDto
|
|
11958
|
+
*/
|
|
11959
|
+
'next_offset'?: number;
|
|
11960
|
+
/**
|
|
11961
|
+
*
|
|
11962
|
+
* @type {Array<DataTypesRefundHistoryDto>}
|
|
11963
|
+
* @memberof DataTypesGetRefundHistoryResponseDto
|
|
11964
|
+
*/
|
|
11965
|
+
'refunds'?: Array<DataTypesRefundHistoryDto>;
|
|
11966
|
+
/**
|
|
11967
|
+
*
|
|
11968
|
+
* @type {number}
|
|
11969
|
+
* @memberof DataTypesGetRefundHistoryResponseDto
|
|
11970
|
+
*/
|
|
11971
|
+
'total_count'?: number;
|
|
11972
|
+
}
|
|
11404
11973
|
/**
|
|
11405
11974
|
*
|
|
11406
11975
|
* @export
|
|
@@ -13408,6 +13977,140 @@ export interface DataTypesOrganizationsListResponse {
|
|
|
13408
13977
|
*/
|
|
13409
13978
|
'status'?: number;
|
|
13410
13979
|
}
|
|
13980
|
+
/**
|
|
13981
|
+
*
|
|
13982
|
+
* @export
|
|
13983
|
+
* @interface DataTypesOriginalPurchaseDetailsDto
|
|
13984
|
+
*/
|
|
13985
|
+
export interface DataTypesOriginalPurchaseDetailsDto {
|
|
13986
|
+
/**
|
|
13987
|
+
*
|
|
13988
|
+
* @type {number}
|
|
13989
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
13990
|
+
*/
|
|
13991
|
+
'amount_paid'?: number;
|
|
13992
|
+
/**
|
|
13993
|
+
*
|
|
13994
|
+
* @type {number}
|
|
13995
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
13996
|
+
*/
|
|
13997
|
+
'credits_bonus'?: number;
|
|
13998
|
+
/**
|
|
13999
|
+
*
|
|
14000
|
+
* @type {number}
|
|
14001
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14002
|
+
*/
|
|
14003
|
+
'credits_purchased'?: number;
|
|
14004
|
+
/**
|
|
14005
|
+
*
|
|
14006
|
+
* @type {string}
|
|
14007
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14008
|
+
*/
|
|
14009
|
+
'currency'?: string;
|
|
14010
|
+
/**
|
|
14011
|
+
*
|
|
14012
|
+
* @type {string}
|
|
14013
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14014
|
+
*/
|
|
14015
|
+
'expiry_date'?: string;
|
|
14016
|
+
/**
|
|
14017
|
+
*
|
|
14018
|
+
* @type {number}
|
|
14019
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14020
|
+
*/
|
|
14021
|
+
'plan_id'?: number;
|
|
14022
|
+
/**
|
|
14023
|
+
*
|
|
14024
|
+
* @type {string}
|
|
14025
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14026
|
+
*/
|
|
14027
|
+
'plan_name'?: string;
|
|
14028
|
+
/**
|
|
14029
|
+
*
|
|
14030
|
+
* @type {number}
|
|
14031
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14032
|
+
*/
|
|
14033
|
+
'price_per_credit'?: number;
|
|
14034
|
+
/**
|
|
14035
|
+
*
|
|
14036
|
+
* @type {string}
|
|
14037
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14038
|
+
*/
|
|
14039
|
+
'purchase_date'?: string;
|
|
14040
|
+
/**
|
|
14041
|
+
*
|
|
14042
|
+
* @type {number}
|
|
14043
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14044
|
+
*/
|
|
14045
|
+
'total_credits'?: number;
|
|
14046
|
+
/**
|
|
14047
|
+
*
|
|
14048
|
+
* @type {number}
|
|
14049
|
+
* @memberof DataTypesOriginalPurchaseDetailsDto
|
|
14050
|
+
*/
|
|
14051
|
+
'validity_days'?: number;
|
|
14052
|
+
}
|
|
14053
|
+
/**
|
|
14054
|
+
* Defines what happens when a rule is triggered (promote/hide documents, apply filters, etc.)
|
|
14055
|
+
* @export
|
|
14056
|
+
* @interface DataTypesOverrideActions
|
|
14057
|
+
*/
|
|
14058
|
+
export interface DataTypesOverrideActions {
|
|
14059
|
+
/**
|
|
14060
|
+
* Dynamic filtering and sorting
|
|
14061
|
+
* @type {string}
|
|
14062
|
+
* @memberof DataTypesOverrideActions
|
|
14063
|
+
*/
|
|
14064
|
+
'filter'?: string;
|
|
14065
|
+
/**
|
|
14066
|
+
*
|
|
14067
|
+
* @type {boolean}
|
|
14068
|
+
* @memberof DataTypesOverrideActions
|
|
14069
|
+
*/
|
|
14070
|
+
'filter_curated_hits'?: boolean;
|
|
14071
|
+
/**
|
|
14072
|
+
*
|
|
14073
|
+
* @type {Array<string>}
|
|
14074
|
+
* @memberof DataTypesOverrideActions
|
|
14075
|
+
*/
|
|
14076
|
+
'hide'?: Array<string>;
|
|
14077
|
+
/**
|
|
14078
|
+
* Metadata to return when rule is triggered
|
|
14079
|
+
* @type {{ [key: string]: any; }}
|
|
14080
|
+
* @memberof DataTypesOverrideActions
|
|
14081
|
+
*/
|
|
14082
|
+
'metadata'?: { [key: string]: any; };
|
|
14083
|
+
/**
|
|
14084
|
+
* Document inclusion/exclusion
|
|
14085
|
+
* @type {Array<DataTypesDocumentPosition>}
|
|
14086
|
+
* @memberof DataTypesOverrideActions
|
|
14087
|
+
*/
|
|
14088
|
+
'promote'?: Array<DataTypesDocumentPosition>;
|
|
14089
|
+
/**
|
|
14090
|
+
* Additional options
|
|
14091
|
+
* @type {boolean}
|
|
14092
|
+
* @memberof DataTypesOverrideActions
|
|
14093
|
+
*/
|
|
14094
|
+
'remove_matched_tokens'?: boolean;
|
|
14095
|
+
/**
|
|
14096
|
+
* Query replacement
|
|
14097
|
+
* @type {string}
|
|
14098
|
+
* @memberof DataTypesOverrideActions
|
|
14099
|
+
*/
|
|
14100
|
+
'replace_query'?: string;
|
|
14101
|
+
/**
|
|
14102
|
+
*
|
|
14103
|
+
* @type {string}
|
|
14104
|
+
* @memberof DataTypesOverrideActions
|
|
14105
|
+
*/
|
|
14106
|
+
'sort'?: string;
|
|
14107
|
+
/**
|
|
14108
|
+
*
|
|
14109
|
+
* @type {boolean}
|
|
14110
|
+
* @memberof DataTypesOverrideActions
|
|
14111
|
+
*/
|
|
14112
|
+
'stop_processing'?: boolean;
|
|
14113
|
+
}
|
|
13411
14114
|
/**
|
|
13412
14115
|
*
|
|
13413
14116
|
* @export
|
|
@@ -14049,6 +14752,143 @@ export interface DataTypesPluralDeclensionsResponseWrapper {
|
|
|
14049
14752
|
*/
|
|
14050
14753
|
'status'?: number;
|
|
14051
14754
|
}
|
|
14755
|
+
/**
|
|
14756
|
+
*
|
|
14757
|
+
* @export
|
|
14758
|
+
* @interface DataTypesProcessRefundRequestDto
|
|
14759
|
+
*/
|
|
14760
|
+
export interface DataTypesProcessRefundRequestDto {
|
|
14761
|
+
/**
|
|
14762
|
+
*
|
|
14763
|
+
* @type {string}
|
|
14764
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14765
|
+
*/
|
|
14766
|
+
'currency': string;
|
|
14767
|
+
/**
|
|
14768
|
+
* External gateway refund ID
|
|
14769
|
+
* @type {string}
|
|
14770
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14771
|
+
*/
|
|
14772
|
+
'gateway_refund_id'?: string;
|
|
14773
|
+
/**
|
|
14774
|
+
*
|
|
14775
|
+
* @type {number}
|
|
14776
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14777
|
+
*/
|
|
14778
|
+
'org_id': number;
|
|
14779
|
+
/**
|
|
14780
|
+
*
|
|
14781
|
+
* @type {number}
|
|
14782
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14783
|
+
*/
|
|
14784
|
+
'payment_id': number;
|
|
14785
|
+
/**
|
|
14786
|
+
* Whether to process credit adjustments
|
|
14787
|
+
* @type {boolean}
|
|
14788
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14789
|
+
*/
|
|
14790
|
+
'process_credit_adjustment'?: boolean;
|
|
14791
|
+
/**
|
|
14792
|
+
*
|
|
14793
|
+
* @type {string}
|
|
14794
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14795
|
+
*/
|
|
14796
|
+
'reason': string;
|
|
14797
|
+
/**
|
|
14798
|
+
*
|
|
14799
|
+
* @type {number}
|
|
14800
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14801
|
+
*/
|
|
14802
|
+
'refund_amount': number;
|
|
14803
|
+
/**
|
|
14804
|
+
*
|
|
14805
|
+
* @type {string}
|
|
14806
|
+
* @memberof DataTypesProcessRefundRequestDto
|
|
14807
|
+
*/
|
|
14808
|
+
'refund_type': DataTypesProcessRefundRequestDtoRefundTypeEnum;
|
|
14809
|
+
}
|
|
14810
|
+
|
|
14811
|
+
export const DataTypesProcessRefundRequestDtoRefundTypeEnum = {
|
|
14812
|
+
Full: 'full',
|
|
14813
|
+
Partial: 'partial',
|
|
14814
|
+
RemainingCredits: 'remaining_credits'
|
|
14815
|
+
} as const;
|
|
14816
|
+
|
|
14817
|
+
export type DataTypesProcessRefundRequestDtoRefundTypeEnum = typeof DataTypesProcessRefundRequestDtoRefundTypeEnum[keyof typeof DataTypesProcessRefundRequestDtoRefundTypeEnum];
|
|
14818
|
+
|
|
14819
|
+
/**
|
|
14820
|
+
*
|
|
14821
|
+
* @export
|
|
14822
|
+
* @interface DataTypesProcessRefundResponseDto
|
|
14823
|
+
*/
|
|
14824
|
+
export interface DataTypesProcessRefundResponseDto {
|
|
14825
|
+
/**
|
|
14826
|
+
*
|
|
14827
|
+
* @type {Array<DataTypesCreditAdjustmentDetailsDto>}
|
|
14828
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14829
|
+
*/
|
|
14830
|
+
'credit_adjustments'?: Array<DataTypesCreditAdjustmentDetailsDto>;
|
|
14831
|
+
/**
|
|
14832
|
+
*
|
|
14833
|
+
* @type {string}
|
|
14834
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14835
|
+
*/
|
|
14836
|
+
'currency'?: string;
|
|
14837
|
+
/**
|
|
14838
|
+
*
|
|
14839
|
+
* @type {string}
|
|
14840
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14841
|
+
*/
|
|
14842
|
+
'gateway_refund_id'?: string;
|
|
14843
|
+
/**
|
|
14844
|
+
*
|
|
14845
|
+
* @type {number}
|
|
14846
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14847
|
+
*/
|
|
14848
|
+
'org_id'?: number;
|
|
14849
|
+
/**
|
|
14850
|
+
*
|
|
14851
|
+
* @type {number}
|
|
14852
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14853
|
+
*/
|
|
14854
|
+
'payment_id'?: number;
|
|
14855
|
+
/**
|
|
14856
|
+
*
|
|
14857
|
+
* @type {string}
|
|
14858
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14859
|
+
*/
|
|
14860
|
+
'processed_at'?: string;
|
|
14861
|
+
/**
|
|
14862
|
+
*
|
|
14863
|
+
* @type {number}
|
|
14864
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14865
|
+
*/
|
|
14866
|
+
'refund_amount'?: number;
|
|
14867
|
+
/**
|
|
14868
|
+
*
|
|
14869
|
+
* @type {number}
|
|
14870
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14871
|
+
*/
|
|
14872
|
+
'refund_id'?: number;
|
|
14873
|
+
/**
|
|
14874
|
+
*
|
|
14875
|
+
* @type {string}
|
|
14876
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14877
|
+
*/
|
|
14878
|
+
'refund_reference'?: string;
|
|
14879
|
+
/**
|
|
14880
|
+
*
|
|
14881
|
+
* @type {string}
|
|
14882
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14883
|
+
*/
|
|
14884
|
+
'refund_type'?: string;
|
|
14885
|
+
/**
|
|
14886
|
+
*
|
|
14887
|
+
* @type {string}
|
|
14888
|
+
* @memberof DataTypesProcessRefundResponseDto
|
|
14889
|
+
*/
|
|
14890
|
+
'status'?: string;
|
|
14891
|
+
}
|
|
14052
14892
|
/**
|
|
14053
14893
|
*
|
|
14054
14894
|
* @export
|
|
@@ -14388,6 +15228,368 @@ export const DataTypesRefundApprovalDtoActionEnum = {
|
|
|
14388
15228
|
|
|
14389
15229
|
export type DataTypesRefundApprovalDtoActionEnum = typeof DataTypesRefundApprovalDtoActionEnum[keyof typeof DataTypesRefundApprovalDtoActionEnum];
|
|
14390
15230
|
|
|
15231
|
+
/**
|
|
15232
|
+
*
|
|
15233
|
+
* @export
|
|
15234
|
+
* @interface DataTypesRefundCalculationDetailsDto
|
|
15235
|
+
*/
|
|
15236
|
+
export interface DataTypesRefundCalculationDetailsDto {
|
|
15237
|
+
/**
|
|
15238
|
+
*
|
|
15239
|
+
* @type {number}
|
|
15240
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15241
|
+
*/
|
|
15242
|
+
'base_refund_amount'?: number;
|
|
15243
|
+
/**
|
|
15244
|
+
*
|
|
15245
|
+
* @type {string}
|
|
15246
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15247
|
+
*/
|
|
15248
|
+
'bonus_credit_policy'?: string;
|
|
15249
|
+
/**
|
|
15250
|
+
*
|
|
15251
|
+
* @type {number}
|
|
15252
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15253
|
+
*/
|
|
15254
|
+
'bonus_credit_refund'?: number;
|
|
15255
|
+
/**
|
|
15256
|
+
*
|
|
15257
|
+
* @type {string}
|
|
15258
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15259
|
+
*/
|
|
15260
|
+
'calculation_method'?: string;
|
|
15261
|
+
/**
|
|
15262
|
+
*
|
|
15263
|
+
* @type {number}
|
|
15264
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15265
|
+
*/
|
|
15266
|
+
'credits_already_used'?: number;
|
|
15267
|
+
/**
|
|
15268
|
+
*
|
|
15269
|
+
* @type {number}
|
|
15270
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15271
|
+
*/
|
|
15272
|
+
'credits_to_refund'?: number;
|
|
15273
|
+
/**
|
|
15274
|
+
*
|
|
15275
|
+
* @type {number}
|
|
15276
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15277
|
+
*/
|
|
15278
|
+
'price_per_credit_used'?: number;
|
|
15279
|
+
/**
|
|
15280
|
+
*
|
|
15281
|
+
* @type {number}
|
|
15282
|
+
* @memberof DataTypesRefundCalculationDetailsDto
|
|
15283
|
+
*/
|
|
15284
|
+
'refundable_percentage'?: number;
|
|
15285
|
+
}
|
|
15286
|
+
/**
|
|
15287
|
+
*
|
|
15288
|
+
* @export
|
|
15289
|
+
* @interface DataTypesRefundCalculationRequestDto
|
|
15290
|
+
*/
|
|
15291
|
+
export interface DataTypesRefundCalculationRequestDto {
|
|
15292
|
+
/**
|
|
15293
|
+
* For partial refunds
|
|
15294
|
+
* @type {number}
|
|
15295
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15296
|
+
*/
|
|
15297
|
+
'amount'?: number;
|
|
15298
|
+
/**
|
|
15299
|
+
* For credit-based refunds
|
|
15300
|
+
* @type {number}
|
|
15301
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15302
|
+
*/
|
|
15303
|
+
'credit_amount'?: number;
|
|
15304
|
+
/**
|
|
15305
|
+
*
|
|
15306
|
+
* @type {string}
|
|
15307
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15308
|
+
*/
|
|
15309
|
+
'currency': string;
|
|
15310
|
+
/**
|
|
15311
|
+
*
|
|
15312
|
+
* @type {number}
|
|
15313
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15314
|
+
*/
|
|
15315
|
+
'org_id': number;
|
|
15316
|
+
/**
|
|
15317
|
+
*
|
|
15318
|
+
* @type {number}
|
|
15319
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15320
|
+
*/
|
|
15321
|
+
'payment_id': number;
|
|
15322
|
+
/**
|
|
15323
|
+
* Optional reason for refund
|
|
15324
|
+
* @type {string}
|
|
15325
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15326
|
+
*/
|
|
15327
|
+
'reason'?: string;
|
|
15328
|
+
/**
|
|
15329
|
+
*
|
|
15330
|
+
* @type {string}
|
|
15331
|
+
* @memberof DataTypesRefundCalculationRequestDto
|
|
15332
|
+
*/
|
|
15333
|
+
'refund_type': DataTypesRefundCalculationRequestDtoRefundTypeEnum;
|
|
15334
|
+
}
|
|
15335
|
+
|
|
15336
|
+
export const DataTypesRefundCalculationRequestDtoRefundTypeEnum = {
|
|
15337
|
+
Full: 'full',
|
|
15338
|
+
Partial: 'partial',
|
|
15339
|
+
RemainingCredits: 'remaining_credits'
|
|
15340
|
+
} as const;
|
|
15341
|
+
|
|
15342
|
+
export type DataTypesRefundCalculationRequestDtoRefundTypeEnum = typeof DataTypesRefundCalculationRequestDtoRefundTypeEnum[keyof typeof DataTypesRefundCalculationRequestDtoRefundTypeEnum];
|
|
15343
|
+
|
|
15344
|
+
/**
|
|
15345
|
+
*
|
|
15346
|
+
* @export
|
|
15347
|
+
* @interface DataTypesRefundCalculationResponseDto
|
|
15348
|
+
*/
|
|
15349
|
+
export interface DataTypesRefundCalculationResponseDto {
|
|
15350
|
+
/**
|
|
15351
|
+
*
|
|
15352
|
+
* @type {string}
|
|
15353
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15354
|
+
*/
|
|
15355
|
+
'calculated_at'?: string;
|
|
15356
|
+
/**
|
|
15357
|
+
*
|
|
15358
|
+
* @type {Array<DataTypesCreditAdjustmentDetailsDto>}
|
|
15359
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15360
|
+
*/
|
|
15361
|
+
'credit_adjustments'?: Array<DataTypesCreditAdjustmentDetailsDto>;
|
|
15362
|
+
/**
|
|
15363
|
+
*
|
|
15364
|
+
* @type {string}
|
|
15365
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15366
|
+
*/
|
|
15367
|
+
'currency'?: string;
|
|
15368
|
+
/**
|
|
15369
|
+
*
|
|
15370
|
+
* @type {boolean}
|
|
15371
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15372
|
+
*/
|
|
15373
|
+
'eligible_for_refund'?: boolean;
|
|
15374
|
+
/**
|
|
15375
|
+
*
|
|
15376
|
+
* @type {DataTypesExpirationWarningDto}
|
|
15377
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15378
|
+
*/
|
|
15379
|
+
'expiration_warning'?: DataTypesExpirationWarningDto;
|
|
15380
|
+
/**
|
|
15381
|
+
*
|
|
15382
|
+
* @type {number}
|
|
15383
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15384
|
+
*/
|
|
15385
|
+
'net_refund_amount'?: number;
|
|
15386
|
+
/**
|
|
15387
|
+
*
|
|
15388
|
+
* @type {number}
|
|
15389
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15390
|
+
*/
|
|
15391
|
+
'org_id'?: number;
|
|
15392
|
+
/**
|
|
15393
|
+
*
|
|
15394
|
+
* @type {DataTypesOriginalPurchaseDetailsDto}
|
|
15395
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15396
|
+
*/
|
|
15397
|
+
'original_purchase'?: DataTypesOriginalPurchaseDetailsDto;
|
|
15398
|
+
/**
|
|
15399
|
+
*
|
|
15400
|
+
* @type {number}
|
|
15401
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15402
|
+
*/
|
|
15403
|
+
'payment_id'?: number;
|
|
15404
|
+
/**
|
|
15405
|
+
*
|
|
15406
|
+
* @type {number}
|
|
15407
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15408
|
+
*/
|
|
15409
|
+
'processing_fee'?: number;
|
|
15410
|
+
/**
|
|
15411
|
+
*
|
|
15412
|
+
* @type {number}
|
|
15413
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15414
|
+
*/
|
|
15415
|
+
'refund_amount'?: number;
|
|
15416
|
+
/**
|
|
15417
|
+
*
|
|
15418
|
+
* @type {DataTypesRefundCalculationDetailsDto}
|
|
15419
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15420
|
+
*/
|
|
15421
|
+
'refund_calculation'?: DataTypesRefundCalculationDetailsDto;
|
|
15422
|
+
/**
|
|
15423
|
+
*
|
|
15424
|
+
* @type {string}
|
|
15425
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15426
|
+
*/
|
|
15427
|
+
'refund_type'?: string;
|
|
15428
|
+
/**
|
|
15429
|
+
*
|
|
15430
|
+
* @type {DataTypesRemainingCreditDetailsDto}
|
|
15431
|
+
* @memberof DataTypesRefundCalculationResponseDto
|
|
15432
|
+
*/
|
|
15433
|
+
'remaining_credits'?: DataTypesRemainingCreditDetailsDto;
|
|
15434
|
+
}
|
|
15435
|
+
/**
|
|
15436
|
+
*
|
|
15437
|
+
* @export
|
|
15438
|
+
* @interface DataTypesRefundEligibilityDto
|
|
15439
|
+
*/
|
|
15440
|
+
export interface DataTypesRefundEligibilityDto {
|
|
15441
|
+
/**
|
|
15442
|
+
*
|
|
15443
|
+
* @type {string}
|
|
15444
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15445
|
+
*/
|
|
15446
|
+
'currency'?: string;
|
|
15447
|
+
/**
|
|
15448
|
+
*
|
|
15449
|
+
* @type {number}
|
|
15450
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15451
|
+
*/
|
|
15452
|
+
'days_since_purchase'?: number;
|
|
15453
|
+
/**
|
|
15454
|
+
*
|
|
15455
|
+
* @type {string}
|
|
15456
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15457
|
+
*/
|
|
15458
|
+
'eligibility_reason'?: string;
|
|
15459
|
+
/**
|
|
15460
|
+
*
|
|
15461
|
+
* @type {boolean}
|
|
15462
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15463
|
+
*/
|
|
15464
|
+
'eligible'?: boolean;
|
|
15465
|
+
/**
|
|
15466
|
+
*
|
|
15467
|
+
* @type {number}
|
|
15468
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15469
|
+
*/
|
|
15470
|
+
'max_refund_amount'?: number;
|
|
15471
|
+
/**
|
|
15472
|
+
*
|
|
15473
|
+
* @type {number}
|
|
15474
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15475
|
+
*/
|
|
15476
|
+
'org_id'?: number;
|
|
15477
|
+
/**
|
|
15478
|
+
*
|
|
15479
|
+
* @type {DataTypesOriginalPurchaseDetailsDto}
|
|
15480
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15481
|
+
*/
|
|
15482
|
+
'original_purchase'?: DataTypesOriginalPurchaseDetailsDto;
|
|
15483
|
+
/**
|
|
15484
|
+
*
|
|
15485
|
+
* @type {number}
|
|
15486
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15487
|
+
*/
|
|
15488
|
+
'payment_id'?: number;
|
|
15489
|
+
/**
|
|
15490
|
+
*
|
|
15491
|
+
* @type {string}
|
|
15492
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15493
|
+
*/
|
|
15494
|
+
'refund_deadline'?: string;
|
|
15495
|
+
/**
|
|
15496
|
+
*
|
|
15497
|
+
* @type {number}
|
|
15498
|
+
* @memberof DataTypesRefundEligibilityDto
|
|
15499
|
+
*/
|
|
15500
|
+
'remaining_credits'?: number;
|
|
15501
|
+
}
|
|
15502
|
+
/**
|
|
15503
|
+
*
|
|
15504
|
+
* @export
|
|
15505
|
+
* @interface DataTypesRefundHistoryDto
|
|
15506
|
+
*/
|
|
15507
|
+
export interface DataTypesRefundHistoryDto {
|
|
15508
|
+
/**
|
|
15509
|
+
*
|
|
15510
|
+
* @type {string}
|
|
15511
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15512
|
+
*/
|
|
15513
|
+
'currency'?: string;
|
|
15514
|
+
/**
|
|
15515
|
+
*
|
|
15516
|
+
* @type {string}
|
|
15517
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15518
|
+
*/
|
|
15519
|
+
'gateway_refund_id'?: string;
|
|
15520
|
+
/**
|
|
15521
|
+
*
|
|
15522
|
+
* @type {number}
|
|
15523
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15524
|
+
*/
|
|
15525
|
+
'org_id'?: number;
|
|
15526
|
+
/**
|
|
15527
|
+
*
|
|
15528
|
+
* @type {number}
|
|
15529
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15530
|
+
*/
|
|
15531
|
+
'payment_id'?: number;
|
|
15532
|
+
/**
|
|
15533
|
+
*
|
|
15534
|
+
* @type {string}
|
|
15535
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15536
|
+
*/
|
|
15537
|
+
'processed_at'?: string;
|
|
15538
|
+
/**
|
|
15539
|
+
*
|
|
15540
|
+
* @type {number}
|
|
15541
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15542
|
+
*/
|
|
15543
|
+
'processed_by'?: number;
|
|
15544
|
+
/**
|
|
15545
|
+
*
|
|
15546
|
+
* @type {string}
|
|
15547
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15548
|
+
*/
|
|
15549
|
+
'reason'?: string;
|
|
15550
|
+
/**
|
|
15551
|
+
*
|
|
15552
|
+
* @type {number}
|
|
15553
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15554
|
+
*/
|
|
15555
|
+
'refund_amount'?: number;
|
|
15556
|
+
/**
|
|
15557
|
+
*
|
|
15558
|
+
* @type {number}
|
|
15559
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15560
|
+
*/
|
|
15561
|
+
'refund_id'?: number;
|
|
15562
|
+
/**
|
|
15563
|
+
*
|
|
15564
|
+
* @type {string}
|
|
15565
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15566
|
+
*/
|
|
15567
|
+
'refund_reference'?: string;
|
|
15568
|
+
/**
|
|
15569
|
+
*
|
|
15570
|
+
* @type {string}
|
|
15571
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15572
|
+
*/
|
|
15573
|
+
'refund_type'?: string;
|
|
15574
|
+
/**
|
|
15575
|
+
*
|
|
15576
|
+
* @type {string}
|
|
15577
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15578
|
+
*/
|
|
15579
|
+
'requested_at'?: string;
|
|
15580
|
+
/**
|
|
15581
|
+
*
|
|
15582
|
+
* @type {number}
|
|
15583
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15584
|
+
*/
|
|
15585
|
+
'requested_by'?: number;
|
|
15586
|
+
/**
|
|
15587
|
+
*
|
|
15588
|
+
* @type {string}
|
|
15589
|
+
* @memberof DataTypesRefundHistoryDto
|
|
15590
|
+
*/
|
|
15591
|
+
'status'?: string;
|
|
15592
|
+
}
|
|
14391
15593
|
/**
|
|
14392
15594
|
*
|
|
14393
15595
|
* @export
|
|
@@ -14724,6 +15926,43 @@ export interface DataTypesRegenerateXStoreSecretResponse {
|
|
|
14724
15926
|
*/
|
|
14725
15927
|
'old_xstore_secret'?: string;
|
|
14726
15928
|
}
|
|
15929
|
+
/**
|
|
15930
|
+
*
|
|
15931
|
+
* @export
|
|
15932
|
+
* @interface DataTypesRemainingCreditDetailsDto
|
|
15933
|
+
*/
|
|
15934
|
+
export interface DataTypesRemainingCreditDetailsDto {
|
|
15935
|
+
/**
|
|
15936
|
+
*
|
|
15937
|
+
* @type {number}
|
|
15938
|
+
* @memberof DataTypesRemainingCreditDetailsDto
|
|
15939
|
+
*/
|
|
15940
|
+
'credits_expiring_soon'?: number;
|
|
15941
|
+
/**
|
|
15942
|
+
*
|
|
15943
|
+
* @type {number}
|
|
15944
|
+
* @memberof DataTypesRemainingCreditDetailsDto
|
|
15945
|
+
*/
|
|
15946
|
+
'expired_credits'?: number;
|
|
15947
|
+
/**
|
|
15948
|
+
*
|
|
15949
|
+
* @type {number}
|
|
15950
|
+
* @memberof DataTypesRemainingCreditDetailsDto
|
|
15951
|
+
*/
|
|
15952
|
+
'never_expiring_credits'?: number;
|
|
15953
|
+
/**
|
|
15954
|
+
*
|
|
15955
|
+
* @type {Array<DataTypesCreditBatchDetailsDto>}
|
|
15956
|
+
* @memberof DataTypesRemainingCreditDetailsDto
|
|
15957
|
+
*/
|
|
15958
|
+
'remaining_by_batch'?: Array<DataTypesCreditBatchDetailsDto>;
|
|
15959
|
+
/**
|
|
15960
|
+
*
|
|
15961
|
+
* @type {number}
|
|
15962
|
+
* @memberof DataTypesRemainingCreditDetailsDto
|
|
15963
|
+
*/
|
|
15964
|
+
'total_remaining'?: number;
|
|
15965
|
+
}
|
|
14727
15966
|
/**
|
|
14728
15967
|
*
|
|
14729
15968
|
* @export
|
|
@@ -15094,6 +16333,37 @@ export interface DataTypesRolesListResponse {
|
|
|
15094
16333
|
*/
|
|
15095
16334
|
'status'?: number;
|
|
15096
16335
|
}
|
|
16336
|
+
/**
|
|
16337
|
+
* Defines the conditions that trigger a rule (query matching, filters, etc.)
|
|
16338
|
+
* @export
|
|
16339
|
+
* @interface DataTypesRuleConfig
|
|
16340
|
+
*/
|
|
16341
|
+
export interface DataTypesRuleConfig {
|
|
16342
|
+
/**
|
|
16343
|
+
* Filter-based rule
|
|
16344
|
+
* @type {string}
|
|
16345
|
+
* @memberof DataTypesRuleConfig
|
|
16346
|
+
*/
|
|
16347
|
+
'filter'?: string;
|
|
16348
|
+
/**
|
|
16349
|
+
* \"exact\" or \"contains\"
|
|
16350
|
+
* @type {string}
|
|
16351
|
+
* @memberof DataTypesRuleConfig
|
|
16352
|
+
*/
|
|
16353
|
+
'match'?: string;
|
|
16354
|
+
/**
|
|
16355
|
+
* Query-based rule
|
|
16356
|
+
* @type {string}
|
|
16357
|
+
* @memberof DataTypesRuleConfig
|
|
16358
|
+
*/
|
|
16359
|
+
'query'?: string;
|
|
16360
|
+
/**
|
|
16361
|
+
* Tags for rule organization
|
|
16362
|
+
* @type {Array<string>}
|
|
16363
|
+
* @memberof DataTypesRuleConfig
|
|
16364
|
+
*/
|
|
16365
|
+
'tags'?: Array<string>;
|
|
16366
|
+
}
|
|
15097
16367
|
/**
|
|
15098
16368
|
*
|
|
15099
16369
|
* @export
|
|
@@ -16404,6 +17674,55 @@ export interface DataTypesTriggerTaskRunResponse {
|
|
|
16404
17674
|
*/
|
|
16405
17675
|
'status'?: number;
|
|
16406
17676
|
}
|
|
17677
|
+
/**
|
|
17678
|
+
* Request payload for updating an existing analytics rule (supports partial updates)
|
|
17679
|
+
* @export
|
|
17680
|
+
* @interface DataTypesUpdateAnalyticsRuleRequest
|
|
17681
|
+
*/
|
|
17682
|
+
export interface DataTypesUpdateAnalyticsRuleRequest {
|
|
17683
|
+
/**
|
|
17684
|
+
*
|
|
17685
|
+
* @type {string}
|
|
17686
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17687
|
+
*/
|
|
17688
|
+
'description'?: string;
|
|
17689
|
+
/**
|
|
17690
|
+
*
|
|
17691
|
+
* @type {number}
|
|
17692
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17693
|
+
*/
|
|
17694
|
+
'effective_from_ts'?: number;
|
|
17695
|
+
/**
|
|
17696
|
+
*
|
|
17697
|
+
* @type {number}
|
|
17698
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17699
|
+
*/
|
|
17700
|
+
'effective_to_ts'?: number;
|
|
17701
|
+
/**
|
|
17702
|
+
*
|
|
17703
|
+
* @type {boolean}
|
|
17704
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17705
|
+
*/
|
|
17706
|
+
'is_active'?: boolean;
|
|
17707
|
+
/**
|
|
17708
|
+
*
|
|
17709
|
+
* @type {string}
|
|
17710
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17711
|
+
*/
|
|
17712
|
+
'name'?: string;
|
|
17713
|
+
/**
|
|
17714
|
+
*
|
|
17715
|
+
* @type {DataTypesOverrideActions}
|
|
17716
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17717
|
+
*/
|
|
17718
|
+
'override_actions'?: DataTypesOverrideActions;
|
|
17719
|
+
/**
|
|
17720
|
+
*
|
|
17721
|
+
* @type {DataTypesRuleConfig}
|
|
17722
|
+
* @memberof DataTypesUpdateAnalyticsRuleRequest
|
|
17723
|
+
*/
|
|
17724
|
+
'rule_config'?: DataTypesRuleConfig;
|
|
17725
|
+
}
|
|
16407
17726
|
/**
|
|
16408
17727
|
*
|
|
16409
17728
|
* @export
|
|
@@ -17611,6 +18930,364 @@ export interface MgDocumentTypesCreateArticleRequestDto {
|
|
|
17611
18930
|
*/
|
|
17612
18931
|
'title'?: string;
|
|
17613
18932
|
}
|
|
18933
|
+
/**
|
|
18934
|
+
*
|
|
18935
|
+
* @export
|
|
18936
|
+
* @interface RefundRazorpayRefundDetailsDto
|
|
18937
|
+
*/
|
|
18938
|
+
export interface RefundRazorpayRefundDetailsDto {
|
|
18939
|
+
/**
|
|
18940
|
+
*
|
|
18941
|
+
* @type {number}
|
|
18942
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18943
|
+
*/
|
|
18944
|
+
'amount'?: number;
|
|
18945
|
+
/**
|
|
18946
|
+
*
|
|
18947
|
+
* @type {string}
|
|
18948
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18949
|
+
*/
|
|
18950
|
+
'currency'?: string;
|
|
18951
|
+
/**
|
|
18952
|
+
*
|
|
18953
|
+
* @type {number}
|
|
18954
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18955
|
+
*/
|
|
18956
|
+
'gateway_fee'?: number;
|
|
18957
|
+
/**
|
|
18958
|
+
*
|
|
18959
|
+
* @type {number}
|
|
18960
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18961
|
+
*/
|
|
18962
|
+
'net_amount'?: number;
|
|
18963
|
+
/**
|
|
18964
|
+
*
|
|
18965
|
+
* @type {string}
|
|
18966
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18967
|
+
*/
|
|
18968
|
+
'payment_id'?: string;
|
|
18969
|
+
/**
|
|
18970
|
+
*
|
|
18971
|
+
* @type {string}
|
|
18972
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18973
|
+
*/
|
|
18974
|
+
'processing_time'?: string;
|
|
18975
|
+
/**
|
|
18976
|
+
* Will be generated during processing
|
|
18977
|
+
* @type {string}
|
|
18978
|
+
* @memberof RefundRazorpayRefundDetailsDto
|
|
18979
|
+
*/
|
|
18980
|
+
'refund_id'?: string;
|
|
18981
|
+
}
|
|
18982
|
+
/**
|
|
18983
|
+
*
|
|
18984
|
+
* @export
|
|
18985
|
+
* @interface RefundRefundPreviewRequestDto
|
|
18986
|
+
*/
|
|
18987
|
+
export interface RefundRefundPreviewRequestDto {
|
|
18988
|
+
/**
|
|
18989
|
+
* For partial refunds
|
|
18990
|
+
* @type {number}
|
|
18991
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
18992
|
+
*/
|
|
18993
|
+
'amount'?: number;
|
|
18994
|
+
/**
|
|
18995
|
+
* For credit-based refunds
|
|
18996
|
+
* @type {number}
|
|
18997
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
18998
|
+
*/
|
|
18999
|
+
'credit_amount'?: number;
|
|
19000
|
+
/**
|
|
19001
|
+
*
|
|
19002
|
+
* @type {string}
|
|
19003
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
19004
|
+
*/
|
|
19005
|
+
'currency': string;
|
|
19006
|
+
/**
|
|
19007
|
+
*
|
|
19008
|
+
* @type {number}
|
|
19009
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
19010
|
+
*/
|
|
19011
|
+
'org_id': number;
|
|
19012
|
+
/**
|
|
19013
|
+
*
|
|
19014
|
+
* @type {number}
|
|
19015
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
19016
|
+
*/
|
|
19017
|
+
'payment_id': number;
|
|
19018
|
+
/**
|
|
19019
|
+
*
|
|
19020
|
+
* @type {string}
|
|
19021
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
19022
|
+
*/
|
|
19023
|
+
'reason': string;
|
|
19024
|
+
/**
|
|
19025
|
+
*
|
|
19026
|
+
* @type {string}
|
|
19027
|
+
* @memberof RefundRefundPreviewRequestDto
|
|
19028
|
+
*/
|
|
19029
|
+
'refund_type': RefundRefundPreviewRequestDtoRefundTypeEnum;
|
|
19030
|
+
}
|
|
19031
|
+
|
|
19032
|
+
export const RefundRefundPreviewRequestDtoRefundTypeEnum = {
|
|
19033
|
+
Full: 'full',
|
|
19034
|
+
Partial: 'partial',
|
|
19035
|
+
RemainingCredits: 'remaining_credits'
|
|
19036
|
+
} as const;
|
|
19037
|
+
|
|
19038
|
+
export type RefundRefundPreviewRequestDtoRefundTypeEnum = typeof RefundRefundPreviewRequestDtoRefundTypeEnum[keyof typeof RefundRefundPreviewRequestDtoRefundTypeEnum];
|
|
19039
|
+
|
|
19040
|
+
/**
|
|
19041
|
+
*
|
|
19042
|
+
* @export
|
|
19043
|
+
* @interface RefundRefundPreviewResponseDto
|
|
19044
|
+
*/
|
|
19045
|
+
export interface RefundRefundPreviewResponseDto {
|
|
19046
|
+
/**
|
|
19047
|
+
*
|
|
19048
|
+
* @type {string}
|
|
19049
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19050
|
+
*/
|
|
19051
|
+
'calculated_at'?: string;
|
|
19052
|
+
/**
|
|
19053
|
+
* Eligibility and warnings
|
|
19054
|
+
* @type {boolean}
|
|
19055
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19056
|
+
*/
|
|
19057
|
+
'eligible_for_refund'?: boolean;
|
|
19058
|
+
/**
|
|
19059
|
+
* Processing timeline
|
|
19060
|
+
* @type {string}
|
|
19061
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19062
|
+
*/
|
|
19063
|
+
'estimated_processing'?: string;
|
|
19064
|
+
/**
|
|
19065
|
+
*
|
|
19066
|
+
* @type {DataTypesExpirationWarningDto}
|
|
19067
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19068
|
+
*/
|
|
19069
|
+
'expiration_warning'?: DataTypesExpirationWarningDto;
|
|
19070
|
+
/**
|
|
19071
|
+
*
|
|
19072
|
+
* @type {number}
|
|
19073
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19074
|
+
*/
|
|
19075
|
+
'org_id'?: number;
|
|
19076
|
+
/**
|
|
19077
|
+
* Original purchase details
|
|
19078
|
+
* @type {DataTypesOriginalPurchaseDetailsDto}
|
|
19079
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19080
|
+
*/
|
|
19081
|
+
'original_purchase'?: DataTypesOriginalPurchaseDetailsDto;
|
|
19082
|
+
/**
|
|
19083
|
+
*
|
|
19084
|
+
* @type {number}
|
|
19085
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19086
|
+
*/
|
|
19087
|
+
'payment_id'?: number;
|
|
19088
|
+
/**
|
|
19089
|
+
* Razorpay integration details
|
|
19090
|
+
* @type {RefundRazorpayRefundDetailsDto}
|
|
19091
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19092
|
+
*/
|
|
19093
|
+
'razorpay_details'?: RefundRazorpayRefundDetailsDto;
|
|
19094
|
+
/**
|
|
19095
|
+
*
|
|
19096
|
+
* @type {string}
|
|
19097
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19098
|
+
*/
|
|
19099
|
+
'reason'?: string;
|
|
19100
|
+
/**
|
|
19101
|
+
* Refund calculation
|
|
19102
|
+
* @type {DataTypesRefundCalculationDetailsDto}
|
|
19103
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19104
|
+
*/
|
|
19105
|
+
'refund_calculation'?: DataTypesRefundCalculationDetailsDto;
|
|
19106
|
+
/**
|
|
19107
|
+
* Final refund summary
|
|
19108
|
+
* @type {RefundRefundSummaryDto}
|
|
19109
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19110
|
+
*/
|
|
19111
|
+
'refund_summary'?: RefundRefundSummaryDto;
|
|
19112
|
+
/**
|
|
19113
|
+
*
|
|
19114
|
+
* @type {string}
|
|
19115
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19116
|
+
*/
|
|
19117
|
+
'refund_type'?: string;
|
|
19118
|
+
/**
|
|
19119
|
+
* Current credit status
|
|
19120
|
+
* @type {DataTypesRemainingCreditDetailsDto}
|
|
19121
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19122
|
+
*/
|
|
19123
|
+
'remaining_credits'?: DataTypesRemainingCreditDetailsDto;
|
|
19124
|
+
/**
|
|
19125
|
+
* Subscription details (if applicable)
|
|
19126
|
+
* @type {RefundSubscriptionInfoDto}
|
|
19127
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19128
|
+
*/
|
|
19129
|
+
'subscription_info'?: RefundSubscriptionInfoDto;
|
|
19130
|
+
/**
|
|
19131
|
+
*
|
|
19132
|
+
* @type {Array<string>}
|
|
19133
|
+
* @memberof RefundRefundPreviewResponseDto
|
|
19134
|
+
*/
|
|
19135
|
+
'warnings'?: Array<string>;
|
|
19136
|
+
}
|
|
19137
|
+
/**
|
|
19138
|
+
*
|
|
19139
|
+
* @export
|
|
19140
|
+
* @interface RefundRefundSummaryDto
|
|
19141
|
+
*/
|
|
19142
|
+
export interface RefundRefundSummaryDto {
|
|
19143
|
+
/**
|
|
19144
|
+
*
|
|
19145
|
+
* @type {number}
|
|
19146
|
+
* @memberof RefundRefundSummaryDto
|
|
19147
|
+
*/
|
|
19148
|
+
'credits_already_used'?: number;
|
|
19149
|
+
/**
|
|
19150
|
+
*
|
|
19151
|
+
* @type {number}
|
|
19152
|
+
* @memberof RefundRefundSummaryDto
|
|
19153
|
+
*/
|
|
19154
|
+
'credits_to_remove'?: number;
|
|
19155
|
+
/**
|
|
19156
|
+
*
|
|
19157
|
+
* @type {string}
|
|
19158
|
+
* @memberof RefundRefundSummaryDto
|
|
19159
|
+
*/
|
|
19160
|
+
'currency'?: string;
|
|
19161
|
+
/**
|
|
19162
|
+
*
|
|
19163
|
+
* @type {number}
|
|
19164
|
+
* @memberof RefundRefundSummaryDto
|
|
19165
|
+
*/
|
|
19166
|
+
'gateway_fee'?: number;
|
|
19167
|
+
/**
|
|
19168
|
+
*
|
|
19169
|
+
* @type {number}
|
|
19170
|
+
* @memberof RefundRefundSummaryDto
|
|
19171
|
+
*/
|
|
19172
|
+
'net_refund_amount'?: number;
|
|
19173
|
+
/**
|
|
19174
|
+
*
|
|
19175
|
+
* @type {number}
|
|
19176
|
+
* @memberof RefundRefundSummaryDto
|
|
19177
|
+
*/
|
|
19178
|
+
'processing_fee'?: number;
|
|
19179
|
+
/**
|
|
19180
|
+
*
|
|
19181
|
+
* @type {string}
|
|
19182
|
+
* @memberof RefundRefundSummaryDto
|
|
19183
|
+
*/
|
|
19184
|
+
'refund_reference'?: string;
|
|
19185
|
+
/**
|
|
19186
|
+
*
|
|
19187
|
+
* @type {number}
|
|
19188
|
+
* @memberof RefundRefundSummaryDto
|
|
19189
|
+
*/
|
|
19190
|
+
'total_refund_amount'?: number;
|
|
19191
|
+
}
|
|
19192
|
+
/**
|
|
19193
|
+
*
|
|
19194
|
+
* @export
|
|
19195
|
+
* @interface RefundSubscriptionInfoDto
|
|
19196
|
+
*/
|
|
19197
|
+
export interface RefundSubscriptionInfoDto {
|
|
19198
|
+
/**
|
|
19199
|
+
*
|
|
19200
|
+
* @type {string}
|
|
19201
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19202
|
+
*/
|
|
19203
|
+
'cancellation_reason'?: string;
|
|
19204
|
+
/**
|
|
19205
|
+
*
|
|
19206
|
+
* @type {string}
|
|
19207
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19208
|
+
*/
|
|
19209
|
+
'next_billing_date'?: string;
|
|
19210
|
+
/**
|
|
19211
|
+
*
|
|
19212
|
+
* @type {string}
|
|
19213
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19214
|
+
*/
|
|
19215
|
+
'plan_name'?: string;
|
|
19216
|
+
/**
|
|
19217
|
+
*
|
|
19218
|
+
* @type {string}
|
|
19219
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19220
|
+
*/
|
|
19221
|
+
'status'?: string;
|
|
19222
|
+
/**
|
|
19223
|
+
*
|
|
19224
|
+
* @type {string}
|
|
19225
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19226
|
+
*/
|
|
19227
|
+
'subscription_id'?: string;
|
|
19228
|
+
/**
|
|
19229
|
+
*
|
|
19230
|
+
* @type {boolean}
|
|
19231
|
+
* @memberof RefundSubscriptionInfoDto
|
|
19232
|
+
*/
|
|
19233
|
+
'will_be_cancelled'?: boolean;
|
|
19234
|
+
}
|
|
19235
|
+
/**
|
|
19236
|
+
*
|
|
19237
|
+
* @export
|
|
19238
|
+
* @interface SubscriptionRouteCancelPreviewRequest
|
|
19239
|
+
*/
|
|
19240
|
+
export interface SubscriptionRouteCancelPreviewRequest {
|
|
19241
|
+
/**
|
|
19242
|
+
*
|
|
19243
|
+
* @type {number}
|
|
19244
|
+
* @memberof SubscriptionRouteCancelPreviewRequest
|
|
19245
|
+
*/
|
|
19246
|
+
'org_id': number;
|
|
19247
|
+
/**
|
|
19248
|
+
*
|
|
19249
|
+
* @type {string}
|
|
19250
|
+
* @memberof SubscriptionRouteCancelPreviewRequest
|
|
19251
|
+
*/
|
|
19252
|
+
'reason': string;
|
|
19253
|
+
/**
|
|
19254
|
+
*
|
|
19255
|
+
* @type {string}
|
|
19256
|
+
* @memberof SubscriptionRouteCancelPreviewRequest
|
|
19257
|
+
*/
|
|
19258
|
+
'subscription_id': string;
|
|
19259
|
+
}
|
|
19260
|
+
/**
|
|
19261
|
+
*
|
|
19262
|
+
* @export
|
|
19263
|
+
* @interface SubscriptionRouteCancelProcessRequest
|
|
19264
|
+
*/
|
|
19265
|
+
export interface SubscriptionRouteCancelProcessRequest {
|
|
19266
|
+
/**
|
|
19267
|
+
* true = cancel now, false = cancel at cycle end
|
|
19268
|
+
* @type {boolean}
|
|
19269
|
+
* @memberof SubscriptionRouteCancelProcessRequest
|
|
19270
|
+
*/
|
|
19271
|
+
'immediate_cancellation'?: boolean;
|
|
19272
|
+
/**
|
|
19273
|
+
*
|
|
19274
|
+
* @type {number}
|
|
19275
|
+
* @memberof SubscriptionRouteCancelProcessRequest
|
|
19276
|
+
*/
|
|
19277
|
+
'org_id': number;
|
|
19278
|
+
/**
|
|
19279
|
+
*
|
|
19280
|
+
* @type {string}
|
|
19281
|
+
* @memberof SubscriptionRouteCancelProcessRequest
|
|
19282
|
+
*/
|
|
19283
|
+
'reason': string;
|
|
19284
|
+
/**
|
|
19285
|
+
*
|
|
19286
|
+
* @type {string}
|
|
19287
|
+
* @memberof SubscriptionRouteCancelProcessRequest
|
|
19288
|
+
*/
|
|
19289
|
+
'subscription_id': string;
|
|
19290
|
+
}
|
|
17614
19291
|
/**
|
|
17615
19292
|
*
|
|
17616
19293
|
* @export
|
|
@@ -22916,6 +24593,1195 @@ export class AnalyticsEventsApi extends BaseAPI {
|
|
|
22916
24593
|
|
|
22917
24594
|
|
|
22918
24595
|
|
|
24596
|
+
/**
|
|
24597
|
+
* AnalyticsRulesApi - axios parameter creator
|
|
24598
|
+
* @export
|
|
24599
|
+
*/
|
|
24600
|
+
export const AnalyticsRulesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
24601
|
+
return {
|
|
24602
|
+
/**
|
|
24603
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
24604
|
+
* @summary List Analytics Rules
|
|
24605
|
+
* @param {string} authorization Bearer JWT token
|
|
24606
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
24607
|
+
* @param {string} [collectionName] Filter by collection name
|
|
24608
|
+
* @param {boolean} [isActive] Filter by active status
|
|
24609
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
24610
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
24611
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
24612
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
24613
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
24614
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
24615
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
24616
|
+
* @param {*} [options] Override http request option.
|
|
24617
|
+
* @throws {RequiredError}
|
|
24618
|
+
*/
|
|
24619
|
+
apiAdminV1AnalyticsRulesGet: async (authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24620
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24621
|
+
assertParamExists('apiAdminV1AnalyticsRulesGet', 'authorization', authorization)
|
|
24622
|
+
const localVarPath = `/api/admin/v1/analytics/rules`;
|
|
24623
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24624
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24625
|
+
let baseOptions;
|
|
24626
|
+
if (configuration) {
|
|
24627
|
+
baseOptions = configuration.baseOptions;
|
|
24628
|
+
}
|
|
24629
|
+
|
|
24630
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24631
|
+
const localVarHeaderParameter = {} as any;
|
|
24632
|
+
const localVarQueryParameter = {} as any;
|
|
24633
|
+
|
|
24634
|
+
if (storeId !== undefined) {
|
|
24635
|
+
localVarQueryParameter['store_id'] = storeId;
|
|
24636
|
+
}
|
|
24637
|
+
|
|
24638
|
+
if (collectionName !== undefined) {
|
|
24639
|
+
localVarQueryParameter['collection_name'] = collectionName;
|
|
24640
|
+
}
|
|
24641
|
+
|
|
24642
|
+
if (isActive !== undefined) {
|
|
24643
|
+
localVarQueryParameter['is_active'] = isActive;
|
|
24644
|
+
}
|
|
24645
|
+
|
|
24646
|
+
if (page !== undefined) {
|
|
24647
|
+
localVarQueryParameter['page'] = page;
|
|
24648
|
+
}
|
|
24649
|
+
|
|
24650
|
+
if (pageSize !== undefined) {
|
|
24651
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
24652
|
+
}
|
|
24653
|
+
|
|
24654
|
+
if (limit !== undefined) {
|
|
24655
|
+
localVarQueryParameter['limit'] = limit;
|
|
24656
|
+
}
|
|
24657
|
+
|
|
24658
|
+
if (offset !== undefined) {
|
|
24659
|
+
localVarQueryParameter['offset'] = offset;
|
|
24660
|
+
}
|
|
24661
|
+
|
|
24662
|
+
if (sortBy !== undefined) {
|
|
24663
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
24664
|
+
}
|
|
24665
|
+
|
|
24666
|
+
if (sortOrder !== undefined) {
|
|
24667
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
24668
|
+
}
|
|
24669
|
+
|
|
24670
|
+
if (searchQuery !== undefined) {
|
|
24671
|
+
localVarQueryParameter['search_query'] = searchQuery;
|
|
24672
|
+
}
|
|
24673
|
+
|
|
24674
|
+
|
|
24675
|
+
|
|
24676
|
+
if (authorization != null) {
|
|
24677
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24678
|
+
}
|
|
24679
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24680
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24681
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24682
|
+
|
|
24683
|
+
return {
|
|
24684
|
+
url: toPathString(localVarUrlObj),
|
|
24685
|
+
options: localVarRequestOptions,
|
|
24686
|
+
};
|
|
24687
|
+
},
|
|
24688
|
+
/**
|
|
24689
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
24690
|
+
* @summary Create Analytics Rule
|
|
24691
|
+
* @param {string} authorization Bearer JWT token
|
|
24692
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
24693
|
+
* @param {*} [options] Override http request option.
|
|
24694
|
+
* @throws {RequiredError}
|
|
24695
|
+
*/
|
|
24696
|
+
apiAdminV1AnalyticsRulesPost: async (authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24697
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24698
|
+
assertParamExists('apiAdminV1AnalyticsRulesPost', 'authorization', authorization)
|
|
24699
|
+
// verify required parameter 'dataTypesCreateAnalyticsRuleRequest' is not null or undefined
|
|
24700
|
+
assertParamExists('apiAdminV1AnalyticsRulesPost', 'dataTypesCreateAnalyticsRuleRequest', dataTypesCreateAnalyticsRuleRequest)
|
|
24701
|
+
const localVarPath = `/api/admin/v1/analytics/rules`;
|
|
24702
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24703
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24704
|
+
let baseOptions;
|
|
24705
|
+
if (configuration) {
|
|
24706
|
+
baseOptions = configuration.baseOptions;
|
|
24707
|
+
}
|
|
24708
|
+
|
|
24709
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
24710
|
+
const localVarHeaderParameter = {} as any;
|
|
24711
|
+
const localVarQueryParameter = {} as any;
|
|
24712
|
+
|
|
24713
|
+
|
|
24714
|
+
|
|
24715
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24716
|
+
|
|
24717
|
+
if (authorization != null) {
|
|
24718
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24719
|
+
}
|
|
24720
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24721
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24722
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24723
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesCreateAnalyticsRuleRequest, localVarRequestOptions, configuration)
|
|
24724
|
+
|
|
24725
|
+
return {
|
|
24726
|
+
url: toPathString(localVarUrlObj),
|
|
24727
|
+
options: localVarRequestOptions,
|
|
24728
|
+
};
|
|
24729
|
+
},
|
|
24730
|
+
/**
|
|
24731
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
24732
|
+
* @summary Delete Analytics Rule
|
|
24733
|
+
* @param {string} authorization Bearer JWT token
|
|
24734
|
+
* @param {string} ruleId Rule ID
|
|
24735
|
+
* @param {*} [options] Override http request option.
|
|
24736
|
+
* @throws {RequiredError}
|
|
24737
|
+
*/
|
|
24738
|
+
apiAdminV1AnalyticsRulesRuleIdDelete: async (authorization: string, ruleId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24739
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24740
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdDelete', 'authorization', authorization)
|
|
24741
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
24742
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdDelete', 'ruleId', ruleId)
|
|
24743
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
24744
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
24745
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24746
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24747
|
+
let baseOptions;
|
|
24748
|
+
if (configuration) {
|
|
24749
|
+
baseOptions = configuration.baseOptions;
|
|
24750
|
+
}
|
|
24751
|
+
|
|
24752
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
24753
|
+
const localVarHeaderParameter = {} as any;
|
|
24754
|
+
const localVarQueryParameter = {} as any;
|
|
24755
|
+
|
|
24756
|
+
|
|
24757
|
+
|
|
24758
|
+
if (authorization != null) {
|
|
24759
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24760
|
+
}
|
|
24761
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24762
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24763
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24764
|
+
|
|
24765
|
+
return {
|
|
24766
|
+
url: toPathString(localVarUrlObj),
|
|
24767
|
+
options: localVarRequestOptions,
|
|
24768
|
+
};
|
|
24769
|
+
},
|
|
24770
|
+
/**
|
|
24771
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
24772
|
+
* @summary Get Analytics Rule
|
|
24773
|
+
* @param {string} authorization Bearer JWT token
|
|
24774
|
+
* @param {string} ruleId Rule ID
|
|
24775
|
+
* @param {*} [options] Override http request option.
|
|
24776
|
+
* @throws {RequiredError}
|
|
24777
|
+
*/
|
|
24778
|
+
apiAdminV1AnalyticsRulesRuleIdGet: async (authorization: string, ruleId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24779
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24780
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdGet', 'authorization', authorization)
|
|
24781
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
24782
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdGet', 'ruleId', ruleId)
|
|
24783
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
24784
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
24785
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24786
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24787
|
+
let baseOptions;
|
|
24788
|
+
if (configuration) {
|
|
24789
|
+
baseOptions = configuration.baseOptions;
|
|
24790
|
+
}
|
|
24791
|
+
|
|
24792
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24793
|
+
const localVarHeaderParameter = {} as any;
|
|
24794
|
+
const localVarQueryParameter = {} as any;
|
|
24795
|
+
|
|
24796
|
+
|
|
24797
|
+
|
|
24798
|
+
if (authorization != null) {
|
|
24799
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24800
|
+
}
|
|
24801
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24802
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24803
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24804
|
+
|
|
24805
|
+
return {
|
|
24806
|
+
url: toPathString(localVarUrlObj),
|
|
24807
|
+
options: localVarRequestOptions,
|
|
24808
|
+
};
|
|
24809
|
+
},
|
|
24810
|
+
/**
|
|
24811
|
+
* 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.
|
|
24812
|
+
* @summary Update Analytics Rule
|
|
24813
|
+
* @param {string} authorization Bearer JWT token
|
|
24814
|
+
* @param {string} ruleId Rule ID
|
|
24815
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
24816
|
+
* @param {*} [options] Override http request option.
|
|
24817
|
+
* @throws {RequiredError}
|
|
24818
|
+
*/
|
|
24819
|
+
apiAdminV1AnalyticsRulesRuleIdPut: async (authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24820
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24821
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdPut', 'authorization', authorization)
|
|
24822
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
24823
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdPut', 'ruleId', ruleId)
|
|
24824
|
+
// verify required parameter 'dataTypesUpdateAnalyticsRuleRequest' is not null or undefined
|
|
24825
|
+
assertParamExists('apiAdminV1AnalyticsRulesRuleIdPut', 'dataTypesUpdateAnalyticsRuleRequest', dataTypesUpdateAnalyticsRuleRequest)
|
|
24826
|
+
const localVarPath = `/api/admin/v1/analytics/rules/{ruleId}`
|
|
24827
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
24828
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24829
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24830
|
+
let baseOptions;
|
|
24831
|
+
if (configuration) {
|
|
24832
|
+
baseOptions = configuration.baseOptions;
|
|
24833
|
+
}
|
|
24834
|
+
|
|
24835
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
24836
|
+
const localVarHeaderParameter = {} as any;
|
|
24837
|
+
const localVarQueryParameter = {} as any;
|
|
24838
|
+
|
|
24839
|
+
|
|
24840
|
+
|
|
24841
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24842
|
+
|
|
24843
|
+
if (authorization != null) {
|
|
24844
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24845
|
+
}
|
|
24846
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24847
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24848
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24849
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesUpdateAnalyticsRuleRequest, localVarRequestOptions, configuration)
|
|
24850
|
+
|
|
24851
|
+
return {
|
|
24852
|
+
url: toPathString(localVarUrlObj),
|
|
24853
|
+
options: localVarRequestOptions,
|
|
24854
|
+
};
|
|
24855
|
+
},
|
|
24856
|
+
/**
|
|
24857
|
+
* 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.
|
|
24858
|
+
* @summary Sync Rules to Typesense
|
|
24859
|
+
* @param {string} authorization Bearer JWT token
|
|
24860
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
24861
|
+
* @param {*} [options] Override http request option.
|
|
24862
|
+
* @throws {RequiredError}
|
|
24863
|
+
*/
|
|
24864
|
+
apiAdminV1AnalyticsRulesSyncPost: async (authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24865
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24866
|
+
assertParamExists('apiAdminV1AnalyticsRulesSyncPost', 'authorization', authorization)
|
|
24867
|
+
// verify required parameter 'dataTypesAnalyticsRuleSyncRequest' is not null or undefined
|
|
24868
|
+
assertParamExists('apiAdminV1AnalyticsRulesSyncPost', 'dataTypesAnalyticsRuleSyncRequest', dataTypesAnalyticsRuleSyncRequest)
|
|
24869
|
+
const localVarPath = `/api/admin/v1/analytics/rules/sync`;
|
|
24870
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24871
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24872
|
+
let baseOptions;
|
|
24873
|
+
if (configuration) {
|
|
24874
|
+
baseOptions = configuration.baseOptions;
|
|
24875
|
+
}
|
|
24876
|
+
|
|
24877
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
24878
|
+
const localVarHeaderParameter = {} as any;
|
|
24879
|
+
const localVarQueryParameter = {} as any;
|
|
24880
|
+
|
|
24881
|
+
|
|
24882
|
+
|
|
24883
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24884
|
+
|
|
24885
|
+
if (authorization != null) {
|
|
24886
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24887
|
+
}
|
|
24888
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24889
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24890
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24891
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesAnalyticsRuleSyncRequest, localVarRequestOptions, configuration)
|
|
24892
|
+
|
|
24893
|
+
return {
|
|
24894
|
+
url: toPathString(localVarUrlObj),
|
|
24895
|
+
options: localVarRequestOptions,
|
|
24896
|
+
};
|
|
24897
|
+
},
|
|
24898
|
+
/**
|
|
24899
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
24900
|
+
* @summary List Analytics Rules
|
|
24901
|
+
* @param {string} authorization Bearer JWT token
|
|
24902
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
24903
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
24904
|
+
* @param {string} [collectionName] Filter by collection name
|
|
24905
|
+
* @param {boolean} [isActive] Filter by active status
|
|
24906
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
24907
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
24908
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
24909
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
24910
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
24911
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
24912
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
24913
|
+
* @param {*} [options] Override http request option.
|
|
24914
|
+
* @throws {RequiredError}
|
|
24915
|
+
*/
|
|
24916
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet: async (authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24917
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24918
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesGet', 'authorization', authorization)
|
|
24919
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
24920
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesGet', 'xstoreid', xstoreid)
|
|
24921
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules`
|
|
24922
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
24923
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24924
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24925
|
+
let baseOptions;
|
|
24926
|
+
if (configuration) {
|
|
24927
|
+
baseOptions = configuration.baseOptions;
|
|
24928
|
+
}
|
|
24929
|
+
|
|
24930
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24931
|
+
const localVarHeaderParameter = {} as any;
|
|
24932
|
+
const localVarQueryParameter = {} as any;
|
|
24933
|
+
|
|
24934
|
+
if (storeId !== undefined) {
|
|
24935
|
+
localVarQueryParameter['store_id'] = storeId;
|
|
24936
|
+
}
|
|
24937
|
+
|
|
24938
|
+
if (collectionName !== undefined) {
|
|
24939
|
+
localVarQueryParameter['collection_name'] = collectionName;
|
|
24940
|
+
}
|
|
24941
|
+
|
|
24942
|
+
if (isActive !== undefined) {
|
|
24943
|
+
localVarQueryParameter['is_active'] = isActive;
|
|
24944
|
+
}
|
|
24945
|
+
|
|
24946
|
+
if (page !== undefined) {
|
|
24947
|
+
localVarQueryParameter['page'] = page;
|
|
24948
|
+
}
|
|
24949
|
+
|
|
24950
|
+
if (pageSize !== undefined) {
|
|
24951
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
24952
|
+
}
|
|
24953
|
+
|
|
24954
|
+
if (limit !== undefined) {
|
|
24955
|
+
localVarQueryParameter['limit'] = limit;
|
|
24956
|
+
}
|
|
24957
|
+
|
|
24958
|
+
if (offset !== undefined) {
|
|
24959
|
+
localVarQueryParameter['offset'] = offset;
|
|
24960
|
+
}
|
|
24961
|
+
|
|
24962
|
+
if (sortBy !== undefined) {
|
|
24963
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
24964
|
+
}
|
|
24965
|
+
|
|
24966
|
+
if (sortOrder !== undefined) {
|
|
24967
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
24968
|
+
}
|
|
24969
|
+
|
|
24970
|
+
if (searchQuery !== undefined) {
|
|
24971
|
+
localVarQueryParameter['search_query'] = searchQuery;
|
|
24972
|
+
}
|
|
24973
|
+
|
|
24974
|
+
|
|
24975
|
+
|
|
24976
|
+
if (authorization != null) {
|
|
24977
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
24978
|
+
}
|
|
24979
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24980
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24981
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24982
|
+
|
|
24983
|
+
return {
|
|
24984
|
+
url: toPathString(localVarUrlObj),
|
|
24985
|
+
options: localVarRequestOptions,
|
|
24986
|
+
};
|
|
24987
|
+
},
|
|
24988
|
+
/**
|
|
24989
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
24990
|
+
* @summary Create Analytics Rule
|
|
24991
|
+
* @param {string} authorization Bearer JWT token
|
|
24992
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
24993
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
24994
|
+
* @param {*} [options] Override http request option.
|
|
24995
|
+
* @throws {RequiredError}
|
|
24996
|
+
*/
|
|
24997
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost: async (authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24998
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
24999
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'authorization', authorization)
|
|
25000
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
25001
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'xstoreid', xstoreid)
|
|
25002
|
+
// verify required parameter 'dataTypesCreateAnalyticsRuleRequest' is not null or undefined
|
|
25003
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesPost', 'dataTypesCreateAnalyticsRuleRequest', dataTypesCreateAnalyticsRuleRequest)
|
|
25004
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules`
|
|
25005
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
25006
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25007
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25008
|
+
let baseOptions;
|
|
25009
|
+
if (configuration) {
|
|
25010
|
+
baseOptions = configuration.baseOptions;
|
|
25011
|
+
}
|
|
25012
|
+
|
|
25013
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25014
|
+
const localVarHeaderParameter = {} as any;
|
|
25015
|
+
const localVarQueryParameter = {} as any;
|
|
25016
|
+
|
|
25017
|
+
|
|
25018
|
+
|
|
25019
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25020
|
+
|
|
25021
|
+
if (authorization != null) {
|
|
25022
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
25023
|
+
}
|
|
25024
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25025
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25026
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25027
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesCreateAnalyticsRuleRequest, localVarRequestOptions, configuration)
|
|
25028
|
+
|
|
25029
|
+
return {
|
|
25030
|
+
url: toPathString(localVarUrlObj),
|
|
25031
|
+
options: localVarRequestOptions,
|
|
25032
|
+
};
|
|
25033
|
+
},
|
|
25034
|
+
/**
|
|
25035
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25036
|
+
* @summary Delete Analytics Rule
|
|
25037
|
+
* @param {string} authorization Bearer JWT token
|
|
25038
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25039
|
+
* @param {string} ruleId Rule ID
|
|
25040
|
+
* @param {*} [options] Override http request option.
|
|
25041
|
+
* @throws {RequiredError}
|
|
25042
|
+
*/
|
|
25043
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete: async (authorization: string, xstoreid: string, ruleId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25044
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
25045
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'authorization', authorization)
|
|
25046
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
25047
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'xstoreid', xstoreid)
|
|
25048
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
25049
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete', 'ruleId', ruleId)
|
|
25050
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
25051
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
25052
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
25053
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25054
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25055
|
+
let baseOptions;
|
|
25056
|
+
if (configuration) {
|
|
25057
|
+
baseOptions = configuration.baseOptions;
|
|
25058
|
+
}
|
|
25059
|
+
|
|
25060
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
25061
|
+
const localVarHeaderParameter = {} as any;
|
|
25062
|
+
const localVarQueryParameter = {} as any;
|
|
25063
|
+
|
|
25064
|
+
|
|
25065
|
+
|
|
25066
|
+
if (authorization != null) {
|
|
25067
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
25068
|
+
}
|
|
25069
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25070
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25071
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25072
|
+
|
|
25073
|
+
return {
|
|
25074
|
+
url: toPathString(localVarUrlObj),
|
|
25075
|
+
options: localVarRequestOptions,
|
|
25076
|
+
};
|
|
25077
|
+
},
|
|
25078
|
+
/**
|
|
25079
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25080
|
+
* @summary Get Analytics Rule
|
|
25081
|
+
* @param {string} authorization Bearer JWT token
|
|
25082
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25083
|
+
* @param {string} ruleId Rule ID
|
|
25084
|
+
* @param {*} [options] Override http request option.
|
|
25085
|
+
* @throws {RequiredError}
|
|
25086
|
+
*/
|
|
25087
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet: async (authorization: string, xstoreid: string, ruleId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25088
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
25089
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'authorization', authorization)
|
|
25090
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
25091
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'xstoreid', xstoreid)
|
|
25092
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
25093
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet', 'ruleId', ruleId)
|
|
25094
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
25095
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
25096
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
25097
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25098
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25099
|
+
let baseOptions;
|
|
25100
|
+
if (configuration) {
|
|
25101
|
+
baseOptions = configuration.baseOptions;
|
|
25102
|
+
}
|
|
25103
|
+
|
|
25104
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25105
|
+
const localVarHeaderParameter = {} as any;
|
|
25106
|
+
const localVarQueryParameter = {} as any;
|
|
25107
|
+
|
|
25108
|
+
|
|
25109
|
+
|
|
25110
|
+
if (authorization != null) {
|
|
25111
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
25112
|
+
}
|
|
25113
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25114
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25115
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25116
|
+
|
|
25117
|
+
return {
|
|
25118
|
+
url: toPathString(localVarUrlObj),
|
|
25119
|
+
options: localVarRequestOptions,
|
|
25120
|
+
};
|
|
25121
|
+
},
|
|
25122
|
+
/**
|
|
25123
|
+
* 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.
|
|
25124
|
+
* @summary Update Analytics Rule
|
|
25125
|
+
* @param {string} authorization Bearer JWT token
|
|
25126
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25127
|
+
* @param {string} ruleId Rule ID
|
|
25128
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25129
|
+
* @param {*} [options] Override http request option.
|
|
25130
|
+
* @throws {RequiredError}
|
|
25131
|
+
*/
|
|
25132
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut: async (authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25133
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
25134
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'authorization', authorization)
|
|
25135
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
25136
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'xstoreid', xstoreid)
|
|
25137
|
+
// verify required parameter 'ruleId' is not null or undefined
|
|
25138
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'ruleId', ruleId)
|
|
25139
|
+
// verify required parameter 'dataTypesUpdateAnalyticsRuleRequest' is not null or undefined
|
|
25140
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut', 'dataTypesUpdateAnalyticsRuleRequest', dataTypesUpdateAnalyticsRuleRequest)
|
|
25141
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/{ruleId}`
|
|
25142
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)))
|
|
25143
|
+
.replace(`{${"ruleId"}}`, encodeURIComponent(String(ruleId)));
|
|
25144
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25145
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25146
|
+
let baseOptions;
|
|
25147
|
+
if (configuration) {
|
|
25148
|
+
baseOptions = configuration.baseOptions;
|
|
25149
|
+
}
|
|
25150
|
+
|
|
25151
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
25152
|
+
const localVarHeaderParameter = {} as any;
|
|
25153
|
+
const localVarQueryParameter = {} as any;
|
|
25154
|
+
|
|
25155
|
+
|
|
25156
|
+
|
|
25157
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25158
|
+
|
|
25159
|
+
if (authorization != null) {
|
|
25160
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
25161
|
+
}
|
|
25162
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25163
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25164
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25165
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesUpdateAnalyticsRuleRequest, localVarRequestOptions, configuration)
|
|
25166
|
+
|
|
25167
|
+
return {
|
|
25168
|
+
url: toPathString(localVarUrlObj),
|
|
25169
|
+
options: localVarRequestOptions,
|
|
25170
|
+
};
|
|
25171
|
+
},
|
|
25172
|
+
/**
|
|
25173
|
+
* 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.
|
|
25174
|
+
* @summary Sync Rules to Typesense
|
|
25175
|
+
* @param {string} authorization Bearer JWT token
|
|
25176
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25177
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25178
|
+
* @param {*} [options] Override http request option.
|
|
25179
|
+
* @throws {RequiredError}
|
|
25180
|
+
*/
|
|
25181
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost: async (authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25182
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
25183
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'authorization', authorization)
|
|
25184
|
+
// verify required parameter 'xstoreid' is not null or undefined
|
|
25185
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'xstoreid', xstoreid)
|
|
25186
|
+
// verify required parameter 'dataTypesAnalyticsRuleSyncRequest' is not null or undefined
|
|
25187
|
+
assertParamExists('apiAdminV1StoresXstoreidAnalyticsRulesSyncPost', 'dataTypesAnalyticsRuleSyncRequest', dataTypesAnalyticsRuleSyncRequest)
|
|
25188
|
+
const localVarPath = `/api/admin/v1/stores/{xstoreid}/analytics/rules/sync`
|
|
25189
|
+
.replace(`{${"xstoreid"}}`, encodeURIComponent(String(xstoreid)));
|
|
25190
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25191
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25192
|
+
let baseOptions;
|
|
25193
|
+
if (configuration) {
|
|
25194
|
+
baseOptions = configuration.baseOptions;
|
|
25195
|
+
}
|
|
25196
|
+
|
|
25197
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25198
|
+
const localVarHeaderParameter = {} as any;
|
|
25199
|
+
const localVarQueryParameter = {} as any;
|
|
25200
|
+
|
|
25201
|
+
|
|
25202
|
+
|
|
25203
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25204
|
+
|
|
25205
|
+
if (authorization != null) {
|
|
25206
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
25207
|
+
}
|
|
25208
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25209
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25210
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25211
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesAnalyticsRuleSyncRequest, localVarRequestOptions, configuration)
|
|
25212
|
+
|
|
25213
|
+
return {
|
|
25214
|
+
url: toPathString(localVarUrlObj),
|
|
25215
|
+
options: localVarRequestOptions,
|
|
25216
|
+
};
|
|
25217
|
+
},
|
|
25218
|
+
}
|
|
25219
|
+
};
|
|
25220
|
+
|
|
25221
|
+
/**
|
|
25222
|
+
* AnalyticsRulesApi - functional programming interface
|
|
25223
|
+
* @export
|
|
25224
|
+
*/
|
|
25225
|
+
export const AnalyticsRulesApiFp = function(configuration?: Configuration) {
|
|
25226
|
+
const localVarAxiosParamCreator = AnalyticsRulesApiAxiosParamCreator(configuration)
|
|
25227
|
+
return {
|
|
25228
|
+
/**
|
|
25229
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25230
|
+
* @summary List Analytics Rules
|
|
25231
|
+
* @param {string} authorization Bearer JWT token
|
|
25232
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25233
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25234
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25235
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25236
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25237
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25238
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25239
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25240
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25241
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25242
|
+
* @param {*} [options] Override http request option.
|
|
25243
|
+
* @throws {RequiredError}
|
|
25244
|
+
*/
|
|
25245
|
+
async apiAdminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleListResponse>> {
|
|
25246
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options);
|
|
25247
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25248
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesGet']?.[localVarOperationServerIndex]?.url;
|
|
25249
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25250
|
+
},
|
|
25251
|
+
/**
|
|
25252
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25253
|
+
* @summary Create Analytics Rule
|
|
25254
|
+
* @param {string} authorization Bearer JWT token
|
|
25255
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25256
|
+
* @param {*} [options] Override http request option.
|
|
25257
|
+
* @throws {RequiredError}
|
|
25258
|
+
*/
|
|
25259
|
+
async apiAdminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25260
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options);
|
|
25261
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25262
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesPost']?.[localVarOperationServerIndex]?.url;
|
|
25263
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25264
|
+
},
|
|
25265
|
+
/**
|
|
25266
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25267
|
+
* @summary Delete Analytics Rule
|
|
25268
|
+
* @param {string} authorization Bearer JWT token
|
|
25269
|
+
* @param {string} ruleId Rule ID
|
|
25270
|
+
* @param {*} [options] Override http request option.
|
|
25271
|
+
* @throws {RequiredError}
|
|
25272
|
+
*/
|
|
25273
|
+
async apiAdminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
|
|
25274
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options);
|
|
25275
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25276
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdDelete']?.[localVarOperationServerIndex]?.url;
|
|
25277
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25278
|
+
},
|
|
25279
|
+
/**
|
|
25280
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25281
|
+
* @summary Get Analytics Rule
|
|
25282
|
+
* @param {string} authorization Bearer JWT token
|
|
25283
|
+
* @param {string} ruleId Rule ID
|
|
25284
|
+
* @param {*} [options] Override http request option.
|
|
25285
|
+
* @throws {RequiredError}
|
|
25286
|
+
*/
|
|
25287
|
+
async apiAdminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25288
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options);
|
|
25289
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25290
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdGet']?.[localVarOperationServerIndex]?.url;
|
|
25291
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25292
|
+
},
|
|
25293
|
+
/**
|
|
25294
|
+
* 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.
|
|
25295
|
+
* @summary Update Analytics Rule
|
|
25296
|
+
* @param {string} authorization Bearer JWT token
|
|
25297
|
+
* @param {string} ruleId Rule ID
|
|
25298
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25299
|
+
* @param {*} [options] Override http request option.
|
|
25300
|
+
* @throws {RequiredError}
|
|
25301
|
+
*/
|
|
25302
|
+
async apiAdminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25303
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options);
|
|
25304
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25305
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesRuleIdPut']?.[localVarOperationServerIndex]?.url;
|
|
25306
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25307
|
+
},
|
|
25308
|
+
/**
|
|
25309
|
+
* 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.
|
|
25310
|
+
* @summary Sync Rules to Typesense
|
|
25311
|
+
* @param {string} authorization Bearer JWT token
|
|
25312
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25313
|
+
* @param {*} [options] Override http request option.
|
|
25314
|
+
* @throws {RequiredError}
|
|
25315
|
+
*/
|
|
25316
|
+
async apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleSyncResponse>> {
|
|
25317
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options);
|
|
25318
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25319
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1AnalyticsRulesSyncPost']?.[localVarOperationServerIndex]?.url;
|
|
25320
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25321
|
+
},
|
|
25322
|
+
/**
|
|
25323
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25324
|
+
* @summary List Analytics Rules
|
|
25325
|
+
* @param {string} authorization Bearer JWT token
|
|
25326
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25327
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25328
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25329
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25330
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25331
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25332
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25333
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25334
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25335
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25336
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25337
|
+
* @param {*} [options] Override http request option.
|
|
25338
|
+
* @throws {RequiredError}
|
|
25339
|
+
*/
|
|
25340
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleListResponse>> {
|
|
25341
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options);
|
|
25342
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25343
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesGet']?.[localVarOperationServerIndex]?.url;
|
|
25344
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25345
|
+
},
|
|
25346
|
+
/**
|
|
25347
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25348
|
+
* @summary Create Analytics Rule
|
|
25349
|
+
* @param {string} authorization Bearer JWT token
|
|
25350
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25351
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25352
|
+
* @param {*} [options] Override http request option.
|
|
25353
|
+
* @throws {RequiredError}
|
|
25354
|
+
*/
|
|
25355
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25356
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options);
|
|
25357
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25358
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesPost']?.[localVarOperationServerIndex]?.url;
|
|
25359
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25360
|
+
},
|
|
25361
|
+
/**
|
|
25362
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25363
|
+
* @summary Delete Analytics Rule
|
|
25364
|
+
* @param {string} authorization Bearer JWT token
|
|
25365
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25366
|
+
* @param {string} ruleId Rule ID
|
|
25367
|
+
* @param {*} [options] Override http request option.
|
|
25368
|
+
* @throws {RequiredError}
|
|
25369
|
+
*/
|
|
25370
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
|
|
25371
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options);
|
|
25372
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25373
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete']?.[localVarOperationServerIndex]?.url;
|
|
25374
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25375
|
+
},
|
|
25376
|
+
/**
|
|
25377
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25378
|
+
* @summary Get Analytics Rule
|
|
25379
|
+
* @param {string} authorization Bearer JWT token
|
|
25380
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25381
|
+
* @param {string} ruleId Rule ID
|
|
25382
|
+
* @param {*} [options] Override http request option.
|
|
25383
|
+
* @throws {RequiredError}
|
|
25384
|
+
*/
|
|
25385
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25386
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options);
|
|
25387
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25388
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet']?.[localVarOperationServerIndex]?.url;
|
|
25389
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25390
|
+
},
|
|
25391
|
+
/**
|
|
25392
|
+
* 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.
|
|
25393
|
+
* @summary Update Analytics Rule
|
|
25394
|
+
* @param {string} authorization Bearer JWT token
|
|
25395
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25396
|
+
* @param {string} ruleId Rule ID
|
|
25397
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25398
|
+
* @param {*} [options] Override http request option.
|
|
25399
|
+
* @throws {RequiredError}
|
|
25400
|
+
*/
|
|
25401
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleResponse>> {
|
|
25402
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options);
|
|
25403
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25404
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut']?.[localVarOperationServerIndex]?.url;
|
|
25405
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25406
|
+
},
|
|
25407
|
+
/**
|
|
25408
|
+
* 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.
|
|
25409
|
+
* @summary Sync Rules to Typesense
|
|
25410
|
+
* @param {string} authorization Bearer JWT token
|
|
25411
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25412
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25413
|
+
* @param {*} [options] Override http request option.
|
|
25414
|
+
* @throws {RequiredError}
|
|
25415
|
+
*/
|
|
25416
|
+
async apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesAnalyticsRuleSyncResponse>> {
|
|
25417
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options);
|
|
25418
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25419
|
+
const localVarOperationServerBasePath = operationServerMap['AnalyticsRulesApi.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost']?.[localVarOperationServerIndex]?.url;
|
|
25420
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25421
|
+
},
|
|
25422
|
+
}
|
|
25423
|
+
};
|
|
25424
|
+
|
|
25425
|
+
/**
|
|
25426
|
+
* AnalyticsRulesApi - factory interface
|
|
25427
|
+
* @export
|
|
25428
|
+
*/
|
|
25429
|
+
export const AnalyticsRulesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25430
|
+
const localVarFp = AnalyticsRulesApiFp(configuration)
|
|
25431
|
+
return {
|
|
25432
|
+
/**
|
|
25433
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25434
|
+
* @summary List Analytics Rules
|
|
25435
|
+
* @param {string} authorization Bearer JWT token
|
|
25436
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25437
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25438
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25439
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25440
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25441
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25442
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25443
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25444
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25445
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25446
|
+
* @param {*} [options] Override http request option.
|
|
25447
|
+
* @throws {RequiredError}
|
|
25448
|
+
*/
|
|
25449
|
+
apiAdminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleListResponse> {
|
|
25450
|
+
return localVarFp.apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(axios, basePath));
|
|
25451
|
+
},
|
|
25452
|
+
/**
|
|
25453
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25454
|
+
* @summary Create Analytics Rule
|
|
25455
|
+
* @param {string} authorization Bearer JWT token
|
|
25456
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25457
|
+
* @param {*} [options] Override http request option.
|
|
25458
|
+
* @throws {RequiredError}
|
|
25459
|
+
*/
|
|
25460
|
+
apiAdminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25461
|
+
return localVarFp.apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
25462
|
+
},
|
|
25463
|
+
/**
|
|
25464
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25465
|
+
* @summary Delete Analytics Rule
|
|
25466
|
+
* @param {string} authorization Bearer JWT token
|
|
25467
|
+
* @param {string} ruleId Rule ID
|
|
25468
|
+
* @param {*} [options] Override http request option.
|
|
25469
|
+
* @throws {RequiredError}
|
|
25470
|
+
*/
|
|
25471
|
+
apiAdminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
|
|
25472
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options).then((request) => request(axios, basePath));
|
|
25473
|
+
},
|
|
25474
|
+
/**
|
|
25475
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25476
|
+
* @summary Get Analytics Rule
|
|
25477
|
+
* @param {string} authorization Bearer JWT token
|
|
25478
|
+
* @param {string} ruleId Rule ID
|
|
25479
|
+
* @param {*} [options] Override http request option.
|
|
25480
|
+
* @throws {RequiredError}
|
|
25481
|
+
*/
|
|
25482
|
+
apiAdminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25483
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options).then((request) => request(axios, basePath));
|
|
25484
|
+
},
|
|
25485
|
+
/**
|
|
25486
|
+
* 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.
|
|
25487
|
+
* @summary Update Analytics Rule
|
|
25488
|
+
* @param {string} authorization Bearer JWT token
|
|
25489
|
+
* @param {string} ruleId Rule ID
|
|
25490
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25491
|
+
* @param {*} [options] Override http request option.
|
|
25492
|
+
* @throws {RequiredError}
|
|
25493
|
+
*/
|
|
25494
|
+
apiAdminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25495
|
+
return localVarFp.apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
25496
|
+
},
|
|
25497
|
+
/**
|
|
25498
|
+
* 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.
|
|
25499
|
+
* @summary Sync Rules to Typesense
|
|
25500
|
+
* @param {string} authorization Bearer JWT token
|
|
25501
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25502
|
+
* @param {*} [options] Override http request option.
|
|
25503
|
+
* @throws {RequiredError}
|
|
25504
|
+
*/
|
|
25505
|
+
apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleSyncResponse> {
|
|
25506
|
+
return localVarFp.apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(axios, basePath));
|
|
25507
|
+
},
|
|
25508
|
+
/**
|
|
25509
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25510
|
+
* @summary List Analytics Rules
|
|
25511
|
+
* @param {string} authorization Bearer JWT token
|
|
25512
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25513
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25514
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25515
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25516
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25517
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25518
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25519
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25520
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25521
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25522
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25523
|
+
* @param {*} [options] Override http request option.
|
|
25524
|
+
* @throws {RequiredError}
|
|
25525
|
+
*/
|
|
25526
|
+
apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleListResponse> {
|
|
25527
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(axios, basePath));
|
|
25528
|
+
},
|
|
25529
|
+
/**
|
|
25530
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25531
|
+
* @summary Create Analytics Rule
|
|
25532
|
+
* @param {string} authorization Bearer JWT token
|
|
25533
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25534
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25535
|
+
* @param {*} [options] Override http request option.
|
|
25536
|
+
* @throws {RequiredError}
|
|
25537
|
+
*/
|
|
25538
|
+
apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25539
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
25540
|
+
},
|
|
25541
|
+
/**
|
|
25542
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25543
|
+
* @summary Delete Analytics Rule
|
|
25544
|
+
* @param {string} authorization Bearer JWT token
|
|
25545
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25546
|
+
* @param {string} ruleId Rule ID
|
|
25547
|
+
* @param {*} [options] Override http request option.
|
|
25548
|
+
* @throws {RequiredError}
|
|
25549
|
+
*/
|
|
25550
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
|
|
25551
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options).then((request) => request(axios, basePath));
|
|
25552
|
+
},
|
|
25553
|
+
/**
|
|
25554
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25555
|
+
* @summary Get Analytics Rule
|
|
25556
|
+
* @param {string} authorization Bearer JWT token
|
|
25557
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25558
|
+
* @param {string} ruleId Rule ID
|
|
25559
|
+
* @param {*} [options] Override http request option.
|
|
25560
|
+
* @throws {RequiredError}
|
|
25561
|
+
*/
|
|
25562
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25563
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options).then((request) => request(axios, basePath));
|
|
25564
|
+
},
|
|
25565
|
+
/**
|
|
25566
|
+
* 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.
|
|
25567
|
+
* @summary Update Analytics Rule
|
|
25568
|
+
* @param {string} authorization Bearer JWT token
|
|
25569
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25570
|
+
* @param {string} ruleId Rule ID
|
|
25571
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25572
|
+
* @param {*} [options] Override http request option.
|
|
25573
|
+
* @throws {RequiredError}
|
|
25574
|
+
*/
|
|
25575
|
+
apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleResponse> {
|
|
25576
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(axios, basePath));
|
|
25577
|
+
},
|
|
25578
|
+
/**
|
|
25579
|
+
* 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.
|
|
25580
|
+
* @summary Sync Rules to Typesense
|
|
25581
|
+
* @param {string} authorization Bearer JWT token
|
|
25582
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25583
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25584
|
+
* @param {*} [options] Override http request option.
|
|
25585
|
+
* @throws {RequiredError}
|
|
25586
|
+
*/
|
|
25587
|
+
apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesAnalyticsRuleSyncResponse> {
|
|
25588
|
+
return localVarFp.apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(axios, basePath));
|
|
25589
|
+
},
|
|
25590
|
+
};
|
|
25591
|
+
};
|
|
25592
|
+
|
|
25593
|
+
/**
|
|
25594
|
+
* AnalyticsRulesApi - object-oriented interface
|
|
25595
|
+
* @export
|
|
25596
|
+
* @class AnalyticsRulesApi
|
|
25597
|
+
* @extends {BaseAPI}
|
|
25598
|
+
*/
|
|
25599
|
+
export class AnalyticsRulesApi extends BaseAPI {
|
|
25600
|
+
/**
|
|
25601
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25602
|
+
* @summary List Analytics Rules
|
|
25603
|
+
* @param {string} authorization Bearer JWT token
|
|
25604
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25605
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25606
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25607
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25608
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25609
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25610
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25611
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25612
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25613
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25614
|
+
* @param {*} [options] Override http request option.
|
|
25615
|
+
* @throws {RequiredError}
|
|
25616
|
+
* @memberof AnalyticsRulesApi
|
|
25617
|
+
*/
|
|
25618
|
+
public apiAdminV1AnalyticsRulesGet(authorization: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig) {
|
|
25619
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesGet(authorization, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(this.axios, this.basePath));
|
|
25620
|
+
}
|
|
25621
|
+
|
|
25622
|
+
/**
|
|
25623
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25624
|
+
* @summary Create Analytics Rule
|
|
25625
|
+
* @param {string} authorization Bearer JWT token
|
|
25626
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25627
|
+
* @param {*} [options] Override http request option.
|
|
25628
|
+
* @throws {RequiredError}
|
|
25629
|
+
* @memberof AnalyticsRulesApi
|
|
25630
|
+
*/
|
|
25631
|
+
public apiAdminV1AnalyticsRulesPost(authorization: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) {
|
|
25632
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesPost(authorization, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25633
|
+
}
|
|
25634
|
+
|
|
25635
|
+
/**
|
|
25636
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25637
|
+
* @summary Delete Analytics Rule
|
|
25638
|
+
* @param {string} authorization Bearer JWT token
|
|
25639
|
+
* @param {string} ruleId Rule ID
|
|
25640
|
+
* @param {*} [options] Override http request option.
|
|
25641
|
+
* @throws {RequiredError}
|
|
25642
|
+
* @memberof AnalyticsRulesApi
|
|
25643
|
+
*/
|
|
25644
|
+
public apiAdminV1AnalyticsRulesRuleIdDelete(authorization: string, ruleId: string, options?: RawAxiosRequestConfig) {
|
|
25645
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesRuleIdDelete(authorization, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
25646
|
+
}
|
|
25647
|
+
|
|
25648
|
+
/**
|
|
25649
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25650
|
+
* @summary Get Analytics Rule
|
|
25651
|
+
* @param {string} authorization Bearer JWT token
|
|
25652
|
+
* @param {string} ruleId Rule ID
|
|
25653
|
+
* @param {*} [options] Override http request option.
|
|
25654
|
+
* @throws {RequiredError}
|
|
25655
|
+
* @memberof AnalyticsRulesApi
|
|
25656
|
+
*/
|
|
25657
|
+
public apiAdminV1AnalyticsRulesRuleIdGet(authorization: string, ruleId: string, options?: RawAxiosRequestConfig) {
|
|
25658
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesRuleIdGet(authorization, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
25659
|
+
}
|
|
25660
|
+
|
|
25661
|
+
/**
|
|
25662
|
+
* 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.
|
|
25663
|
+
* @summary Update Analytics Rule
|
|
25664
|
+
* @param {string} authorization Bearer JWT token
|
|
25665
|
+
* @param {string} ruleId Rule ID
|
|
25666
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25667
|
+
* @param {*} [options] Override http request option.
|
|
25668
|
+
* @throws {RequiredError}
|
|
25669
|
+
* @memberof AnalyticsRulesApi
|
|
25670
|
+
*/
|
|
25671
|
+
public apiAdminV1AnalyticsRulesRuleIdPut(authorization: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) {
|
|
25672
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesRuleIdPut(authorization, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25673
|
+
}
|
|
25674
|
+
|
|
25675
|
+
/**
|
|
25676
|
+
* 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.
|
|
25677
|
+
* @summary Sync Rules to Typesense
|
|
25678
|
+
* @param {string} authorization Bearer JWT token
|
|
25679
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25680
|
+
* @param {*} [options] Override http request option.
|
|
25681
|
+
* @throws {RequiredError}
|
|
25682
|
+
* @memberof AnalyticsRulesApi
|
|
25683
|
+
*/
|
|
25684
|
+
public apiAdminV1AnalyticsRulesSyncPost(authorization: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig) {
|
|
25685
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1AnalyticsRulesSyncPost(authorization, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25686
|
+
}
|
|
25687
|
+
|
|
25688
|
+
/**
|
|
25689
|
+
* Retrieve a paginated list of analytics rules with optional filtering by store, collection, and active status. Supports both page-based and offset-based pagination.
|
|
25690
|
+
* @summary List Analytics Rules
|
|
25691
|
+
* @param {string} authorization Bearer JWT token
|
|
25692
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25693
|
+
* @param {number} [storeId] Filter by store ID (for general routes)
|
|
25694
|
+
* @param {string} [collectionName] Filter by collection name
|
|
25695
|
+
* @param {boolean} [isActive] Filter by active status
|
|
25696
|
+
* @param {number} [page] Page number (1-based, alternative to limit/offset)
|
|
25697
|
+
* @param {number} [pageSize] Number of results per page (alternative to limit)
|
|
25698
|
+
* @param {number} [limit] Maximum number of results (default: 50)
|
|
25699
|
+
* @param {number} [offset] Offset for pagination (default: 0)
|
|
25700
|
+
* @param {string} [sortBy] Sort field (name, created_at, modified_at, rule_id)
|
|
25701
|
+
* @param {string} [sortOrder] Sort order (asc, desc, default: desc)
|
|
25702
|
+
* @param {string} [searchQuery] Search in rule names, descriptions, and rule_ids
|
|
25703
|
+
* @param {*} [options] Override http request option.
|
|
25704
|
+
* @throws {RequiredError}
|
|
25705
|
+
* @memberof AnalyticsRulesApi
|
|
25706
|
+
*/
|
|
25707
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization: string, xstoreid: string, storeId?: number, collectionName?: string, isActive?: boolean, page?: number, pageSize?: number, limit?: number, offset?: number, sortBy?: string, sortOrder?: string, searchQuery?: string, options?: RawAxiosRequestConfig) {
|
|
25708
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesGet(authorization, xstoreid, storeId, collectionName, isActive, page, pageSize, limit, offset, sortBy, sortOrder, searchQuery, options).then((request) => request(this.axios, this.basePath));
|
|
25709
|
+
}
|
|
25710
|
+
|
|
25711
|
+
/**
|
|
25712
|
+
* Create a new analytics rule for Typesense curation. Rules define how search results should be modified (promoted, hidden, filtered, sorted) based on query conditions.
|
|
25713
|
+
* @summary Create Analytics Rule
|
|
25714
|
+
* @param {string} authorization Bearer JWT token
|
|
25715
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25716
|
+
* @param {DataTypesCreateAnalyticsRuleRequest} dataTypesCreateAnalyticsRuleRequest Analytics rule configuration
|
|
25717
|
+
* @param {*} [options] Override http request option.
|
|
25718
|
+
* @throws {RequiredError}
|
|
25719
|
+
* @memberof AnalyticsRulesApi
|
|
25720
|
+
*/
|
|
25721
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization: string, xstoreid: string, dataTypesCreateAnalyticsRuleRequest: DataTypesCreateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) {
|
|
25722
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesPost(authorization, xstoreid, dataTypesCreateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25723
|
+
}
|
|
25724
|
+
|
|
25725
|
+
/**
|
|
25726
|
+
* Permanently delete an analytics rule from both the database and Typesense. This operation cannot be undone.
|
|
25727
|
+
* @summary Delete Analytics Rule
|
|
25728
|
+
* @param {string} authorization Bearer JWT token
|
|
25729
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25730
|
+
* @param {string} ruleId Rule ID
|
|
25731
|
+
* @param {*} [options] Override http request option.
|
|
25732
|
+
* @throws {RequiredError}
|
|
25733
|
+
* @memberof AnalyticsRulesApi
|
|
25734
|
+
*/
|
|
25735
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig) {
|
|
25736
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdDelete(authorization, xstoreid, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
25737
|
+
}
|
|
25738
|
+
|
|
25739
|
+
/**
|
|
25740
|
+
* Retrieve a specific analytics rule by its ID. Returns the complete rule configuration including Typesense override actions.
|
|
25741
|
+
* @summary Get Analytics Rule
|
|
25742
|
+
* @param {string} authorization Bearer JWT token
|
|
25743
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25744
|
+
* @param {string} ruleId Rule ID
|
|
25745
|
+
* @param {*} [options] Override http request option.
|
|
25746
|
+
* @throws {RequiredError}
|
|
25747
|
+
* @memberof AnalyticsRulesApi
|
|
25748
|
+
*/
|
|
25749
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization: string, xstoreid: string, ruleId: string, options?: RawAxiosRequestConfig) {
|
|
25750
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdGet(authorization, xstoreid, ruleId, options).then((request) => request(this.axios, this.basePath));
|
|
25751
|
+
}
|
|
25752
|
+
|
|
25753
|
+
/**
|
|
25754
|
+
* 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.
|
|
25755
|
+
* @summary Update Analytics Rule
|
|
25756
|
+
* @param {string} authorization Bearer JWT token
|
|
25757
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25758
|
+
* @param {string} ruleId Rule ID
|
|
25759
|
+
* @param {DataTypesUpdateAnalyticsRuleRequest} dataTypesUpdateAnalyticsRuleRequest Updated rule configuration (partial update supported)
|
|
25760
|
+
* @param {*} [options] Override http request option.
|
|
25761
|
+
* @throws {RequiredError}
|
|
25762
|
+
* @memberof AnalyticsRulesApi
|
|
25763
|
+
*/
|
|
25764
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization: string, xstoreid: string, ruleId: string, dataTypesUpdateAnalyticsRuleRequest: DataTypesUpdateAnalyticsRuleRequest, options?: RawAxiosRequestConfig) {
|
|
25765
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesRuleIdPut(authorization, xstoreid, ruleId, dataTypesUpdateAnalyticsRuleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25766
|
+
}
|
|
25767
|
+
|
|
25768
|
+
/**
|
|
25769
|
+
* 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.
|
|
25770
|
+
* @summary Sync Rules to Typesense
|
|
25771
|
+
* @param {string} authorization Bearer JWT token
|
|
25772
|
+
* @param {string} xstoreid Store ID (for store-specific routes)
|
|
25773
|
+
* @param {DataTypesAnalyticsRuleSyncRequest} dataTypesAnalyticsRuleSyncRequest Sync configuration (optional filters)
|
|
25774
|
+
* @param {*} [options] Override http request option.
|
|
25775
|
+
* @throws {RequiredError}
|
|
25776
|
+
* @memberof AnalyticsRulesApi
|
|
25777
|
+
*/
|
|
25778
|
+
public apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization: string, xstoreid: string, dataTypesAnalyticsRuleSyncRequest: DataTypesAnalyticsRuleSyncRequest, options?: RawAxiosRequestConfig) {
|
|
25779
|
+
return AnalyticsRulesApiFp(this.configuration).apiAdminV1StoresXstoreidAnalyticsRulesSyncPost(authorization, xstoreid, dataTypesAnalyticsRuleSyncRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25780
|
+
}
|
|
25781
|
+
}
|
|
25782
|
+
|
|
25783
|
+
|
|
25784
|
+
|
|
22919
25785
|
/**
|
|
22920
25786
|
* ArticlesApi - axios parameter creator
|
|
22921
25787
|
* @export
|
|
@@ -23556,6 +26422,193 @@ export class AuthApi extends BaseAPI {
|
|
|
23556
26422
|
|
|
23557
26423
|
|
|
23558
26424
|
|
|
26425
|
+
/**
|
|
26426
|
+
* AutomatedRefundManagementApi - axios parameter creator
|
|
26427
|
+
* @export
|
|
26428
|
+
*/
|
|
26429
|
+
export const AutomatedRefundManagementApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
26430
|
+
return {
|
|
26431
|
+
/**
|
|
26432
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
26433
|
+
* @summary Preview automated refund
|
|
26434
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
26435
|
+
* @param {*} [options] Override http request option.
|
|
26436
|
+
* @throws {RequiredError}
|
|
26437
|
+
*/
|
|
26438
|
+
apiRefundAutomatedPreviewPost: async (refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26439
|
+
// verify required parameter 'refundRefundPreviewRequestDto' is not null or undefined
|
|
26440
|
+
assertParamExists('apiRefundAutomatedPreviewPost', 'refundRefundPreviewRequestDto', refundRefundPreviewRequestDto)
|
|
26441
|
+
const localVarPath = `/api/refund/automated/preview`;
|
|
26442
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26443
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26444
|
+
let baseOptions;
|
|
26445
|
+
if (configuration) {
|
|
26446
|
+
baseOptions = configuration.baseOptions;
|
|
26447
|
+
}
|
|
26448
|
+
|
|
26449
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
26450
|
+
const localVarHeaderParameter = {} as any;
|
|
26451
|
+
const localVarQueryParameter = {} as any;
|
|
26452
|
+
|
|
26453
|
+
// authentication BearerAuth required
|
|
26454
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
26455
|
+
|
|
26456
|
+
|
|
26457
|
+
|
|
26458
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
26459
|
+
|
|
26460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
26461
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
26462
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
26463
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refundRefundPreviewRequestDto, localVarRequestOptions, configuration)
|
|
26464
|
+
|
|
26465
|
+
return {
|
|
26466
|
+
url: toPathString(localVarUrlObj),
|
|
26467
|
+
options: localVarRequestOptions,
|
|
26468
|
+
};
|
|
26469
|
+
},
|
|
26470
|
+
/**
|
|
26471
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
26472
|
+
* @summary Process automated refund
|
|
26473
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
26474
|
+
* @param {*} [options] Override http request option.
|
|
26475
|
+
* @throws {RequiredError}
|
|
26476
|
+
*/
|
|
26477
|
+
apiRefundAutomatedProcessPost: async (refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26478
|
+
// verify required parameter 'refundRefundPreviewRequestDto' is not null or undefined
|
|
26479
|
+
assertParamExists('apiRefundAutomatedProcessPost', 'refundRefundPreviewRequestDto', refundRefundPreviewRequestDto)
|
|
26480
|
+
const localVarPath = `/api/refund/automated/process`;
|
|
26481
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26482
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26483
|
+
let baseOptions;
|
|
26484
|
+
if (configuration) {
|
|
26485
|
+
baseOptions = configuration.baseOptions;
|
|
26486
|
+
}
|
|
26487
|
+
|
|
26488
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
26489
|
+
const localVarHeaderParameter = {} as any;
|
|
26490
|
+
const localVarQueryParameter = {} as any;
|
|
26491
|
+
|
|
26492
|
+
// authentication BearerAuth required
|
|
26493
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
26494
|
+
|
|
26495
|
+
|
|
26496
|
+
|
|
26497
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
26498
|
+
|
|
26499
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
26500
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
26501
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
26502
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refundRefundPreviewRequestDto, localVarRequestOptions, configuration)
|
|
26503
|
+
|
|
26504
|
+
return {
|
|
26505
|
+
url: toPathString(localVarUrlObj),
|
|
26506
|
+
options: localVarRequestOptions,
|
|
26507
|
+
};
|
|
26508
|
+
},
|
|
26509
|
+
}
|
|
26510
|
+
};
|
|
26511
|
+
|
|
26512
|
+
/**
|
|
26513
|
+
* AutomatedRefundManagementApi - functional programming interface
|
|
26514
|
+
* @export
|
|
26515
|
+
*/
|
|
26516
|
+
export const AutomatedRefundManagementApiFp = function(configuration?: Configuration) {
|
|
26517
|
+
const localVarAxiosParamCreator = AutomatedRefundManagementApiAxiosParamCreator(configuration)
|
|
26518
|
+
return {
|
|
26519
|
+
/**
|
|
26520
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
26521
|
+
* @summary Preview automated refund
|
|
26522
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
26523
|
+
* @param {*} [options] Override http request option.
|
|
26524
|
+
* @throws {RequiredError}
|
|
26525
|
+
*/
|
|
26526
|
+
async apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseRefundRefundPreviewResponseDto>> {
|
|
26527
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options);
|
|
26528
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26529
|
+
const localVarOperationServerBasePath = operationServerMap['AutomatedRefundManagementApi.apiRefundAutomatedPreviewPost']?.[localVarOperationServerIndex]?.url;
|
|
26530
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26531
|
+
},
|
|
26532
|
+
/**
|
|
26533
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
26534
|
+
* @summary Process automated refund
|
|
26535
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
26536
|
+
* @param {*} [options] Override http request option.
|
|
26537
|
+
* @throws {RequiredError}
|
|
26538
|
+
*/
|
|
26539
|
+
async apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesProcessRefundResponseDto>> {
|
|
26540
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options);
|
|
26541
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26542
|
+
const localVarOperationServerBasePath = operationServerMap['AutomatedRefundManagementApi.apiRefundAutomatedProcessPost']?.[localVarOperationServerIndex]?.url;
|
|
26543
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26544
|
+
},
|
|
26545
|
+
}
|
|
26546
|
+
};
|
|
26547
|
+
|
|
26548
|
+
/**
|
|
26549
|
+
* AutomatedRefundManagementApi - factory interface
|
|
26550
|
+
* @export
|
|
26551
|
+
*/
|
|
26552
|
+
export const AutomatedRefundManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
26553
|
+
const localVarFp = AutomatedRefundManagementApiFp(configuration)
|
|
26554
|
+
return {
|
|
26555
|
+
/**
|
|
26556
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
26557
|
+
* @summary Preview automated refund
|
|
26558
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
26559
|
+
* @param {*} [options] Override http request option.
|
|
26560
|
+
* @throws {RequiredError}
|
|
26561
|
+
*/
|
|
26562
|
+
apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseRefundRefundPreviewResponseDto> {
|
|
26563
|
+
return localVarFp.apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options).then((request) => request(axios, basePath));
|
|
26564
|
+
},
|
|
26565
|
+
/**
|
|
26566
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
26567
|
+
* @summary Process automated refund
|
|
26568
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
26569
|
+
* @param {*} [options] Override http request option.
|
|
26570
|
+
* @throws {RequiredError}
|
|
26571
|
+
*/
|
|
26572
|
+
apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesProcessRefundResponseDto> {
|
|
26573
|
+
return localVarFp.apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options).then((request) => request(axios, basePath));
|
|
26574
|
+
},
|
|
26575
|
+
};
|
|
26576
|
+
};
|
|
26577
|
+
|
|
26578
|
+
/**
|
|
26579
|
+
* AutomatedRefundManagementApi - object-oriented interface
|
|
26580
|
+
* @export
|
|
26581
|
+
* @class AutomatedRefundManagementApi
|
|
26582
|
+
* @extends {BaseAPI}
|
|
26583
|
+
*/
|
|
26584
|
+
export class AutomatedRefundManagementApi extends BaseAPI {
|
|
26585
|
+
/**
|
|
26586
|
+
* Shows detailed refund calculation, subscription cancellation, and Razorpay processing details before execution
|
|
26587
|
+
* @summary Preview automated refund
|
|
26588
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Refund preview request
|
|
26589
|
+
* @param {*} [options] Override http request option.
|
|
26590
|
+
* @throws {RequiredError}
|
|
26591
|
+
* @memberof AutomatedRefundManagementApi
|
|
26592
|
+
*/
|
|
26593
|
+
public apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig) {
|
|
26594
|
+
return AutomatedRefundManagementApiFp(this.configuration).apiRefundAutomatedPreviewPost(refundRefundPreviewRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
26595
|
+
}
|
|
26596
|
+
|
|
26597
|
+
/**
|
|
26598
|
+
* Processes refund automatically with subscription cancellation, Razorpay integration, and credit adjustments
|
|
26599
|
+
* @summary Process automated refund
|
|
26600
|
+
* @param {RefundRefundPreviewRequestDto} refundRefundPreviewRequestDto Automated refund processing request
|
|
26601
|
+
* @param {*} [options] Override http request option.
|
|
26602
|
+
* @throws {RequiredError}
|
|
26603
|
+
* @memberof AutomatedRefundManagementApi
|
|
26604
|
+
*/
|
|
26605
|
+
public apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig) {
|
|
26606
|
+
return AutomatedRefundManagementApiFp(this.configuration).apiRefundAutomatedProcessPost(refundRefundPreviewRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
26607
|
+
}
|
|
26608
|
+
}
|
|
26609
|
+
|
|
26610
|
+
|
|
26611
|
+
|
|
23559
26612
|
/**
|
|
23560
26613
|
* BillingDashboardApi - axios parameter creator
|
|
23561
26614
|
* @export
|
|
@@ -37664,6 +40717,189 @@ export class QuerySuggestionsManagementApi extends BaseAPI {
|
|
|
37664
40717
|
*/
|
|
37665
40718
|
export const RefundManagementApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
37666
40719
|
return {
|
|
40720
|
+
/**
|
|
40721
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
40722
|
+
* @summary Calculate refund amount
|
|
40723
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
40724
|
+
* @param {*} [options] Override http request option.
|
|
40725
|
+
* @throws {RequiredError}
|
|
40726
|
+
*/
|
|
40727
|
+
apiRefundCalculatePost: async (dataTypesRefundCalculationRequestDto: DataTypesRefundCalculationRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40728
|
+
// verify required parameter 'dataTypesRefundCalculationRequestDto' is not null or undefined
|
|
40729
|
+
assertParamExists('apiRefundCalculatePost', 'dataTypesRefundCalculationRequestDto', dataTypesRefundCalculationRequestDto)
|
|
40730
|
+
const localVarPath = `/api/refund/calculate`;
|
|
40731
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40732
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40733
|
+
let baseOptions;
|
|
40734
|
+
if (configuration) {
|
|
40735
|
+
baseOptions = configuration.baseOptions;
|
|
40736
|
+
}
|
|
40737
|
+
|
|
40738
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
40739
|
+
const localVarHeaderParameter = {} as any;
|
|
40740
|
+
const localVarQueryParameter = {} as any;
|
|
40741
|
+
|
|
40742
|
+
// authentication BearerAuth required
|
|
40743
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
40744
|
+
|
|
40745
|
+
|
|
40746
|
+
|
|
40747
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
40748
|
+
|
|
40749
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40750
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40751
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40752
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesRefundCalculationRequestDto, localVarRequestOptions, configuration)
|
|
40753
|
+
|
|
40754
|
+
return {
|
|
40755
|
+
url: toPathString(localVarUrlObj),
|
|
40756
|
+
options: localVarRequestOptions,
|
|
40757
|
+
};
|
|
40758
|
+
},
|
|
40759
|
+
/**
|
|
40760
|
+
* Checks if a payment is eligible for refund
|
|
40761
|
+
* @summary Check refund eligibility
|
|
40762
|
+
* @param {number} paymentId Payment ID
|
|
40763
|
+
* @param {*} [options] Override http request option.
|
|
40764
|
+
* @throws {RequiredError}
|
|
40765
|
+
*/
|
|
40766
|
+
apiRefundEligibilityPaymentIdGet: async (paymentId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40767
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
40768
|
+
assertParamExists('apiRefundEligibilityPaymentIdGet', 'paymentId', paymentId)
|
|
40769
|
+
const localVarPath = `/api/refund/eligibility/{payment_id}`
|
|
40770
|
+
.replace(`{${"payment_id"}}`, encodeURIComponent(String(paymentId)));
|
|
40771
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40772
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40773
|
+
let baseOptions;
|
|
40774
|
+
if (configuration) {
|
|
40775
|
+
baseOptions = configuration.baseOptions;
|
|
40776
|
+
}
|
|
40777
|
+
|
|
40778
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40779
|
+
const localVarHeaderParameter = {} as any;
|
|
40780
|
+
const localVarQueryParameter = {} as any;
|
|
40781
|
+
|
|
40782
|
+
// authentication BearerAuth required
|
|
40783
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
40784
|
+
|
|
40785
|
+
|
|
40786
|
+
|
|
40787
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40788
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40789
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40790
|
+
|
|
40791
|
+
return {
|
|
40792
|
+
url: toPathString(localVarUrlObj),
|
|
40793
|
+
options: localVarRequestOptions,
|
|
40794
|
+
};
|
|
40795
|
+
},
|
|
40796
|
+
/**
|
|
40797
|
+
* Retrieves refund history for an organization with filtering options
|
|
40798
|
+
* @summary Get refund history
|
|
40799
|
+
* @param {number} [orgId] Organization ID
|
|
40800
|
+
* @param {number} [paymentId] Payment ID
|
|
40801
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
40802
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
40803
|
+
* @param {string} [status] Refund status
|
|
40804
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
40805
|
+
* @param {number} [offset] Offset (default 0)
|
|
40806
|
+
* @param {*} [options] Override http request option.
|
|
40807
|
+
* @throws {RequiredError}
|
|
40808
|
+
*/
|
|
40809
|
+
apiRefundHistoryGet: async (orgId?: number, paymentId?: number, startDate?: string, endDate?: string, status?: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40810
|
+
const localVarPath = `/api/refund/history`;
|
|
40811
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40812
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40813
|
+
let baseOptions;
|
|
40814
|
+
if (configuration) {
|
|
40815
|
+
baseOptions = configuration.baseOptions;
|
|
40816
|
+
}
|
|
40817
|
+
|
|
40818
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40819
|
+
const localVarHeaderParameter = {} as any;
|
|
40820
|
+
const localVarQueryParameter = {} as any;
|
|
40821
|
+
|
|
40822
|
+
// authentication BearerAuth required
|
|
40823
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
40824
|
+
|
|
40825
|
+
if (orgId !== undefined) {
|
|
40826
|
+
localVarQueryParameter['org_id'] = orgId;
|
|
40827
|
+
}
|
|
40828
|
+
|
|
40829
|
+
if (paymentId !== undefined) {
|
|
40830
|
+
localVarQueryParameter['payment_id'] = paymentId;
|
|
40831
|
+
}
|
|
40832
|
+
|
|
40833
|
+
if (startDate !== undefined) {
|
|
40834
|
+
localVarQueryParameter['start_date'] = startDate;
|
|
40835
|
+
}
|
|
40836
|
+
|
|
40837
|
+
if (endDate !== undefined) {
|
|
40838
|
+
localVarQueryParameter['end_date'] = endDate;
|
|
40839
|
+
}
|
|
40840
|
+
|
|
40841
|
+
if (status !== undefined) {
|
|
40842
|
+
localVarQueryParameter['status'] = status;
|
|
40843
|
+
}
|
|
40844
|
+
|
|
40845
|
+
if (limit !== undefined) {
|
|
40846
|
+
localVarQueryParameter['limit'] = limit;
|
|
40847
|
+
}
|
|
40848
|
+
|
|
40849
|
+
if (offset !== undefined) {
|
|
40850
|
+
localVarQueryParameter['offset'] = offset;
|
|
40851
|
+
}
|
|
40852
|
+
|
|
40853
|
+
|
|
40854
|
+
|
|
40855
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40856
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40857
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40858
|
+
|
|
40859
|
+
return {
|
|
40860
|
+
url: toPathString(localVarUrlObj),
|
|
40861
|
+
options: localVarRequestOptions,
|
|
40862
|
+
};
|
|
40863
|
+
},
|
|
40864
|
+
/**
|
|
40865
|
+
* Processes a refund request and executes credit adjustments
|
|
40866
|
+
* @summary Process refund
|
|
40867
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
40868
|
+
* @param {*} [options] Override http request option.
|
|
40869
|
+
* @throws {RequiredError}
|
|
40870
|
+
*/
|
|
40871
|
+
apiRefundProcessPost: async (dataTypesProcessRefundRequestDto: DataTypesProcessRefundRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40872
|
+
// verify required parameter 'dataTypesProcessRefundRequestDto' is not null or undefined
|
|
40873
|
+
assertParamExists('apiRefundProcessPost', 'dataTypesProcessRefundRequestDto', dataTypesProcessRefundRequestDto)
|
|
40874
|
+
const localVarPath = `/api/refund/process`;
|
|
40875
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40876
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40877
|
+
let baseOptions;
|
|
40878
|
+
if (configuration) {
|
|
40879
|
+
baseOptions = configuration.baseOptions;
|
|
40880
|
+
}
|
|
40881
|
+
|
|
40882
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
40883
|
+
const localVarHeaderParameter = {} as any;
|
|
40884
|
+
const localVarQueryParameter = {} as any;
|
|
40885
|
+
|
|
40886
|
+
// authentication BearerAuth required
|
|
40887
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
40888
|
+
|
|
40889
|
+
|
|
40890
|
+
|
|
40891
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
40892
|
+
|
|
40893
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40894
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40895
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40896
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesProcessRefundRequestDto, localVarRequestOptions, configuration)
|
|
40897
|
+
|
|
40898
|
+
return {
|
|
40899
|
+
url: toPathString(localVarUrlObj),
|
|
40900
|
+
options: localVarRequestOptions,
|
|
40901
|
+
};
|
|
40902
|
+
},
|
|
37667
40903
|
/**
|
|
37668
40904
|
* Approves or rejects a pending refund request
|
|
37669
40905
|
* @summary Process refund approval or rejection
|
|
@@ -37905,6 +41141,64 @@ export const RefundManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
37905
41141
|
export const RefundManagementApiFp = function(configuration?: Configuration) {
|
|
37906
41142
|
const localVarAxiosParamCreator = RefundManagementApiAxiosParamCreator(configuration)
|
|
37907
41143
|
return {
|
|
41144
|
+
/**
|
|
41145
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
41146
|
+
* @summary Calculate refund amount
|
|
41147
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
41148
|
+
* @param {*} [options] Override http request option.
|
|
41149
|
+
* @throws {RequiredError}
|
|
41150
|
+
*/
|
|
41151
|
+
async apiRefundCalculatePost(dataTypesRefundCalculationRequestDto: DataTypesRefundCalculationRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesRefundCalculationResponseDto>> {
|
|
41152
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options);
|
|
41153
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
41154
|
+
const localVarOperationServerBasePath = operationServerMap['RefundManagementApi.apiRefundCalculatePost']?.[localVarOperationServerIndex]?.url;
|
|
41155
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41156
|
+
},
|
|
41157
|
+
/**
|
|
41158
|
+
* Checks if a payment is eligible for refund
|
|
41159
|
+
* @summary Check refund eligibility
|
|
41160
|
+
* @param {number} paymentId Payment ID
|
|
41161
|
+
* @param {*} [options] Override http request option.
|
|
41162
|
+
* @throws {RequiredError}
|
|
41163
|
+
*/
|
|
41164
|
+
async apiRefundEligibilityPaymentIdGet(paymentId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesRefundEligibilityDto>> {
|
|
41165
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundEligibilityPaymentIdGet(paymentId, options);
|
|
41166
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
41167
|
+
const localVarOperationServerBasePath = operationServerMap['RefundManagementApi.apiRefundEligibilityPaymentIdGet']?.[localVarOperationServerIndex]?.url;
|
|
41168
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41169
|
+
},
|
|
41170
|
+
/**
|
|
41171
|
+
* Retrieves refund history for an organization with filtering options
|
|
41172
|
+
* @summary Get refund history
|
|
41173
|
+
* @param {number} [orgId] Organization ID
|
|
41174
|
+
* @param {number} [paymentId] Payment ID
|
|
41175
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
41176
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
41177
|
+
* @param {string} [status] Refund status
|
|
41178
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
41179
|
+
* @param {number} [offset] Offset (default 0)
|
|
41180
|
+
* @param {*} [options] Override http request option.
|
|
41181
|
+
* @throws {RequiredError}
|
|
41182
|
+
*/
|
|
41183
|
+
async apiRefundHistoryGet(orgId?: number, paymentId?: number, startDate?: string, endDate?: string, status?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto>> {
|
|
41184
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options);
|
|
41185
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
41186
|
+
const localVarOperationServerBasePath = operationServerMap['RefundManagementApi.apiRefundHistoryGet']?.[localVarOperationServerIndex]?.url;
|
|
41187
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41188
|
+
},
|
|
41189
|
+
/**
|
|
41190
|
+
* Processes a refund request and executes credit adjustments
|
|
41191
|
+
* @summary Process refund
|
|
41192
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
41193
|
+
* @param {*} [options] Override http request option.
|
|
41194
|
+
* @throws {RequiredError}
|
|
41195
|
+
*/
|
|
41196
|
+
async apiRefundProcessPost(dataTypesProcessRefundRequestDto: DataTypesProcessRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesProcessRefundResponseDto>> {
|
|
41197
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiRefundProcessPost(dataTypesProcessRefundRequestDto, options);
|
|
41198
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
41199
|
+
const localVarOperationServerBasePath = operationServerMap['RefundManagementApi.apiRefundProcessPost']?.[localVarOperationServerIndex]?.url;
|
|
41200
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
41201
|
+
},
|
|
37908
41202
|
/**
|
|
37909
41203
|
* Approves or rejects a pending refund request
|
|
37910
41204
|
* @summary Process refund approval or rejection
|
|
@@ -37988,6 +41282,52 @@ export const RefundManagementApiFp = function(configuration?: Configuration) {
|
|
|
37988
41282
|
export const RefundManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
37989
41283
|
const localVarFp = RefundManagementApiFp(configuration)
|
|
37990
41284
|
return {
|
|
41285
|
+
/**
|
|
41286
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
41287
|
+
* @summary Calculate refund amount
|
|
41288
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
41289
|
+
* @param {*} [options] Override http request option.
|
|
41290
|
+
* @throws {RequiredError}
|
|
41291
|
+
*/
|
|
41292
|
+
apiRefundCalculatePost(dataTypesRefundCalculationRequestDto: DataTypesRefundCalculationRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesRefundCalculationResponseDto> {
|
|
41293
|
+
return localVarFp.apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options).then((request) => request(axios, basePath));
|
|
41294
|
+
},
|
|
41295
|
+
/**
|
|
41296
|
+
* Checks if a payment is eligible for refund
|
|
41297
|
+
* @summary Check refund eligibility
|
|
41298
|
+
* @param {number} paymentId Payment ID
|
|
41299
|
+
* @param {*} [options] Override http request option.
|
|
41300
|
+
* @throws {RequiredError}
|
|
41301
|
+
*/
|
|
41302
|
+
apiRefundEligibilityPaymentIdGet(paymentId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesRefundEligibilityDto> {
|
|
41303
|
+
return localVarFp.apiRefundEligibilityPaymentIdGet(paymentId, options).then((request) => request(axios, basePath));
|
|
41304
|
+
},
|
|
41305
|
+
/**
|
|
41306
|
+
* Retrieves refund history for an organization with filtering options
|
|
41307
|
+
* @summary Get refund history
|
|
41308
|
+
* @param {number} [orgId] Organization ID
|
|
41309
|
+
* @param {number} [paymentId] Payment ID
|
|
41310
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
41311
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
41312
|
+
* @param {string} [status] Refund status
|
|
41313
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
41314
|
+
* @param {number} [offset] Offset (default 0)
|
|
41315
|
+
* @param {*} [options] Override http request option.
|
|
41316
|
+
* @throws {RequiredError}
|
|
41317
|
+
*/
|
|
41318
|
+
apiRefundHistoryGet(orgId?: number, paymentId?: number, startDate?: string, endDate?: string, status?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesGetRefundHistoryResponseDto> {
|
|
41319
|
+
return localVarFp.apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options).then((request) => request(axios, basePath));
|
|
41320
|
+
},
|
|
41321
|
+
/**
|
|
41322
|
+
* Processes a refund request and executes credit adjustments
|
|
41323
|
+
* @summary Process refund
|
|
41324
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
41325
|
+
* @param {*} [options] Override http request option.
|
|
41326
|
+
* @throws {RequiredError}
|
|
41327
|
+
*/
|
|
41328
|
+
apiRefundProcessPost(dataTypesProcessRefundRequestDto: DataTypesProcessRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesProcessRefundResponseDto> {
|
|
41329
|
+
return localVarFp.apiRefundProcessPost(dataTypesProcessRefundRequestDto, options).then((request) => request(axios, basePath));
|
|
41330
|
+
},
|
|
37991
41331
|
/**
|
|
37992
41332
|
* Approves or rejects a pending refund request
|
|
37993
41333
|
* @summary Process refund approval or rejection
|
|
@@ -38056,6 +41396,60 @@ export const RefundManagementApiFactory = function (configuration?: Configuratio
|
|
|
38056
41396
|
* @extends {BaseAPI}
|
|
38057
41397
|
*/
|
|
38058
41398
|
export class RefundManagementApi extends BaseAPI {
|
|
41399
|
+
/**
|
|
41400
|
+
* Calculates refund amount based on remaining credits and original credit pricing
|
|
41401
|
+
* @summary Calculate refund amount
|
|
41402
|
+
* @param {DataTypesRefundCalculationRequestDto} dataTypesRefundCalculationRequestDto Refund calculation request
|
|
41403
|
+
* @param {*} [options] Override http request option.
|
|
41404
|
+
* @throws {RequiredError}
|
|
41405
|
+
* @memberof RefundManagementApi
|
|
41406
|
+
*/
|
|
41407
|
+
public apiRefundCalculatePost(dataTypesRefundCalculationRequestDto: DataTypesRefundCalculationRequestDto, options?: RawAxiosRequestConfig) {
|
|
41408
|
+
return RefundManagementApiFp(this.configuration).apiRefundCalculatePost(dataTypesRefundCalculationRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
41409
|
+
}
|
|
41410
|
+
|
|
41411
|
+
/**
|
|
41412
|
+
* Checks if a payment is eligible for refund
|
|
41413
|
+
* @summary Check refund eligibility
|
|
41414
|
+
* @param {number} paymentId Payment ID
|
|
41415
|
+
* @param {*} [options] Override http request option.
|
|
41416
|
+
* @throws {RequiredError}
|
|
41417
|
+
* @memberof RefundManagementApi
|
|
41418
|
+
*/
|
|
41419
|
+
public apiRefundEligibilityPaymentIdGet(paymentId: number, options?: RawAxiosRequestConfig) {
|
|
41420
|
+
return RefundManagementApiFp(this.configuration).apiRefundEligibilityPaymentIdGet(paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
41421
|
+
}
|
|
41422
|
+
|
|
41423
|
+
/**
|
|
41424
|
+
* Retrieves refund history for an organization with filtering options
|
|
41425
|
+
* @summary Get refund history
|
|
41426
|
+
* @param {number} [orgId] Organization ID
|
|
41427
|
+
* @param {number} [paymentId] Payment ID
|
|
41428
|
+
* @param {string} [startDate] Start date (RFC3339)
|
|
41429
|
+
* @param {string} [endDate] End date (RFC3339)
|
|
41430
|
+
* @param {string} [status] Refund status
|
|
41431
|
+
* @param {number} [limit] Limit (default 20, max 100)
|
|
41432
|
+
* @param {number} [offset] Offset (default 0)
|
|
41433
|
+
* @param {*} [options] Override http request option.
|
|
41434
|
+
* @throws {RequiredError}
|
|
41435
|
+
* @memberof RefundManagementApi
|
|
41436
|
+
*/
|
|
41437
|
+
public apiRefundHistoryGet(orgId?: number, paymentId?: number, startDate?: string, endDate?: string, status?: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
|
|
41438
|
+
return RefundManagementApiFp(this.configuration).apiRefundHistoryGet(orgId, paymentId, startDate, endDate, status, limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
41439
|
+
}
|
|
41440
|
+
|
|
41441
|
+
/**
|
|
41442
|
+
* Processes a refund request and executes credit adjustments
|
|
41443
|
+
* @summary Process refund
|
|
41444
|
+
* @param {DataTypesProcessRefundRequestDto} dataTypesProcessRefundRequestDto Refund processing request
|
|
41445
|
+
* @param {*} [options] Override http request option.
|
|
41446
|
+
* @throws {RequiredError}
|
|
41447
|
+
* @memberof RefundManagementApi
|
|
41448
|
+
*/
|
|
41449
|
+
public apiRefundProcessPost(dataTypesProcessRefundRequestDto: DataTypesProcessRefundRequestDto, options?: RawAxiosRequestConfig) {
|
|
41450
|
+
return RefundManagementApiFp(this.configuration).apiRefundProcessPost(dataTypesProcessRefundRequestDto, options).then((request) => request(this.axios, this.basePath));
|
|
41451
|
+
}
|
|
41452
|
+
|
|
38059
41453
|
/**
|
|
38060
41454
|
* Approves or rejects a pending refund request
|
|
38061
41455
|
* @summary Process refund approval or rejection
|
|
@@ -42493,6 +45887,84 @@ export class StoresApi extends BaseAPI {
|
|
|
42493
45887
|
*/
|
|
42494
45888
|
export const SubscriptionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
42495
45889
|
return {
|
|
45890
|
+
/**
|
|
45891
|
+
* Shows detailed preview of subscription cancellation including credit calculation, billing period info, and potential refund
|
|
45892
|
+
* @summary Preview subscription cancellation details
|
|
45893
|
+
* @param {SubscriptionRouteCancelPreviewRequest} subscriptionRouteCancelPreviewRequest Cancellation preview request
|
|
45894
|
+
* @param {*} [options] Override http request option.
|
|
45895
|
+
* @throws {RequiredError}
|
|
45896
|
+
*/
|
|
45897
|
+
adminSubscriptionsCancelPreviewPost: async (subscriptionRouteCancelPreviewRequest: SubscriptionRouteCancelPreviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45898
|
+
// verify required parameter 'subscriptionRouteCancelPreviewRequest' is not null or undefined
|
|
45899
|
+
assertParamExists('adminSubscriptionsCancelPreviewPost', 'subscriptionRouteCancelPreviewRequest', subscriptionRouteCancelPreviewRequest)
|
|
45900
|
+
const localVarPath = `/admin/subscriptions/cancel/preview`;
|
|
45901
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45902
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
45903
|
+
let baseOptions;
|
|
45904
|
+
if (configuration) {
|
|
45905
|
+
baseOptions = configuration.baseOptions;
|
|
45906
|
+
}
|
|
45907
|
+
|
|
45908
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
45909
|
+
const localVarHeaderParameter = {} as any;
|
|
45910
|
+
const localVarQueryParameter = {} as any;
|
|
45911
|
+
|
|
45912
|
+
// authentication BearerAuth required
|
|
45913
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
45914
|
+
|
|
45915
|
+
|
|
45916
|
+
|
|
45917
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
45918
|
+
|
|
45919
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
45920
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
45921
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
45922
|
+
localVarRequestOptions.data = serializeDataIfNeeded(subscriptionRouteCancelPreviewRequest, localVarRequestOptions, configuration)
|
|
45923
|
+
|
|
45924
|
+
return {
|
|
45925
|
+
url: toPathString(localVarUrlObj),
|
|
45926
|
+
options: localVarRequestOptions,
|
|
45927
|
+
};
|
|
45928
|
+
},
|
|
45929
|
+
/**
|
|
45930
|
+
* Cancels the subscription, removes unused credits, and processes refund if applicable
|
|
45931
|
+
* @summary Process subscription cancellation
|
|
45932
|
+
* @param {SubscriptionRouteCancelProcessRequest} subscriptionRouteCancelProcessRequest Cancellation process request
|
|
45933
|
+
* @param {*} [options] Override http request option.
|
|
45934
|
+
* @throws {RequiredError}
|
|
45935
|
+
*/
|
|
45936
|
+
adminSubscriptionsCancelProcessPost: async (subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45937
|
+
// verify required parameter 'subscriptionRouteCancelProcessRequest' is not null or undefined
|
|
45938
|
+
assertParamExists('adminSubscriptionsCancelProcessPost', 'subscriptionRouteCancelProcessRequest', subscriptionRouteCancelProcessRequest)
|
|
45939
|
+
const localVarPath = `/admin/subscriptions/cancel/process`;
|
|
45940
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45941
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
45942
|
+
let baseOptions;
|
|
45943
|
+
if (configuration) {
|
|
45944
|
+
baseOptions = configuration.baseOptions;
|
|
45945
|
+
}
|
|
45946
|
+
|
|
45947
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
45948
|
+
const localVarHeaderParameter = {} as any;
|
|
45949
|
+
const localVarQueryParameter = {} as any;
|
|
45950
|
+
|
|
45951
|
+
// authentication BearerAuth required
|
|
45952
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
45953
|
+
|
|
45954
|
+
|
|
45955
|
+
|
|
45956
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
45957
|
+
|
|
45958
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
45959
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
45960
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
45961
|
+
localVarRequestOptions.data = serializeDataIfNeeded(subscriptionRouteCancelProcessRequest, localVarRequestOptions, configuration)
|
|
45962
|
+
|
|
45963
|
+
return {
|
|
45964
|
+
url: toPathString(localVarUrlObj),
|
|
45965
|
+
options: localVarRequestOptions,
|
|
45966
|
+
};
|
|
45967
|
+
},
|
|
42496
45968
|
/**
|
|
42497
45969
|
* Updates Subscription information by ID.
|
|
42498
45970
|
* @summary Update an existing Subscription
|
|
@@ -42696,6 +46168,32 @@ export const SubscriptionsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
42696
46168
|
export const SubscriptionsApiFp = function(configuration?: Configuration) {
|
|
42697
46169
|
const localVarAxiosParamCreator = SubscriptionsApiAxiosParamCreator(configuration)
|
|
42698
46170
|
return {
|
|
46171
|
+
/**
|
|
46172
|
+
* Shows detailed preview of subscription cancellation including credit calculation, billing period info, and potential refund
|
|
46173
|
+
* @summary Preview subscription cancellation details
|
|
46174
|
+
* @param {SubscriptionRouteCancelPreviewRequest} subscriptionRouteCancelPreviewRequest Cancellation preview request
|
|
46175
|
+
* @param {*} [options] Override http request option.
|
|
46176
|
+
* @throws {RequiredError}
|
|
46177
|
+
*/
|
|
46178
|
+
async adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest: SubscriptionRouteCancelPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
46179
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest, options);
|
|
46180
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
46181
|
+
const localVarOperationServerBasePath = operationServerMap['SubscriptionsApi.adminSubscriptionsCancelPreviewPost']?.[localVarOperationServerIndex]?.url;
|
|
46182
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
46183
|
+
},
|
|
46184
|
+
/**
|
|
46185
|
+
* Cancels the subscription, removes unused credits, and processes refund if applicable
|
|
46186
|
+
* @summary Process subscription cancellation
|
|
46187
|
+
* @param {SubscriptionRouteCancelProcessRequest} subscriptionRouteCancelProcessRequest Cancellation process request
|
|
46188
|
+
* @param {*} [options] Override http request option.
|
|
46189
|
+
* @throws {RequiredError}
|
|
46190
|
+
*/
|
|
46191
|
+
async adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>> {
|
|
46192
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest, options);
|
|
46193
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
46194
|
+
const localVarOperationServerBasePath = operationServerMap['SubscriptionsApi.adminSubscriptionsCancelProcessPost']?.[localVarOperationServerIndex]?.url;
|
|
46195
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
46196
|
+
},
|
|
42699
46197
|
/**
|
|
42700
46198
|
* Updates Subscription information by ID.
|
|
42701
46199
|
* @summary Update an existing Subscription
|
|
@@ -42772,6 +46270,26 @@ export const SubscriptionsApiFp = function(configuration?: Configuration) {
|
|
|
42772
46270
|
export const SubscriptionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
42773
46271
|
const localVarFp = SubscriptionsApiFp(configuration)
|
|
42774
46272
|
return {
|
|
46273
|
+
/**
|
|
46274
|
+
* Shows detailed preview of subscription cancellation including credit calculation, billing period info, and potential refund
|
|
46275
|
+
* @summary Preview subscription cancellation details
|
|
46276
|
+
* @param {SubscriptionRouteCancelPreviewRequest} subscriptionRouteCancelPreviewRequest Cancellation preview request
|
|
46277
|
+
* @param {*} [options] Override http request option.
|
|
46278
|
+
* @throws {RequiredError}
|
|
46279
|
+
*/
|
|
46280
|
+
adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest: SubscriptionRouteCancelPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
46281
|
+
return localVarFp.adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest, options).then((request) => request(axios, basePath));
|
|
46282
|
+
},
|
|
46283
|
+
/**
|
|
46284
|
+
* Cancels the subscription, removes unused credits, and processes refund if applicable
|
|
46285
|
+
* @summary Process subscription cancellation
|
|
46286
|
+
* @param {SubscriptionRouteCancelProcessRequest} subscriptionRouteCancelProcessRequest Cancellation process request
|
|
46287
|
+
* @param {*} [options] Override http request option.
|
|
46288
|
+
* @throws {RequiredError}
|
|
46289
|
+
*/
|
|
46290
|
+
adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
|
|
46291
|
+
return localVarFp.adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest, options).then((request) => request(axios, basePath));
|
|
46292
|
+
},
|
|
42775
46293
|
/**
|
|
42776
46294
|
* Updates Subscription information by ID.
|
|
42777
46295
|
* @summary Update an existing Subscription
|
|
@@ -42833,6 +46351,30 @@ export const SubscriptionsApiFactory = function (configuration?: Configuration,
|
|
|
42833
46351
|
* @extends {BaseAPI}
|
|
42834
46352
|
*/
|
|
42835
46353
|
export class SubscriptionsApi extends BaseAPI {
|
|
46354
|
+
/**
|
|
46355
|
+
* Shows detailed preview of subscription cancellation including credit calculation, billing period info, and potential refund
|
|
46356
|
+
* @summary Preview subscription cancellation details
|
|
46357
|
+
* @param {SubscriptionRouteCancelPreviewRequest} subscriptionRouteCancelPreviewRequest Cancellation preview request
|
|
46358
|
+
* @param {*} [options] Override http request option.
|
|
46359
|
+
* @throws {RequiredError}
|
|
46360
|
+
* @memberof SubscriptionsApi
|
|
46361
|
+
*/
|
|
46362
|
+
public adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest: SubscriptionRouteCancelPreviewRequest, options?: RawAxiosRequestConfig) {
|
|
46363
|
+
return SubscriptionsApiFp(this.configuration).adminSubscriptionsCancelPreviewPost(subscriptionRouteCancelPreviewRequest, options).then((request) => request(this.axios, this.basePath));
|
|
46364
|
+
}
|
|
46365
|
+
|
|
46366
|
+
/**
|
|
46367
|
+
* Cancels the subscription, removes unused credits, and processes refund if applicable
|
|
46368
|
+
* @summary Process subscription cancellation
|
|
46369
|
+
* @param {SubscriptionRouteCancelProcessRequest} subscriptionRouteCancelProcessRequest Cancellation process request
|
|
46370
|
+
* @param {*} [options] Override http request option.
|
|
46371
|
+
* @throws {RequiredError}
|
|
46372
|
+
* @memberof SubscriptionsApi
|
|
46373
|
+
*/
|
|
46374
|
+
public adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest: SubscriptionRouteCancelProcessRequest, options?: RawAxiosRequestConfig) {
|
|
46375
|
+
return SubscriptionsApiFp(this.configuration).adminSubscriptionsCancelProcessPost(subscriptionRouteCancelProcessRequest, options).then((request) => request(this.axios, this.basePath));
|
|
46376
|
+
}
|
|
46377
|
+
|
|
42836
46378
|
/**
|
|
42837
46379
|
* Updates Subscription information by ID.
|
|
42838
46380
|
* @summary Update an existing Subscription
|