@seekora-ai/admin-api 1.1.93 → 1.1.95
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 +47 -13
- package/api.ts +2945 -578
- package/dist/api.d.ts +2420 -573
- package/dist/api.js +1000 -68
- package/dist/esm/api.d.ts +2420 -573
- package/dist/esm/api.js +982 -58
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.95.tgz +0 -0
- package/seekora-ai-admin-api-1.1.93.tgz +0 -0
package/dist/api.d.ts
CHANGED
|
@@ -12572,6 +12572,118 @@ export interface DataTypesAdminSearchRequest {
|
|
|
12572
12572
|
*/
|
|
12573
12573
|
'widget_mode'?: boolean;
|
|
12574
12574
|
}
|
|
12575
|
+
/**
|
|
12576
|
+
*
|
|
12577
|
+
* @export
|
|
12578
|
+
* @interface DataTypesAnalyticsConfigBatchLimits
|
|
12579
|
+
*/
|
|
12580
|
+
export interface DataTypesAnalyticsConfigBatchLimits {
|
|
12581
|
+
/**
|
|
12582
|
+
*
|
|
12583
|
+
* @type {number}
|
|
12584
|
+
* @memberof DataTypesAnalyticsConfigBatchLimits
|
|
12585
|
+
*/
|
|
12586
|
+
'max_event_size_bytes'?: number;
|
|
12587
|
+
/**
|
|
12588
|
+
*
|
|
12589
|
+
* @type {number}
|
|
12590
|
+
* @memberof DataTypesAnalyticsConfigBatchLimits
|
|
12591
|
+
*/
|
|
12592
|
+
'max_events_per_batch'?: number;
|
|
12593
|
+
}
|
|
12594
|
+
/**
|
|
12595
|
+
*
|
|
12596
|
+
* @export
|
|
12597
|
+
* @interface DataTypesAnalyticsConfigData
|
|
12598
|
+
*/
|
|
12599
|
+
export interface DataTypesAnalyticsConfigData {
|
|
12600
|
+
/**
|
|
12601
|
+
*
|
|
12602
|
+
* @type {DataTypesAnalyticsConfigBatchLimits}
|
|
12603
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12604
|
+
*/
|
|
12605
|
+
'batch_limits'?: DataTypesAnalyticsConfigBatchLimits;
|
|
12606
|
+
/**
|
|
12607
|
+
*
|
|
12608
|
+
* @type {DataTypesAnalyticsConfigFunnelStages}
|
|
12609
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12610
|
+
*/
|
|
12611
|
+
'funnel_stages'?: DataTypesAnalyticsConfigFunnelStages;
|
|
12612
|
+
/**
|
|
12613
|
+
*
|
|
12614
|
+
* @type {DataTypesAnalyticsConfigMetadataGuidelines}
|
|
12615
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12616
|
+
*/
|
|
12617
|
+
'metadata_guidelines'?: DataTypesAnalyticsConfigMetadataGuidelines;
|
|
12618
|
+
/**
|
|
12619
|
+
*
|
|
12620
|
+
* @type {Array<string>}
|
|
12621
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12622
|
+
*/
|
|
12623
|
+
'optional_fields'?: Array<string>;
|
|
12624
|
+
/**
|
|
12625
|
+
*
|
|
12626
|
+
* @type {Array<string>}
|
|
12627
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12628
|
+
*/
|
|
12629
|
+
'required_fields'?: Array<string>;
|
|
12630
|
+
/**
|
|
12631
|
+
*
|
|
12632
|
+
* @type {Array<string>}
|
|
12633
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12634
|
+
*/
|
|
12635
|
+
'supported_event_categories'?: Array<string>;
|
|
12636
|
+
/**
|
|
12637
|
+
*
|
|
12638
|
+
* @type {Array<string>}
|
|
12639
|
+
* @memberof DataTypesAnalyticsConfigData
|
|
12640
|
+
*/
|
|
12641
|
+
'supported_event_types'?: Array<string>;
|
|
12642
|
+
}
|
|
12643
|
+
/**
|
|
12644
|
+
*
|
|
12645
|
+
* @export
|
|
12646
|
+
* @interface DataTypesAnalyticsConfigFunnelStages
|
|
12647
|
+
*/
|
|
12648
|
+
export interface DataTypesAnalyticsConfigFunnelStages {
|
|
12649
|
+
/**
|
|
12650
|
+
*
|
|
12651
|
+
* @type {string}
|
|
12652
|
+
* @memberof DataTypesAnalyticsConfigFunnelStages
|
|
12653
|
+
*/
|
|
12654
|
+
'description'?: string;
|
|
12655
|
+
/**
|
|
12656
|
+
*
|
|
12657
|
+
* @type {Array<string>}
|
|
12658
|
+
* @memberof DataTypesAnalyticsConfigFunnelStages
|
|
12659
|
+
*/
|
|
12660
|
+
'examples'?: Array<string>;
|
|
12661
|
+
}
|
|
12662
|
+
/**
|
|
12663
|
+
*
|
|
12664
|
+
* @export
|
|
12665
|
+
* @interface DataTypesAnalyticsConfigMetadataGuidelines
|
|
12666
|
+
*/
|
|
12667
|
+
export interface DataTypesAnalyticsConfigMetadataGuidelines {
|
|
12668
|
+
/**
|
|
12669
|
+
*
|
|
12670
|
+
* @type {number}
|
|
12671
|
+
* @memberof DataTypesAnalyticsConfigMetadataGuidelines
|
|
12672
|
+
*/
|
|
12673
|
+
'max_keys'?: number;
|
|
12674
|
+
/**
|
|
12675
|
+
*
|
|
12676
|
+
* @type {number}
|
|
12677
|
+
* @memberof DataTypesAnalyticsConfigMetadataGuidelines
|
|
12678
|
+
*/
|
|
12679
|
+
'max_value_length'?: number;
|
|
12680
|
+
/**
|
|
12681
|
+
*
|
|
12682
|
+
* @type {Array<string>}
|
|
12683
|
+
* @memberof DataTypesAnalyticsConfigMetadataGuidelines
|
|
12684
|
+
*/
|
|
12685
|
+
'reserved_keys'?: Array<string>;
|
|
12686
|
+
}
|
|
12575
12687
|
/**
|
|
12576
12688
|
* Standard error response format for analytics rules API
|
|
12577
12689
|
* @export
|
|
@@ -12876,6 +12988,56 @@ export interface DataTypesAutocompleteSuggestion {
|
|
|
12876
12988
|
*/
|
|
12877
12989
|
'text'?: string;
|
|
12878
12990
|
}
|
|
12991
|
+
/**
|
|
12992
|
+
*
|
|
12993
|
+
* @export
|
|
12994
|
+
* @interface DataTypesBatchEventData
|
|
12995
|
+
*/
|
|
12996
|
+
export interface DataTypesBatchEventData {
|
|
12997
|
+
/**
|
|
12998
|
+
*
|
|
12999
|
+
* @type {number}
|
|
13000
|
+
* @memberof DataTypesBatchEventData
|
|
13001
|
+
*/
|
|
13002
|
+
'error_count'?: number;
|
|
13003
|
+
/**
|
|
13004
|
+
*
|
|
13005
|
+
* @type {Array<string>}
|
|
13006
|
+
* @memberof DataTypesBatchEventData
|
|
13007
|
+
*/
|
|
13008
|
+
'errors'?: Array<string>;
|
|
13009
|
+
/**
|
|
13010
|
+
*
|
|
13011
|
+
* @type {number}
|
|
13012
|
+
* @memberof DataTypesBatchEventData
|
|
13013
|
+
*/
|
|
13014
|
+
'processed_count'?: number;
|
|
13015
|
+
/**
|
|
13016
|
+
*
|
|
13017
|
+
* @type {Array<DataTypesBatchEventProcessedItem>}
|
|
13018
|
+
* @memberof DataTypesBatchEventData
|
|
13019
|
+
*/
|
|
13020
|
+
'processed_events'?: Array<DataTypesBatchEventProcessedItem>;
|
|
13021
|
+
}
|
|
13022
|
+
/**
|
|
13023
|
+
*
|
|
13024
|
+
* @export
|
|
13025
|
+
* @interface DataTypesBatchEventProcessedItem
|
|
13026
|
+
*/
|
|
13027
|
+
export interface DataTypesBatchEventProcessedItem {
|
|
13028
|
+
/**
|
|
13029
|
+
*
|
|
13030
|
+
* @type {string}
|
|
13031
|
+
* @memberof DataTypesBatchEventProcessedItem
|
|
13032
|
+
*/
|
|
13033
|
+
'event_id'?: string;
|
|
13034
|
+
/**
|
|
13035
|
+
*
|
|
13036
|
+
* @type {string}
|
|
13037
|
+
* @memberof DataTypesBatchEventProcessedItem
|
|
13038
|
+
*/
|
|
13039
|
+
'timestamp'?: string;
|
|
13040
|
+
}
|
|
12879
13041
|
/**
|
|
12880
13042
|
*
|
|
12881
13043
|
* @export
|
|
@@ -13941,6 +14103,31 @@ export interface DataTypesConfigurationSchemaResponseWrapper {
|
|
|
13941
14103
|
*/
|
|
13942
14104
|
'status'?: number;
|
|
13943
14105
|
}
|
|
14106
|
+
/**
|
|
14107
|
+
*
|
|
14108
|
+
* @export
|
|
14109
|
+
* @interface DataTypesConnectorSearchResult
|
|
14110
|
+
*/
|
|
14111
|
+
export interface DataTypesConnectorSearchResult {
|
|
14112
|
+
/**
|
|
14113
|
+
*
|
|
14114
|
+
* @type {number}
|
|
14115
|
+
* @memberof DataTypesConnectorSearchResult
|
|
14116
|
+
*/
|
|
14117
|
+
'found'?: number;
|
|
14118
|
+
/**
|
|
14119
|
+
*
|
|
14120
|
+
* @type {Array<object>}
|
|
14121
|
+
* @memberof DataTypesConnectorSearchResult
|
|
14122
|
+
*/
|
|
14123
|
+
'results'?: Array<object>;
|
|
14124
|
+
/**
|
|
14125
|
+
*
|
|
14126
|
+
* @type {string}
|
|
14127
|
+
* @memberof DataTypesConnectorSearchResult
|
|
14128
|
+
*/
|
|
14129
|
+
'status'?: string;
|
|
14130
|
+
}
|
|
13944
14131
|
/**
|
|
13945
14132
|
*
|
|
13946
14133
|
* @export
|
|
@@ -14125,6 +14312,96 @@ export interface DataTypesCreateAnalyticsRuleRequest {
|
|
|
14125
14312
|
*/
|
|
14126
14313
|
'store_id'?: number;
|
|
14127
14314
|
}
|
|
14315
|
+
/**
|
|
14316
|
+
*
|
|
14317
|
+
* @export
|
|
14318
|
+
* @interface DataTypesCreateCustomPlanRequest
|
|
14319
|
+
*/
|
|
14320
|
+
export interface DataTypesCreateCustomPlanRequest {
|
|
14321
|
+
/**
|
|
14322
|
+
*
|
|
14323
|
+
* @type {string}
|
|
14324
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14325
|
+
*/
|
|
14326
|
+
'billing_type': DataTypesCreateCustomPlanRequestBillingTypeEnum;
|
|
14327
|
+
/**
|
|
14328
|
+
*
|
|
14329
|
+
* @type {number}
|
|
14330
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14331
|
+
*/
|
|
14332
|
+
'bonus_credits'?: number;
|
|
14333
|
+
/**
|
|
14334
|
+
*
|
|
14335
|
+
* @type {string}
|
|
14336
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14337
|
+
*/
|
|
14338
|
+
'currency': DataTypesCreateCustomPlanRequestCurrencyEnum;
|
|
14339
|
+
/**
|
|
14340
|
+
*
|
|
14341
|
+
* @type {string}
|
|
14342
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14343
|
+
*/
|
|
14344
|
+
'description'?: string;
|
|
14345
|
+
/**
|
|
14346
|
+
*
|
|
14347
|
+
* @type {string}
|
|
14348
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14349
|
+
*/
|
|
14350
|
+
'highlights'?: string;
|
|
14351
|
+
/**
|
|
14352
|
+
*
|
|
14353
|
+
* @type {string}
|
|
14354
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14355
|
+
*/
|
|
14356
|
+
'notes'?: string;
|
|
14357
|
+
/**
|
|
14358
|
+
*
|
|
14359
|
+
* @type {number}
|
|
14360
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14361
|
+
*/
|
|
14362
|
+
'org_id': number;
|
|
14363
|
+
/**
|
|
14364
|
+
*
|
|
14365
|
+
* @type {string}
|
|
14366
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14367
|
+
*/
|
|
14368
|
+
'plan_features': string;
|
|
14369
|
+
/**
|
|
14370
|
+
*
|
|
14371
|
+
* @type {string}
|
|
14372
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14373
|
+
*/
|
|
14374
|
+
'plan_name': string;
|
|
14375
|
+
/**
|
|
14376
|
+
*
|
|
14377
|
+
* @type {number}
|
|
14378
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14379
|
+
*/
|
|
14380
|
+
'price': number;
|
|
14381
|
+
/**
|
|
14382
|
+
*
|
|
14383
|
+
* @type {number}
|
|
14384
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14385
|
+
*/
|
|
14386
|
+
'total_credits': number;
|
|
14387
|
+
/**
|
|
14388
|
+
*
|
|
14389
|
+
* @type {number}
|
|
14390
|
+
* @memberof DataTypesCreateCustomPlanRequest
|
|
14391
|
+
*/
|
|
14392
|
+
'trial_days'?: number;
|
|
14393
|
+
}
|
|
14394
|
+
export declare const DataTypesCreateCustomPlanRequestBillingTypeEnum: {
|
|
14395
|
+
readonly Monthly: "monthly";
|
|
14396
|
+
readonly Annual: "annual";
|
|
14397
|
+
readonly OneTime: "one-time";
|
|
14398
|
+
};
|
|
14399
|
+
export type DataTypesCreateCustomPlanRequestBillingTypeEnum = typeof DataTypesCreateCustomPlanRequestBillingTypeEnum[keyof typeof DataTypesCreateCustomPlanRequestBillingTypeEnum];
|
|
14400
|
+
export declare const DataTypesCreateCustomPlanRequestCurrencyEnum: {
|
|
14401
|
+
readonly Usd: "USD";
|
|
14402
|
+
readonly Inr: "INR";
|
|
14403
|
+
};
|
|
14404
|
+
export type DataTypesCreateCustomPlanRequestCurrencyEnum = typeof DataTypesCreateCustomPlanRequestCurrencyEnum[keyof typeof DataTypesCreateCustomPlanRequestCurrencyEnum];
|
|
14128
14405
|
/**
|
|
14129
14406
|
*
|
|
14130
14407
|
* @export
|
|
@@ -15050,6 +15327,88 @@ export interface DataTypesCreateSourceResponse {
|
|
|
15050
15327
|
*/
|
|
15051
15328
|
'status'?: number;
|
|
15052
15329
|
}
|
|
15330
|
+
/**
|
|
15331
|
+
*
|
|
15332
|
+
* @export
|
|
15333
|
+
* @interface DataTypesCreateStoreRequest
|
|
15334
|
+
*/
|
|
15335
|
+
export interface DataTypesCreateStoreRequest {
|
|
15336
|
+
/**
|
|
15337
|
+
* Optional: array of documents to import immediately
|
|
15338
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
15339
|
+
* @memberof DataTypesCreateStoreRequest
|
|
15340
|
+
*/
|
|
15341
|
+
'dataset'?: Array<{
|
|
15342
|
+
[key: string]: any;
|
|
15343
|
+
}>;
|
|
15344
|
+
/**
|
|
15345
|
+
*
|
|
15346
|
+
* @type {string}
|
|
15347
|
+
* @memberof DataTypesCreateStoreRequest
|
|
15348
|
+
*/
|
|
15349
|
+
'industry'?: string;
|
|
15350
|
+
/**
|
|
15351
|
+
*
|
|
15352
|
+
* @type {string}
|
|
15353
|
+
* @memberof DataTypesCreateStoreRequest
|
|
15354
|
+
*/
|
|
15355
|
+
'location'?: string;
|
|
15356
|
+
/**
|
|
15357
|
+
*
|
|
15358
|
+
* @type {string}
|
|
15359
|
+
* @memberof DataTypesCreateStoreRequest
|
|
15360
|
+
*/
|
|
15361
|
+
'storeName': string;
|
|
15362
|
+
}
|
|
15363
|
+
/**
|
|
15364
|
+
*
|
|
15365
|
+
* @export
|
|
15366
|
+
* @interface DataTypesCreateStoreResponse
|
|
15367
|
+
*/
|
|
15368
|
+
export interface DataTypesCreateStoreResponse {
|
|
15369
|
+
/**
|
|
15370
|
+
* Job ID if dataset was imported
|
|
15371
|
+
* @type {string}
|
|
15372
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15373
|
+
*/
|
|
15374
|
+
'importJobId'?: string;
|
|
15375
|
+
/**
|
|
15376
|
+
* Number of documents imported
|
|
15377
|
+
* @type {number}
|
|
15378
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15379
|
+
*/
|
|
15380
|
+
'importedCount'?: number;
|
|
15381
|
+
/**
|
|
15382
|
+
*
|
|
15383
|
+
* @type {number}
|
|
15384
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15385
|
+
*/
|
|
15386
|
+
'storeId'?: number;
|
|
15387
|
+
/**
|
|
15388
|
+
*
|
|
15389
|
+
* @type {string}
|
|
15390
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15391
|
+
*/
|
|
15392
|
+
'storeName'?: string;
|
|
15393
|
+
/**
|
|
15394
|
+
*
|
|
15395
|
+
* @type {string}
|
|
15396
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15397
|
+
*/
|
|
15398
|
+
'xStoreId'?: string;
|
|
15399
|
+
/**
|
|
15400
|
+
*
|
|
15401
|
+
* @type {string}
|
|
15402
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15403
|
+
*/
|
|
15404
|
+
'xStoreSecret'?: string;
|
|
15405
|
+
/**
|
|
15406
|
+
*
|
|
15407
|
+
* @type {string}
|
|
15408
|
+
* @memberof DataTypesCreateStoreResponse
|
|
15409
|
+
*/
|
|
15410
|
+
'xStoreWriteSecret'?: string;
|
|
15411
|
+
}
|
|
15053
15412
|
/**
|
|
15054
15413
|
*
|
|
15055
15414
|
* @export
|
|
@@ -15863,6 +16222,176 @@ export interface DataTypesCurrentPlanInfo {
|
|
|
15863
16222
|
*/
|
|
15864
16223
|
'subscription_id'?: string;
|
|
15865
16224
|
}
|
|
16225
|
+
/**
|
|
16226
|
+
*
|
|
16227
|
+
* @export
|
|
16228
|
+
* @interface DataTypesCustomPlanListResponse
|
|
16229
|
+
*/
|
|
16230
|
+
export interface DataTypesCustomPlanListResponse {
|
|
16231
|
+
/**
|
|
16232
|
+
*
|
|
16233
|
+
* @type {Array<DataTypesCustomPlanResponse>}
|
|
16234
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16235
|
+
*/
|
|
16236
|
+
'data'?: Array<DataTypesCustomPlanResponse>;
|
|
16237
|
+
/**
|
|
16238
|
+
*
|
|
16239
|
+
* @type {string}
|
|
16240
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16241
|
+
*/
|
|
16242
|
+
'message'?: string;
|
|
16243
|
+
/**
|
|
16244
|
+
*
|
|
16245
|
+
* @type {number}
|
|
16246
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16247
|
+
*/
|
|
16248
|
+
'page'?: number;
|
|
16249
|
+
/**
|
|
16250
|
+
*
|
|
16251
|
+
* @type {number}
|
|
16252
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16253
|
+
*/
|
|
16254
|
+
'page_size'?: number;
|
|
16255
|
+
/**
|
|
16256
|
+
*
|
|
16257
|
+
* @type {number}
|
|
16258
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16259
|
+
*/
|
|
16260
|
+
'status'?: number;
|
|
16261
|
+
/**
|
|
16262
|
+
*
|
|
16263
|
+
* @type {number}
|
|
16264
|
+
* @memberof DataTypesCustomPlanListResponse
|
|
16265
|
+
*/
|
|
16266
|
+
'total'?: number;
|
|
16267
|
+
}
|
|
16268
|
+
/**
|
|
16269
|
+
*
|
|
16270
|
+
* @export
|
|
16271
|
+
* @interface DataTypesCustomPlanResponse
|
|
16272
|
+
*/
|
|
16273
|
+
export interface DataTypesCustomPlanResponse {
|
|
16274
|
+
/**
|
|
16275
|
+
*
|
|
16276
|
+
* @type {string}
|
|
16277
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16278
|
+
*/
|
|
16279
|
+
'billing_type'?: string;
|
|
16280
|
+
/**
|
|
16281
|
+
*
|
|
16282
|
+
* @type {number}
|
|
16283
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16284
|
+
*/
|
|
16285
|
+
'bonus_credits'?: number;
|
|
16286
|
+
/**
|
|
16287
|
+
*
|
|
16288
|
+
* @type {string}
|
|
16289
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16290
|
+
*/
|
|
16291
|
+
'created_at'?: string;
|
|
16292
|
+
/**
|
|
16293
|
+
*
|
|
16294
|
+
* @type {number}
|
|
16295
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16296
|
+
*/
|
|
16297
|
+
'created_by_user_id'?: number;
|
|
16298
|
+
/**
|
|
16299
|
+
*
|
|
16300
|
+
* @type {string}
|
|
16301
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16302
|
+
*/
|
|
16303
|
+
'currency'?: string;
|
|
16304
|
+
/**
|
|
16305
|
+
*
|
|
16306
|
+
* @type {string}
|
|
16307
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16308
|
+
*/
|
|
16309
|
+
'description'?: string;
|
|
16310
|
+
/**
|
|
16311
|
+
*
|
|
16312
|
+
* @type {string}
|
|
16313
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16314
|
+
*/
|
|
16315
|
+
'highlights'?: string;
|
|
16316
|
+
/**
|
|
16317
|
+
*
|
|
16318
|
+
* @type {boolean}
|
|
16319
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16320
|
+
*/
|
|
16321
|
+
'is_active'?: boolean;
|
|
16322
|
+
/**
|
|
16323
|
+
*
|
|
16324
|
+
* @type {boolean}
|
|
16325
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16326
|
+
*/
|
|
16327
|
+
'is_custom'?: boolean;
|
|
16328
|
+
/**
|
|
16329
|
+
*
|
|
16330
|
+
* @type {string}
|
|
16331
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16332
|
+
*/
|
|
16333
|
+
'modified_at'?: string;
|
|
16334
|
+
/**
|
|
16335
|
+
*
|
|
16336
|
+
* @type {string}
|
|
16337
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16338
|
+
*/
|
|
16339
|
+
'notes'?: string;
|
|
16340
|
+
/**
|
|
16341
|
+
*
|
|
16342
|
+
* @type {number}
|
|
16343
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16344
|
+
*/
|
|
16345
|
+
'org_id'?: number;
|
|
16346
|
+
/**
|
|
16347
|
+
*
|
|
16348
|
+
* @type {string}
|
|
16349
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16350
|
+
*/
|
|
16351
|
+
'org_name'?: string;
|
|
16352
|
+
/**
|
|
16353
|
+
*
|
|
16354
|
+
* @type {Array<DataTypesPaymentLinkResponse>}
|
|
16355
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16356
|
+
*/
|
|
16357
|
+
'payment_links'?: Array<DataTypesPaymentLinkResponse>;
|
|
16358
|
+
/**
|
|
16359
|
+
*
|
|
16360
|
+
* @type {string}
|
|
16361
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16362
|
+
*/
|
|
16363
|
+
'plan_features'?: string;
|
|
16364
|
+
/**
|
|
16365
|
+
*
|
|
16366
|
+
* @type {number}
|
|
16367
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16368
|
+
*/
|
|
16369
|
+
'plan_id'?: number;
|
|
16370
|
+
/**
|
|
16371
|
+
*
|
|
16372
|
+
* @type {string}
|
|
16373
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16374
|
+
*/
|
|
16375
|
+
'plan_name'?: string;
|
|
16376
|
+
/**
|
|
16377
|
+
*
|
|
16378
|
+
* @type {number}
|
|
16379
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16380
|
+
*/
|
|
16381
|
+
'price'?: number;
|
|
16382
|
+
/**
|
|
16383
|
+
*
|
|
16384
|
+
* @type {number}
|
|
16385
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16386
|
+
*/
|
|
16387
|
+
'total_credits'?: number;
|
|
16388
|
+
/**
|
|
16389
|
+
*
|
|
16390
|
+
* @type {number}
|
|
16391
|
+
* @memberof DataTypesCustomPlanResponse
|
|
16392
|
+
*/
|
|
16393
|
+
'trial_days'?: number;
|
|
16394
|
+
}
|
|
15866
16395
|
/**
|
|
15867
16396
|
*
|
|
15868
16397
|
* @export
|
|
@@ -16978,7 +17507,7 @@ export interface DataTypesErrorMetaResponse {
|
|
|
16978
17507
|
*/
|
|
16979
17508
|
export interface DataTypesEventPayload {
|
|
16980
17509
|
/**
|
|
16981
|
-
*
|
|
17510
|
+
* Experiment identifier
|
|
16982
17511
|
* @type {string}
|
|
16983
17512
|
* @memberof DataTypesEventPayload
|
|
16984
17513
|
*/
|
|
@@ -16990,7 +17519,7 @@ export interface DataTypesEventPayload {
|
|
|
16990
17519
|
*/
|
|
16991
17520
|
'ab_variant'?: string;
|
|
16992
17521
|
/**
|
|
16993
|
-
*
|
|
17522
|
+
*
|
|
16994
17523
|
* @type {Array<string>}
|
|
16995
17524
|
* @memberof DataTypesEventPayload
|
|
16996
17525
|
*/
|
|
@@ -17050,7 +17579,7 @@ export interface DataTypesEventPayload {
|
|
|
17050
17579
|
*/
|
|
17051
17580
|
'click_type'?: string;
|
|
17052
17581
|
/**
|
|
17053
|
-
*
|
|
17582
|
+
*
|
|
17054
17583
|
* @type {string}
|
|
17055
17584
|
* @memberof DataTypesEventPayload
|
|
17056
17585
|
*/
|
|
@@ -17098,7 +17627,7 @@ export interface DataTypesEventPayload {
|
|
|
17098
17627
|
*/
|
|
17099
17628
|
'correlation_id'?: string;
|
|
17100
17629
|
/**
|
|
17101
|
-
*
|
|
17630
|
+
*
|
|
17102
17631
|
* @type {string}
|
|
17103
17632
|
* @memberof DataTypesEventPayload
|
|
17104
17633
|
*/
|
|
@@ -17122,7 +17651,7 @@ export interface DataTypesEventPayload {
|
|
|
17122
17651
|
*/
|
|
17123
17652
|
'custom_json'?: string;
|
|
17124
17653
|
/**
|
|
17125
|
-
*
|
|
17654
|
+
* URL user navigates to after click
|
|
17126
17655
|
* @type {string}
|
|
17127
17656
|
* @memberof DataTypesEventPayload
|
|
17128
17657
|
*/
|
|
@@ -17140,7 +17669,7 @@ export interface DataTypesEventPayload {
|
|
|
17140
17669
|
*/
|
|
17141
17670
|
'device_type'?: string;
|
|
17142
17671
|
/**
|
|
17143
|
-
*
|
|
17672
|
+
*
|
|
17144
17673
|
* @type {string}
|
|
17145
17674
|
* @memberof DataTypesEventPayload
|
|
17146
17675
|
*/
|
|
@@ -17182,7 +17711,7 @@ export interface DataTypesEventPayload {
|
|
|
17182
17711
|
*/
|
|
17183
17712
|
'insert_id'?: string;
|
|
17184
17713
|
/**
|
|
17185
|
-
*
|
|
17714
|
+
*
|
|
17186
17715
|
* @type {string}
|
|
17187
17716
|
* @memberof DataTypesEventPayload
|
|
17188
17717
|
*/
|
|
@@ -17232,7 +17761,7 @@ export interface DataTypesEventPayload {
|
|
|
17232
17761
|
[key: string]: any;
|
|
17233
17762
|
};
|
|
17234
17763
|
/**
|
|
17235
|
-
*
|
|
17764
|
+
*
|
|
17236
17765
|
* @type {string}
|
|
17237
17766
|
* @memberof DataTypesEventPayload
|
|
17238
17767
|
*/
|
|
@@ -17304,7 +17833,7 @@ export interface DataTypesEventPayload {
|
|
|
17304
17833
|
*/
|
|
17305
17834
|
'quantity'?: number;
|
|
17306
17835
|
/**
|
|
17307
|
-
*
|
|
17836
|
+
*
|
|
17308
17837
|
* @type {string}
|
|
17309
17838
|
* @memberof DataTypesEventPayload
|
|
17310
17839
|
*/
|
|
@@ -17466,7 +17995,7 @@ export interface DataTypesEventPayload {
|
|
|
17466
17995
|
*/
|
|
17467
17996
|
'utm_medium'?: string;
|
|
17468
17997
|
/**
|
|
17469
|
-
*
|
|
17998
|
+
*
|
|
17470
17999
|
* @type {string}
|
|
17471
18000
|
* @memberof DataTypesEventPayload
|
|
17472
18001
|
*/
|
|
@@ -17478,7 +18007,7 @@ export interface DataTypesEventPayload {
|
|
|
17478
18007
|
*/
|
|
17479
18008
|
'utm_term'?: string;
|
|
17480
18009
|
/**
|
|
17481
|
-
*
|
|
18010
|
+
*
|
|
17482
18011
|
* @type {number}
|
|
17483
18012
|
* @memberof DataTypesEventPayload
|
|
17484
18013
|
*/
|
|
@@ -17502,6 +18031,44 @@ export interface DataTypesEventPayload {
|
|
|
17502
18031
|
*/
|
|
17503
18032
|
'xstoreid'?: string;
|
|
17504
18033
|
}
|
|
18034
|
+
/**
|
|
18035
|
+
*
|
|
18036
|
+
* @export
|
|
18037
|
+
* @interface DataTypesEventSubmitData
|
|
18038
|
+
*/
|
|
18039
|
+
export interface DataTypesEventSubmitData {
|
|
18040
|
+
/**
|
|
18041
|
+
*
|
|
18042
|
+
* @type {string}
|
|
18043
|
+
* @memberof DataTypesEventSubmitData
|
|
18044
|
+
*/
|
|
18045
|
+
'event_id'?: string;
|
|
18046
|
+
/**
|
|
18047
|
+
*
|
|
18048
|
+
* @type {string}
|
|
18049
|
+
* @memberof DataTypesEventSubmitData
|
|
18050
|
+
*/
|
|
18051
|
+
'timestamp'?: string;
|
|
18052
|
+
}
|
|
18053
|
+
/**
|
|
18054
|
+
*
|
|
18055
|
+
* @export
|
|
18056
|
+
* @interface DataTypesEventValidateData
|
|
18057
|
+
*/
|
|
18058
|
+
export interface DataTypesEventValidateData {
|
|
18059
|
+
/**
|
|
18060
|
+
*
|
|
18061
|
+
* @type {string}
|
|
18062
|
+
* @memberof DataTypesEventValidateData
|
|
18063
|
+
*/
|
|
18064
|
+
'event_name'?: string;
|
|
18065
|
+
/**
|
|
18066
|
+
*
|
|
18067
|
+
* @type {string}
|
|
18068
|
+
* @memberof DataTypesEventValidateData
|
|
18069
|
+
*/
|
|
18070
|
+
'event_type'?: string;
|
|
18071
|
+
}
|
|
17505
18072
|
/**
|
|
17506
18073
|
*
|
|
17507
18074
|
* @export
|
|
@@ -19078,6 +19645,37 @@ export interface DataTypesGenerateInvoiceReceiptResponse {
|
|
|
19078
19645
|
*/
|
|
19079
19646
|
'success'?: boolean;
|
|
19080
19647
|
}
|
|
19648
|
+
/**
|
|
19649
|
+
*
|
|
19650
|
+
* @export
|
|
19651
|
+
* @interface DataTypesGeneratePaymentLinkRequest
|
|
19652
|
+
*/
|
|
19653
|
+
export interface DataTypesGeneratePaymentLinkRequest {
|
|
19654
|
+
/**
|
|
19655
|
+
*
|
|
19656
|
+
* @type {string}
|
|
19657
|
+
* @memberof DataTypesGeneratePaymentLinkRequest
|
|
19658
|
+
*/
|
|
19659
|
+
'description'?: string;
|
|
19660
|
+
/**
|
|
19661
|
+
*
|
|
19662
|
+
* @type {number}
|
|
19663
|
+
* @memberof DataTypesGeneratePaymentLinkRequest
|
|
19664
|
+
*/
|
|
19665
|
+
'expires_in_days': number;
|
|
19666
|
+
/**
|
|
19667
|
+
*
|
|
19668
|
+
* @type {string}
|
|
19669
|
+
* @memberof DataTypesGeneratePaymentLinkRequest
|
|
19670
|
+
*/
|
|
19671
|
+
'gateway'?: string;
|
|
19672
|
+
/**
|
|
19673
|
+
*
|
|
19674
|
+
* @type {boolean}
|
|
19675
|
+
* @memberof DataTypesGeneratePaymentLinkRequest
|
|
19676
|
+
*/
|
|
19677
|
+
'notify_org'?: boolean;
|
|
19678
|
+
}
|
|
19081
19679
|
/**
|
|
19082
19680
|
*
|
|
19083
19681
|
* @export
|
|
@@ -20053,6 +20651,56 @@ export interface DataTypesGenericResponseBillingServiceTrialEligibilityResponse
|
|
|
20053
20651
|
*/
|
|
20054
20652
|
'status'?: number;
|
|
20055
20653
|
}
|
|
20654
|
+
/**
|
|
20655
|
+
*
|
|
20656
|
+
* @export
|
|
20657
|
+
* @interface DataTypesGenericResponseDataTypesAnalyticsConfigData
|
|
20658
|
+
*/
|
|
20659
|
+
export interface DataTypesGenericResponseDataTypesAnalyticsConfigData {
|
|
20660
|
+
/**
|
|
20661
|
+
*
|
|
20662
|
+
* @type {DataTypesAnalyticsConfigData}
|
|
20663
|
+
* @memberof DataTypesGenericResponseDataTypesAnalyticsConfigData
|
|
20664
|
+
*/
|
|
20665
|
+
'data'?: DataTypesAnalyticsConfigData;
|
|
20666
|
+
/**
|
|
20667
|
+
*
|
|
20668
|
+
* @type {string}
|
|
20669
|
+
* @memberof DataTypesGenericResponseDataTypesAnalyticsConfigData
|
|
20670
|
+
*/
|
|
20671
|
+
'message'?: string;
|
|
20672
|
+
/**
|
|
20673
|
+
*
|
|
20674
|
+
* @type {number}
|
|
20675
|
+
* @memberof DataTypesGenericResponseDataTypesAnalyticsConfigData
|
|
20676
|
+
*/
|
|
20677
|
+
'status'?: number;
|
|
20678
|
+
}
|
|
20679
|
+
/**
|
|
20680
|
+
*
|
|
20681
|
+
* @export
|
|
20682
|
+
* @interface DataTypesGenericResponseDataTypesBatchEventData
|
|
20683
|
+
*/
|
|
20684
|
+
export interface DataTypesGenericResponseDataTypesBatchEventData {
|
|
20685
|
+
/**
|
|
20686
|
+
*
|
|
20687
|
+
* @type {DataTypesBatchEventData}
|
|
20688
|
+
* @memberof DataTypesGenericResponseDataTypesBatchEventData
|
|
20689
|
+
*/
|
|
20690
|
+
'data'?: DataTypesBatchEventData;
|
|
20691
|
+
/**
|
|
20692
|
+
*
|
|
20693
|
+
* @type {string}
|
|
20694
|
+
* @memberof DataTypesGenericResponseDataTypesBatchEventData
|
|
20695
|
+
*/
|
|
20696
|
+
'message'?: string;
|
|
20697
|
+
/**
|
|
20698
|
+
*
|
|
20699
|
+
* @type {number}
|
|
20700
|
+
* @memberof DataTypesGenericResponseDataTypesBatchEventData
|
|
20701
|
+
*/
|
|
20702
|
+
'status'?: number;
|
|
20703
|
+
}
|
|
20056
20704
|
/**
|
|
20057
20705
|
*
|
|
20058
20706
|
* @export
|
|
@@ -20128,6 +20776,31 @@ export interface DataTypesGenericResponseDataTypesConsumptionHistoryResponse {
|
|
|
20128
20776
|
*/
|
|
20129
20777
|
'status'?: number;
|
|
20130
20778
|
}
|
|
20779
|
+
/**
|
|
20780
|
+
*
|
|
20781
|
+
* @export
|
|
20782
|
+
* @interface DataTypesGenericResponseDataTypesCreateStoreResponse
|
|
20783
|
+
*/
|
|
20784
|
+
export interface DataTypesGenericResponseDataTypesCreateStoreResponse {
|
|
20785
|
+
/**
|
|
20786
|
+
*
|
|
20787
|
+
* @type {DataTypesCreateStoreResponse}
|
|
20788
|
+
* @memberof DataTypesGenericResponseDataTypesCreateStoreResponse
|
|
20789
|
+
*/
|
|
20790
|
+
'data'?: DataTypesCreateStoreResponse;
|
|
20791
|
+
/**
|
|
20792
|
+
*
|
|
20793
|
+
* @type {string}
|
|
20794
|
+
* @memberof DataTypesGenericResponseDataTypesCreateStoreResponse
|
|
20795
|
+
*/
|
|
20796
|
+
'message'?: string;
|
|
20797
|
+
/**
|
|
20798
|
+
*
|
|
20799
|
+
* @type {number}
|
|
20800
|
+
* @memberof DataTypesGenericResponseDataTypesCreateStoreResponse
|
|
20801
|
+
*/
|
|
20802
|
+
'status'?: number;
|
|
20803
|
+
}
|
|
20131
20804
|
/**
|
|
20132
20805
|
*
|
|
20133
20806
|
* @export
|
|
@@ -20178,6 +20851,56 @@ export interface DataTypesGenericResponseDataTypesCurrentPlanInfo {
|
|
|
20178
20851
|
*/
|
|
20179
20852
|
'status'?: number;
|
|
20180
20853
|
}
|
|
20854
|
+
/**
|
|
20855
|
+
*
|
|
20856
|
+
* @export
|
|
20857
|
+
* @interface DataTypesGenericResponseDataTypesEventSubmitData
|
|
20858
|
+
*/
|
|
20859
|
+
export interface DataTypesGenericResponseDataTypesEventSubmitData {
|
|
20860
|
+
/**
|
|
20861
|
+
*
|
|
20862
|
+
* @type {DataTypesEventSubmitData}
|
|
20863
|
+
* @memberof DataTypesGenericResponseDataTypesEventSubmitData
|
|
20864
|
+
*/
|
|
20865
|
+
'data'?: DataTypesEventSubmitData;
|
|
20866
|
+
/**
|
|
20867
|
+
*
|
|
20868
|
+
* @type {string}
|
|
20869
|
+
* @memberof DataTypesGenericResponseDataTypesEventSubmitData
|
|
20870
|
+
*/
|
|
20871
|
+
'message'?: string;
|
|
20872
|
+
/**
|
|
20873
|
+
*
|
|
20874
|
+
* @type {number}
|
|
20875
|
+
* @memberof DataTypesGenericResponseDataTypesEventSubmitData
|
|
20876
|
+
*/
|
|
20877
|
+
'status'?: number;
|
|
20878
|
+
}
|
|
20879
|
+
/**
|
|
20880
|
+
*
|
|
20881
|
+
* @export
|
|
20882
|
+
* @interface DataTypesGenericResponseDataTypesEventValidateData
|
|
20883
|
+
*/
|
|
20884
|
+
export interface DataTypesGenericResponseDataTypesEventValidateData {
|
|
20885
|
+
/**
|
|
20886
|
+
*
|
|
20887
|
+
* @type {DataTypesEventValidateData}
|
|
20888
|
+
* @memberof DataTypesGenericResponseDataTypesEventValidateData
|
|
20889
|
+
*/
|
|
20890
|
+
'data'?: DataTypesEventValidateData;
|
|
20891
|
+
/**
|
|
20892
|
+
*
|
|
20893
|
+
* @type {string}
|
|
20894
|
+
* @memberof DataTypesGenericResponseDataTypesEventValidateData
|
|
20895
|
+
*/
|
|
20896
|
+
'message'?: string;
|
|
20897
|
+
/**
|
|
20898
|
+
*
|
|
20899
|
+
* @type {number}
|
|
20900
|
+
* @memberof DataTypesGenericResponseDataTypesEventValidateData
|
|
20901
|
+
*/
|
|
20902
|
+
'status'?: number;
|
|
20903
|
+
}
|
|
20181
20904
|
/**
|
|
20182
20905
|
*
|
|
20183
20906
|
* @export
|
|
@@ -20378,56 +21101,6 @@ export interface DataTypesGenericResponseDataTypesPayInvoiceResponse {
|
|
|
20378
21101
|
*/
|
|
20379
21102
|
'status'?: number;
|
|
20380
21103
|
}
|
|
20381
|
-
/**
|
|
20382
|
-
*
|
|
20383
|
-
* @export
|
|
20384
|
-
* @interface DataTypesGenericResponseDataTypesPublicCreateStoreResponse
|
|
20385
|
-
*/
|
|
20386
|
-
export interface DataTypesGenericResponseDataTypesPublicCreateStoreResponse {
|
|
20387
|
-
/**
|
|
20388
|
-
*
|
|
20389
|
-
* @type {DataTypesPublicCreateStoreResponse}
|
|
20390
|
-
* @memberof DataTypesGenericResponseDataTypesPublicCreateStoreResponse
|
|
20391
|
-
*/
|
|
20392
|
-
'data'?: DataTypesPublicCreateStoreResponse;
|
|
20393
|
-
/**
|
|
20394
|
-
*
|
|
20395
|
-
* @type {string}
|
|
20396
|
-
* @memberof DataTypesGenericResponseDataTypesPublicCreateStoreResponse
|
|
20397
|
-
*/
|
|
20398
|
-
'message'?: string;
|
|
20399
|
-
/**
|
|
20400
|
-
*
|
|
20401
|
-
* @type {number}
|
|
20402
|
-
* @memberof DataTypesGenericResponseDataTypesPublicCreateStoreResponse
|
|
20403
|
-
*/
|
|
20404
|
-
'status'?: number;
|
|
20405
|
-
}
|
|
20406
|
-
/**
|
|
20407
|
-
*
|
|
20408
|
-
* @export
|
|
20409
|
-
* @interface DataTypesGenericResponseDataTypesPublicStoreInfoResponse
|
|
20410
|
-
*/
|
|
20411
|
-
export interface DataTypesGenericResponseDataTypesPublicStoreInfoResponse {
|
|
20412
|
-
/**
|
|
20413
|
-
*
|
|
20414
|
-
* @type {DataTypesPublicStoreInfoResponse}
|
|
20415
|
-
* @memberof DataTypesGenericResponseDataTypesPublicStoreInfoResponse
|
|
20416
|
-
*/
|
|
20417
|
-
'data'?: DataTypesPublicStoreInfoResponse;
|
|
20418
|
-
/**
|
|
20419
|
-
*
|
|
20420
|
-
* @type {string}
|
|
20421
|
-
* @memberof DataTypesGenericResponseDataTypesPublicStoreInfoResponse
|
|
20422
|
-
*/
|
|
20423
|
-
'message'?: string;
|
|
20424
|
-
/**
|
|
20425
|
-
*
|
|
20426
|
-
* @type {number}
|
|
20427
|
-
* @memberof DataTypesGenericResponseDataTypesPublicStoreInfoResponse
|
|
20428
|
-
*/
|
|
20429
|
-
'status'?: number;
|
|
20430
|
-
}
|
|
20431
21104
|
/**
|
|
20432
21105
|
*
|
|
20433
21106
|
* @export
|
|
@@ -20553,6 +21226,31 @@ export interface DataTypesGenericResponseDataTypesStoreConfigWithOnboardingRespo
|
|
|
20553
21226
|
*/
|
|
20554
21227
|
'status'?: number;
|
|
20555
21228
|
}
|
|
21229
|
+
/**
|
|
21230
|
+
*
|
|
21231
|
+
* @export
|
|
21232
|
+
* @interface DataTypesGenericResponseDataTypesStoreInfoResponse
|
|
21233
|
+
*/
|
|
21234
|
+
export interface DataTypesGenericResponseDataTypesStoreInfoResponse {
|
|
21235
|
+
/**
|
|
21236
|
+
*
|
|
21237
|
+
* @type {DataTypesStoreInfoResponse}
|
|
21238
|
+
* @memberof DataTypesGenericResponseDataTypesStoreInfoResponse
|
|
21239
|
+
*/
|
|
21240
|
+
'data'?: DataTypesStoreInfoResponse;
|
|
21241
|
+
/**
|
|
21242
|
+
*
|
|
21243
|
+
* @type {string}
|
|
21244
|
+
* @memberof DataTypesGenericResponseDataTypesStoreInfoResponse
|
|
21245
|
+
*/
|
|
21246
|
+
'message'?: string;
|
|
21247
|
+
/**
|
|
21248
|
+
*
|
|
21249
|
+
* @type {number}
|
|
21250
|
+
* @memberof DataTypesGenericResponseDataTypesStoreInfoResponse
|
|
21251
|
+
*/
|
|
21252
|
+
'status'?: number;
|
|
21253
|
+
}
|
|
20556
21254
|
/**
|
|
20557
21255
|
*
|
|
20558
21256
|
* @export
|
|
@@ -22905,6 +23603,61 @@ export interface DataTypesManualCreditAdjustmentRequest {
|
|
|
22905
23603
|
*/
|
|
22906
23604
|
'store_id': number;
|
|
22907
23605
|
}
|
|
23606
|
+
/**
|
|
23607
|
+
*
|
|
23608
|
+
* @export
|
|
23609
|
+
* @interface DataTypesMarkPaidRequest
|
|
23610
|
+
*/
|
|
23611
|
+
export interface DataTypesMarkPaidRequest {
|
|
23612
|
+
/**
|
|
23613
|
+
*
|
|
23614
|
+
* @type {number}
|
|
23615
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23616
|
+
*/
|
|
23617
|
+
'amount': number;
|
|
23618
|
+
/**
|
|
23619
|
+
*
|
|
23620
|
+
* @type {string}
|
|
23621
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23622
|
+
*/
|
|
23623
|
+
'currency': DataTypesMarkPaidRequestCurrencyEnum;
|
|
23624
|
+
/**
|
|
23625
|
+
*
|
|
23626
|
+
* @type {string}
|
|
23627
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23628
|
+
*/
|
|
23629
|
+
'notes'?: string;
|
|
23630
|
+
/**
|
|
23631
|
+
* YYYY-MM-DD format
|
|
23632
|
+
* @type {string}
|
|
23633
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23634
|
+
*/
|
|
23635
|
+
'payment_date': string;
|
|
23636
|
+
/**
|
|
23637
|
+
*
|
|
23638
|
+
* @type {string}
|
|
23639
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23640
|
+
*/
|
|
23641
|
+
'payment_method': DataTypesMarkPaidRequestPaymentMethodEnum;
|
|
23642
|
+
/**
|
|
23643
|
+
*
|
|
23644
|
+
* @type {string}
|
|
23645
|
+
* @memberof DataTypesMarkPaidRequest
|
|
23646
|
+
*/
|
|
23647
|
+
'reference_number'?: string;
|
|
23648
|
+
}
|
|
23649
|
+
export declare const DataTypesMarkPaidRequestCurrencyEnum: {
|
|
23650
|
+
readonly Usd: "USD";
|
|
23651
|
+
readonly Inr: "INR";
|
|
23652
|
+
};
|
|
23653
|
+
export type DataTypesMarkPaidRequestCurrencyEnum = typeof DataTypesMarkPaidRequestCurrencyEnum[keyof typeof DataTypesMarkPaidRequestCurrencyEnum];
|
|
23654
|
+
export declare const DataTypesMarkPaidRequestPaymentMethodEnum: {
|
|
23655
|
+
readonly WireTransfer: "wire_transfer";
|
|
23656
|
+
readonly BankTransfer: "bank_transfer";
|
|
23657
|
+
readonly Check: "check";
|
|
23658
|
+
readonly Other: "other";
|
|
23659
|
+
};
|
|
23660
|
+
export type DataTypesMarkPaidRequestPaymentMethodEnum = typeof DataTypesMarkPaidRequestPaymentMethodEnum[keyof typeof DataTypesMarkPaidRequestPaymentMethodEnum];
|
|
22908
23661
|
/**
|
|
22909
23662
|
*
|
|
22910
23663
|
* @export
|
|
@@ -24830,6 +25583,25 @@ export declare const DataTypesNotificationType: {
|
|
|
24830
25583
|
readonly TypeCustom: "custom";
|
|
24831
25584
|
};
|
|
24832
25585
|
export type DataTypesNotificationType = typeof DataTypesNotificationType[keyof typeof DataTypesNotificationType];
|
|
25586
|
+
/**
|
|
25587
|
+
*
|
|
25588
|
+
* @export
|
|
25589
|
+
* @interface DataTypesNotifyOrgRequest
|
|
25590
|
+
*/
|
|
25591
|
+
export interface DataTypesNotifyOrgRequest {
|
|
25592
|
+
/**
|
|
25593
|
+
*
|
|
25594
|
+
* @type {string}
|
|
25595
|
+
* @memberof DataTypesNotifyOrgRequest
|
|
25596
|
+
*/
|
|
25597
|
+
'message'?: string;
|
|
25598
|
+
/**
|
|
25599
|
+
*
|
|
25600
|
+
* @type {string}
|
|
25601
|
+
* @memberof DataTypesNotifyOrgRequest
|
|
25602
|
+
*/
|
|
25603
|
+
'subject'?: string;
|
|
25604
|
+
}
|
|
24833
25605
|
/**
|
|
24834
25606
|
*
|
|
24835
25607
|
* @export
|
|
@@ -24871,117 +25643,93 @@ export interface DataTypesOTPPayload {
|
|
|
24871
25643
|
/**
|
|
24872
25644
|
*
|
|
24873
25645
|
* @export
|
|
24874
|
-
* @interface
|
|
25646
|
+
* @interface DataTypesOfflinePaymentResponse
|
|
24875
25647
|
*/
|
|
24876
|
-
export interface
|
|
24877
|
-
/**
|
|
24878
|
-
*
|
|
24879
|
-
* @type {any}
|
|
24880
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
24881
|
-
*/
|
|
24882
|
-
'facets'?: any;
|
|
25648
|
+
export interface DataTypesOfflinePaymentResponse {
|
|
24883
25649
|
/**
|
|
24884
25650
|
*
|
|
24885
25651
|
* @type {number}
|
|
24886
|
-
* @memberof
|
|
25652
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24887
25653
|
*/
|
|
24888
|
-
'
|
|
25654
|
+
'amount'?: number;
|
|
24889
25655
|
/**
|
|
24890
25656
|
*
|
|
24891
|
-
* @type {
|
|
24892
|
-
* @memberof
|
|
25657
|
+
* @type {string}
|
|
25658
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24893
25659
|
*/
|
|
24894
|
-
'
|
|
25660
|
+
'created_at'?: string;
|
|
24895
25661
|
/**
|
|
24896
25662
|
*
|
|
24897
|
-
* @type {Array<DataTypesOfficialSearchResult>}
|
|
24898
|
-
* @memberof DataTypesOfficialSearchResponse
|
|
24899
|
-
*/
|
|
24900
|
-
'results'?: Array<DataTypesOfficialSearchResult>;
|
|
24901
|
-
/**
|
|
24902
|
-
* Unique search identifier for analytics linking
|
|
24903
25663
|
* @type {string}
|
|
24904
|
-
* @memberof
|
|
25664
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24905
25665
|
*/
|
|
24906
|
-
'
|
|
25666
|
+
'currency'?: string;
|
|
24907
25667
|
/**
|
|
24908
|
-
*
|
|
24909
|
-
* @type {
|
|
24910
|
-
* @memberof
|
|
25668
|
+
*
|
|
25669
|
+
* @type {number}
|
|
25670
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24911
25671
|
*/
|
|
24912
|
-
'
|
|
25672
|
+
'id'?: number;
|
|
24913
25673
|
/**
|
|
24914
25674
|
*
|
|
24915
|
-
* @type {
|
|
24916
|
-
* @memberof
|
|
25675
|
+
* @type {string}
|
|
25676
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24917
25677
|
*/
|
|
24918
|
-
'
|
|
25678
|
+
'notes'?: string;
|
|
24919
25679
|
/**
|
|
24920
25680
|
*
|
|
24921
25681
|
* @type {number}
|
|
24922
|
-
* @memberof
|
|
25682
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24923
25683
|
*/
|
|
24924
|
-
'
|
|
24925
|
-
}
|
|
24926
|
-
/**
|
|
24927
|
-
*
|
|
24928
|
-
* @export
|
|
24929
|
-
* @interface DataTypesOfficialSearchResponseWrapper
|
|
24930
|
-
*/
|
|
24931
|
-
export interface DataTypesOfficialSearchResponseWrapper {
|
|
25684
|
+
'org_id'?: number;
|
|
24932
25685
|
/**
|
|
24933
|
-
*
|
|
24934
|
-
* @type {
|
|
24935
|
-
* @memberof
|
|
25686
|
+
* YYYY-MM-DD format
|
|
25687
|
+
* @type {string}
|
|
25688
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24936
25689
|
*/
|
|
24937
|
-
'
|
|
25690
|
+
'payment_date'?: string;
|
|
24938
25691
|
/**
|
|
24939
25692
|
*
|
|
24940
25693
|
* @type {string}
|
|
24941
|
-
* @memberof
|
|
25694
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24942
25695
|
*/
|
|
24943
|
-
'
|
|
25696
|
+
'payment_method'?: string;
|
|
24944
25697
|
/**
|
|
24945
25698
|
*
|
|
24946
25699
|
* @type {number}
|
|
24947
|
-
* @memberof
|
|
25700
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24948
25701
|
*/
|
|
24949
|
-
'
|
|
24950
|
-
}
|
|
24951
|
-
/**
|
|
24952
|
-
*
|
|
24953
|
-
* @export
|
|
24954
|
-
* @interface DataTypesOfficialSearchResult
|
|
24955
|
-
*/
|
|
24956
|
-
export interface DataTypesOfficialSearchResult {
|
|
25702
|
+
'plan_id'?: number;
|
|
24957
25703
|
/**
|
|
24958
25704
|
*
|
|
24959
|
-
* @type {
|
|
24960
|
-
* @memberof
|
|
25705
|
+
* @type {string}
|
|
25706
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24961
25707
|
*/
|
|
24962
|
-
'
|
|
24963
|
-
[key: string]: any;
|
|
24964
|
-
};
|
|
25708
|
+
'reference_number'?: string;
|
|
24965
25709
|
/**
|
|
24966
25710
|
*
|
|
24967
|
-
* @type {
|
|
24968
|
-
* @memberof
|
|
25711
|
+
* @type {string}
|
|
25712
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24969
25713
|
*/
|
|
24970
|
-
'
|
|
24971
|
-
|
|
24972
|
-
|
|
25714
|
+
'status'?: string;
|
|
25715
|
+
/**
|
|
25716
|
+
*
|
|
25717
|
+
* @type {number}
|
|
25718
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
25719
|
+
*/
|
|
25720
|
+
'subscription_id'?: number;
|
|
24973
25721
|
/**
|
|
24974
25722
|
*
|
|
24975
25723
|
* @type {string}
|
|
24976
|
-
* @memberof
|
|
25724
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24977
25725
|
*/
|
|
24978
|
-
'
|
|
25726
|
+
'verified_at'?: string;
|
|
24979
25727
|
/**
|
|
24980
25728
|
*
|
|
24981
25729
|
* @type {number}
|
|
24982
|
-
* @memberof
|
|
25730
|
+
* @memberof DataTypesOfflinePaymentResponse
|
|
24983
25731
|
*/
|
|
24984
|
-
'
|
|
25732
|
+
'verified_by_user_id'?: number;
|
|
24985
25733
|
}
|
|
24986
25734
|
/**
|
|
24987
25735
|
*
|
|
@@ -25177,6 +25925,12 @@ export interface DataTypesOnboardingStatus {
|
|
|
25177
25925
|
* @memberof DataTypesOnboardingStatus
|
|
25178
25926
|
*/
|
|
25179
25927
|
'is_complete'?: boolean;
|
|
25928
|
+
/**
|
|
25929
|
+
* Whether the check was unreliable due to transient infrastructure errors
|
|
25930
|
+
* @type {boolean}
|
|
25931
|
+
* @memberof DataTypesOnboardingStatus
|
|
25932
|
+
*/
|
|
25933
|
+
'is_degraded'?: boolean;
|
|
25180
25934
|
/**
|
|
25181
25935
|
* List of missing components
|
|
25182
25936
|
* @type {Array<string>}
|
|
@@ -26562,6 +27316,164 @@ export interface DataTypesPayment {
|
|
|
26562
27316
|
*/
|
|
26563
27317
|
'transactionId'?: string;
|
|
26564
27318
|
}
|
|
27319
|
+
/**
|
|
27320
|
+
*
|
|
27321
|
+
* @export
|
|
27322
|
+
* @interface DataTypesPaymentLinkListResponse
|
|
27323
|
+
*/
|
|
27324
|
+
export interface DataTypesPaymentLinkListResponse {
|
|
27325
|
+
/**
|
|
27326
|
+
*
|
|
27327
|
+
* @type {Array<DataTypesPaymentLinkResponse>}
|
|
27328
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27329
|
+
*/
|
|
27330
|
+
'data'?: Array<DataTypesPaymentLinkResponse>;
|
|
27331
|
+
/**
|
|
27332
|
+
*
|
|
27333
|
+
* @type {string}
|
|
27334
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27335
|
+
*/
|
|
27336
|
+
'message'?: string;
|
|
27337
|
+
/**
|
|
27338
|
+
*
|
|
27339
|
+
* @type {number}
|
|
27340
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27341
|
+
*/
|
|
27342
|
+
'page'?: number;
|
|
27343
|
+
/**
|
|
27344
|
+
*
|
|
27345
|
+
* @type {number}
|
|
27346
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27347
|
+
*/
|
|
27348
|
+
'page_size'?: number;
|
|
27349
|
+
/**
|
|
27350
|
+
*
|
|
27351
|
+
* @type {number}
|
|
27352
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27353
|
+
*/
|
|
27354
|
+
'status'?: number;
|
|
27355
|
+
/**
|
|
27356
|
+
*
|
|
27357
|
+
* @type {number}
|
|
27358
|
+
* @memberof DataTypesPaymentLinkListResponse
|
|
27359
|
+
*/
|
|
27360
|
+
'total'?: number;
|
|
27361
|
+
}
|
|
27362
|
+
/**
|
|
27363
|
+
*
|
|
27364
|
+
* @export
|
|
27365
|
+
* @interface DataTypesPaymentLinkResponse
|
|
27366
|
+
*/
|
|
27367
|
+
export interface DataTypesPaymentLinkResponse {
|
|
27368
|
+
/**
|
|
27369
|
+
*
|
|
27370
|
+
* @type {number}
|
|
27371
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27372
|
+
*/
|
|
27373
|
+
'amount'?: number;
|
|
27374
|
+
/**
|
|
27375
|
+
*
|
|
27376
|
+
* @type {string}
|
|
27377
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27378
|
+
*/
|
|
27379
|
+
'created_at'?: string;
|
|
27380
|
+
/**
|
|
27381
|
+
*
|
|
27382
|
+
* @type {number}
|
|
27383
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27384
|
+
*/
|
|
27385
|
+
'created_by_user_id'?: number;
|
|
27386
|
+
/**
|
|
27387
|
+
*
|
|
27388
|
+
* @type {string}
|
|
27389
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27390
|
+
*/
|
|
27391
|
+
'currency'?: string;
|
|
27392
|
+
/**
|
|
27393
|
+
*
|
|
27394
|
+
* @type {string}
|
|
27395
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27396
|
+
*/
|
|
27397
|
+
'expires_at'?: string;
|
|
27398
|
+
/**
|
|
27399
|
+
*
|
|
27400
|
+
* @type {string}
|
|
27401
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27402
|
+
*/
|
|
27403
|
+
'gateway'?: string;
|
|
27404
|
+
/**
|
|
27405
|
+
*
|
|
27406
|
+
* @type {string}
|
|
27407
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27408
|
+
*/
|
|
27409
|
+
'gateway_data'?: string;
|
|
27410
|
+
/**
|
|
27411
|
+
*
|
|
27412
|
+
* @type {string}
|
|
27413
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27414
|
+
*/
|
|
27415
|
+
'gateway_link_id'?: string;
|
|
27416
|
+
/**
|
|
27417
|
+
*
|
|
27418
|
+
* @type {string}
|
|
27419
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27420
|
+
*/
|
|
27421
|
+
'gateway_link_url'?: string;
|
|
27422
|
+
/**
|
|
27423
|
+
*
|
|
27424
|
+
* @type {number}
|
|
27425
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27426
|
+
*/
|
|
27427
|
+
'id'?: number;
|
|
27428
|
+
/**
|
|
27429
|
+
*
|
|
27430
|
+
* @type {string}
|
|
27431
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27432
|
+
*/
|
|
27433
|
+
'notes'?: string;
|
|
27434
|
+
/**
|
|
27435
|
+
*
|
|
27436
|
+
* @type {number}
|
|
27437
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27438
|
+
*/
|
|
27439
|
+
'order_id'?: number;
|
|
27440
|
+
/**
|
|
27441
|
+
*
|
|
27442
|
+
* @type {number}
|
|
27443
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27444
|
+
*/
|
|
27445
|
+
'org_id'?: number;
|
|
27446
|
+
/**
|
|
27447
|
+
*
|
|
27448
|
+
* @type {string}
|
|
27449
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27450
|
+
*/
|
|
27451
|
+
'paid_at'?: string;
|
|
27452
|
+
/**
|
|
27453
|
+
*
|
|
27454
|
+
* @type {number}
|
|
27455
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27456
|
+
*/
|
|
27457
|
+
'plan_id'?: number;
|
|
27458
|
+
/**
|
|
27459
|
+
*
|
|
27460
|
+
* @type {string}
|
|
27461
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27462
|
+
*/
|
|
27463
|
+
'short_url'?: string;
|
|
27464
|
+
/**
|
|
27465
|
+
*
|
|
27466
|
+
* @type {string}
|
|
27467
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27468
|
+
*/
|
|
27469
|
+
'status'?: string;
|
|
27470
|
+
/**
|
|
27471
|
+
*
|
|
27472
|
+
* @type {string}
|
|
27473
|
+
* @memberof DataTypesPaymentLinkResponse
|
|
27474
|
+
*/
|
|
27475
|
+
'updated_at'?: string;
|
|
27476
|
+
}
|
|
26565
27477
|
/**
|
|
26566
27478
|
*
|
|
26567
27479
|
* @export
|
|
@@ -27314,384 +28226,6 @@ export interface DataTypesProjectedRunoutInfo {
|
|
|
27314
28226
|
*/
|
|
27315
28227
|
'warning_level'?: string;
|
|
27316
28228
|
}
|
|
27317
|
-
/**
|
|
27318
|
-
*
|
|
27319
|
-
* @export
|
|
27320
|
-
* @interface DataTypesPublicCreateStoreRequest
|
|
27321
|
-
*/
|
|
27322
|
-
export interface DataTypesPublicCreateStoreRequest {
|
|
27323
|
-
/**
|
|
27324
|
-
* Optional: array of documents to import immediately
|
|
27325
|
-
* @type {Array<{ [key: string]: any; }>}
|
|
27326
|
-
* @memberof DataTypesPublicCreateStoreRequest
|
|
27327
|
-
*/
|
|
27328
|
-
'dataset'?: Array<{
|
|
27329
|
-
[key: string]: any;
|
|
27330
|
-
}>;
|
|
27331
|
-
/**
|
|
27332
|
-
*
|
|
27333
|
-
* @type {string}
|
|
27334
|
-
* @memberof DataTypesPublicCreateStoreRequest
|
|
27335
|
-
*/
|
|
27336
|
-
'industry'?: string;
|
|
27337
|
-
/**
|
|
27338
|
-
*
|
|
27339
|
-
* @type {string}
|
|
27340
|
-
* @memberof DataTypesPublicCreateStoreRequest
|
|
27341
|
-
*/
|
|
27342
|
-
'location'?: string;
|
|
27343
|
-
/**
|
|
27344
|
-
*
|
|
27345
|
-
* @type {string}
|
|
27346
|
-
* @memberof DataTypesPublicCreateStoreRequest
|
|
27347
|
-
*/
|
|
27348
|
-
'storeName': string;
|
|
27349
|
-
}
|
|
27350
|
-
/**
|
|
27351
|
-
*
|
|
27352
|
-
* @export
|
|
27353
|
-
* @interface DataTypesPublicCreateStoreResponse
|
|
27354
|
-
*/
|
|
27355
|
-
export interface DataTypesPublicCreateStoreResponse {
|
|
27356
|
-
/**
|
|
27357
|
-
* Job ID if dataset was imported
|
|
27358
|
-
* @type {string}
|
|
27359
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27360
|
-
*/
|
|
27361
|
-
'importJobId'?: string;
|
|
27362
|
-
/**
|
|
27363
|
-
* Number of documents imported
|
|
27364
|
-
* @type {number}
|
|
27365
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27366
|
-
*/
|
|
27367
|
-
'importedCount'?: number;
|
|
27368
|
-
/**
|
|
27369
|
-
*
|
|
27370
|
-
* @type {number}
|
|
27371
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27372
|
-
*/
|
|
27373
|
-
'storeId'?: number;
|
|
27374
|
-
/**
|
|
27375
|
-
*
|
|
27376
|
-
* @type {string}
|
|
27377
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27378
|
-
*/
|
|
27379
|
-
'storeName'?: string;
|
|
27380
|
-
/**
|
|
27381
|
-
*
|
|
27382
|
-
* @type {string}
|
|
27383
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27384
|
-
*/
|
|
27385
|
-
'xStoreId'?: string;
|
|
27386
|
-
/**
|
|
27387
|
-
*
|
|
27388
|
-
* @type {string}
|
|
27389
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27390
|
-
*/
|
|
27391
|
-
'xStoreSecret'?: string;
|
|
27392
|
-
/**
|
|
27393
|
-
*
|
|
27394
|
-
* @type {string}
|
|
27395
|
-
* @memberof DataTypesPublicCreateStoreResponse
|
|
27396
|
-
*/
|
|
27397
|
-
'xStoreWriteSecret'?: string;
|
|
27398
|
-
}
|
|
27399
|
-
/**
|
|
27400
|
-
*
|
|
27401
|
-
* @export
|
|
27402
|
-
* @interface DataTypesPublicSearchRequest
|
|
27403
|
-
*/
|
|
27404
|
-
export interface DataTypesPublicSearchRequest {
|
|
27405
|
-
/**
|
|
27406
|
-
*
|
|
27407
|
-
* @type {Array<string>}
|
|
27408
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27409
|
-
*/
|
|
27410
|
-
'analytics_tags'?: Array<string>;
|
|
27411
|
-
/**
|
|
27412
|
-
* Anonymous/cookie ID for personalization
|
|
27413
|
-
* @type {string}
|
|
27414
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27415
|
-
*/
|
|
27416
|
-
'anon_id'?: string;
|
|
27417
|
-
/**
|
|
27418
|
-
*
|
|
27419
|
-
* @type {boolean}
|
|
27420
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27421
|
-
*/
|
|
27422
|
-
'apply_rules'?: boolean;
|
|
27423
|
-
/**
|
|
27424
|
-
*
|
|
27425
|
-
* @type {boolean}
|
|
27426
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27427
|
-
*/
|
|
27428
|
-
'cache_results'?: boolean;
|
|
27429
|
-
/**
|
|
27430
|
-
*
|
|
27431
|
-
* @type {boolean}
|
|
27432
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27433
|
-
*/
|
|
27434
|
-
'exact_match_boost'?: boolean;
|
|
27435
|
-
/**
|
|
27436
|
-
*
|
|
27437
|
-
* @type {string}
|
|
27438
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27439
|
-
*/
|
|
27440
|
-
'facet_by'?: string;
|
|
27441
|
-
/**
|
|
27442
|
-
*
|
|
27443
|
-
* @type {string}
|
|
27444
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27445
|
-
*/
|
|
27446
|
-
'facet_search_text'?: string;
|
|
27447
|
-
/**
|
|
27448
|
-
*
|
|
27449
|
-
* @type {Array<number>}
|
|
27450
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27451
|
-
*/
|
|
27452
|
-
'field_weights'?: Array<number>;
|
|
27453
|
-
/**
|
|
27454
|
-
*
|
|
27455
|
-
* @type {string}
|
|
27456
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27457
|
-
*/
|
|
27458
|
-
'filter'?: string;
|
|
27459
|
-
/**
|
|
27460
|
-
*
|
|
27461
|
-
* @type {Array<string>}
|
|
27462
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27463
|
-
*/
|
|
27464
|
-
'full_snippet_fields'?: Array<string>;
|
|
27465
|
-
/**
|
|
27466
|
-
*
|
|
27467
|
-
* @type {string}
|
|
27468
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27469
|
-
*/
|
|
27470
|
-
'group_field'?: string;
|
|
27471
|
-
/**
|
|
27472
|
-
*
|
|
27473
|
-
* @type {number}
|
|
27474
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27475
|
-
*/
|
|
27476
|
-
'group_size'?: number;
|
|
27477
|
-
/**
|
|
27478
|
-
*
|
|
27479
|
-
* @type {boolean}
|
|
27480
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27481
|
-
*/
|
|
27482
|
-
'include_snippets'?: boolean;
|
|
27483
|
-
/**
|
|
27484
|
-
*
|
|
27485
|
-
* @type {boolean}
|
|
27486
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27487
|
-
*/
|
|
27488
|
-
'include_suggestions'?: boolean;
|
|
27489
|
-
/**
|
|
27490
|
-
*
|
|
27491
|
-
* @type {string}
|
|
27492
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27493
|
-
*/
|
|
27494
|
-
'infix_mode'?: string;
|
|
27495
|
-
/**
|
|
27496
|
-
*
|
|
27497
|
-
* @type {number}
|
|
27498
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27499
|
-
*/
|
|
27500
|
-
'max_facet_values'?: number;
|
|
27501
|
-
/**
|
|
27502
|
-
*
|
|
27503
|
-
* @type {Array<string>}
|
|
27504
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27505
|
-
*/
|
|
27506
|
-
'omit_fields'?: Array<string>;
|
|
27507
|
-
/**
|
|
27508
|
-
*
|
|
27509
|
-
* @type {number}
|
|
27510
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27511
|
-
*/
|
|
27512
|
-
'page'?: number;
|
|
27513
|
-
/**
|
|
27514
|
-
*
|
|
27515
|
-
* @type {number}
|
|
27516
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27517
|
-
*/
|
|
27518
|
-
'per_page'?: number;
|
|
27519
|
-
/**
|
|
27520
|
-
*
|
|
27521
|
-
* @type {string}
|
|
27522
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27523
|
-
*/
|
|
27524
|
-
'prefix_mode'?: string;
|
|
27525
|
-
/**
|
|
27526
|
-
*
|
|
27527
|
-
* @type {string}
|
|
27528
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27529
|
-
*/
|
|
27530
|
-
'preset_name'?: string;
|
|
27531
|
-
/**
|
|
27532
|
-
*
|
|
27533
|
-
* @type {string}
|
|
27534
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27535
|
-
*/
|
|
27536
|
-
'q': string;
|
|
27537
|
-
/**
|
|
27538
|
-
*
|
|
27539
|
-
* @type {boolean}
|
|
27540
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27541
|
-
*/
|
|
27542
|
-
'require_all_terms'?: boolean;
|
|
27543
|
-
/**
|
|
27544
|
-
*
|
|
27545
|
-
* @type {Array<string>}
|
|
27546
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27547
|
-
*/
|
|
27548
|
-
'return_fields'?: Array<string>;
|
|
27549
|
-
/**
|
|
27550
|
-
* Advanced query controls (public-friendly field names)
|
|
27551
|
-
* @type {Array<string>}
|
|
27552
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27553
|
-
*/
|
|
27554
|
-
'search_fields'?: Array<string>;
|
|
27555
|
-
/**
|
|
27556
|
-
*
|
|
27557
|
-
* @type {number}
|
|
27558
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27559
|
-
*/
|
|
27560
|
-
'search_timeout_ms'?: number;
|
|
27561
|
-
/**
|
|
27562
|
-
* Session ID for session-based personalization
|
|
27563
|
-
* @type {string}
|
|
27564
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27565
|
-
*/
|
|
27566
|
-
'session_id'?: string;
|
|
27567
|
-
/**
|
|
27568
|
-
*
|
|
27569
|
-
* @type {Array<string>}
|
|
27570
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27571
|
-
*/
|
|
27572
|
-
'snippet_fields'?: Array<string>;
|
|
27573
|
-
/**
|
|
27574
|
-
*
|
|
27575
|
-
* @type {number}
|
|
27576
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27577
|
-
*/
|
|
27578
|
-
'snippet_min_len'?: number;
|
|
27579
|
-
/**
|
|
27580
|
-
*
|
|
27581
|
-
* @type {string}
|
|
27582
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27583
|
-
*/
|
|
27584
|
-
'snippet_prefix'?: string;
|
|
27585
|
-
/**
|
|
27586
|
-
*
|
|
27587
|
-
* @type {string}
|
|
27588
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27589
|
-
*/
|
|
27590
|
-
'snippet_suffix'?: string;
|
|
27591
|
-
/**
|
|
27592
|
-
*
|
|
27593
|
-
* @type {number}
|
|
27594
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27595
|
-
*/
|
|
27596
|
-
'snippet_token_limit'?: number;
|
|
27597
|
-
/**
|
|
27598
|
-
*
|
|
27599
|
-
* @type {string}
|
|
27600
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27601
|
-
*/
|
|
27602
|
-
'sort'?: string;
|
|
27603
|
-
/**
|
|
27604
|
-
* IDs of stopword sets to use
|
|
27605
|
-
* @type {Array<string>}
|
|
27606
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27607
|
-
*/
|
|
27608
|
-
'stopword_sets'?: Array<string>;
|
|
27609
|
-
/**
|
|
27610
|
-
*
|
|
27611
|
-
* @type {number}
|
|
27612
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27613
|
-
*/
|
|
27614
|
-
'suggestions_limit'?: number;
|
|
27615
|
-
/**
|
|
27616
|
-
* IDs of synonym sets to use
|
|
27617
|
-
* @type {Array<string>}
|
|
27618
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27619
|
-
*/
|
|
27620
|
-
'synonym_sets'?: Array<string>;
|
|
27621
|
-
/**
|
|
27622
|
-
*
|
|
27623
|
-
* @type {number}
|
|
27624
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27625
|
-
*/
|
|
27626
|
-
'typo_max'?: number;
|
|
27627
|
-
/**
|
|
27628
|
-
*
|
|
27629
|
-
* @type {number}
|
|
27630
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27631
|
-
*/
|
|
27632
|
-
'typo_min_len_1'?: number;
|
|
27633
|
-
/**
|
|
27634
|
-
*
|
|
27635
|
-
* @type {number}
|
|
27636
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27637
|
-
*/
|
|
27638
|
-
'typo_min_len_2'?: number;
|
|
27639
|
-
/**
|
|
27640
|
-
* Personalization fields (optional, backward compatible)
|
|
27641
|
-
* @type {string}
|
|
27642
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27643
|
-
*/
|
|
27644
|
-
'user_id'?: string;
|
|
27645
|
-
/**
|
|
27646
|
-
* If true, returns only display fields instead of full document (used in public API only)
|
|
27647
|
-
* @type {boolean}
|
|
27648
|
-
* @memberof DataTypesPublicSearchRequest
|
|
27649
|
-
*/
|
|
27650
|
-
'widget_mode'?: boolean;
|
|
27651
|
-
}
|
|
27652
|
-
/**
|
|
27653
|
-
*
|
|
27654
|
-
* @export
|
|
27655
|
-
* @interface DataTypesPublicStoreInfoResponse
|
|
27656
|
-
*/
|
|
27657
|
-
export interface DataTypesPublicStoreInfoResponse {
|
|
27658
|
-
/**
|
|
27659
|
-
*
|
|
27660
|
-
* @type {string}
|
|
27661
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27662
|
-
*/
|
|
27663
|
-
'createdAt'?: string;
|
|
27664
|
-
/**
|
|
27665
|
-
*
|
|
27666
|
-
* @type {boolean}
|
|
27667
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27668
|
-
*/
|
|
27669
|
-
'isActive'?: boolean;
|
|
27670
|
-
/**
|
|
27671
|
-
*
|
|
27672
|
-
* @type {string}
|
|
27673
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27674
|
-
*/
|
|
27675
|
-
'location'?: string;
|
|
27676
|
-
/**
|
|
27677
|
-
*
|
|
27678
|
-
* @type {number}
|
|
27679
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27680
|
-
*/
|
|
27681
|
-
'storeId'?: number;
|
|
27682
|
-
/**
|
|
27683
|
-
*
|
|
27684
|
-
* @type {string}
|
|
27685
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27686
|
-
*/
|
|
27687
|
-
'storeName'?: string;
|
|
27688
|
-
/**
|
|
27689
|
-
*
|
|
27690
|
-
* @type {string}
|
|
27691
|
-
* @memberof DataTypesPublicStoreInfoResponse
|
|
27692
|
-
*/
|
|
27693
|
-
'xStoreId'?: string;
|
|
27694
|
-
}
|
|
27695
28229
|
/**
|
|
27696
28230
|
*
|
|
27697
28231
|
* @export
|
|
@@ -29471,6 +30005,259 @@ export interface DataTypesSchemaResponseWrapper {
|
|
|
29471
30005
|
*/
|
|
29472
30006
|
'status'?: number;
|
|
29473
30007
|
}
|
|
30008
|
+
/**
|
|
30009
|
+
*
|
|
30010
|
+
* @export
|
|
30011
|
+
* @interface DataTypesSearchRequest
|
|
30012
|
+
*/
|
|
30013
|
+
export interface DataTypesSearchRequest {
|
|
30014
|
+
/**
|
|
30015
|
+
*
|
|
30016
|
+
* @type {Array<string>}
|
|
30017
|
+
* @memberof DataTypesSearchRequest
|
|
30018
|
+
*/
|
|
30019
|
+
'analytics_tags'?: Array<string>;
|
|
30020
|
+
/**
|
|
30021
|
+
* Anonymous/cookie ID for personalization
|
|
30022
|
+
* @type {string}
|
|
30023
|
+
* @memberof DataTypesSearchRequest
|
|
30024
|
+
*/
|
|
30025
|
+
'anon_id'?: string;
|
|
30026
|
+
/**
|
|
30027
|
+
*
|
|
30028
|
+
* @type {boolean}
|
|
30029
|
+
* @memberof DataTypesSearchRequest
|
|
30030
|
+
*/
|
|
30031
|
+
'apply_rules'?: boolean;
|
|
30032
|
+
/**
|
|
30033
|
+
*
|
|
30034
|
+
* @type {boolean}
|
|
30035
|
+
* @memberof DataTypesSearchRequest
|
|
30036
|
+
*/
|
|
30037
|
+
'cache_results'?: boolean;
|
|
30038
|
+
/**
|
|
30039
|
+
*
|
|
30040
|
+
* @type {boolean}
|
|
30041
|
+
* @memberof DataTypesSearchRequest
|
|
30042
|
+
*/
|
|
30043
|
+
'exact_match_boost'?: boolean;
|
|
30044
|
+
/**
|
|
30045
|
+
*
|
|
30046
|
+
* @type {string}
|
|
30047
|
+
* @memberof DataTypesSearchRequest
|
|
30048
|
+
*/
|
|
30049
|
+
'facet_by'?: string;
|
|
30050
|
+
/**
|
|
30051
|
+
*
|
|
30052
|
+
* @type {string}
|
|
30053
|
+
* @memberof DataTypesSearchRequest
|
|
30054
|
+
*/
|
|
30055
|
+
'facet_search_text'?: string;
|
|
30056
|
+
/**
|
|
30057
|
+
*
|
|
30058
|
+
* @type {Array<number>}
|
|
30059
|
+
* @memberof DataTypesSearchRequest
|
|
30060
|
+
*/
|
|
30061
|
+
'field_weights'?: Array<number>;
|
|
30062
|
+
/**
|
|
30063
|
+
*
|
|
30064
|
+
* @type {string}
|
|
30065
|
+
* @memberof DataTypesSearchRequest
|
|
30066
|
+
*/
|
|
30067
|
+
'filter'?: string;
|
|
30068
|
+
/**
|
|
30069
|
+
*
|
|
30070
|
+
* @type {Array<string>}
|
|
30071
|
+
* @memberof DataTypesSearchRequest
|
|
30072
|
+
*/
|
|
30073
|
+
'full_snippet_fields'?: Array<string>;
|
|
30074
|
+
/**
|
|
30075
|
+
*
|
|
30076
|
+
* @type {string}
|
|
30077
|
+
* @memberof DataTypesSearchRequest
|
|
30078
|
+
*/
|
|
30079
|
+
'group_field'?: string;
|
|
30080
|
+
/**
|
|
30081
|
+
*
|
|
30082
|
+
* @type {number}
|
|
30083
|
+
* @memberof DataTypesSearchRequest
|
|
30084
|
+
*/
|
|
30085
|
+
'group_size'?: number;
|
|
30086
|
+
/**
|
|
30087
|
+
*
|
|
30088
|
+
* @type {boolean}
|
|
30089
|
+
* @memberof DataTypesSearchRequest
|
|
30090
|
+
*/
|
|
30091
|
+
'include_snippets'?: boolean;
|
|
30092
|
+
/**
|
|
30093
|
+
*
|
|
30094
|
+
* @type {boolean}
|
|
30095
|
+
* @memberof DataTypesSearchRequest
|
|
30096
|
+
*/
|
|
30097
|
+
'include_suggestions'?: boolean;
|
|
30098
|
+
/**
|
|
30099
|
+
*
|
|
30100
|
+
* @type {string}
|
|
30101
|
+
* @memberof DataTypesSearchRequest
|
|
30102
|
+
*/
|
|
30103
|
+
'infix_mode'?: string;
|
|
30104
|
+
/**
|
|
30105
|
+
*
|
|
30106
|
+
* @type {number}
|
|
30107
|
+
* @memberof DataTypesSearchRequest
|
|
30108
|
+
*/
|
|
30109
|
+
'max_facet_values'?: number;
|
|
30110
|
+
/**
|
|
30111
|
+
*
|
|
30112
|
+
* @type {Array<string>}
|
|
30113
|
+
* @memberof DataTypesSearchRequest
|
|
30114
|
+
*/
|
|
30115
|
+
'omit_fields'?: Array<string>;
|
|
30116
|
+
/**
|
|
30117
|
+
*
|
|
30118
|
+
* @type {number}
|
|
30119
|
+
* @memberof DataTypesSearchRequest
|
|
30120
|
+
*/
|
|
30121
|
+
'page'?: number;
|
|
30122
|
+
/**
|
|
30123
|
+
*
|
|
30124
|
+
* @type {number}
|
|
30125
|
+
* @memberof DataTypesSearchRequest
|
|
30126
|
+
*/
|
|
30127
|
+
'per_page'?: number;
|
|
30128
|
+
/**
|
|
30129
|
+
*
|
|
30130
|
+
* @type {string}
|
|
30131
|
+
* @memberof DataTypesSearchRequest
|
|
30132
|
+
*/
|
|
30133
|
+
'prefix_mode'?: string;
|
|
30134
|
+
/**
|
|
30135
|
+
*
|
|
30136
|
+
* @type {string}
|
|
30137
|
+
* @memberof DataTypesSearchRequest
|
|
30138
|
+
*/
|
|
30139
|
+
'preset_name'?: string;
|
|
30140
|
+
/**
|
|
30141
|
+
*
|
|
30142
|
+
* @type {string}
|
|
30143
|
+
* @memberof DataTypesSearchRequest
|
|
30144
|
+
*/
|
|
30145
|
+
'q': string;
|
|
30146
|
+
/**
|
|
30147
|
+
*
|
|
30148
|
+
* @type {boolean}
|
|
30149
|
+
* @memberof DataTypesSearchRequest
|
|
30150
|
+
*/
|
|
30151
|
+
'require_all_terms'?: boolean;
|
|
30152
|
+
/**
|
|
30153
|
+
*
|
|
30154
|
+
* @type {Array<string>}
|
|
30155
|
+
* @memberof DataTypesSearchRequest
|
|
30156
|
+
*/
|
|
30157
|
+
'return_fields'?: Array<string>;
|
|
30158
|
+
/**
|
|
30159
|
+
* Advanced query controls (public-friendly field names)
|
|
30160
|
+
* @type {Array<string>}
|
|
30161
|
+
* @memberof DataTypesSearchRequest
|
|
30162
|
+
*/
|
|
30163
|
+
'search_fields'?: Array<string>;
|
|
30164
|
+
/**
|
|
30165
|
+
*
|
|
30166
|
+
* @type {number}
|
|
30167
|
+
* @memberof DataTypesSearchRequest
|
|
30168
|
+
*/
|
|
30169
|
+
'search_timeout_ms'?: number;
|
|
30170
|
+
/**
|
|
30171
|
+
* Session ID for session-based personalization
|
|
30172
|
+
* @type {string}
|
|
30173
|
+
* @memberof DataTypesSearchRequest
|
|
30174
|
+
*/
|
|
30175
|
+
'session_id'?: string;
|
|
30176
|
+
/**
|
|
30177
|
+
*
|
|
30178
|
+
* @type {Array<string>}
|
|
30179
|
+
* @memberof DataTypesSearchRequest
|
|
30180
|
+
*/
|
|
30181
|
+
'snippet_fields'?: Array<string>;
|
|
30182
|
+
/**
|
|
30183
|
+
*
|
|
30184
|
+
* @type {number}
|
|
30185
|
+
* @memberof DataTypesSearchRequest
|
|
30186
|
+
*/
|
|
30187
|
+
'snippet_min_len'?: number;
|
|
30188
|
+
/**
|
|
30189
|
+
*
|
|
30190
|
+
* @type {string}
|
|
30191
|
+
* @memberof DataTypesSearchRequest
|
|
30192
|
+
*/
|
|
30193
|
+
'snippet_prefix'?: string;
|
|
30194
|
+
/**
|
|
30195
|
+
*
|
|
30196
|
+
* @type {string}
|
|
30197
|
+
* @memberof DataTypesSearchRequest
|
|
30198
|
+
*/
|
|
30199
|
+
'snippet_suffix'?: string;
|
|
30200
|
+
/**
|
|
30201
|
+
*
|
|
30202
|
+
* @type {number}
|
|
30203
|
+
* @memberof DataTypesSearchRequest
|
|
30204
|
+
*/
|
|
30205
|
+
'snippet_token_limit'?: number;
|
|
30206
|
+
/**
|
|
30207
|
+
*
|
|
30208
|
+
* @type {string}
|
|
30209
|
+
* @memberof DataTypesSearchRequest
|
|
30210
|
+
*/
|
|
30211
|
+
'sort'?: string;
|
|
30212
|
+
/**
|
|
30213
|
+
* IDs of stopword sets to use
|
|
30214
|
+
* @type {Array<string>}
|
|
30215
|
+
* @memberof DataTypesSearchRequest
|
|
30216
|
+
*/
|
|
30217
|
+
'stopword_sets'?: Array<string>;
|
|
30218
|
+
/**
|
|
30219
|
+
*
|
|
30220
|
+
* @type {number}
|
|
30221
|
+
* @memberof DataTypesSearchRequest
|
|
30222
|
+
*/
|
|
30223
|
+
'suggestions_limit'?: number;
|
|
30224
|
+
/**
|
|
30225
|
+
* IDs of synonym sets to use
|
|
30226
|
+
* @type {Array<string>}
|
|
30227
|
+
* @memberof DataTypesSearchRequest
|
|
30228
|
+
*/
|
|
30229
|
+
'synonym_sets'?: Array<string>;
|
|
30230
|
+
/**
|
|
30231
|
+
*
|
|
30232
|
+
* @type {number}
|
|
30233
|
+
* @memberof DataTypesSearchRequest
|
|
30234
|
+
*/
|
|
30235
|
+
'typo_max'?: number;
|
|
30236
|
+
/**
|
|
30237
|
+
*
|
|
30238
|
+
* @type {number}
|
|
30239
|
+
* @memberof DataTypesSearchRequest
|
|
30240
|
+
*/
|
|
30241
|
+
'typo_min_len_1'?: number;
|
|
30242
|
+
/**
|
|
30243
|
+
*
|
|
30244
|
+
* @type {number}
|
|
30245
|
+
* @memberof DataTypesSearchRequest
|
|
30246
|
+
*/
|
|
30247
|
+
'typo_min_len_2'?: number;
|
|
30248
|
+
/**
|
|
30249
|
+
* Personalization fields (optional, backward compatible)
|
|
30250
|
+
* @type {string}
|
|
30251
|
+
* @memberof DataTypesSearchRequest
|
|
30252
|
+
*/
|
|
30253
|
+
'user_id'?: string;
|
|
30254
|
+
/**
|
|
30255
|
+
* If true, returns only display fields instead of full document (used in public API only)
|
|
30256
|
+
* @type {boolean}
|
|
30257
|
+
* @memberof DataTypesSearchRequest
|
|
30258
|
+
*/
|
|
30259
|
+
'widget_mode'?: boolean;
|
|
30260
|
+
}
|
|
29474
30261
|
/**
|
|
29475
30262
|
*
|
|
29476
30263
|
* @export
|
|
@@ -29514,6 +30301,86 @@ export interface DataTypesSearchRequestsGraphResponse {
|
|
|
29514
30301
|
*/
|
|
29515
30302
|
'total_requests'?: number;
|
|
29516
30303
|
}
|
|
30304
|
+
/**
|
|
30305
|
+
*
|
|
30306
|
+
* @export
|
|
30307
|
+
* @interface DataTypesSearchResponse
|
|
30308
|
+
*/
|
|
30309
|
+
export interface DataTypesSearchResponse {
|
|
30310
|
+
/**
|
|
30311
|
+
*
|
|
30312
|
+
* @type {any}
|
|
30313
|
+
* @memberof DataTypesSearchResponse
|
|
30314
|
+
*/
|
|
30315
|
+
'facets'?: any;
|
|
30316
|
+
/**
|
|
30317
|
+
*
|
|
30318
|
+
* @type {number}
|
|
30319
|
+
* @memberof DataTypesSearchResponse
|
|
30320
|
+
*/
|
|
30321
|
+
'page'?: number;
|
|
30322
|
+
/**
|
|
30323
|
+
*
|
|
30324
|
+
* @type {number}
|
|
30325
|
+
* @memberof DataTypesSearchResponse
|
|
30326
|
+
*/
|
|
30327
|
+
'per_page'?: number;
|
|
30328
|
+
/**
|
|
30329
|
+
*
|
|
30330
|
+
* @type {Array<DataTypesSearchResult>}
|
|
30331
|
+
* @memberof DataTypesSearchResponse
|
|
30332
|
+
*/
|
|
30333
|
+
'results'?: Array<DataTypesSearchResult>;
|
|
30334
|
+
/**
|
|
30335
|
+
* Unique search identifier for analytics linking
|
|
30336
|
+
* @type {string}
|
|
30337
|
+
* @memberof DataTypesSearchResponse
|
|
30338
|
+
*/
|
|
30339
|
+
'search_id'?: string;
|
|
30340
|
+
/**
|
|
30341
|
+
* Available sort options based on schema
|
|
30342
|
+
* @type {Array<DataTypesSortOption>}
|
|
30343
|
+
* @memberof DataTypesSearchResponse
|
|
30344
|
+
*/
|
|
30345
|
+
'sort_options'?: Array<DataTypesSortOption>;
|
|
30346
|
+
/**
|
|
30347
|
+
*
|
|
30348
|
+
* @type {Array<DataTypesAutocompleteSuggestion>}
|
|
30349
|
+
* @memberof DataTypesSearchResponse
|
|
30350
|
+
*/
|
|
30351
|
+
'suggestions'?: Array<DataTypesAutocompleteSuggestion>;
|
|
30352
|
+
/**
|
|
30353
|
+
*
|
|
30354
|
+
* @type {number}
|
|
30355
|
+
* @memberof DataTypesSearchResponse
|
|
30356
|
+
*/
|
|
30357
|
+
'total_results'?: number;
|
|
30358
|
+
}
|
|
30359
|
+
/**
|
|
30360
|
+
*
|
|
30361
|
+
* @export
|
|
30362
|
+
* @interface DataTypesSearchResponseWrapper
|
|
30363
|
+
*/
|
|
30364
|
+
export interface DataTypesSearchResponseWrapper {
|
|
30365
|
+
/**
|
|
30366
|
+
*
|
|
30367
|
+
* @type {DataTypesSearchResponse}
|
|
30368
|
+
* @memberof DataTypesSearchResponseWrapper
|
|
30369
|
+
*/
|
|
30370
|
+
'data'?: DataTypesSearchResponse;
|
|
30371
|
+
/**
|
|
30372
|
+
*
|
|
30373
|
+
* @type {string}
|
|
30374
|
+
* @memberof DataTypesSearchResponseWrapper
|
|
30375
|
+
*/
|
|
30376
|
+
'message'?: string;
|
|
30377
|
+
/**
|
|
30378
|
+
*
|
|
30379
|
+
* @type {number}
|
|
30380
|
+
* @memberof DataTypesSearchResponseWrapper
|
|
30381
|
+
*/
|
|
30382
|
+
'status'?: number;
|
|
30383
|
+
}
|
|
29517
30384
|
/**
|
|
29518
30385
|
*
|
|
29519
30386
|
* @export
|
|
@@ -29522,22 +30389,32 @@ export interface DataTypesSearchRequestsGraphResponse {
|
|
|
29522
30389
|
export interface DataTypesSearchResult {
|
|
29523
30390
|
/**
|
|
29524
30391
|
*
|
|
29525
|
-
* @type {
|
|
30392
|
+
* @type {{ [key: string]: any; }}
|
|
29526
30393
|
* @memberof DataTypesSearchResult
|
|
29527
30394
|
*/
|
|
29528
|
-
'
|
|
30395
|
+
'document'?: {
|
|
30396
|
+
[key: string]: any;
|
|
30397
|
+
};
|
|
29529
30398
|
/**
|
|
29530
30399
|
*
|
|
29531
|
-
* @type {
|
|
30400
|
+
* @type {{ [key: string]: any; }}
|
|
29532
30401
|
* @memberof DataTypesSearchResult
|
|
29533
30402
|
*/
|
|
29534
|
-
'
|
|
30403
|
+
'highlight'?: {
|
|
30404
|
+
[key: string]: any;
|
|
30405
|
+
};
|
|
29535
30406
|
/**
|
|
29536
30407
|
*
|
|
29537
30408
|
* @type {string}
|
|
29538
30409
|
* @memberof DataTypesSearchResult
|
|
29539
30410
|
*/
|
|
29540
|
-
'
|
|
30411
|
+
'id'?: string;
|
|
30412
|
+
/**
|
|
30413
|
+
*
|
|
30414
|
+
* @type {number}
|
|
30415
|
+
* @memberof DataTypesSearchResult
|
|
30416
|
+
*/
|
|
30417
|
+
'score'?: number;
|
|
29541
30418
|
}
|
|
29542
30419
|
/**
|
|
29543
30420
|
*
|
|
@@ -29547,10 +30424,10 @@ export interface DataTypesSearchResult {
|
|
|
29547
30424
|
export interface DataTypesSearchResultResponse {
|
|
29548
30425
|
/**
|
|
29549
30426
|
*
|
|
29550
|
-
* @type {
|
|
30427
|
+
* @type {DataTypesConnectorSearchResult}
|
|
29551
30428
|
* @memberof DataTypesSearchResultResponse
|
|
29552
30429
|
*/
|
|
29553
|
-
'data'?:
|
|
30430
|
+
'data'?: DataTypesConnectorSearchResult;
|
|
29554
30431
|
/**
|
|
29555
30432
|
*
|
|
29556
30433
|
* @type {string}
|
|
@@ -31075,6 +31952,409 @@ export interface DataTypesStoreAccessWithDetails {
|
|
|
31075
31952
|
*/
|
|
31076
31953
|
'user_id'?: number;
|
|
31077
31954
|
}
|
|
31955
|
+
/**
|
|
31956
|
+
*
|
|
31957
|
+
* @export
|
|
31958
|
+
* @interface DataTypesStoreConfigUpdateRequest
|
|
31959
|
+
*/
|
|
31960
|
+
export interface DataTypesStoreConfigUpdateRequest {
|
|
31961
|
+
/**
|
|
31962
|
+
* Optional: If set, updates the public search flag
|
|
31963
|
+
* @type {boolean}
|
|
31964
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31965
|
+
*/
|
|
31966
|
+
'allow_public_search'?: boolean;
|
|
31967
|
+
/**
|
|
31968
|
+
*
|
|
31969
|
+
* @type {string}
|
|
31970
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31971
|
+
*/
|
|
31972
|
+
'collection_alias'?: string;
|
|
31973
|
+
/**
|
|
31974
|
+
*
|
|
31975
|
+
* @type {string}
|
|
31976
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31977
|
+
*/
|
|
31978
|
+
'collection_name'?: string;
|
|
31979
|
+
/**
|
|
31980
|
+
*
|
|
31981
|
+
* @type {string}
|
|
31982
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31983
|
+
*/
|
|
31984
|
+
'default_sorting_field'?: string;
|
|
31985
|
+
/**
|
|
31986
|
+
* Default stopwords set ID to use in searches
|
|
31987
|
+
* @type {string}
|
|
31988
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31989
|
+
*/
|
|
31990
|
+
'default_stopwords_set'?: string;
|
|
31991
|
+
/**
|
|
31992
|
+
*
|
|
31993
|
+
* @type {number}
|
|
31994
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
31995
|
+
*/
|
|
31996
|
+
'drop_tokens_threshold'?: number;
|
|
31997
|
+
/**
|
|
31998
|
+
* Dropdown recommendations configuration
|
|
31999
|
+
* @type {DataTypesDropdownRecommendationsConfig}
|
|
32000
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32001
|
+
*/
|
|
32002
|
+
'dropdown_recommendations_config'?: DataTypesDropdownRecommendationsConfig;
|
|
32003
|
+
/**
|
|
32004
|
+
*
|
|
32005
|
+
* @type {string}
|
|
32006
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32007
|
+
*/
|
|
32008
|
+
'embed'?: string;
|
|
32009
|
+
/**
|
|
32010
|
+
*
|
|
32011
|
+
* @type {boolean}
|
|
32012
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32013
|
+
*/
|
|
32014
|
+
'enable_autocomplete'?: boolean;
|
|
32015
|
+
/**
|
|
32016
|
+
*
|
|
32017
|
+
* @type {boolean}
|
|
32018
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32019
|
+
*/
|
|
32020
|
+
'enable_highlight'?: boolean;
|
|
32021
|
+
/**
|
|
32022
|
+
*
|
|
32023
|
+
* @type {boolean}
|
|
32024
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32025
|
+
*/
|
|
32026
|
+
'enable_overrides'?: boolean;
|
|
32027
|
+
/**
|
|
32028
|
+
*
|
|
32029
|
+
* @type {boolean}
|
|
32030
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32031
|
+
*/
|
|
32032
|
+
'enable_smart_autocomplete'?: boolean;
|
|
32033
|
+
/**
|
|
32034
|
+
* Enable stemming on search collections
|
|
32035
|
+
* @type {boolean}
|
|
32036
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32037
|
+
*/
|
|
32038
|
+
'enable_stemming'?: boolean;
|
|
32039
|
+
/**
|
|
32040
|
+
*
|
|
32041
|
+
* @type {boolean}
|
|
32042
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32043
|
+
*/
|
|
32044
|
+
'enable_typo_highlight'?: boolean;
|
|
32045
|
+
/**
|
|
32046
|
+
*
|
|
32047
|
+
* @type {boolean}
|
|
32048
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32049
|
+
*/
|
|
32050
|
+
'enable_typo_tolerance'?: boolean;
|
|
32051
|
+
/**
|
|
32052
|
+
* No omitempty to preserve empty arrays
|
|
32053
|
+
* @type {Array<string>}
|
|
32054
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32055
|
+
*/
|
|
32056
|
+
'exclude_fields'?: Array<string>;
|
|
32057
|
+
/**
|
|
32058
|
+
*
|
|
32059
|
+
* @type {boolean}
|
|
32060
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32061
|
+
*/
|
|
32062
|
+
'exhaustive_search'?: boolean;
|
|
32063
|
+
/**
|
|
32064
|
+
* No omitempty to preserve empty arrays
|
|
32065
|
+
* @type {Array<string>}
|
|
32066
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32067
|
+
*/
|
|
32068
|
+
'facet_by'?: Array<string>;
|
|
32069
|
+
/**
|
|
32070
|
+
*
|
|
32071
|
+
* @type {string}
|
|
32072
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32073
|
+
*/
|
|
32074
|
+
'facet_query'?: string;
|
|
32075
|
+
/**
|
|
32076
|
+
* No omitempty to preserve empty arrays
|
|
32077
|
+
* @type {Array<DataTypesFacetRangeConfig>}
|
|
32078
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32079
|
+
*/
|
|
32080
|
+
'facet_ranges'?: Array<DataTypesFacetRangeConfig>;
|
|
32081
|
+
/**
|
|
32082
|
+
*
|
|
32083
|
+
* @type {string}
|
|
32084
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32085
|
+
*/
|
|
32086
|
+
'filter_by'?: string;
|
|
32087
|
+
/**
|
|
32088
|
+
*
|
|
32089
|
+
* @type {string}
|
|
32090
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32091
|
+
*/
|
|
32092
|
+
'group_by'?: string;
|
|
32093
|
+
/**
|
|
32094
|
+
*
|
|
32095
|
+
* @type {number}
|
|
32096
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32097
|
+
*/
|
|
32098
|
+
'group_limit'?: number;
|
|
32099
|
+
/**
|
|
32100
|
+
* No omitempty to preserve empty arrays
|
|
32101
|
+
* @type {Array<string>}
|
|
32102
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32103
|
+
*/
|
|
32104
|
+
'hidden_facet_fields'?: Array<string>;
|
|
32105
|
+
/**
|
|
32106
|
+
* No omitempty to preserve empty arrays
|
|
32107
|
+
* @type {Array<string>}
|
|
32108
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32109
|
+
*/
|
|
32110
|
+
'hidden_fields'?: Array<string>;
|
|
32111
|
+
/**
|
|
32112
|
+
* No omitempty to preserve empty arrays
|
|
32113
|
+
* @type {Array<string>}
|
|
32114
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32115
|
+
*/
|
|
32116
|
+
'hidden_filter_fields'?: Array<string>;
|
|
32117
|
+
/**
|
|
32118
|
+
*
|
|
32119
|
+
* @type {number}
|
|
32120
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32121
|
+
*/
|
|
32122
|
+
'highlight_affix_num_tokens'?: number;
|
|
32123
|
+
/**
|
|
32124
|
+
*
|
|
32125
|
+
* @type {string}
|
|
32126
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32127
|
+
*/
|
|
32128
|
+
'highlight_end_tag'?: string;
|
|
32129
|
+
/**
|
|
32130
|
+
* No omitempty to preserve empty arrays
|
|
32131
|
+
* @type {Array<string>}
|
|
32132
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32133
|
+
*/
|
|
32134
|
+
'highlight_fields'?: Array<string>;
|
|
32135
|
+
/**
|
|
32136
|
+
* No omitempty to preserve empty arrays
|
|
32137
|
+
* @type {Array<string>}
|
|
32138
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32139
|
+
*/
|
|
32140
|
+
'highlight_full_fields'?: Array<string>;
|
|
32141
|
+
/**
|
|
32142
|
+
*
|
|
32143
|
+
* @type {string}
|
|
32144
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32145
|
+
*/
|
|
32146
|
+
'highlight_start_tag'?: string;
|
|
32147
|
+
/**
|
|
32148
|
+
*
|
|
32149
|
+
* @type {string}
|
|
32150
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32151
|
+
*/
|
|
32152
|
+
'image_url'?: string;
|
|
32153
|
+
/**
|
|
32154
|
+
* No omitempty to preserve empty arrays
|
|
32155
|
+
* @type {Array<string>}
|
|
32156
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32157
|
+
*/
|
|
32158
|
+
'include_fields'?: Array<string>;
|
|
32159
|
+
/**
|
|
32160
|
+
* \"always\", \"fallback\", or \"off\"
|
|
32161
|
+
* @type {string}
|
|
32162
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32163
|
+
*/
|
|
32164
|
+
'infix'?: string;
|
|
32165
|
+
/**
|
|
32166
|
+
*
|
|
32167
|
+
* @type {string}
|
|
32168
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32169
|
+
*/
|
|
32170
|
+
'locale'?: string;
|
|
32171
|
+
/**
|
|
32172
|
+
*
|
|
32173
|
+
* @type {number}
|
|
32174
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32175
|
+
*/
|
|
32176
|
+
'max_candidates'?: number;
|
|
32177
|
+
/**
|
|
32178
|
+
*
|
|
32179
|
+
* @type {number}
|
|
32180
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32181
|
+
*/
|
|
32182
|
+
'max_facet_values'?: number;
|
|
32183
|
+
/**
|
|
32184
|
+
*
|
|
32185
|
+
* @type {number}
|
|
32186
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32187
|
+
*/
|
|
32188
|
+
'min_len_1typo'?: number;
|
|
32189
|
+
/**
|
|
32190
|
+
*
|
|
32191
|
+
* @type {number}
|
|
32192
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32193
|
+
*/
|
|
32194
|
+
'min_len_2typo'?: number;
|
|
32195
|
+
/**
|
|
32196
|
+
*
|
|
32197
|
+
* @type {number}
|
|
32198
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32199
|
+
*/
|
|
32200
|
+
'num_typos'?: number;
|
|
32201
|
+
/**
|
|
32202
|
+
*
|
|
32203
|
+
* @type {number}
|
|
32204
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32205
|
+
*/
|
|
32206
|
+
'page'?: number;
|
|
32207
|
+
/**
|
|
32208
|
+
*
|
|
32209
|
+
* @type {number}
|
|
32210
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32211
|
+
*/
|
|
32212
|
+
'per_page'?: number;
|
|
32213
|
+
/**
|
|
32214
|
+
*
|
|
32215
|
+
* @type {string}
|
|
32216
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32217
|
+
*/
|
|
32218
|
+
'prefix'?: string;
|
|
32219
|
+
/**
|
|
32220
|
+
*
|
|
32221
|
+
* @type {string}
|
|
32222
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32223
|
+
*/
|
|
32224
|
+
'preset'?: string;
|
|
32225
|
+
/**
|
|
32226
|
+
*
|
|
32227
|
+
* @type {string}
|
|
32228
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32229
|
+
*/
|
|
32230
|
+
'primary_text'?: string;
|
|
32231
|
+
/**
|
|
32232
|
+
*
|
|
32233
|
+
* @type {boolean}
|
|
32234
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32235
|
+
*/
|
|
32236
|
+
'prioritize_exact_match'?: boolean;
|
|
32237
|
+
/**
|
|
32238
|
+
* Required: Query string
|
|
32239
|
+
* @type {string}
|
|
32240
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32241
|
+
*/
|
|
32242
|
+
'q'?: string;
|
|
32243
|
+
/**
|
|
32244
|
+
* Required: Array of search fields
|
|
32245
|
+
* @type {Array<string>}
|
|
32246
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32247
|
+
*/
|
|
32248
|
+
'query_by'?: Array<string>;
|
|
32249
|
+
/**
|
|
32250
|
+
* Optional: Relative field weights as array (no omitempty to preserve empty arrays)
|
|
32251
|
+
* @type {Array<number>}
|
|
32252
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32253
|
+
*/
|
|
32254
|
+
'query_by_weights'?: Array<number>;
|
|
32255
|
+
/**
|
|
32256
|
+
* Query suggestions configuration
|
|
32257
|
+
* @type {DataTypesQuerySuggestionsConfig}
|
|
32258
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32259
|
+
*/
|
|
32260
|
+
'query_suggestions_config'?: DataTypesQuerySuggestionsConfig;
|
|
32261
|
+
/**
|
|
32262
|
+
*
|
|
32263
|
+
* @type {boolean}
|
|
32264
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32265
|
+
*/
|
|
32266
|
+
'query_syntax'?: boolean;
|
|
32267
|
+
/**
|
|
32268
|
+
*
|
|
32269
|
+
* @type {number}
|
|
32270
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32271
|
+
*/
|
|
32272
|
+
'search_cutoff_ms'?: number;
|
|
32273
|
+
/**
|
|
32274
|
+
* \"text\", \"vector\", \"hybrid\"
|
|
32275
|
+
* @type {string}
|
|
32276
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32277
|
+
*/
|
|
32278
|
+
'search_strategy'?: string;
|
|
32279
|
+
/**
|
|
32280
|
+
*
|
|
32281
|
+
* @type {string}
|
|
32282
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32283
|
+
*/
|
|
32284
|
+
'secondary_text'?: string;
|
|
32285
|
+
/**
|
|
32286
|
+
*
|
|
32287
|
+
* @type {boolean}
|
|
32288
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32289
|
+
*/
|
|
32290
|
+
'semantic_ranker'?: boolean;
|
|
32291
|
+
/**
|
|
32292
|
+
*
|
|
32293
|
+
* @type {number}
|
|
32294
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32295
|
+
*/
|
|
32296
|
+
'snippet_threshold'?: number;
|
|
32297
|
+
/**
|
|
32298
|
+
* No omitempty to preserve empty arrays
|
|
32299
|
+
* @type {Array<DataTypesSortField>}
|
|
32300
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32301
|
+
*/
|
|
32302
|
+
'sort_by'?: Array<DataTypesSortField>;
|
|
32303
|
+
/**
|
|
32304
|
+
* Locale for stemming (e.g., \"en\", \"fr\", \"de\")
|
|
32305
|
+
* @type {string}
|
|
32306
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32307
|
+
*/
|
|
32308
|
+
'stemming_locale'?: string;
|
|
32309
|
+
/**
|
|
32310
|
+
* Flattened stopwords and synonyms fields
|
|
32311
|
+
* @type {Array<DataTypesStopwordEntry>}
|
|
32312
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32313
|
+
*/
|
|
32314
|
+
'stopwords'?: Array<DataTypesStopwordEntry>;
|
|
32315
|
+
/**
|
|
32316
|
+
* No omitempty to preserve empty arrays
|
|
32317
|
+
* @type {Array<string>}
|
|
32318
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32319
|
+
*/
|
|
32320
|
+
'symbols_to_index'?: Array<string>;
|
|
32321
|
+
/**
|
|
32322
|
+
* No omitempty to preserve empty arrays
|
|
32323
|
+
* @type {Array<DataTypesSynonymEntry>}
|
|
32324
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32325
|
+
*/
|
|
32326
|
+
'synonyms'?: Array<DataTypesSynonymEntry>;
|
|
32327
|
+
/**
|
|
32328
|
+
*
|
|
32329
|
+
* @type {string}
|
|
32330
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32331
|
+
*/
|
|
32332
|
+
'tertiary_text'?: string;
|
|
32333
|
+
/**
|
|
32334
|
+
* Optional: Search-only scoped API key
|
|
32335
|
+
* @type {string}
|
|
32336
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32337
|
+
*/
|
|
32338
|
+
'token'?: string;
|
|
32339
|
+
/**
|
|
32340
|
+
* No omitempty to preserve empty arrays
|
|
32341
|
+
* @type {Array<string>}
|
|
32342
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32343
|
+
*/
|
|
32344
|
+
'token_separators'?: Array<string>;
|
|
32345
|
+
/**
|
|
32346
|
+
*
|
|
32347
|
+
* @type {boolean}
|
|
32348
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32349
|
+
*/
|
|
32350
|
+
'use_cache'?: boolean;
|
|
32351
|
+
/**
|
|
32352
|
+
*
|
|
32353
|
+
* @type {string}
|
|
32354
|
+
* @memberof DataTypesStoreConfigUpdateRequest
|
|
32355
|
+
*/
|
|
32356
|
+
'vector_query'?: string;
|
|
32357
|
+
}
|
|
31078
32358
|
/**
|
|
31079
32359
|
*
|
|
31080
32360
|
* @export
|
|
@@ -31259,6 +32539,49 @@ export interface DataTypesStoreCredentialsResponse {
|
|
|
31259
32539
|
*/
|
|
31260
32540
|
'status'?: number;
|
|
31261
32541
|
}
|
|
32542
|
+
/**
|
|
32543
|
+
*
|
|
32544
|
+
* @export
|
|
32545
|
+
* @interface DataTypesStoreInfoResponse
|
|
32546
|
+
*/
|
|
32547
|
+
export interface DataTypesStoreInfoResponse {
|
|
32548
|
+
/**
|
|
32549
|
+
*
|
|
32550
|
+
* @type {string}
|
|
32551
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32552
|
+
*/
|
|
32553
|
+
'createdAt'?: string;
|
|
32554
|
+
/**
|
|
32555
|
+
*
|
|
32556
|
+
* @type {boolean}
|
|
32557
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32558
|
+
*/
|
|
32559
|
+
'isActive'?: boolean;
|
|
32560
|
+
/**
|
|
32561
|
+
*
|
|
32562
|
+
* @type {string}
|
|
32563
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32564
|
+
*/
|
|
32565
|
+
'location'?: string;
|
|
32566
|
+
/**
|
|
32567
|
+
*
|
|
32568
|
+
* @type {number}
|
|
32569
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32570
|
+
*/
|
|
32571
|
+
'storeId'?: number;
|
|
32572
|
+
/**
|
|
32573
|
+
*
|
|
32574
|
+
* @type {string}
|
|
32575
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32576
|
+
*/
|
|
32577
|
+
'storeName'?: string;
|
|
32578
|
+
/**
|
|
32579
|
+
*
|
|
32580
|
+
* @type {string}
|
|
32581
|
+
* @memberof DataTypesStoreInfoResponse
|
|
32582
|
+
*/
|
|
32583
|
+
'xStoreId'?: string;
|
|
32584
|
+
}
|
|
31262
32585
|
/**
|
|
31263
32586
|
*
|
|
31264
32587
|
* @export
|
|
@@ -32823,6 +34146,67 @@ export interface DataTypesUpdateAnalyticsRuleRequest {
|
|
|
32823
34146
|
*/
|
|
32824
34147
|
'rule_config'?: DataTypesRuleConfig;
|
|
32825
34148
|
}
|
|
34149
|
+
/**
|
|
34150
|
+
*
|
|
34151
|
+
* @export
|
|
34152
|
+
* @interface DataTypesUpdateCustomPlanRequest
|
|
34153
|
+
*/
|
|
34154
|
+
export interface DataTypesUpdateCustomPlanRequest {
|
|
34155
|
+
/**
|
|
34156
|
+
*
|
|
34157
|
+
* @type {number}
|
|
34158
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34159
|
+
*/
|
|
34160
|
+
'bonus_credits'?: number;
|
|
34161
|
+
/**
|
|
34162
|
+
*
|
|
34163
|
+
* @type {string}
|
|
34164
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34165
|
+
*/
|
|
34166
|
+
'description'?: string;
|
|
34167
|
+
/**
|
|
34168
|
+
*
|
|
34169
|
+
* @type {string}
|
|
34170
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34171
|
+
*/
|
|
34172
|
+
'highlights'?: string;
|
|
34173
|
+
/**
|
|
34174
|
+
*
|
|
34175
|
+
* @type {boolean}
|
|
34176
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34177
|
+
*/
|
|
34178
|
+
'is_active'?: boolean;
|
|
34179
|
+
/**
|
|
34180
|
+
*
|
|
34181
|
+
* @type {string}
|
|
34182
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34183
|
+
*/
|
|
34184
|
+
'notes'?: string;
|
|
34185
|
+
/**
|
|
34186
|
+
*
|
|
34187
|
+
* @type {string}
|
|
34188
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34189
|
+
*/
|
|
34190
|
+
'plan_features'?: string;
|
|
34191
|
+
/**
|
|
34192
|
+
*
|
|
34193
|
+
* @type {string}
|
|
34194
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34195
|
+
*/
|
|
34196
|
+
'plan_name'?: string;
|
|
34197
|
+
/**
|
|
34198
|
+
*
|
|
34199
|
+
* @type {number}
|
|
34200
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34201
|
+
*/
|
|
34202
|
+
'price'?: number;
|
|
34203
|
+
/**
|
|
34204
|
+
*
|
|
34205
|
+
* @type {number}
|
|
34206
|
+
* @memberof DataTypesUpdateCustomPlanRequest
|
|
34207
|
+
*/
|
|
34208
|
+
'total_credits'?: number;
|
|
34209
|
+
}
|
|
32826
34210
|
/**
|
|
32827
34211
|
*
|
|
32828
34212
|
* @export
|
|
@@ -44439,7 +45823,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
44439
45823
|
* @param {*} [options] Override http request option.
|
|
44440
45824
|
* @throws {RequiredError}
|
|
44441
45825
|
*/
|
|
44442
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45826
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>>;
|
|
44443
45827
|
/**
|
|
44444
45828
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
44445
45829
|
* @summary Get Analytics Configuration
|
|
@@ -44448,7 +45832,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
44448
45832
|
* @param {*} [options] Override http request option.
|
|
44449
45833
|
* @throws {RequiredError}
|
|
44450
45834
|
*/
|
|
44451
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45835
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>>;
|
|
44452
45836
|
/**
|
|
44453
45837
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
44454
45838
|
* @summary Submit Analytics Event
|
|
@@ -44458,7 +45842,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
44458
45842
|
* @param {*} [options] Override http request option.
|
|
44459
45843
|
* @throws {RequiredError}
|
|
44460
45844
|
*/
|
|
44461
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45845
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>>;
|
|
44462
45846
|
/**
|
|
44463
45847
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
44464
45848
|
* @summary Get Event Schema
|
|
@@ -44477,7 +45861,7 @@ export declare const AnalyticsEventsApiFp: (configuration?: Configuration) => {
|
|
|
44477
45861
|
* @param {*} [options] Override http request option.
|
|
44478
45862
|
* @throws {RequiredError}
|
|
44479
45863
|
*/
|
|
44480
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
45864
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>>;
|
|
44481
45865
|
};
|
|
44482
45866
|
/**
|
|
44483
45867
|
* AnalyticsEventsApi - factory interface
|
|
@@ -44493,7 +45877,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
44493
45877
|
* @param {*} [options] Override http request option.
|
|
44494
45878
|
* @throws {RequiredError}
|
|
44495
45879
|
*/
|
|
44496
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45880
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesBatchEventData>;
|
|
44497
45881
|
/**
|
|
44498
45882
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
44499
45883
|
* @summary Get Analytics Configuration
|
|
@@ -44502,7 +45886,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
44502
45886
|
* @param {*} [options] Override http request option.
|
|
44503
45887
|
* @throws {RequiredError}
|
|
44504
45888
|
*/
|
|
44505
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45889
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesAnalyticsConfigData>;
|
|
44506
45890
|
/**
|
|
44507
45891
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
44508
45892
|
* @summary Submit Analytics Event
|
|
@@ -44512,7 +45896,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
44512
45896
|
* @param {*} [options] Override http request option.
|
|
44513
45897
|
* @throws {RequiredError}
|
|
44514
45898
|
*/
|
|
44515
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45899
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventSubmitData>;
|
|
44516
45900
|
/**
|
|
44517
45901
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
44518
45902
|
* @summary Get Event Schema
|
|
@@ -44531,7 +45915,7 @@ export declare const AnalyticsEventsApiFactory: (configuration?: Configuration,
|
|
|
44531
45915
|
* @param {*} [options] Override http request option.
|
|
44532
45916
|
* @throws {RequiredError}
|
|
44533
45917
|
*/
|
|
44534
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
45918
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesEventValidateData>;
|
|
44535
45919
|
};
|
|
44536
45920
|
/**
|
|
44537
45921
|
* AnalyticsEventsApi - object-oriented interface
|
|
@@ -44550,7 +45934,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
44550
45934
|
* @throws {RequiredError}
|
|
44551
45935
|
* @memberof AnalyticsEventsApi
|
|
44552
45936
|
*/
|
|
44553
|
-
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
45937
|
+
analyticsBatchPost(xStoreid: string, xStoresecret: string, analyticsBatchPostRequest: AnalyticsBatchPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesBatchEventData, any, {}>>;
|
|
44554
45938
|
/**
|
|
44555
45939
|
* Retrieve analytics configuration including supported event types, batch limits, and funnel stages for client integration
|
|
44556
45940
|
* @summary Get Analytics Configuration
|
|
@@ -44560,7 +45944,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
44560
45944
|
* @throws {RequiredError}
|
|
44561
45945
|
* @memberof AnalyticsEventsApi
|
|
44562
45946
|
*/
|
|
44563
|
-
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
45947
|
+
analyticsConfigGet(xStoreid: string, xStoresecret: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesAnalyticsConfigData, any, {}>>;
|
|
44564
45948
|
/**
|
|
44565
45949
|
* Submit a single analytics event for tracking user interactions, search behavior, and conversions
|
|
44566
45950
|
* @summary Submit Analytics Event
|
|
@@ -44571,7 +45955,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
44571
45955
|
* @throws {RequiredError}
|
|
44572
45956
|
* @memberof AnalyticsEventsApi
|
|
44573
45957
|
*/
|
|
44574
|
-
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
45958
|
+
analyticsEventPost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventSubmitData, any, {}>>;
|
|
44575
45959
|
/**
|
|
44576
45960
|
* Retrieve the complete event schema including required and optional fields, data types, and validation rules
|
|
44577
45961
|
* @summary Get Event Schema
|
|
@@ -44592,7 +45976,7 @@ export declare class AnalyticsEventsApi extends BaseAPI {
|
|
|
44592
45976
|
* @throws {RequiredError}
|
|
44593
45977
|
* @memberof AnalyticsEventsApi
|
|
44594
45978
|
*/
|
|
44595
|
-
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
45979
|
+
analyticsValidatePost(xStoreid: string, xStoresecret: string, dataTypesEventPayload: DataTypesEventPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesEventValidateData, any, {}>>;
|
|
44596
45980
|
}
|
|
44597
45981
|
/**
|
|
44598
45982
|
* AnalyticsFunnelsApi - axios parameter creator
|
|
@@ -46917,6 +48301,469 @@ export declare class AutomatedRefundManagementApi extends BaseAPI {
|
|
|
46917
48301
|
*/
|
|
46918
48302
|
refundAutomatedProcessPost(refundRefundPreviewRequestDto: RefundRefundPreviewRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
46919
48303
|
}
|
|
48304
|
+
/**
|
|
48305
|
+
* BackofficeCustomPlansApi - axios parameter creator
|
|
48306
|
+
* @export
|
|
48307
|
+
*/
|
|
48308
|
+
export declare const BackofficeCustomPlansApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48309
|
+
/**
|
|
48310
|
+
* Returns a paginated, filterable list of custom enterprise plans
|
|
48311
|
+
* @summary List custom plans
|
|
48312
|
+
* @param {number} [page] Page number
|
|
48313
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48314
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48315
|
+
* @param {string} [status] Filter by status (active, inactive, all)
|
|
48316
|
+
* @param {string} [search] Search by plan name or org name
|
|
48317
|
+
* @param {*} [options] Override http request option.
|
|
48318
|
+
* @throws {RequiredError}
|
|
48319
|
+
*/
|
|
48320
|
+
backofficePlansCustomGet: (page?: number, pageSize?: number, orgId?: number, status?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48321
|
+
/**
|
|
48322
|
+
* Deactivates a custom enterprise plan by setting is_active to false
|
|
48323
|
+
* @summary Soft-delete a custom plan
|
|
48324
|
+
* @param {number} id Custom plan ID
|
|
48325
|
+
* @param {*} [options] Override http request option.
|
|
48326
|
+
* @throws {RequiredError}
|
|
48327
|
+
*/
|
|
48328
|
+
backofficePlansCustomIdDelete: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48329
|
+
/**
|
|
48330
|
+
* Retrieves a single custom enterprise plan by its ID
|
|
48331
|
+
* @summary Get a custom plan by ID
|
|
48332
|
+
* @param {number} id Custom plan ID
|
|
48333
|
+
* @param {*} [options] Override http request option.
|
|
48334
|
+
* @throws {RequiredError}
|
|
48335
|
+
*/
|
|
48336
|
+
backofficePlansCustomIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48337
|
+
/**
|
|
48338
|
+
* Records a manual/offline payment for a custom plan, creates subscription and allocates credits
|
|
48339
|
+
* @summary Mark a custom plan as paid (offline payment)
|
|
48340
|
+
* @param {number} id Custom plan ID
|
|
48341
|
+
* @param {DataTypesMarkPaidRequest} dataTypesMarkPaidRequest Offline payment details
|
|
48342
|
+
* @param {*} [options] Override http request option.
|
|
48343
|
+
* @throws {RequiredError}
|
|
48344
|
+
*/
|
|
48345
|
+
backofficePlansCustomIdMarkPaidPost: (id: number, dataTypesMarkPaidRequest: DataTypesMarkPaidRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48346
|
+
/**
|
|
48347
|
+
* Sends a notification to the organization regarding their custom plan
|
|
48348
|
+
* @summary Send notification to org about custom plan
|
|
48349
|
+
* @param {number} id Custom plan ID
|
|
48350
|
+
* @param {DataTypesNotifyOrgRequest} [dataTypesNotifyOrgRequest] Notification options
|
|
48351
|
+
* @param {*} [options] Override http request option.
|
|
48352
|
+
* @throws {RequiredError}
|
|
48353
|
+
*/
|
|
48354
|
+
backofficePlansCustomIdNotifyPost: (id: number, dataTypesNotifyOrgRequest?: DataTypesNotifyOrgRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48355
|
+
/**
|
|
48356
|
+
* Creates a payment link via the specified gateway for a custom plan
|
|
48357
|
+
* @summary Generate a payment link for a custom plan
|
|
48358
|
+
* @param {number} id Custom plan ID
|
|
48359
|
+
* @param {DataTypesGeneratePaymentLinkRequest} dataTypesGeneratePaymentLinkRequest Payment link options
|
|
48360
|
+
* @param {*} [options] Override http request option.
|
|
48361
|
+
* @throws {RequiredError}
|
|
48362
|
+
*/
|
|
48363
|
+
backofficePlansCustomIdPaymentLinkPost: (id: number, dataTypesGeneratePaymentLinkRequest: DataTypesGeneratePaymentLinkRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48364
|
+
/**
|
|
48365
|
+
* Updates the specified fields of a custom enterprise plan
|
|
48366
|
+
* @summary Update a custom plan
|
|
48367
|
+
* @param {number} id Custom plan ID
|
|
48368
|
+
* @param {DataTypesUpdateCustomPlanRequest} dataTypesUpdateCustomPlanRequest Fields to update
|
|
48369
|
+
* @param {*} [options] Override http request option.
|
|
48370
|
+
* @throws {RequiredError}
|
|
48371
|
+
*/
|
|
48372
|
+
backofficePlansCustomIdPut: (id: number, dataTypesUpdateCustomPlanRequest: DataTypesUpdateCustomPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48373
|
+
/**
|
|
48374
|
+
* Creates a new custom enterprise plan for a specific organization
|
|
48375
|
+
* @summary Create a custom enterprise plan
|
|
48376
|
+
* @param {DataTypesCreateCustomPlanRequest} dataTypesCreateCustomPlanRequest Custom plan details
|
|
48377
|
+
* @param {*} [options] Override http request option.
|
|
48378
|
+
* @throws {RequiredError}
|
|
48379
|
+
*/
|
|
48380
|
+
backofficePlansCustomPost: (dataTypesCreateCustomPlanRequest: DataTypesCreateCustomPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48381
|
+
};
|
|
48382
|
+
/**
|
|
48383
|
+
* BackofficeCustomPlansApi - functional programming interface
|
|
48384
|
+
* @export
|
|
48385
|
+
*/
|
|
48386
|
+
export declare const BackofficeCustomPlansApiFp: (configuration?: Configuration) => {
|
|
48387
|
+
/**
|
|
48388
|
+
* Returns a paginated, filterable list of custom enterprise plans
|
|
48389
|
+
* @summary List custom plans
|
|
48390
|
+
* @param {number} [page] Page number
|
|
48391
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48392
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48393
|
+
* @param {string} [status] Filter by status (active, inactive, all)
|
|
48394
|
+
* @param {string} [search] Search by plan name or org name
|
|
48395
|
+
* @param {*} [options] Override http request option.
|
|
48396
|
+
* @throws {RequiredError}
|
|
48397
|
+
*/
|
|
48398
|
+
backofficePlansCustomGet(page?: number, pageSize?: number, orgId?: number, status?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCustomPlanListResponse>>;
|
|
48399
|
+
/**
|
|
48400
|
+
* Deactivates a custom enterprise plan by setting is_active to false
|
|
48401
|
+
* @summary Soft-delete a custom plan
|
|
48402
|
+
* @param {number} id Custom plan ID
|
|
48403
|
+
* @param {*} [options] Override http request option.
|
|
48404
|
+
* @throws {RequiredError}
|
|
48405
|
+
*/
|
|
48406
|
+
backofficePlansCustomIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48407
|
+
/**
|
|
48408
|
+
* Retrieves a single custom enterprise plan by its ID
|
|
48409
|
+
* @summary Get a custom plan by ID
|
|
48410
|
+
* @param {number} id Custom plan ID
|
|
48411
|
+
* @param {*} [options] Override http request option.
|
|
48412
|
+
* @throws {RequiredError}
|
|
48413
|
+
*/
|
|
48414
|
+
backofficePlansCustomIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCustomPlanResponse>>;
|
|
48415
|
+
/**
|
|
48416
|
+
* Records a manual/offline payment for a custom plan, creates subscription and allocates credits
|
|
48417
|
+
* @summary Mark a custom plan as paid (offline payment)
|
|
48418
|
+
* @param {number} id Custom plan ID
|
|
48419
|
+
* @param {DataTypesMarkPaidRequest} dataTypesMarkPaidRequest Offline payment details
|
|
48420
|
+
* @param {*} [options] Override http request option.
|
|
48421
|
+
* @throws {RequiredError}
|
|
48422
|
+
*/
|
|
48423
|
+
backofficePlansCustomIdMarkPaidPost(id: number, dataTypesMarkPaidRequest: DataTypesMarkPaidRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfflinePaymentResponse>>;
|
|
48424
|
+
/**
|
|
48425
|
+
* Sends a notification to the organization regarding their custom plan
|
|
48426
|
+
* @summary Send notification to org about custom plan
|
|
48427
|
+
* @param {number} id Custom plan ID
|
|
48428
|
+
* @param {DataTypesNotifyOrgRequest} [dataTypesNotifyOrgRequest] Notification options
|
|
48429
|
+
* @param {*} [options] Override http request option.
|
|
48430
|
+
* @throws {RequiredError}
|
|
48431
|
+
*/
|
|
48432
|
+
backofficePlansCustomIdNotifyPost(id: number, dataTypesNotifyOrgRequest?: DataTypesNotifyOrgRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
|
|
48433
|
+
/**
|
|
48434
|
+
* Creates a payment link via the specified gateway for a custom plan
|
|
48435
|
+
* @summary Generate a payment link for a custom plan
|
|
48436
|
+
* @param {number} id Custom plan ID
|
|
48437
|
+
* @param {DataTypesGeneratePaymentLinkRequest} dataTypesGeneratePaymentLinkRequest Payment link options
|
|
48438
|
+
* @param {*} [options] Override http request option.
|
|
48439
|
+
* @throws {RequiredError}
|
|
48440
|
+
*/
|
|
48441
|
+
backofficePlansCustomIdPaymentLinkPost(id: number, dataTypesGeneratePaymentLinkRequest: DataTypesGeneratePaymentLinkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentLinkResponse>>;
|
|
48442
|
+
/**
|
|
48443
|
+
* Updates the specified fields of a custom enterprise plan
|
|
48444
|
+
* @summary Update a custom plan
|
|
48445
|
+
* @param {number} id Custom plan ID
|
|
48446
|
+
* @param {DataTypesUpdateCustomPlanRequest} dataTypesUpdateCustomPlanRequest Fields to update
|
|
48447
|
+
* @param {*} [options] Override http request option.
|
|
48448
|
+
* @throws {RequiredError}
|
|
48449
|
+
*/
|
|
48450
|
+
backofficePlansCustomIdPut(id: number, dataTypesUpdateCustomPlanRequest: DataTypesUpdateCustomPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCustomPlanResponse>>;
|
|
48451
|
+
/**
|
|
48452
|
+
* Creates a new custom enterprise plan for a specific organization
|
|
48453
|
+
* @summary Create a custom enterprise plan
|
|
48454
|
+
* @param {DataTypesCreateCustomPlanRequest} dataTypesCreateCustomPlanRequest Custom plan details
|
|
48455
|
+
* @param {*} [options] Override http request option.
|
|
48456
|
+
* @throws {RequiredError}
|
|
48457
|
+
*/
|
|
48458
|
+
backofficePlansCustomPost(dataTypesCreateCustomPlanRequest: DataTypesCreateCustomPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCustomPlanResponse>>;
|
|
48459
|
+
};
|
|
48460
|
+
/**
|
|
48461
|
+
* BackofficeCustomPlansApi - factory interface
|
|
48462
|
+
* @export
|
|
48463
|
+
*/
|
|
48464
|
+
export declare const BackofficeCustomPlansApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48465
|
+
/**
|
|
48466
|
+
* Returns a paginated, filterable list of custom enterprise plans
|
|
48467
|
+
* @summary List custom plans
|
|
48468
|
+
* @param {number} [page] Page number
|
|
48469
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48470
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48471
|
+
* @param {string} [status] Filter by status (active, inactive, all)
|
|
48472
|
+
* @param {string} [search] Search by plan name or org name
|
|
48473
|
+
* @param {*} [options] Override http request option.
|
|
48474
|
+
* @throws {RequiredError}
|
|
48475
|
+
*/
|
|
48476
|
+
backofficePlansCustomGet(page?: number, pageSize?: number, orgId?: number, status?: string, search?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCustomPlanListResponse>;
|
|
48477
|
+
/**
|
|
48478
|
+
* Deactivates a custom enterprise plan by setting is_active to false
|
|
48479
|
+
* @summary Soft-delete a custom plan
|
|
48480
|
+
* @param {number} id Custom plan ID
|
|
48481
|
+
* @param {*} [options] Override http request option.
|
|
48482
|
+
* @throws {RequiredError}
|
|
48483
|
+
*/
|
|
48484
|
+
backofficePlansCustomIdDelete(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
48485
|
+
/**
|
|
48486
|
+
* Retrieves a single custom enterprise plan by its ID
|
|
48487
|
+
* @summary Get a custom plan by ID
|
|
48488
|
+
* @param {number} id Custom plan ID
|
|
48489
|
+
* @param {*} [options] Override http request option.
|
|
48490
|
+
* @throws {RequiredError}
|
|
48491
|
+
*/
|
|
48492
|
+
backofficePlansCustomIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCustomPlanResponse>;
|
|
48493
|
+
/**
|
|
48494
|
+
* Records a manual/offline payment for a custom plan, creates subscription and allocates credits
|
|
48495
|
+
* @summary Mark a custom plan as paid (offline payment)
|
|
48496
|
+
* @param {number} id Custom plan ID
|
|
48497
|
+
* @param {DataTypesMarkPaidRequest} dataTypesMarkPaidRequest Offline payment details
|
|
48498
|
+
* @param {*} [options] Override http request option.
|
|
48499
|
+
* @throws {RequiredError}
|
|
48500
|
+
*/
|
|
48501
|
+
backofficePlansCustomIdMarkPaidPost(id: number, dataTypesMarkPaidRequest: DataTypesMarkPaidRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfflinePaymentResponse>;
|
|
48502
|
+
/**
|
|
48503
|
+
* Sends a notification to the organization regarding their custom plan
|
|
48504
|
+
* @summary Send notification to org about custom plan
|
|
48505
|
+
* @param {number} id Custom plan ID
|
|
48506
|
+
* @param {DataTypesNotifyOrgRequest} [dataTypesNotifyOrgRequest] Notification options
|
|
48507
|
+
* @param {*} [options] Override http request option.
|
|
48508
|
+
* @throws {RequiredError}
|
|
48509
|
+
*/
|
|
48510
|
+
backofficePlansCustomIdNotifyPost(id: number, dataTypesNotifyOrgRequest?: DataTypesNotifyOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
|
|
48511
|
+
/**
|
|
48512
|
+
* Creates a payment link via the specified gateway for a custom plan
|
|
48513
|
+
* @summary Generate a payment link for a custom plan
|
|
48514
|
+
* @param {number} id Custom plan ID
|
|
48515
|
+
* @param {DataTypesGeneratePaymentLinkRequest} dataTypesGeneratePaymentLinkRequest Payment link options
|
|
48516
|
+
* @param {*} [options] Override http request option.
|
|
48517
|
+
* @throws {RequiredError}
|
|
48518
|
+
*/
|
|
48519
|
+
backofficePlansCustomIdPaymentLinkPost(id: number, dataTypesGeneratePaymentLinkRequest: DataTypesGeneratePaymentLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentLinkResponse>;
|
|
48520
|
+
/**
|
|
48521
|
+
* Updates the specified fields of a custom enterprise plan
|
|
48522
|
+
* @summary Update a custom plan
|
|
48523
|
+
* @param {number} id Custom plan ID
|
|
48524
|
+
* @param {DataTypesUpdateCustomPlanRequest} dataTypesUpdateCustomPlanRequest Fields to update
|
|
48525
|
+
* @param {*} [options] Override http request option.
|
|
48526
|
+
* @throws {RequiredError}
|
|
48527
|
+
*/
|
|
48528
|
+
backofficePlansCustomIdPut(id: number, dataTypesUpdateCustomPlanRequest: DataTypesUpdateCustomPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCustomPlanResponse>;
|
|
48529
|
+
/**
|
|
48530
|
+
* Creates a new custom enterprise plan for a specific organization
|
|
48531
|
+
* @summary Create a custom enterprise plan
|
|
48532
|
+
* @param {DataTypesCreateCustomPlanRequest} dataTypesCreateCustomPlanRequest Custom plan details
|
|
48533
|
+
* @param {*} [options] Override http request option.
|
|
48534
|
+
* @throws {RequiredError}
|
|
48535
|
+
*/
|
|
48536
|
+
backofficePlansCustomPost(dataTypesCreateCustomPlanRequest: DataTypesCreateCustomPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCustomPlanResponse>;
|
|
48537
|
+
};
|
|
48538
|
+
/**
|
|
48539
|
+
* BackofficeCustomPlansApi - object-oriented interface
|
|
48540
|
+
* @export
|
|
48541
|
+
* @class BackofficeCustomPlansApi
|
|
48542
|
+
* @extends {BaseAPI}
|
|
48543
|
+
*/
|
|
48544
|
+
export declare class BackofficeCustomPlansApi extends BaseAPI {
|
|
48545
|
+
/**
|
|
48546
|
+
* Returns a paginated, filterable list of custom enterprise plans
|
|
48547
|
+
* @summary List custom plans
|
|
48548
|
+
* @param {number} [page] Page number
|
|
48549
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48550
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48551
|
+
* @param {string} [status] Filter by status (active, inactive, all)
|
|
48552
|
+
* @param {string} [search] Search by plan name or org name
|
|
48553
|
+
* @param {*} [options] Override http request option.
|
|
48554
|
+
* @throws {RequiredError}
|
|
48555
|
+
* @memberof BackofficeCustomPlansApi
|
|
48556
|
+
*/
|
|
48557
|
+
backofficePlansCustomGet(page?: number, pageSize?: number, orgId?: number, status?: string, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomPlanListResponse, any, {}>>;
|
|
48558
|
+
/**
|
|
48559
|
+
* Deactivates a custom enterprise plan by setting is_active to false
|
|
48560
|
+
* @summary Soft-delete a custom plan
|
|
48561
|
+
* @param {number} id Custom plan ID
|
|
48562
|
+
* @param {*} [options] Override http request option.
|
|
48563
|
+
* @throws {RequiredError}
|
|
48564
|
+
* @memberof BackofficeCustomPlansApi
|
|
48565
|
+
*/
|
|
48566
|
+
backofficePlansCustomIdDelete(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
48567
|
+
/**
|
|
48568
|
+
* Retrieves a single custom enterprise plan by its ID
|
|
48569
|
+
* @summary Get a custom plan by ID
|
|
48570
|
+
* @param {number} id Custom plan ID
|
|
48571
|
+
* @param {*} [options] Override http request option.
|
|
48572
|
+
* @throws {RequiredError}
|
|
48573
|
+
* @memberof BackofficeCustomPlansApi
|
|
48574
|
+
*/
|
|
48575
|
+
backofficePlansCustomIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomPlanResponse, any, {}>>;
|
|
48576
|
+
/**
|
|
48577
|
+
* Records a manual/offline payment for a custom plan, creates subscription and allocates credits
|
|
48578
|
+
* @summary Mark a custom plan as paid (offline payment)
|
|
48579
|
+
* @param {number} id Custom plan ID
|
|
48580
|
+
* @param {DataTypesMarkPaidRequest} dataTypesMarkPaidRequest Offline payment details
|
|
48581
|
+
* @param {*} [options] Override http request option.
|
|
48582
|
+
* @throws {RequiredError}
|
|
48583
|
+
* @memberof BackofficeCustomPlansApi
|
|
48584
|
+
*/
|
|
48585
|
+
backofficePlansCustomIdMarkPaidPost(id: number, dataTypesMarkPaidRequest: DataTypesMarkPaidRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfflinePaymentResponse, any, {}>>;
|
|
48586
|
+
/**
|
|
48587
|
+
* Sends a notification to the organization regarding their custom plan
|
|
48588
|
+
* @summary Send notification to org about custom plan
|
|
48589
|
+
* @param {number} id Custom plan ID
|
|
48590
|
+
* @param {DataTypesNotifyOrgRequest} [dataTypesNotifyOrgRequest] Notification options
|
|
48591
|
+
* @param {*} [options] Override http request option.
|
|
48592
|
+
* @throws {RequiredError}
|
|
48593
|
+
* @memberof BackofficeCustomPlansApi
|
|
48594
|
+
*/
|
|
48595
|
+
backofficePlansCustomIdNotifyPost(id: number, dataTypesNotifyOrgRequest?: DataTypesNotifyOrgRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any, {}>>;
|
|
48596
|
+
/**
|
|
48597
|
+
* Creates a payment link via the specified gateway for a custom plan
|
|
48598
|
+
* @summary Generate a payment link for a custom plan
|
|
48599
|
+
* @param {number} id Custom plan ID
|
|
48600
|
+
* @param {DataTypesGeneratePaymentLinkRequest} dataTypesGeneratePaymentLinkRequest Payment link options
|
|
48601
|
+
* @param {*} [options] Override http request option.
|
|
48602
|
+
* @throws {RequiredError}
|
|
48603
|
+
* @memberof BackofficeCustomPlansApi
|
|
48604
|
+
*/
|
|
48605
|
+
backofficePlansCustomIdPaymentLinkPost(id: number, dataTypesGeneratePaymentLinkRequest: DataTypesGeneratePaymentLinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentLinkResponse, any, {}>>;
|
|
48606
|
+
/**
|
|
48607
|
+
* Updates the specified fields of a custom enterprise plan
|
|
48608
|
+
* @summary Update a custom plan
|
|
48609
|
+
* @param {number} id Custom plan ID
|
|
48610
|
+
* @param {DataTypesUpdateCustomPlanRequest} dataTypesUpdateCustomPlanRequest Fields to update
|
|
48611
|
+
* @param {*} [options] Override http request option.
|
|
48612
|
+
* @throws {RequiredError}
|
|
48613
|
+
* @memberof BackofficeCustomPlansApi
|
|
48614
|
+
*/
|
|
48615
|
+
backofficePlansCustomIdPut(id: number, dataTypesUpdateCustomPlanRequest: DataTypesUpdateCustomPlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomPlanResponse, any, {}>>;
|
|
48616
|
+
/**
|
|
48617
|
+
* Creates a new custom enterprise plan for a specific organization
|
|
48618
|
+
* @summary Create a custom enterprise plan
|
|
48619
|
+
* @param {DataTypesCreateCustomPlanRequest} dataTypesCreateCustomPlanRequest Custom plan details
|
|
48620
|
+
* @param {*} [options] Override http request option.
|
|
48621
|
+
* @throws {RequiredError}
|
|
48622
|
+
* @memberof BackofficeCustomPlansApi
|
|
48623
|
+
*/
|
|
48624
|
+
backofficePlansCustomPost(dataTypesCreateCustomPlanRequest: DataTypesCreateCustomPlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomPlanResponse, any, {}>>;
|
|
48625
|
+
}
|
|
48626
|
+
/**
|
|
48627
|
+
* BackofficePaymentLinksApi - axios parameter creator
|
|
48628
|
+
* @export
|
|
48629
|
+
*/
|
|
48630
|
+
export declare const BackofficePaymentLinksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48631
|
+
/**
|
|
48632
|
+
* Returns a paginated, filterable list of payment links
|
|
48633
|
+
* @summary List payment links
|
|
48634
|
+
* @param {number} [page] Page number
|
|
48635
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48636
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48637
|
+
* @param {string} [status] Filter by status (created, paid, expired, cancelled, all)
|
|
48638
|
+
* @param {number} [planId] Filter by plan ID
|
|
48639
|
+
* @param {*} [options] Override http request option.
|
|
48640
|
+
* @throws {RequiredError}
|
|
48641
|
+
*/
|
|
48642
|
+
backofficePaymentLinksGet: (page?: number, pageSize?: number, orgId?: number, status?: string, planId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48643
|
+
/**
|
|
48644
|
+
* Cancels a payment link that is in \'created\' status
|
|
48645
|
+
* @summary Cancel a payment link
|
|
48646
|
+
* @param {number} id Payment link ID
|
|
48647
|
+
* @param {*} [options] Override http request option.
|
|
48648
|
+
* @throws {RequiredError}
|
|
48649
|
+
*/
|
|
48650
|
+
backofficePaymentLinksIdCancelPost: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48651
|
+
/**
|
|
48652
|
+
* Retrieves a single payment link by its ID
|
|
48653
|
+
* @summary Get a payment link by ID
|
|
48654
|
+
* @param {number} id Payment link ID
|
|
48655
|
+
* @param {*} [options] Override http request option.
|
|
48656
|
+
* @throws {RequiredError}
|
|
48657
|
+
*/
|
|
48658
|
+
backofficePaymentLinksIdGet: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48659
|
+
};
|
|
48660
|
+
/**
|
|
48661
|
+
* BackofficePaymentLinksApi - functional programming interface
|
|
48662
|
+
* @export
|
|
48663
|
+
*/
|
|
48664
|
+
export declare const BackofficePaymentLinksApiFp: (configuration?: Configuration) => {
|
|
48665
|
+
/**
|
|
48666
|
+
* Returns a paginated, filterable list of payment links
|
|
48667
|
+
* @summary List payment links
|
|
48668
|
+
* @param {number} [page] Page number
|
|
48669
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48670
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48671
|
+
* @param {string} [status] Filter by status (created, paid, expired, cancelled, all)
|
|
48672
|
+
* @param {number} [planId] Filter by plan ID
|
|
48673
|
+
* @param {*} [options] Override http request option.
|
|
48674
|
+
* @throws {RequiredError}
|
|
48675
|
+
*/
|
|
48676
|
+
backofficePaymentLinksGet(page?: number, pageSize?: number, orgId?: number, status?: string, planId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentLinkListResponse>>;
|
|
48677
|
+
/**
|
|
48678
|
+
* Cancels a payment link that is in \'created\' status
|
|
48679
|
+
* @summary Cancel a payment link
|
|
48680
|
+
* @param {number} id Payment link ID
|
|
48681
|
+
* @param {*} [options] Override http request option.
|
|
48682
|
+
* @throws {RequiredError}
|
|
48683
|
+
*/
|
|
48684
|
+
backofficePaymentLinksIdCancelPost(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentLinkResponse>>;
|
|
48685
|
+
/**
|
|
48686
|
+
* Retrieves a single payment link by its ID
|
|
48687
|
+
* @summary Get a payment link by ID
|
|
48688
|
+
* @param {number} id Payment link ID
|
|
48689
|
+
* @param {*} [options] Override http request option.
|
|
48690
|
+
* @throws {RequiredError}
|
|
48691
|
+
*/
|
|
48692
|
+
backofficePaymentLinksIdGet(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentLinkResponse>>;
|
|
48693
|
+
};
|
|
48694
|
+
/**
|
|
48695
|
+
* BackofficePaymentLinksApi - factory interface
|
|
48696
|
+
* @export
|
|
48697
|
+
*/
|
|
48698
|
+
export declare const BackofficePaymentLinksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48699
|
+
/**
|
|
48700
|
+
* Returns a paginated, filterable list of payment links
|
|
48701
|
+
* @summary List payment links
|
|
48702
|
+
* @param {number} [page] Page number
|
|
48703
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48704
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48705
|
+
* @param {string} [status] Filter by status (created, paid, expired, cancelled, all)
|
|
48706
|
+
* @param {number} [planId] Filter by plan ID
|
|
48707
|
+
* @param {*} [options] Override http request option.
|
|
48708
|
+
* @throws {RequiredError}
|
|
48709
|
+
*/
|
|
48710
|
+
backofficePaymentLinksGet(page?: number, pageSize?: number, orgId?: number, status?: string, planId?: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentLinkListResponse>;
|
|
48711
|
+
/**
|
|
48712
|
+
* Cancels a payment link that is in \'created\' status
|
|
48713
|
+
* @summary Cancel a payment link
|
|
48714
|
+
* @param {number} id Payment link ID
|
|
48715
|
+
* @param {*} [options] Override http request option.
|
|
48716
|
+
* @throws {RequiredError}
|
|
48717
|
+
*/
|
|
48718
|
+
backofficePaymentLinksIdCancelPost(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentLinkResponse>;
|
|
48719
|
+
/**
|
|
48720
|
+
* Retrieves a single payment link by its ID
|
|
48721
|
+
* @summary Get a payment link by ID
|
|
48722
|
+
* @param {number} id Payment link ID
|
|
48723
|
+
* @param {*} [options] Override http request option.
|
|
48724
|
+
* @throws {RequiredError}
|
|
48725
|
+
*/
|
|
48726
|
+
backofficePaymentLinksIdGet(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentLinkResponse>;
|
|
48727
|
+
};
|
|
48728
|
+
/**
|
|
48729
|
+
* BackofficePaymentLinksApi - object-oriented interface
|
|
48730
|
+
* @export
|
|
48731
|
+
* @class BackofficePaymentLinksApi
|
|
48732
|
+
* @extends {BaseAPI}
|
|
48733
|
+
*/
|
|
48734
|
+
export declare class BackofficePaymentLinksApi extends BaseAPI {
|
|
48735
|
+
/**
|
|
48736
|
+
* Returns a paginated, filterable list of payment links
|
|
48737
|
+
* @summary List payment links
|
|
48738
|
+
* @param {number} [page] Page number
|
|
48739
|
+
* @param {number} [pageSize] Page size (max 100)
|
|
48740
|
+
* @param {number} [orgId] Filter by organization ID
|
|
48741
|
+
* @param {string} [status] Filter by status (created, paid, expired, cancelled, all)
|
|
48742
|
+
* @param {number} [planId] Filter by plan ID
|
|
48743
|
+
* @param {*} [options] Override http request option.
|
|
48744
|
+
* @throws {RequiredError}
|
|
48745
|
+
* @memberof BackofficePaymentLinksApi
|
|
48746
|
+
*/
|
|
48747
|
+
backofficePaymentLinksGet(page?: number, pageSize?: number, orgId?: number, status?: string, planId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentLinkListResponse, any, {}>>;
|
|
48748
|
+
/**
|
|
48749
|
+
* Cancels a payment link that is in \'created\' status
|
|
48750
|
+
* @summary Cancel a payment link
|
|
48751
|
+
* @param {number} id Payment link ID
|
|
48752
|
+
* @param {*} [options] Override http request option.
|
|
48753
|
+
* @throws {RequiredError}
|
|
48754
|
+
* @memberof BackofficePaymentLinksApi
|
|
48755
|
+
*/
|
|
48756
|
+
backofficePaymentLinksIdCancelPost(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentLinkResponse, any, {}>>;
|
|
48757
|
+
/**
|
|
48758
|
+
* Retrieves a single payment link by its ID
|
|
48759
|
+
* @summary Get a payment link by ID
|
|
48760
|
+
* @param {number} id Payment link ID
|
|
48761
|
+
* @param {*} [options] Override http request option.
|
|
48762
|
+
* @throws {RequiredError}
|
|
48763
|
+
* @memberof BackofficePaymentLinksApi
|
|
48764
|
+
*/
|
|
48765
|
+
backofficePaymentLinksIdGet(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentLinkResponse, any, {}>>;
|
|
48766
|
+
}
|
|
46920
48767
|
/**
|
|
46921
48768
|
* BillingDashboardApi - axios parameter creator
|
|
46922
48769
|
* @export
|
|
@@ -57882,8 +59729,8 @@ export declare const PaymentGatewayApiAxiosParamCreator: (configuration?: Config
|
|
|
57882
59729
|
*/
|
|
57883
59730
|
adminPaymentGatewayCreateOrderPost: (dataTypesCreatePaymentOrderRequest: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57884
59731
|
/**
|
|
57885
|
-
* Returns
|
|
57886
|
-
* @summary Get available credit plans
|
|
59732
|
+
* Returns all active global credit plans plus any custom plans assigned to the authenticated user\'s organization. Requires JWT authentication.
|
|
59733
|
+
* @summary Get available credit plans (including org-specific custom plans)
|
|
57887
59734
|
* @param {*} [options] Override http request option.
|
|
57888
59735
|
* @throws {RequiredError}
|
|
57889
59736
|
*/
|
|
@@ -57965,8 +59812,8 @@ export declare const PaymentGatewayApiAxiosParamCreator: (configuration?: Config
|
|
|
57965
59812
|
*/
|
|
57966
59813
|
adminPaymentGatewayVerifyPost: (dataTypesVerifyPaymentRequest: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57967
59814
|
/**
|
|
57968
|
-
* Returns list of all active credit plans for purchase
|
|
57969
|
-
* @summary Get available credit plans
|
|
59815
|
+
* Returns list of all active global credit plans for purchase. Public endpoint, no authentication required.
|
|
59816
|
+
* @summary Get available credit plans (public)
|
|
57970
59817
|
* @param {*} [options] Override http request option.
|
|
57971
59818
|
* @throws {RequiredError}
|
|
57972
59819
|
*/
|
|
@@ -58003,12 +59850,12 @@ export declare const PaymentGatewayApiFp: (configuration?: Configuration) => {
|
|
|
58003
59850
|
*/
|
|
58004
59851
|
adminPaymentGatewayCreateOrderPost(dataTypesCreatePaymentOrderRequest: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>>;
|
|
58005
59852
|
/**
|
|
58006
|
-
* Returns
|
|
58007
|
-
* @summary Get available credit plans
|
|
59853
|
+
* Returns all active global credit plans plus any custom plans assigned to the authenticated user\'s organization. Requires JWT authentication.
|
|
59854
|
+
* @summary Get available credit plans (including org-specific custom plans)
|
|
58008
59855
|
* @param {*} [options] Override http request option.
|
|
58009
59856
|
* @throws {RequiredError}
|
|
58010
59857
|
*/
|
|
58011
|
-
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
59858
|
+
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCustomPlanResponse>>>;
|
|
58012
59859
|
/**
|
|
58013
59860
|
* Returns list of all available payment gateways
|
|
58014
59861
|
* @summary Get available payment gateways
|
|
@@ -58086,8 +59933,8 @@ export declare const PaymentGatewayApiFp: (configuration?: Configuration) => {
|
|
|
58086
59933
|
*/
|
|
58087
59934
|
adminPaymentGatewayVerifyPost(dataTypesVerifyPaymentRequest: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusPollResponse>>;
|
|
58088
59935
|
/**
|
|
58089
|
-
* Returns list of all active credit plans for purchase
|
|
58090
|
-
* @summary Get available credit plans
|
|
59936
|
+
* Returns list of all active global credit plans for purchase. Public endpoint, no authentication required.
|
|
59937
|
+
* @summary Get available credit plans (public)
|
|
58091
59938
|
* @param {*} [options] Override http request option.
|
|
58092
59939
|
* @throws {RequiredError}
|
|
58093
59940
|
*/
|
|
@@ -58128,12 +59975,12 @@ export declare const PaymentGatewayApiFactory: (configuration?: Configuration, b
|
|
|
58128
59975
|
*/
|
|
58129
59976
|
adminPaymentGatewayCreateOrderPost(dataTypesCreatePaymentOrderRequest: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse>;
|
|
58130
59977
|
/**
|
|
58131
|
-
* Returns
|
|
58132
|
-
* @summary Get available credit plans
|
|
59978
|
+
* Returns all active global credit plans plus any custom plans assigned to the authenticated user\'s organization. Requires JWT authentication.
|
|
59979
|
+
* @summary Get available credit plans (including org-specific custom plans)
|
|
58133
59980
|
* @param {*} [options] Override http request option.
|
|
58134
59981
|
* @throws {RequiredError}
|
|
58135
59982
|
*/
|
|
58136
|
-
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<
|
|
59983
|
+
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCustomPlanResponse>>;
|
|
58137
59984
|
/**
|
|
58138
59985
|
* Returns list of all available payment gateways
|
|
58139
59986
|
* @summary Get available payment gateways
|
|
@@ -58211,8 +60058,8 @@ export declare const PaymentGatewayApiFactory: (configuration?: Configuration, b
|
|
|
58211
60058
|
*/
|
|
58212
60059
|
adminPaymentGatewayVerifyPost(dataTypesVerifyPaymentRequest: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusPollResponse>;
|
|
58213
60060
|
/**
|
|
58214
|
-
* Returns list of all active credit plans for purchase
|
|
58215
|
-
* @summary Get available credit plans
|
|
60061
|
+
* Returns list of all active global credit plans for purchase. Public endpoint, no authentication required.
|
|
60062
|
+
* @summary Get available credit plans (public)
|
|
58216
60063
|
* @param {*} [options] Override http request option.
|
|
58217
60064
|
* @throws {RequiredError}
|
|
58218
60065
|
*/
|
|
@@ -58256,13 +60103,13 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
58256
60103
|
*/
|
|
58257
60104
|
adminPaymentGatewayCreateOrderPost(dataTypesCreatePaymentOrderRequest: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreatePaymentOrderResponse, any, {}>>;
|
|
58258
60105
|
/**
|
|
58259
|
-
* Returns
|
|
58260
|
-
* @summary Get available credit plans
|
|
60106
|
+
* Returns all active global credit plans plus any custom plans assigned to the authenticated user\'s organization. Requires JWT authentication.
|
|
60107
|
+
* @summary Get available credit plans (including org-specific custom plans)
|
|
58261
60108
|
* @param {*} [options] Override http request option.
|
|
58262
60109
|
* @throws {RequiredError}
|
|
58263
60110
|
* @memberof PaymentGatewayApi
|
|
58264
60111
|
*/
|
|
58265
|
-
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
60112
|
+
adminPaymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCustomPlanResponse[], any, {}>>;
|
|
58266
60113
|
/**
|
|
58267
60114
|
* Returns list of all available payment gateways
|
|
58268
60115
|
* @summary Get available payment gateways
|
|
@@ -58348,8 +60195,8 @@ export declare class PaymentGatewayApi extends BaseAPI {
|
|
|
58348
60195
|
*/
|
|
58349
60196
|
adminPaymentGatewayVerifyPost(dataTypesVerifyPaymentRequest: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentStatusPollResponse, any, {}>>;
|
|
58350
60197
|
/**
|
|
58351
|
-
* Returns list of all active credit plans for purchase
|
|
58352
|
-
* @summary Get available credit plans
|
|
60198
|
+
* Returns list of all active global credit plans for purchase. Public endpoint, no authentication required.
|
|
60199
|
+
* @summary Get available credit plans (public)
|
|
58353
60200
|
* @param {*} [options] Override http request option.
|
|
58354
60201
|
* @throws {RequiredError}
|
|
58355
60202
|
* @memberof PaymentGatewayApi
|
|
@@ -62217,14 +64064,14 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
62217
64064
|
* @summary Search (POST)
|
|
62218
64065
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62219
64066
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62220
|
-
* @param {
|
|
64067
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
62221
64068
|
* @param {string} [xUserId] User ID for personalization
|
|
62222
64069
|
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62223
64070
|
* @param {string} [xSessionId] Session ID for personalization
|
|
62224
64071
|
* @param {*} [options] Override http request option.
|
|
62225
64072
|
* @throws {RequiredError}
|
|
62226
64073
|
*/
|
|
62227
|
-
v1SearchPost: (xStoreid: string, xStoresecret: string,
|
|
64074
|
+
v1SearchPost: (xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62228
64075
|
};
|
|
62229
64076
|
/**
|
|
62230
64077
|
* SearchApi - functional programming interface
|
|
@@ -62332,20 +64179,20 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
|
62332
64179
|
* @param {*} [options] Override http request option.
|
|
62333
64180
|
* @throws {RequiredError}
|
|
62334
64181
|
*/
|
|
62335
|
-
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
64182
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResponseWrapper>>;
|
|
62336
64183
|
/**
|
|
62337
64184
|
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
62338
64185
|
* @summary Search (POST)
|
|
62339
64186
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62340
64187
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62341
|
-
* @param {
|
|
64188
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
62342
64189
|
* @param {string} [xUserId] User ID for personalization
|
|
62343
64190
|
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62344
64191
|
* @param {string} [xSessionId] Session ID for personalization
|
|
62345
64192
|
* @param {*} [options] Override http request option.
|
|
62346
64193
|
* @throws {RequiredError}
|
|
62347
64194
|
*/
|
|
62348
|
-
v1SearchPost(xStoreid: string, xStoresecret: string,
|
|
64195
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSearchResponseWrapper>>;
|
|
62349
64196
|
};
|
|
62350
64197
|
/**
|
|
62351
64198
|
* SearchApi - factory interface
|
|
@@ -62453,20 +64300,20 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
|
|
|
62453
64300
|
* @param {*} [options] Override http request option.
|
|
62454
64301
|
* @throws {RequiredError}
|
|
62455
64302
|
*/
|
|
62456
|
-
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
64303
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResponseWrapper>;
|
|
62457
64304
|
/**
|
|
62458
64305
|
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
62459
64306
|
* @summary Search (POST)
|
|
62460
64307
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62461
64308
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62462
|
-
* @param {
|
|
64309
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
62463
64310
|
* @param {string} [xUserId] User ID for personalization
|
|
62464
64311
|
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62465
64312
|
* @param {string} [xSessionId] Session ID for personalization
|
|
62466
64313
|
* @param {*} [options] Override http request option.
|
|
62467
64314
|
* @throws {RequiredError}
|
|
62468
64315
|
*/
|
|
62469
|
-
v1SearchPost(xStoreid: string, xStoresecret: string,
|
|
64316
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSearchResponseWrapper>;
|
|
62470
64317
|
};
|
|
62471
64318
|
/**
|
|
62472
64319
|
* SearchApi - object-oriented interface
|
|
@@ -62583,13 +64430,13 @@ export declare class SearchApi extends BaseAPI {
|
|
|
62583
64430
|
* @throws {RequiredError}
|
|
62584
64431
|
* @memberof SearchApi
|
|
62585
64432
|
*/
|
|
62586
|
-
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
64433
|
+
v1SearchGet(xStoreid: string, xStoresecret: string, q: string, xUserId?: string, xAnonId?: string, xSessionId?: string, page?: number, perPage?: number, sortBy?: string, filterBy?: string, facetBy?: string, maxFacetValues?: number, widgetMode?: boolean, includeSuggestions?: boolean, suggestionsLimit?: number, analyticsTags?: string, stopwordSets?: string, synonymSets?: string, searchFields?: string, returnFields?: string, omitFields?: string, snippetFields?: string, fullSnippetFields?: string, fieldWeights?: string, groupField?: string, groupSize?: number, snippetPrefix?: string, snippetSuffix?: string, snippetTokenLimit?: number, snippetMinLen?: number, includeSnippets?: boolean, prefixMode?: string, infixMode?: string, typoMax?: number, typoMinLen1?: number, typoMinLen2?: number, searchTimeoutMs?: number, requireAllTerms?: boolean, exactMatchBoost?: boolean, cacheResults?: boolean, applyRules?: boolean, presetName?: string, facetSearchText?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResponseWrapper, any, {}>>;
|
|
62587
64434
|
/**
|
|
62588
64435
|
* Run a full-text search for your store. **Authentication:** Send `x-storeid` and `x-storesecret` (from Seekora dashboard). Optional: `x-user-id`, `x-anon-id`, `x-session-id` for personalization. Supports pagination, filters, facets, sorting, snippets, and autocomplete suggestions. Use `widget_mode: true` for lightweight widget results.
|
|
62589
64436
|
* @summary Search (POST)
|
|
62590
64437
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
62591
64438
|
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
62592
|
-
* @param {
|
|
64439
|
+
* @param {DataTypesSearchRequest} dataTypesSearchRequest Search query, filters, pagination, and options
|
|
62593
64440
|
* @param {string} [xUserId] User ID for personalization
|
|
62594
64441
|
* @param {string} [xAnonId] Anonymous user ID for personalization
|
|
62595
64442
|
* @param {string} [xSessionId] Session ID for personalization
|
|
@@ -62597,7 +64444,7 @@ export declare class SearchApi extends BaseAPI {
|
|
|
62597
64444
|
* @throws {RequiredError}
|
|
62598
64445
|
* @memberof SearchApi
|
|
62599
64446
|
*/
|
|
62600
|
-
v1SearchPost(xStoreid: string, xStoresecret: string,
|
|
64447
|
+
v1SearchPost(xStoreid: string, xStoresecret: string, dataTypesSearchRequest: DataTypesSearchRequest, xUserId?: string, xAnonId?: string, xSessionId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSearchResponseWrapper, any, {}>>;
|
|
62601
64448
|
}
|
|
62602
64449
|
/**
|
|
62603
64450
|
* StopwordsApi - axios parameter creator
|
|
@@ -63594,11 +65441,11 @@ export declare const StoreManagementApiAxiosParamCreator: (configuration?: Confi
|
|
|
63594
65441
|
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
63595
65442
|
* @summary Create Store (Public SDK API)
|
|
63596
65443
|
* @param {string} authorization Bearer JWT Token
|
|
63597
|
-
* @param {
|
|
65444
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
63598
65445
|
* @param {*} [options] Override http request option.
|
|
63599
65446
|
* @throws {RequiredError}
|
|
63600
65447
|
*/
|
|
63601
|
-
apiV1StoresPost: (authorization: string,
|
|
65448
|
+
apiV1StoresPost: (authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63602
65449
|
/**
|
|
63603
65450
|
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63604
65451
|
* @summary Get store configuration
|
|
@@ -63615,11 +65462,11 @@ export declare const StoreManagementApiAxiosParamCreator: (configuration?: Confi
|
|
|
63615
65462
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
63616
65463
|
* @param {string} xStoreWriteSecret Store write secret
|
|
63617
65464
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63618
|
-
* @param {
|
|
65465
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
63619
65466
|
* @param {*} [options] Override http request option.
|
|
63620
65467
|
* @throws {RequiredError}
|
|
63621
65468
|
*/
|
|
63622
|
-
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string,
|
|
65469
|
+
apiV1StoresXStoreIDConfigPut: (xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63623
65470
|
/**
|
|
63624
65471
|
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63625
65472
|
* @summary Get store config schema
|
|
@@ -63746,11 +65593,11 @@ export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
|
63746
65593
|
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
63747
65594
|
* @summary Create Store (Public SDK API)
|
|
63748
65595
|
* @param {string} authorization Bearer JWT Token
|
|
63749
|
-
* @param {
|
|
65596
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
63750
65597
|
* @param {*} [options] Override http request option.
|
|
63751
65598
|
* @throws {RequiredError}
|
|
63752
65599
|
*/
|
|
63753
|
-
apiV1StoresPost(authorization: string,
|
|
65600
|
+
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesCreateStoreResponse>>;
|
|
63754
65601
|
/**
|
|
63755
65602
|
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63756
65603
|
* @summary Get store configuration
|
|
@@ -63767,11 +65614,11 @@ export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
|
63767
65614
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
63768
65615
|
* @param {string} xStoreWriteSecret Store write secret
|
|
63769
65616
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63770
|
-
* @param {
|
|
65617
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
63771
65618
|
* @param {*} [options] Override http request option.
|
|
63772
65619
|
* @throws {RequiredError}
|
|
63773
65620
|
*/
|
|
63774
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string,
|
|
65621
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
|
|
63775
65622
|
/**
|
|
63776
65623
|
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63777
65624
|
* @summary Get store config schema
|
|
@@ -63845,7 +65692,7 @@ export declare const StoreManagementApiFp: (configuration?: Configuration) => {
|
|
|
63845
65692
|
* @param {*} [options] Override http request option.
|
|
63846
65693
|
* @throws {RequiredError}
|
|
63847
65694
|
*/
|
|
63848
|
-
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
65695
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>>;
|
|
63849
65696
|
/**
|
|
63850
65697
|
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63851
65698
|
* @summary Get query suggestions configuration
|
|
@@ -63898,11 +65745,11 @@ export declare const StoreManagementApiFactory: (configuration?: Configuration,
|
|
|
63898
65745
|
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
63899
65746
|
* @summary Create Store (Public SDK API)
|
|
63900
65747
|
* @param {string} authorization Bearer JWT Token
|
|
63901
|
-
* @param {
|
|
65748
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
63902
65749
|
* @param {*} [options] Override http request option.
|
|
63903
65750
|
* @throws {RequiredError}
|
|
63904
65751
|
*/
|
|
63905
|
-
apiV1StoresPost(authorization: string,
|
|
65752
|
+
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesCreateStoreResponse>;
|
|
63906
65753
|
/**
|
|
63907
65754
|
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63908
65755
|
* @summary Get store configuration
|
|
@@ -63919,11 +65766,11 @@ export declare const StoreManagementApiFactory: (configuration?: Configuration,
|
|
|
63919
65766
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
63920
65767
|
* @param {string} xStoreWriteSecret Store write secret
|
|
63921
65768
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
63922
|
-
* @param {
|
|
65769
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
63923
65770
|
* @param {*} [options] Override http request option.
|
|
63924
65771
|
* @throws {RequiredError}
|
|
63925
65772
|
*/
|
|
63926
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string,
|
|
65773
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
|
|
63927
65774
|
/**
|
|
63928
65775
|
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
63929
65776
|
* @summary Get store config schema
|
|
@@ -63997,7 +65844,7 @@ export declare const StoreManagementApiFactory: (configuration?: Configuration,
|
|
|
63997
65844
|
* @param {*} [options] Override http request option.
|
|
63998
65845
|
* @throws {RequiredError}
|
|
63999
65846
|
*/
|
|
64000
|
-
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
65847
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGenericResponseDataTypesStoreInfoResponse>;
|
|
64001
65848
|
/**
|
|
64002
65849
|
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64003
65850
|
* @summary Get query suggestions configuration
|
|
@@ -64052,12 +65899,12 @@ export declare class StoreManagementApi extends BaseAPI {
|
|
|
64052
65899
|
* Creates a new store with minimal information. Returns store credentials (xStoreID, xStoreSecret, xStoreWriteSecret) immediately. This is a public API for SDK integration. Requires JWT authentication.
|
|
64053
65900
|
* @summary Create Store (Public SDK API)
|
|
64054
65901
|
* @param {string} authorization Bearer JWT Token
|
|
64055
|
-
* @param {
|
|
65902
|
+
* @param {DataTypesCreateStoreRequest} dataTypesCreateStoreRequest Store creation request
|
|
64056
65903
|
* @param {*} [options] Override http request option.
|
|
64057
65904
|
* @throws {RequiredError}
|
|
64058
65905
|
* @memberof StoreManagementApi
|
|
64059
65906
|
*/
|
|
64060
|
-
apiV1StoresPost(authorization: string,
|
|
65907
|
+
apiV1StoresPost(authorization: string, dataTypesCreateStoreRequest: DataTypesCreateStoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesCreateStoreResponse, any, {}>>;
|
|
64061
65908
|
/**
|
|
64062
65909
|
* Returns search and query-suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64063
65910
|
* @summary Get store configuration
|
|
@@ -64075,12 +65922,12 @@ export declare class StoreManagementApi extends BaseAPI {
|
|
|
64075
65922
|
* @param {string} xStoreid Store ID (from dashboard)
|
|
64076
65923
|
* @param {string} xStoreWriteSecret Store write secret
|
|
64077
65924
|
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
64078
|
-
* @param {
|
|
65925
|
+
* @param {DataTypesStoreConfigUpdateRequest} dataTypesStoreConfigUpdateRequest Fields to update (partial, includes allow_public_search)
|
|
64079
65926
|
* @param {*} [options] Override http request option.
|
|
64080
65927
|
* @throws {RequiredError}
|
|
64081
65928
|
* @memberof StoreManagementApi
|
|
64082
65929
|
*/
|
|
64083
|
-
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string,
|
|
65930
|
+
apiV1StoresXStoreIDConfigPut(xStoreid: string, xStoreWriteSecret: string, xStoreID: string, dataTypesStoreConfigUpdateRequest: DataTypesStoreConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any, {}>>;
|
|
64084
65931
|
/**
|
|
64085
65932
|
* Returns metadata for all configurable store fields (types, defaults, validation). **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64086
65933
|
* @summary Get store config schema
|
|
@@ -64161,7 +66008,7 @@ export declare class StoreManagementApi extends BaseAPI {
|
|
|
64161
66008
|
* @throws {RequiredError}
|
|
64162
66009
|
* @memberof StoreManagementApi
|
|
64163
66010
|
*/
|
|
64164
|
-
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
66011
|
+
apiV1StoresXStoreIDGet(xStoreid: string, xStoresecret: string, xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGenericResponseDataTypesStoreInfoResponse, any, {}>>;
|
|
64165
66012
|
/**
|
|
64166
66013
|
* Returns autocomplete/suggestions configuration for the store. **Auth:** `x-storeid` and `x-storesecret`. Path `xStoreID` must match the `x-storeid` header.
|
|
64167
66014
|
* @summary Get query suggestions configuration
|