@seekora-ai/admin-api 1.0.46 → 1.0.48
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 +20 -3
- package/api.ts +1247 -105
- package/dist/api.d.ts +1109 -280
- package/dist/api.js +644 -48
- package/dist/esm/api.d.ts +1109 -280
- package/dist/esm/api.js +636 -44
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.48.tgz +0 -0
- package/seekora-ai-admin-api-1.0.46.tgz +0 -0
package/api.ts
CHANGED
|
@@ -2485,6 +2485,49 @@ export interface AnalyticsKPIPointExtended {
|
|
|
2485
2485
|
*/
|
|
2486
2486
|
'unique_users'?: number;
|
|
2487
2487
|
}
|
|
2488
|
+
/**
|
|
2489
|
+
*
|
|
2490
|
+
* @export
|
|
2491
|
+
* @interface AnalyticsPaginationMeta
|
|
2492
|
+
*/
|
|
2493
|
+
export interface AnalyticsPaginationMeta {
|
|
2494
|
+
/**
|
|
2495
|
+
*
|
|
2496
|
+
* @type {boolean}
|
|
2497
|
+
* @memberof AnalyticsPaginationMeta
|
|
2498
|
+
*/
|
|
2499
|
+
'has_next'?: boolean;
|
|
2500
|
+
/**
|
|
2501
|
+
*
|
|
2502
|
+
* @type {boolean}
|
|
2503
|
+
* @memberof AnalyticsPaginationMeta
|
|
2504
|
+
*/
|
|
2505
|
+
'has_previous'?: boolean;
|
|
2506
|
+
/**
|
|
2507
|
+
*
|
|
2508
|
+
* @type {number}
|
|
2509
|
+
* @memberof AnalyticsPaginationMeta
|
|
2510
|
+
*/
|
|
2511
|
+
'page'?: number;
|
|
2512
|
+
/**
|
|
2513
|
+
*
|
|
2514
|
+
* @type {number}
|
|
2515
|
+
* @memberof AnalyticsPaginationMeta
|
|
2516
|
+
*/
|
|
2517
|
+
'page_size'?: number;
|
|
2518
|
+
/**
|
|
2519
|
+
*
|
|
2520
|
+
* @type {number}
|
|
2521
|
+
* @memberof AnalyticsPaginationMeta
|
|
2522
|
+
*/
|
|
2523
|
+
'total_items'?: number;
|
|
2524
|
+
/**
|
|
2525
|
+
*
|
|
2526
|
+
* @type {number}
|
|
2527
|
+
* @memberof AnalyticsPaginationMeta
|
|
2528
|
+
*/
|
|
2529
|
+
'total_pages'?: number;
|
|
2530
|
+
}
|
|
2488
2531
|
/**
|
|
2489
2532
|
*
|
|
2490
2533
|
* @export
|
|
@@ -2805,16 +2848,16 @@ export interface AnalyticsQueryInsights {
|
|
|
2805
2848
|
'no_results_rate'?: number;
|
|
2806
2849
|
/**
|
|
2807
2850
|
*
|
|
2808
|
-
* @type {
|
|
2851
|
+
* @type {AnalyticsQueryPopularFiltersSection}
|
|
2809
2852
|
* @memberof AnalyticsQueryInsights
|
|
2810
2853
|
*/
|
|
2811
|
-
'popular_filters'?:
|
|
2854
|
+
'popular_filters'?: AnalyticsQueryPopularFiltersSection;
|
|
2812
2855
|
/**
|
|
2813
2856
|
*
|
|
2814
|
-
* @type {
|
|
2857
|
+
* @type {AnalyticsQueryPopularResultsSection}
|
|
2815
2858
|
* @memberof AnalyticsQueryInsights
|
|
2816
2859
|
*/
|
|
2817
|
-
'popular_results'?:
|
|
2860
|
+
'popular_results'?: AnalyticsQueryPopularResultsSection;
|
|
2818
2861
|
/**
|
|
2819
2862
|
*
|
|
2820
2863
|
* @type {string}
|
|
@@ -2965,51 +3008,95 @@ export interface AnalyticsQueryPopularFilter {
|
|
|
2965
3008
|
/**
|
|
2966
3009
|
*
|
|
2967
3010
|
* @export
|
|
2968
|
-
* @interface
|
|
3011
|
+
* @interface AnalyticsQueryPopularFiltersSection
|
|
2969
3012
|
*/
|
|
2970
|
-
export interface
|
|
3013
|
+
export interface AnalyticsQueryPopularFiltersSection {
|
|
3014
|
+
/**
|
|
3015
|
+
*
|
|
3016
|
+
* @type {Array<AnalyticsQueryPopularFilter>}
|
|
3017
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
3018
|
+
*/
|
|
3019
|
+
'items'?: Array<AnalyticsQueryPopularFilter>;
|
|
3020
|
+
/**
|
|
3021
|
+
*
|
|
3022
|
+
* @type {AnalyticsPaginationMeta}
|
|
3023
|
+
* @memberof AnalyticsQueryPopularFiltersSection
|
|
3024
|
+
*/
|
|
3025
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
3026
|
+
}
|
|
3027
|
+
/**
|
|
3028
|
+
*
|
|
3029
|
+
* @export
|
|
3030
|
+
* @interface AnalyticsQueryPopularResultWithWidget
|
|
3031
|
+
*/
|
|
3032
|
+
export interface AnalyticsQueryPopularResultWithWidget {
|
|
2971
3033
|
/**
|
|
2972
3034
|
*
|
|
2973
3035
|
* @type {number}
|
|
2974
|
-
* @memberof
|
|
3036
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2975
3037
|
*/
|
|
2976
3038
|
'avg_position'?: number;
|
|
2977
3039
|
/**
|
|
2978
3040
|
*
|
|
2979
3041
|
* @type {number}
|
|
2980
|
-
* @memberof
|
|
3042
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2981
3043
|
*/
|
|
2982
3044
|
'click_through_rate'?: number;
|
|
2983
3045
|
/**
|
|
2984
3046
|
*
|
|
2985
3047
|
* @type {number}
|
|
2986
|
-
* @memberof
|
|
3048
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2987
3049
|
*/
|
|
2988
3050
|
'clicks'?: number;
|
|
2989
3051
|
/**
|
|
2990
3052
|
*
|
|
2991
3053
|
* @type {number}
|
|
2992
|
-
* @memberof
|
|
3054
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2993
3055
|
*/
|
|
2994
3056
|
'impressions'?: number;
|
|
2995
3057
|
/**
|
|
2996
3058
|
*
|
|
2997
3059
|
* @type {string}
|
|
2998
|
-
* @memberof
|
|
3060
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
2999
3061
|
*/
|
|
3000
3062
|
'item_id'?: string;
|
|
3001
3063
|
/**
|
|
3002
3064
|
*
|
|
3003
3065
|
* @type {string}
|
|
3004
|
-
* @memberof
|
|
3066
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3005
3067
|
*/
|
|
3006
3068
|
'item_name'?: string;
|
|
3007
3069
|
/**
|
|
3008
3070
|
* percentage of total impressions for this query
|
|
3009
3071
|
* @type {number}
|
|
3010
|
-
* @memberof
|
|
3072
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3011
3073
|
*/
|
|
3012
3074
|
'share'?: number;
|
|
3075
|
+
/**
|
|
3076
|
+
* Widget display fields
|
|
3077
|
+
* @type {AnalyticsWidgetData}
|
|
3078
|
+
* @memberof AnalyticsQueryPopularResultWithWidget
|
|
3079
|
+
*/
|
|
3080
|
+
'widget'?: AnalyticsWidgetData;
|
|
3081
|
+
}
|
|
3082
|
+
/**
|
|
3083
|
+
*
|
|
3084
|
+
* @export
|
|
3085
|
+
* @interface AnalyticsQueryPopularResultsSection
|
|
3086
|
+
*/
|
|
3087
|
+
export interface AnalyticsQueryPopularResultsSection {
|
|
3088
|
+
/**
|
|
3089
|
+
*
|
|
3090
|
+
* @type {Array<AnalyticsQueryPopularResultWithWidget>}
|
|
3091
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
3092
|
+
*/
|
|
3093
|
+
'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
|
|
3094
|
+
/**
|
|
3095
|
+
*
|
|
3096
|
+
* @type {AnalyticsPaginationMeta}
|
|
3097
|
+
* @memberof AnalyticsQueryPopularResultsSection
|
|
3098
|
+
*/
|
|
3099
|
+
'meta'?: AnalyticsPaginationMeta;
|
|
3013
3100
|
}
|
|
3014
3101
|
/**
|
|
3015
3102
|
*
|
|
@@ -4216,6 +4303,173 @@ export interface DataTypesCreateOrganizationRequest {
|
|
|
4216
4303
|
*/
|
|
4217
4304
|
'ZipCode'?: string;
|
|
4218
4305
|
}
|
|
4306
|
+
/**
|
|
4307
|
+
*
|
|
4308
|
+
* @export
|
|
4309
|
+
* @interface DataTypesCreatePaymentOrderRequest
|
|
4310
|
+
*/
|
|
4311
|
+
export interface DataTypesCreatePaymentOrderRequest {
|
|
4312
|
+
/**
|
|
4313
|
+
* Optional for subscription/credit (uses plan price)
|
|
4314
|
+
* @type {number}
|
|
4315
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4316
|
+
*/
|
|
4317
|
+
'amount'?: number;
|
|
4318
|
+
/**
|
|
4319
|
+
*
|
|
4320
|
+
* @type {boolean}
|
|
4321
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4322
|
+
*/
|
|
4323
|
+
'auto_renewal'?: boolean;
|
|
4324
|
+
/**
|
|
4325
|
+
* Fields for credit top-up
|
|
4326
|
+
* @type {number}
|
|
4327
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4328
|
+
*/
|
|
4329
|
+
'credit_plan_id'?: number;
|
|
4330
|
+
/**
|
|
4331
|
+
*
|
|
4332
|
+
* @type {string}
|
|
4333
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4334
|
+
*/
|
|
4335
|
+
'currency': string;
|
|
4336
|
+
/**
|
|
4337
|
+
*
|
|
4338
|
+
* @type {DataTypesCustomerInfoDto}
|
|
4339
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4340
|
+
*/
|
|
4341
|
+
'customer_info': DataTypesCustomerInfoDto;
|
|
4342
|
+
/**
|
|
4343
|
+
* Optional, auto-generated if not provided
|
|
4344
|
+
* @type {string}
|
|
4345
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4346
|
+
*/
|
|
4347
|
+
'description'?: string;
|
|
4348
|
+
/**
|
|
4349
|
+
* Optional, uses default if not specified
|
|
4350
|
+
* @type {string}
|
|
4351
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4352
|
+
*/
|
|
4353
|
+
'gateway'?: string;
|
|
4354
|
+
/**
|
|
4355
|
+
*
|
|
4356
|
+
* @type {{ [key: string]: any; }}
|
|
4357
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4358
|
+
*/
|
|
4359
|
+
'metadata'?: { [key: string]: any; };
|
|
4360
|
+
/**
|
|
4361
|
+
* Fields for subscription payments
|
|
4362
|
+
* @type {number}
|
|
4363
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4364
|
+
*/
|
|
4365
|
+
'org_id'?: number;
|
|
4366
|
+
/**
|
|
4367
|
+
*
|
|
4368
|
+
* @type {string}
|
|
4369
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4370
|
+
*/
|
|
4371
|
+
'payment_method'?: string;
|
|
4372
|
+
/**
|
|
4373
|
+
*
|
|
4374
|
+
* @type {string}
|
|
4375
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4376
|
+
*/
|
|
4377
|
+
'payment_type': DataTypesCreatePaymentOrderRequestPaymentTypeEnum;
|
|
4378
|
+
/**
|
|
4379
|
+
*
|
|
4380
|
+
* @type {number}
|
|
4381
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4382
|
+
*/
|
|
4383
|
+
'plan_id'?: number;
|
|
4384
|
+
/**
|
|
4385
|
+
*
|
|
4386
|
+
* @type {string}
|
|
4387
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4388
|
+
*/
|
|
4389
|
+
'return_url'?: string;
|
|
4390
|
+
/**
|
|
4391
|
+
* Required for generic payments
|
|
4392
|
+
* @type {number}
|
|
4393
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4394
|
+
*/
|
|
4395
|
+
'subs_id'?: number;
|
|
4396
|
+
}
|
|
4397
|
+
|
|
4398
|
+
export const DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
4399
|
+
Generic: 'generic',
|
|
4400
|
+
Subscription: 'subscription',
|
|
4401
|
+
CreditTopup: 'credit_topup'
|
|
4402
|
+
} as const;
|
|
4403
|
+
|
|
4404
|
+
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
4405
|
+
|
|
4406
|
+
/**
|
|
4407
|
+
*
|
|
4408
|
+
* @export
|
|
4409
|
+
* @interface DataTypesCreatePaymentOrderResponse
|
|
4410
|
+
*/
|
|
4411
|
+
export interface DataTypesCreatePaymentOrderResponse {
|
|
4412
|
+
/**
|
|
4413
|
+
*
|
|
4414
|
+
* @type {number}
|
|
4415
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4416
|
+
*/
|
|
4417
|
+
'amount'?: number;
|
|
4418
|
+
/**
|
|
4419
|
+
*
|
|
4420
|
+
* @type {string}
|
|
4421
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4422
|
+
*/
|
|
4423
|
+
'created_at'?: string;
|
|
4424
|
+
/**
|
|
4425
|
+
*
|
|
4426
|
+
* @type {string}
|
|
4427
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4428
|
+
*/
|
|
4429
|
+
'currency'?: string;
|
|
4430
|
+
/**
|
|
4431
|
+
*
|
|
4432
|
+
* @type {string}
|
|
4433
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4434
|
+
*/
|
|
4435
|
+
'expires_at'?: string;
|
|
4436
|
+
/**
|
|
4437
|
+
*
|
|
4438
|
+
* @type {string}
|
|
4439
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4440
|
+
*/
|
|
4441
|
+
'gateway'?: string;
|
|
4442
|
+
/**
|
|
4443
|
+
*
|
|
4444
|
+
* @type {{ [key: string]: any; }}
|
|
4445
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4446
|
+
*/
|
|
4447
|
+
'gateway_response'?: { [key: string]: any; };
|
|
4448
|
+
/**
|
|
4449
|
+
*
|
|
4450
|
+
* @type {string}
|
|
4451
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4452
|
+
*/
|
|
4453
|
+
'order_id'?: string;
|
|
4454
|
+
/**
|
|
4455
|
+
*
|
|
4456
|
+
* @type {string}
|
|
4457
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4458
|
+
*/
|
|
4459
|
+
'payment_id'?: string;
|
|
4460
|
+
/**
|
|
4461
|
+
*
|
|
4462
|
+
* @type {string}
|
|
4463
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4464
|
+
*/
|
|
4465
|
+
'payment_url'?: string;
|
|
4466
|
+
/**
|
|
4467
|
+
*
|
|
4468
|
+
* @type {string}
|
|
4469
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4470
|
+
*/
|
|
4471
|
+
'status'?: string;
|
|
4472
|
+
}
|
|
4219
4473
|
/**
|
|
4220
4474
|
*
|
|
4221
4475
|
* @export
|
|
@@ -5352,6 +5606,37 @@ export interface DataTypesCustomWordWithStatus {
|
|
|
5352
5606
|
*/
|
|
5353
5607
|
'word'?: string;
|
|
5354
5608
|
}
|
|
5609
|
+
/**
|
|
5610
|
+
*
|
|
5611
|
+
* @export
|
|
5612
|
+
* @interface DataTypesCustomerInfoDto
|
|
5613
|
+
*/
|
|
5614
|
+
export interface DataTypesCustomerInfoDto {
|
|
5615
|
+
/**
|
|
5616
|
+
*
|
|
5617
|
+
* @type {string}
|
|
5618
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5619
|
+
*/
|
|
5620
|
+
'address'?: string;
|
|
5621
|
+
/**
|
|
5622
|
+
*
|
|
5623
|
+
* @type {string}
|
|
5624
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5625
|
+
*/
|
|
5626
|
+
'email': string;
|
|
5627
|
+
/**
|
|
5628
|
+
*
|
|
5629
|
+
* @type {string}
|
|
5630
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5631
|
+
*/
|
|
5632
|
+
'name': string;
|
|
5633
|
+
/**
|
|
5634
|
+
*
|
|
5635
|
+
* @type {string}
|
|
5636
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5637
|
+
*/
|
|
5638
|
+
'phone': string;
|
|
5639
|
+
}
|
|
5355
5640
|
/**
|
|
5356
5641
|
*
|
|
5357
5642
|
* @export
|
|
@@ -5942,6 +6227,50 @@ export interface DataTypesFieldMetadata {
|
|
|
5942
6227
|
*/
|
|
5943
6228
|
'type'?: string;
|
|
5944
6229
|
}
|
|
6230
|
+
/**
|
|
6231
|
+
*
|
|
6232
|
+
* @export
|
|
6233
|
+
* @interface DataTypesGatewayInfo
|
|
6234
|
+
*/
|
|
6235
|
+
export interface DataTypesGatewayInfo {
|
|
6236
|
+
/**
|
|
6237
|
+
*
|
|
6238
|
+
* @type {Array<string>}
|
|
6239
|
+
* @memberof DataTypesGatewayInfo
|
|
6240
|
+
*/
|
|
6241
|
+
'features'?: Array<string>;
|
|
6242
|
+
/**
|
|
6243
|
+
*
|
|
6244
|
+
* @type {boolean}
|
|
6245
|
+
* @memberof DataTypesGatewayInfo
|
|
6246
|
+
*/
|
|
6247
|
+
'is_active'?: boolean;
|
|
6248
|
+
/**
|
|
6249
|
+
*
|
|
6250
|
+
* @type {boolean}
|
|
6251
|
+
* @memberof DataTypesGatewayInfo
|
|
6252
|
+
*/
|
|
6253
|
+
'is_default'?: boolean;
|
|
6254
|
+
/**
|
|
6255
|
+
*
|
|
6256
|
+
* @type {string}
|
|
6257
|
+
* @memberof DataTypesGatewayInfo
|
|
6258
|
+
*/
|
|
6259
|
+
'name'?: string;
|
|
6260
|
+
}
|
|
6261
|
+
/**
|
|
6262
|
+
*
|
|
6263
|
+
* @export
|
|
6264
|
+
* @interface DataTypesGatewayListResponse
|
|
6265
|
+
*/
|
|
6266
|
+
export interface DataTypesGatewayListResponse {
|
|
6267
|
+
/**
|
|
6268
|
+
*
|
|
6269
|
+
* @type {Array<DataTypesGatewayInfo>}
|
|
6270
|
+
* @memberof DataTypesGatewayListResponse
|
|
6271
|
+
*/
|
|
6272
|
+
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
6273
|
+
}
|
|
5945
6274
|
/**
|
|
5946
6275
|
*
|
|
5947
6276
|
* @export
|
|
@@ -8505,48 +8834,109 @@ export interface DataTypesPaymentResponse {
|
|
|
8505
8834
|
/**
|
|
8506
8835
|
*
|
|
8507
8836
|
* @export
|
|
8508
|
-
* @interface
|
|
8837
|
+
* @interface DataTypesPaymentStatusResponse
|
|
8509
8838
|
*/
|
|
8510
|
-
export interface
|
|
8839
|
+
export interface DataTypesPaymentStatusResponse {
|
|
8511
8840
|
/**
|
|
8512
8841
|
*
|
|
8513
|
-
* @type {
|
|
8514
|
-
* @memberof
|
|
8842
|
+
* @type {number}
|
|
8843
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8515
8844
|
*/
|
|
8516
|
-
'
|
|
8845
|
+
'amount'?: number;
|
|
8517
8846
|
/**
|
|
8518
8847
|
*
|
|
8519
8848
|
* @type {string}
|
|
8520
|
-
* @memberof
|
|
8849
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8521
8850
|
*/
|
|
8522
|
-
'
|
|
8851
|
+
'currency'?: string;
|
|
8523
8852
|
/**
|
|
8524
8853
|
*
|
|
8525
|
-
* @type {
|
|
8526
|
-
* @memberof
|
|
8527
|
-
*/
|
|
8528
|
-
'status'?: number;
|
|
8529
|
-
}
|
|
8530
|
-
/**
|
|
8531
|
-
*
|
|
8532
|
-
* @export
|
|
8533
|
-
* @interface DataTypesPlan
|
|
8534
|
-
*/
|
|
8535
|
-
export interface DataTypesPlan {
|
|
8536
|
-
/**
|
|
8537
|
-
* JSON key remains \"BillingCycle\"
|
|
8538
|
-
* @type {number}
|
|
8539
|
-
* @memberof DataTypesPlan
|
|
8854
|
+
* @type {string}
|
|
8855
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8540
8856
|
*/
|
|
8541
|
-
'
|
|
8857
|
+
'failure_reason'?: string;
|
|
8542
8858
|
/**
|
|
8543
|
-
*
|
|
8859
|
+
*
|
|
8544
8860
|
* @type {string}
|
|
8545
|
-
* @memberof
|
|
8861
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8546
8862
|
*/
|
|
8547
|
-
'
|
|
8863
|
+
'gateway'?: string;
|
|
8548
8864
|
/**
|
|
8549
|
-
*
|
|
8865
|
+
*
|
|
8866
|
+
* @type {{ [key: string]: any; }}
|
|
8867
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8868
|
+
*/
|
|
8869
|
+
'gateway_data'?: { [key: string]: any; };
|
|
8870
|
+
/**
|
|
8871
|
+
*
|
|
8872
|
+
* @type {string}
|
|
8873
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8874
|
+
*/
|
|
8875
|
+
'order_id'?: string;
|
|
8876
|
+
/**
|
|
8877
|
+
*
|
|
8878
|
+
* @type {string}
|
|
8879
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8880
|
+
*/
|
|
8881
|
+
'payment_id'?: string;
|
|
8882
|
+
/**
|
|
8883
|
+
*
|
|
8884
|
+
* @type {string}
|
|
8885
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8886
|
+
*/
|
|
8887
|
+
'status'?: string;
|
|
8888
|
+
/**
|
|
8889
|
+
*
|
|
8890
|
+
* @type {string}
|
|
8891
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8892
|
+
*/
|
|
8893
|
+
'updated_at'?: string;
|
|
8894
|
+
}
|
|
8895
|
+
/**
|
|
8896
|
+
*
|
|
8897
|
+
* @export
|
|
8898
|
+
* @interface DataTypesPaymentsListResponse
|
|
8899
|
+
*/
|
|
8900
|
+
export interface DataTypesPaymentsListResponse {
|
|
8901
|
+
/**
|
|
8902
|
+
*
|
|
8903
|
+
* @type {Array<DataTypesPayment>}
|
|
8904
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8905
|
+
*/
|
|
8906
|
+
'data'?: Array<DataTypesPayment>;
|
|
8907
|
+
/**
|
|
8908
|
+
*
|
|
8909
|
+
* @type {string}
|
|
8910
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8911
|
+
*/
|
|
8912
|
+
'message'?: string;
|
|
8913
|
+
/**
|
|
8914
|
+
*
|
|
8915
|
+
* @type {number}
|
|
8916
|
+
* @memberof DataTypesPaymentsListResponse
|
|
8917
|
+
*/
|
|
8918
|
+
'status'?: number;
|
|
8919
|
+
}
|
|
8920
|
+
/**
|
|
8921
|
+
*
|
|
8922
|
+
* @export
|
|
8923
|
+
* @interface DataTypesPlan
|
|
8924
|
+
*/
|
|
8925
|
+
export interface DataTypesPlan {
|
|
8926
|
+
/**
|
|
8927
|
+
* JSON key remains \"BillingCycle\"
|
|
8928
|
+
* @type {number}
|
|
8929
|
+
* @memberof DataTypesPlan
|
|
8930
|
+
*/
|
|
8931
|
+
'BillingCycle'?: number;
|
|
8932
|
+
/**
|
|
8933
|
+
* JSON key remains \"CreatedAt\"
|
|
8934
|
+
* @type {string}
|
|
8935
|
+
* @memberof DataTypesPlan
|
|
8936
|
+
*/
|
|
8937
|
+
'CreatedAt'?: string;
|
|
8938
|
+
/**
|
|
8939
|
+
* JSON key remains \"CreatedBy\", can be NULL
|
|
8550
8940
|
* @type {number}
|
|
8551
8941
|
* @memberof DataTypesPlan
|
|
8552
8942
|
*/
|
|
@@ -9025,6 +9415,92 @@ export interface DataTypesPurchaseCreditsResponse {
|
|
|
9025
9415
|
*/
|
|
9026
9416
|
'updated_balance'?: DataTypesCreditBalance;
|
|
9027
9417
|
}
|
|
9418
|
+
/**
|
|
9419
|
+
*
|
|
9420
|
+
* @export
|
|
9421
|
+
* @interface DataTypesRefundRequestDto
|
|
9422
|
+
*/
|
|
9423
|
+
export interface DataTypesRefundRequestDto {
|
|
9424
|
+
/**
|
|
9425
|
+
*
|
|
9426
|
+
* @type {number}
|
|
9427
|
+
* @memberof DataTypesRefundRequestDto
|
|
9428
|
+
*/
|
|
9429
|
+
'amount': number;
|
|
9430
|
+
/**
|
|
9431
|
+
*
|
|
9432
|
+
* @type {string}
|
|
9433
|
+
* @memberof DataTypesRefundRequestDto
|
|
9434
|
+
*/
|
|
9435
|
+
'gateway': string;
|
|
9436
|
+
/**
|
|
9437
|
+
*
|
|
9438
|
+
* @type {{ [key: string]: any; }}
|
|
9439
|
+
* @memberof DataTypesRefundRequestDto
|
|
9440
|
+
*/
|
|
9441
|
+
'metadata'?: { [key: string]: any; };
|
|
9442
|
+
/**
|
|
9443
|
+
*
|
|
9444
|
+
* @type {string}
|
|
9445
|
+
* @memberof DataTypesRefundRequestDto
|
|
9446
|
+
*/
|
|
9447
|
+
'payment_id': string;
|
|
9448
|
+
/**
|
|
9449
|
+
*
|
|
9450
|
+
* @type {string}
|
|
9451
|
+
* @memberof DataTypesRefundRequestDto
|
|
9452
|
+
*/
|
|
9453
|
+
'reason': string;
|
|
9454
|
+
}
|
|
9455
|
+
/**
|
|
9456
|
+
*
|
|
9457
|
+
* @export
|
|
9458
|
+
* @interface DataTypesRefundResponseDto
|
|
9459
|
+
*/
|
|
9460
|
+
export interface DataTypesRefundResponseDto {
|
|
9461
|
+
/**
|
|
9462
|
+
*
|
|
9463
|
+
* @type {number}
|
|
9464
|
+
* @memberof DataTypesRefundResponseDto
|
|
9465
|
+
*/
|
|
9466
|
+
'amount'?: number;
|
|
9467
|
+
/**
|
|
9468
|
+
*
|
|
9469
|
+
* @type {string}
|
|
9470
|
+
* @memberof DataTypesRefundResponseDto
|
|
9471
|
+
*/
|
|
9472
|
+
'created_at'?: string;
|
|
9473
|
+
/**
|
|
9474
|
+
*
|
|
9475
|
+
* @type {string}
|
|
9476
|
+
* @memberof DataTypesRefundResponseDto
|
|
9477
|
+
*/
|
|
9478
|
+
'gateway'?: string;
|
|
9479
|
+
/**
|
|
9480
|
+
*
|
|
9481
|
+
* @type {{ [key: string]: any; }}
|
|
9482
|
+
* @memberof DataTypesRefundResponseDto
|
|
9483
|
+
*/
|
|
9484
|
+
'gateway_response'?: { [key: string]: any; };
|
|
9485
|
+
/**
|
|
9486
|
+
*
|
|
9487
|
+
* @type {string}
|
|
9488
|
+
* @memberof DataTypesRefundResponseDto
|
|
9489
|
+
*/
|
|
9490
|
+
'payment_id'?: string;
|
|
9491
|
+
/**
|
|
9492
|
+
*
|
|
9493
|
+
* @type {string}
|
|
9494
|
+
* @memberof DataTypesRefundResponseDto
|
|
9495
|
+
*/
|
|
9496
|
+
'refund_id'?: string;
|
|
9497
|
+
/**
|
|
9498
|
+
*
|
|
9499
|
+
* @type {string}
|
|
9500
|
+
* @memberof DataTypesRefundResponseDto
|
|
9501
|
+
*/
|
|
9502
|
+
'status'?: string;
|
|
9503
|
+
}
|
|
9028
9504
|
/**
|
|
9029
9505
|
*
|
|
9030
9506
|
* @export
|
|
@@ -11475,6 +11951,25 @@ export interface DataTypesVerifyOTPResponseWrapper {
|
|
|
11475
11951
|
*/
|
|
11476
11952
|
'status'?: number;
|
|
11477
11953
|
}
|
|
11954
|
+
/**
|
|
11955
|
+
*
|
|
11956
|
+
* @export
|
|
11957
|
+
* @interface DataTypesVerifyPaymentRequest
|
|
11958
|
+
*/
|
|
11959
|
+
export interface DataTypesVerifyPaymentRequest {
|
|
11960
|
+
/**
|
|
11961
|
+
*
|
|
11962
|
+
* @type {string}
|
|
11963
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11964
|
+
*/
|
|
11965
|
+
'gateway': string;
|
|
11966
|
+
/**
|
|
11967
|
+
*
|
|
11968
|
+
* @type {string}
|
|
11969
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11970
|
+
*/
|
|
11971
|
+
'payment_id': string;
|
|
11972
|
+
}
|
|
11478
11973
|
/**
|
|
11479
11974
|
*
|
|
11480
11975
|
* @export
|
|
@@ -13881,12 +14376,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13881
14376
|
};
|
|
13882
14377
|
},
|
|
13883
14378
|
/**
|
|
13884
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
14379
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13885
14380
|
* @summary Get No-Clicks Queries
|
|
13886
14381
|
* @param {string} xStoreID Store ID
|
|
13887
14382
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13888
14383
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13889
14384
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14385
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14386
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14387
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14388
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14389
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13890
14390
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13891
14391
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13892
14392
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13905,7 +14405,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13905
14405
|
* @param {*} [options] Override http request option.
|
|
13906
14406
|
* @throws {RequiredError}
|
|
13907
14407
|
*/
|
|
13908
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14408
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
13909
14409
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13910
14410
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
|
|
13911
14411
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -13936,6 +14436,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13936
14436
|
localVarQueryParameter['search'] = search;
|
|
13937
14437
|
}
|
|
13938
14438
|
|
|
14439
|
+
if (analyticsTags !== undefined) {
|
|
14440
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14441
|
+
}
|
|
14442
|
+
|
|
14443
|
+
if (tagsMatchMode !== undefined) {
|
|
14444
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14445
|
+
}
|
|
14446
|
+
|
|
14447
|
+
if (tagsExclude !== undefined) {
|
|
14448
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14449
|
+
}
|
|
14450
|
+
|
|
14451
|
+
if (tagKeyFilter !== undefined) {
|
|
14452
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14453
|
+
}
|
|
14454
|
+
|
|
14455
|
+
if (tagValueFilter !== undefined) {
|
|
14456
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14457
|
+
}
|
|
14458
|
+
|
|
13939
14459
|
if (compareMode !== undefined) {
|
|
13940
14460
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
13941
14461
|
}
|
|
@@ -14008,12 +14528,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14008
14528
|
};
|
|
14009
14529
|
},
|
|
14010
14530
|
/**
|
|
14011
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
14531
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14012
14532
|
* @summary Get No-Results Queries
|
|
14013
14533
|
* @param {string} xStoreID Store ID
|
|
14014
14534
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14015
14535
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14016
14536
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14537
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14538
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14539
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14540
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14541
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14017
14542
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14018
14543
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14019
14544
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14032,7 +14557,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14032
14557
|
* @param {*} [options] Override http request option.
|
|
14033
14558
|
* @throws {RequiredError}
|
|
14034
14559
|
*/
|
|
14035
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14560
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14036
14561
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14037
14562
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
|
|
14038
14563
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -14063,6 +14588,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14063
14588
|
localVarQueryParameter['search'] = search;
|
|
14064
14589
|
}
|
|
14065
14590
|
|
|
14591
|
+
if (analyticsTags !== undefined) {
|
|
14592
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14593
|
+
}
|
|
14594
|
+
|
|
14595
|
+
if (tagsMatchMode !== undefined) {
|
|
14596
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14597
|
+
}
|
|
14598
|
+
|
|
14599
|
+
if (tagsExclude !== undefined) {
|
|
14600
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14601
|
+
}
|
|
14602
|
+
|
|
14603
|
+
if (tagKeyFilter !== undefined) {
|
|
14604
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14605
|
+
}
|
|
14606
|
+
|
|
14607
|
+
if (tagValueFilter !== undefined) {
|
|
14608
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14609
|
+
}
|
|
14610
|
+
|
|
14066
14611
|
if (compareMode !== undefined) {
|
|
14067
14612
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14068
14613
|
}
|
|
@@ -14135,16 +14680,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14135
14680
|
};
|
|
14136
14681
|
},
|
|
14137
14682
|
/**
|
|
14138
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
14683
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
14139
14684
|
* @summary Get Query Insights
|
|
14140
14685
|
* @param {string} xStoreID Store ID
|
|
14141
14686
|
* @param {string} query Search query to analyze
|
|
14142
14687
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14143
14688
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14689
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
14690
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
14691
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
14692
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
14693
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14144
14694
|
* @param {*} [options] Override http request option.
|
|
14145
14695
|
* @throws {RequiredError}
|
|
14146
14696
|
*/
|
|
14147
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14697
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14148
14698
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14149
14699
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
|
|
14150
14700
|
// verify required parameter 'query' is not null or undefined
|
|
@@ -14174,6 +14724,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14174
14724
|
localVarQueryParameter['end_time'] = endTime;
|
|
14175
14725
|
}
|
|
14176
14726
|
|
|
14727
|
+
if (resultsPage !== undefined) {
|
|
14728
|
+
localVarQueryParameter['results_page'] = resultsPage;
|
|
14729
|
+
}
|
|
14730
|
+
|
|
14731
|
+
if (resultsPageSize !== undefined) {
|
|
14732
|
+
localVarQueryParameter['results_page_size'] = resultsPageSize;
|
|
14733
|
+
}
|
|
14734
|
+
|
|
14735
|
+
if (filtersPage !== undefined) {
|
|
14736
|
+
localVarQueryParameter['filters_page'] = filtersPage;
|
|
14737
|
+
}
|
|
14738
|
+
|
|
14739
|
+
if (filtersPageSize !== undefined) {
|
|
14740
|
+
localVarQueryParameter['filters_page_size'] = filtersPageSize;
|
|
14741
|
+
}
|
|
14742
|
+
|
|
14743
|
+
if (includeWidget !== undefined) {
|
|
14744
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
14745
|
+
}
|
|
14746
|
+
|
|
14177
14747
|
|
|
14178
14748
|
|
|
14179
14749
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -14186,12 +14756,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14186
14756
|
};
|
|
14187
14757
|
},
|
|
14188
14758
|
/**
|
|
14189
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
14759
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
14190
14760
|
* @summary Get Top Results Analytics
|
|
14191
14761
|
* @param {string} xStoreID Store ID
|
|
14192
14762
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14193
14763
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14194
14764
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
14765
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14766
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14767
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14768
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14769
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14770
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14771
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14772
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14773
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14774
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14775
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14776
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14777
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14195
14778
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14196
14779
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14197
14780
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -14205,7 +14788,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14205
14788
|
* @param {*} [options] Override http request option.
|
|
14206
14789
|
* @throws {RequiredError}
|
|
14207
14790
|
*/
|
|
14208
|
-
adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14791
|
+
adminAnalyticsStoreXStoreIDResultsGet: async (xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14209
14792
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14210
14793
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID)
|
|
14211
14794
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -14236,47 +14819,99 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14236
14819
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
14237
14820
|
}
|
|
14238
14821
|
|
|
14239
|
-
if (
|
|
14240
|
-
localVarQueryParameter['
|
|
14822
|
+
if (analyticsTags !== undefined) {
|
|
14823
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14241
14824
|
}
|
|
14242
14825
|
|
|
14243
|
-
if (
|
|
14244
|
-
localVarQueryParameter['
|
|
14826
|
+
if (tagsMatchMode !== undefined) {
|
|
14827
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14245
14828
|
}
|
|
14246
14829
|
|
|
14247
|
-
if (
|
|
14248
|
-
localVarQueryParameter['
|
|
14830
|
+
if (tagsExclude !== undefined) {
|
|
14831
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14249
14832
|
}
|
|
14250
14833
|
|
|
14251
|
-
if (
|
|
14252
|
-
localVarQueryParameter['
|
|
14834
|
+
if (tagKeyFilter !== undefined) {
|
|
14835
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14253
14836
|
}
|
|
14254
14837
|
|
|
14255
|
-
if (
|
|
14256
|
-
localVarQueryParameter['
|
|
14838
|
+
if (tagValueFilter !== undefined) {
|
|
14839
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14257
14840
|
}
|
|
14258
14841
|
|
|
14259
|
-
if (
|
|
14260
|
-
localVarQueryParameter['
|
|
14842
|
+
if (compareMode !== undefined) {
|
|
14843
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14261
14844
|
}
|
|
14262
14845
|
|
|
14263
|
-
if (
|
|
14264
|
-
localVarQueryParameter['
|
|
14846
|
+
if (compareStartTime !== undefined) {
|
|
14847
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14265
14848
|
}
|
|
14266
14849
|
|
|
14267
|
-
if (
|
|
14268
|
-
localVarQueryParameter['
|
|
14850
|
+
if (compareEndTime !== undefined) {
|
|
14851
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14269
14852
|
}
|
|
14270
14853
|
|
|
14271
|
-
if (
|
|
14272
|
-
localVarQueryParameter['
|
|
14854
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14855
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14273
14856
|
}
|
|
14274
14857
|
|
|
14275
|
-
if (
|
|
14276
|
-
localVarQueryParameter['
|
|
14858
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14859
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14277
14860
|
}
|
|
14278
14861
|
|
|
14279
|
-
|
|
14862
|
+
if (compareTagsExclude !== undefined) {
|
|
14863
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14864
|
+
}
|
|
14865
|
+
|
|
14866
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14867
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14868
|
+
}
|
|
14869
|
+
|
|
14870
|
+
if (compareTagValueFilter !== undefined) {
|
|
14871
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14872
|
+
}
|
|
14873
|
+
|
|
14874
|
+
if (minImpressions !== undefined) {
|
|
14875
|
+
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
14876
|
+
}
|
|
14877
|
+
|
|
14878
|
+
if (sortBy !== undefined) {
|
|
14879
|
+
localVarQueryParameter['sort_by'] = sortBy;
|
|
14880
|
+
}
|
|
14881
|
+
|
|
14882
|
+
if (sortOrder !== undefined) {
|
|
14883
|
+
localVarQueryParameter['sort_order'] = sortOrder;
|
|
14884
|
+
}
|
|
14885
|
+
|
|
14886
|
+
if (sort !== undefined) {
|
|
14887
|
+
localVarQueryParameter['sort'] = sort;
|
|
14888
|
+
}
|
|
14889
|
+
|
|
14890
|
+
if (includeDocuments !== undefined) {
|
|
14891
|
+
localVarQueryParameter['include_documents'] = includeDocuments;
|
|
14892
|
+
}
|
|
14893
|
+
|
|
14894
|
+
if (includeWidget !== undefined) {
|
|
14895
|
+
localVarQueryParameter['include_widget'] = includeWidget;
|
|
14896
|
+
}
|
|
14897
|
+
|
|
14898
|
+
if (limit !== undefined) {
|
|
14899
|
+
localVarQueryParameter['limit'] = limit;
|
|
14900
|
+
}
|
|
14901
|
+
|
|
14902
|
+
if (offset !== undefined) {
|
|
14903
|
+
localVarQueryParameter['offset'] = offset;
|
|
14904
|
+
}
|
|
14905
|
+
|
|
14906
|
+
if (page !== undefined) {
|
|
14907
|
+
localVarQueryParameter['page'] = page;
|
|
14908
|
+
}
|
|
14909
|
+
|
|
14910
|
+
if (pageSize !== undefined) {
|
|
14911
|
+
localVarQueryParameter['page_size'] = pageSize;
|
|
14912
|
+
}
|
|
14913
|
+
|
|
14914
|
+
|
|
14280
14915
|
|
|
14281
14916
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14282
14917
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -14732,12 +15367,17 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14732
15367
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14733
15368
|
},
|
|
14734
15369
|
/**
|
|
14735
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
15370
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
14736
15371
|
* @summary Get No-Clicks Queries
|
|
14737
15372
|
* @param {string} xStoreID Store ID
|
|
14738
15373
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14739
15374
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14740
15375
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15376
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15377
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15378
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15379
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15380
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14741
15381
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14742
15382
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14743
15383
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14756,19 +15396,24 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14756
15396
|
* @param {*} [options] Override http request option.
|
|
14757
15397
|
* @throws {RequiredError}
|
|
14758
15398
|
*/
|
|
14759
|
-
async adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
14760
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
15399
|
+
async adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
15400
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
14761
15401
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14762
15402
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']?.[localVarOperationServerIndex]?.url;
|
|
14763
15403
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14764
15404
|
},
|
|
14765
15405
|
/**
|
|
14766
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
15406
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14767
15407
|
* @summary Get No-Results Queries
|
|
14768
15408
|
* @param {string} xStoreID Store ID
|
|
14769
15409
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14770
15410
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14771
15411
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15412
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15413
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15414
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15415
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15416
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14772
15417
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14773
15418
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14774
15419
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14787,35 +15432,53 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14787
15432
|
* @param {*} [options] Override http request option.
|
|
14788
15433
|
* @throws {RequiredError}
|
|
14789
15434
|
*/
|
|
14790
|
-
async adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
14791
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
15435
|
+
async adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response>> {
|
|
15436
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options);
|
|
14792
15437
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14793
15438
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14794
15439
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14795
15440
|
},
|
|
14796
15441
|
/**
|
|
14797
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
15442
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
14798
15443
|
* @summary Get Query Insights
|
|
14799
15444
|
* @param {string} xStoreID Store ID
|
|
14800
15445
|
* @param {string} query Search query to analyze
|
|
14801
15446
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14802
15447
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15448
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
15449
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
15450
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
15451
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
15452
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
14803
15453
|
* @param {*} [options] Override http request option.
|
|
14804
15454
|
* @throws {RequiredError}
|
|
14805
15455
|
*/
|
|
14806
|
-
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
14807
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
|
|
15456
|
+
async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
|
|
15457
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
|
|
14808
15458
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14809
15459
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
|
|
14810
15460
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14811
15461
|
},
|
|
14812
15462
|
/**
|
|
14813
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
15463
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
14814
15464
|
* @summary Get Top Results Analytics
|
|
14815
15465
|
* @param {string} xStoreID Store ID
|
|
14816
15466
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14817
15467
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14818
15468
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15469
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15470
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15471
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15472
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15473
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15474
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15475
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15476
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15477
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15478
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15479
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15480
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15481
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14819
15482
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14820
15483
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14821
15484
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -14829,8 +15492,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14829
15492
|
* @param {*} [options] Override http request option.
|
|
14830
15493
|
* @throws {RequiredError}
|
|
14831
15494
|
*/
|
|
14832
|
-
async adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>> {
|
|
14833
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
15495
|
+
async adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response>> {
|
|
15496
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options);
|
|
14834
15497
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14835
15498
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14836
15499
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15117,12 +15780,17 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15117
15780
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesGet(xStoreID, startTime, endTime, granularity, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, orderBy, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15118
15781
|
},
|
|
15119
15782
|
/**
|
|
15120
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
15783
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
15121
15784
|
* @summary Get No-Clicks Queries
|
|
15122
15785
|
* @param {string} xStoreID Store ID
|
|
15123
15786
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15124
15787
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15125
15788
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15789
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15790
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15791
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15792
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15793
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15126
15794
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15127
15795
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15128
15796
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15141,16 +15809,21 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15141
15809
|
* @param {*} [options] Override http request option.
|
|
15142
15810
|
* @throws {RequiredError}
|
|
15143
15811
|
*/
|
|
15144
|
-
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15145
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15812
|
+
adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15813
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15146
15814
|
},
|
|
15147
15815
|
/**
|
|
15148
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
15816
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
15149
15817
|
* @summary Get No-Results Queries
|
|
15150
15818
|
* @param {string} xStoreID Store ID
|
|
15151
15819
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15152
15820
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15153
15821
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15822
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15823
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15824
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15825
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15826
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15154
15827
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15155
15828
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15156
15829
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15169,29 +15842,47 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15169
15842
|
* @param {*} [options] Override http request option.
|
|
15170
15843
|
* @throws {RequiredError}
|
|
15171
15844
|
*/
|
|
15172
|
-
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15173
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15845
|
+
adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response> {
|
|
15846
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
|
|
15174
15847
|
},
|
|
15175
15848
|
/**
|
|
15176
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
15849
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
15177
15850
|
* @summary Get Query Insights
|
|
15178
15851
|
* @param {string} xStoreID Store ID
|
|
15179
15852
|
* @param {string} query Search query to analyze
|
|
15180
15853
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15181
15854
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15855
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
15856
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
15857
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
15858
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
15859
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
15182
15860
|
* @param {*} [options] Override http request option.
|
|
15183
15861
|
* @throws {RequiredError}
|
|
15184
15862
|
*/
|
|
15185
|
-
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
15186
|
-
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
15863
|
+
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
|
|
15864
|
+
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
|
|
15187
15865
|
},
|
|
15188
15866
|
/**
|
|
15189
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
15867
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
15190
15868
|
* @summary Get Top Results Analytics
|
|
15191
15869
|
* @param {string} xStoreID Store ID
|
|
15192
15870
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15193
15871
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15194
15872
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15873
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15874
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15875
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15876
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15877
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15878
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15879
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15880
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15881
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15882
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15883
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15884
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15885
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
15195
15886
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
15196
15887
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
15197
15888
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -15205,8 +15896,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15205
15896
|
* @param {*} [options] Override http request option.
|
|
15206
15897
|
* @throws {RequiredError}
|
|
15207
15898
|
*/
|
|
15208
|
-
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response> {
|
|
15209
|
-
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
15899
|
+
adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response> {
|
|
15900
|
+
return localVarFp.adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(axios, basePath));
|
|
15210
15901
|
},
|
|
15211
15902
|
/**
|
|
15212
15903
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -15506,12 +16197,17 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15506
16197
|
}
|
|
15507
16198
|
|
|
15508
16199
|
/**
|
|
15509
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
16200
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
15510
16201
|
* @summary Get No-Clicks Queries
|
|
15511
16202
|
* @param {string} xStoreID Store ID
|
|
15512
16203
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15513
16204
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15514
16205
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16206
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16207
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16208
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16209
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16210
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15515
16211
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15516
16212
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15517
16213
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15531,17 +16227,22 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15531
16227
|
* @throws {RequiredError}
|
|
15532
16228
|
* @memberof AnalyticsApi
|
|
15533
16229
|
*/
|
|
15534
|
-
public adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
15535
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
16230
|
+
public adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
16231
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoClicksGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
15536
16232
|
}
|
|
15537
16233
|
|
|
15538
16234
|
/**
|
|
15539
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
16235
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
15540
16236
|
* @summary Get No-Results Queries
|
|
15541
16237
|
* @param {string} xStoreID Store ID
|
|
15542
16238
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15543
16239
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15544
16240
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16241
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16242
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16243
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16244
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16245
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15545
16246
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15546
16247
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15547
16248
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15561,32 +16262,50 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15561
16262
|
* @throws {RequiredError}
|
|
15562
16263
|
* @memberof AnalyticsApi
|
|
15563
16264
|
*/
|
|
15564
|
-
public adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
15565
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
16265
|
+
public adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID: string, startTime?: string, endTime?: string, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, sortBy?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) {
|
|
16266
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(this.axios, this.basePath));
|
|
15566
16267
|
}
|
|
15567
16268
|
|
|
15568
16269
|
/**
|
|
15569
|
-
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
16270
|
+
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
|
|
15570
16271
|
* @summary Get Query Insights
|
|
15571
16272
|
* @param {string} xStoreID Store ID
|
|
15572
16273
|
* @param {string} query Search query to analyze
|
|
15573
16274
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15574
16275
|
* @param {string} [endTime] End time in RFC3339 format
|
|
16276
|
+
* @param {number} [resultsPage] Page number for popular results pagination
|
|
16277
|
+
* @param {number} [resultsPageSize] Number of results per page for popular results
|
|
16278
|
+
* @param {number} [filtersPage] Page number for popular filters pagination
|
|
16279
|
+
* @param {number} [filtersPageSize] Number of filters per page for popular filters
|
|
16280
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for popular results
|
|
15575
16281
|
* @param {*} [options] Override http request option.
|
|
15576
16282
|
* @throws {RequiredError}
|
|
15577
16283
|
* @memberof AnalyticsApi
|
|
15578
16284
|
*/
|
|
15579
|
-
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) {
|
|
15580
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
|
|
16285
|
+
public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
|
|
16286
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
|
|
15581
16287
|
}
|
|
15582
16288
|
|
|
15583
16289
|
/**
|
|
15584
|
-
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards.
|
|
16290
|
+
* Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
|
|
15585
16291
|
* @summary Get Top Results Analytics
|
|
15586
16292
|
* @param {string} xStoreID Store ID
|
|
15587
16293
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15588
16294
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15589
16295
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
16296
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16297
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16298
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16299
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16300
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16301
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16302
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16303
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16304
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16305
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16306
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16307
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16308
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
15590
16309
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
15591
16310
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
15592
16311
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -15601,8 +16320,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15601
16320
|
* @throws {RequiredError}
|
|
15602
16321
|
* @memberof AnalyticsApi
|
|
15603
16322
|
*/
|
|
15604
|
-
public adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
15605
|
-
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
16323
|
+
public adminAnalyticsStoreXStoreIDResultsGet(xStoreID: string, startTime?: string, endTime?: string, itemIds?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, minImpressions?: number, sortBy?: AdminAnalyticsStoreXStoreIDResultsGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum, sort?: string, includeDocuments?: boolean, includeWidget?: boolean, limit?: number, offset?: number, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) {
|
|
16324
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDResultsGet(xStoreID, startTime, endTime, itemIds, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, minImpressions, sortBy, sortOrder, sort, includeDocuments, includeWidget, limit, offset, page, pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
15606
16325
|
}
|
|
15607
16326
|
|
|
15608
16327
|
/**
|
|
@@ -15875,6 +16594,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
15875
16594
|
Desc: 'desc'
|
|
15876
16595
|
} as const;
|
|
15877
16596
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
16597
|
+
/**
|
|
16598
|
+
* @export
|
|
16599
|
+
*/
|
|
16600
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
16601
|
+
Any: 'any',
|
|
16602
|
+
All: 'all'
|
|
16603
|
+
} as const;
|
|
16604
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum];
|
|
15878
16605
|
/**
|
|
15879
16606
|
* @export
|
|
15880
16607
|
*/
|
|
@@ -15900,6 +16627,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
15900
16627
|
Desc: 'desc'
|
|
15901
16628
|
} as const;
|
|
15902
16629
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
16630
|
+
/**
|
|
16631
|
+
* @export
|
|
16632
|
+
*/
|
|
16633
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
16634
|
+
Any: 'any',
|
|
16635
|
+
All: 'all'
|
|
16636
|
+
} as const;
|
|
16637
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum];
|
|
15903
16638
|
/**
|
|
15904
16639
|
* @export
|
|
15905
16640
|
*/
|
|
@@ -15925,6 +16660,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
15925
16660
|
Desc: 'desc'
|
|
15926
16661
|
} as const;
|
|
15927
16662
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
16663
|
+
/**
|
|
16664
|
+
* @export
|
|
16665
|
+
*/
|
|
16666
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
16667
|
+
Any: 'any',
|
|
16668
|
+
All: 'all'
|
|
16669
|
+
} as const;
|
|
16670
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum];
|
|
16671
|
+
/**
|
|
16672
|
+
* @export
|
|
16673
|
+
*/
|
|
16674
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
16675
|
+
Any: 'any',
|
|
16676
|
+
All: 'all'
|
|
16677
|
+
} as const;
|
|
16678
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum];
|
|
15928
16679
|
/**
|
|
15929
16680
|
* @export
|
|
15930
16681
|
*/
|
|
@@ -24798,6 +25549,397 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
24798
25549
|
|
|
24799
25550
|
|
|
24800
25551
|
|
|
25552
|
+
/**
|
|
25553
|
+
* PaymentGatewayApi - axios parameter creator
|
|
25554
|
+
* @export
|
|
25555
|
+
*/
|
|
25556
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25557
|
+
return {
|
|
25558
|
+
/**
|
|
25559
|
+
* Creates a payment order using specified or default payment gateway
|
|
25560
|
+
* @summary Create a new payment order
|
|
25561
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25562
|
+
* @param {*} [options] Override http request option.
|
|
25563
|
+
* @throws {RequiredError}
|
|
25564
|
+
*/
|
|
25565
|
+
paymentGatewayCreateOrderPost: async (order: DataTypesCreatePaymentOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25566
|
+
// verify required parameter 'order' is not null or undefined
|
|
25567
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order)
|
|
25568
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
25569
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25570
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25571
|
+
let baseOptions;
|
|
25572
|
+
if (configuration) {
|
|
25573
|
+
baseOptions = configuration.baseOptions;
|
|
25574
|
+
}
|
|
25575
|
+
|
|
25576
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25577
|
+
const localVarHeaderParameter = {} as any;
|
|
25578
|
+
const localVarQueryParameter = {} as any;
|
|
25579
|
+
|
|
25580
|
+
// authentication BearerAuth required
|
|
25581
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25582
|
+
|
|
25583
|
+
|
|
25584
|
+
|
|
25585
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25586
|
+
|
|
25587
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25588
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25589
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25590
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration)
|
|
25591
|
+
|
|
25592
|
+
return {
|
|
25593
|
+
url: toPathString(localVarUrlObj),
|
|
25594
|
+
options: localVarRequestOptions,
|
|
25595
|
+
};
|
|
25596
|
+
},
|
|
25597
|
+
/**
|
|
25598
|
+
* Returns list of all active credit plans for purchase
|
|
25599
|
+
* @summary Get available credit plans
|
|
25600
|
+
* @param {*} [options] Override http request option.
|
|
25601
|
+
* @throws {RequiredError}
|
|
25602
|
+
*/
|
|
25603
|
+
paymentGatewayCreditPlansGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25604
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
25605
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25606
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25607
|
+
let baseOptions;
|
|
25608
|
+
if (configuration) {
|
|
25609
|
+
baseOptions = configuration.baseOptions;
|
|
25610
|
+
}
|
|
25611
|
+
|
|
25612
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25613
|
+
const localVarHeaderParameter = {} as any;
|
|
25614
|
+
const localVarQueryParameter = {} as any;
|
|
25615
|
+
|
|
25616
|
+
// authentication BearerAuth required
|
|
25617
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25618
|
+
|
|
25619
|
+
|
|
25620
|
+
|
|
25621
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25622
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25623
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25624
|
+
|
|
25625
|
+
return {
|
|
25626
|
+
url: toPathString(localVarUrlObj),
|
|
25627
|
+
options: localVarRequestOptions,
|
|
25628
|
+
};
|
|
25629
|
+
},
|
|
25630
|
+
/**
|
|
25631
|
+
* Returns list of all available payment gateways
|
|
25632
|
+
* @summary Get available payment gateways
|
|
25633
|
+
* @param {*} [options] Override http request option.
|
|
25634
|
+
* @throws {RequiredError}
|
|
25635
|
+
*/
|
|
25636
|
+
paymentGatewayGatewaysGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25637
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
25638
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25639
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25640
|
+
let baseOptions;
|
|
25641
|
+
if (configuration) {
|
|
25642
|
+
baseOptions = configuration.baseOptions;
|
|
25643
|
+
}
|
|
25644
|
+
|
|
25645
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25646
|
+
const localVarHeaderParameter = {} as any;
|
|
25647
|
+
const localVarQueryParameter = {} as any;
|
|
25648
|
+
|
|
25649
|
+
// authentication BearerAuth required
|
|
25650
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25651
|
+
|
|
25652
|
+
|
|
25653
|
+
|
|
25654
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25655
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25656
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25657
|
+
|
|
25658
|
+
return {
|
|
25659
|
+
url: toPathString(localVarUrlObj),
|
|
25660
|
+
options: localVarRequestOptions,
|
|
25661
|
+
};
|
|
25662
|
+
},
|
|
25663
|
+
/**
|
|
25664
|
+
* Processes a refund for a completed payment
|
|
25665
|
+
* @summary Process payment refund
|
|
25666
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25667
|
+
* @param {*} [options] Override http request option.
|
|
25668
|
+
* @throws {RequiredError}
|
|
25669
|
+
*/
|
|
25670
|
+
paymentGatewayRefundPost: async (refund: DataTypesRefundRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25671
|
+
// verify required parameter 'refund' is not null or undefined
|
|
25672
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund)
|
|
25673
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
25674
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25675
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25676
|
+
let baseOptions;
|
|
25677
|
+
if (configuration) {
|
|
25678
|
+
baseOptions = configuration.baseOptions;
|
|
25679
|
+
}
|
|
25680
|
+
|
|
25681
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25682
|
+
const localVarHeaderParameter = {} as any;
|
|
25683
|
+
const localVarQueryParameter = {} as any;
|
|
25684
|
+
|
|
25685
|
+
// authentication BearerAuth required
|
|
25686
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25687
|
+
|
|
25688
|
+
|
|
25689
|
+
|
|
25690
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25691
|
+
|
|
25692
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25693
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25694
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25695
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration)
|
|
25696
|
+
|
|
25697
|
+
return {
|
|
25698
|
+
url: toPathString(localVarUrlObj),
|
|
25699
|
+
options: localVarRequestOptions,
|
|
25700
|
+
};
|
|
25701
|
+
},
|
|
25702
|
+
/**
|
|
25703
|
+
* Verifies the current status of a payment
|
|
25704
|
+
* @summary Verify payment status
|
|
25705
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25706
|
+
* @param {*} [options] Override http request option.
|
|
25707
|
+
* @throws {RequiredError}
|
|
25708
|
+
*/
|
|
25709
|
+
paymentGatewayVerifyPost: async (verify: DataTypesVerifyPaymentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25710
|
+
// verify required parameter 'verify' is not null or undefined
|
|
25711
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify)
|
|
25712
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
25713
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25714
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25715
|
+
let baseOptions;
|
|
25716
|
+
if (configuration) {
|
|
25717
|
+
baseOptions = configuration.baseOptions;
|
|
25718
|
+
}
|
|
25719
|
+
|
|
25720
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25721
|
+
const localVarHeaderParameter = {} as any;
|
|
25722
|
+
const localVarQueryParameter = {} as any;
|
|
25723
|
+
|
|
25724
|
+
// authentication BearerAuth required
|
|
25725
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25726
|
+
|
|
25727
|
+
|
|
25728
|
+
|
|
25729
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25730
|
+
|
|
25731
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25732
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25733
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25734
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration)
|
|
25735
|
+
|
|
25736
|
+
return {
|
|
25737
|
+
url: toPathString(localVarUrlObj),
|
|
25738
|
+
options: localVarRequestOptions,
|
|
25739
|
+
};
|
|
25740
|
+
},
|
|
25741
|
+
}
|
|
25742
|
+
};
|
|
25743
|
+
|
|
25744
|
+
/**
|
|
25745
|
+
* PaymentGatewayApi - functional programming interface
|
|
25746
|
+
* @export
|
|
25747
|
+
*/
|
|
25748
|
+
export const PaymentGatewayApiFp = function(configuration?: Configuration) {
|
|
25749
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration)
|
|
25750
|
+
return {
|
|
25751
|
+
/**
|
|
25752
|
+
* Creates a payment order using specified or default payment gateway
|
|
25753
|
+
* @summary Create a new payment order
|
|
25754
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25755
|
+
* @param {*} [options] Override http request option.
|
|
25756
|
+
* @throws {RequiredError}
|
|
25757
|
+
*/
|
|
25758
|
+
async paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>> {
|
|
25759
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
25760
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25761
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']?.[localVarOperationServerIndex]?.url;
|
|
25762
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25763
|
+
},
|
|
25764
|
+
/**
|
|
25765
|
+
* Returns list of all active credit plans for purchase
|
|
25766
|
+
* @summary Get available credit plans
|
|
25767
|
+
* @param {*} [options] Override http request option.
|
|
25768
|
+
* @throws {RequiredError}
|
|
25769
|
+
*/
|
|
25770
|
+
async paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCreditPlan>>> {
|
|
25771
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
25772
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25773
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']?.[localVarOperationServerIndex]?.url;
|
|
25774
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25775
|
+
},
|
|
25776
|
+
/**
|
|
25777
|
+
* Returns list of all available payment gateways
|
|
25778
|
+
* @summary Get available payment gateways
|
|
25779
|
+
* @param {*} [options] Override http request option.
|
|
25780
|
+
* @throws {RequiredError}
|
|
25781
|
+
*/
|
|
25782
|
+
async paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGatewayListResponse>> {
|
|
25783
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
25784
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25785
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']?.[localVarOperationServerIndex]?.url;
|
|
25786
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25787
|
+
},
|
|
25788
|
+
/**
|
|
25789
|
+
* Processes a refund for a completed payment
|
|
25790
|
+
* @summary Process payment refund
|
|
25791
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25792
|
+
* @param {*} [options] Override http request option.
|
|
25793
|
+
* @throws {RequiredError}
|
|
25794
|
+
*/
|
|
25795
|
+
async paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundResponseDto>> {
|
|
25796
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
25797
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25798
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']?.[localVarOperationServerIndex]?.url;
|
|
25799
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25800
|
+
},
|
|
25801
|
+
/**
|
|
25802
|
+
* Verifies the current status of a payment
|
|
25803
|
+
* @summary Verify payment status
|
|
25804
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25805
|
+
* @param {*} [options] Override http request option.
|
|
25806
|
+
* @throws {RequiredError}
|
|
25807
|
+
*/
|
|
25808
|
+
async paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusResponse>> {
|
|
25809
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
25810
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25811
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']?.[localVarOperationServerIndex]?.url;
|
|
25812
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25813
|
+
},
|
|
25814
|
+
}
|
|
25815
|
+
};
|
|
25816
|
+
|
|
25817
|
+
/**
|
|
25818
|
+
* PaymentGatewayApi - factory interface
|
|
25819
|
+
* @export
|
|
25820
|
+
*/
|
|
25821
|
+
export const PaymentGatewayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25822
|
+
const localVarFp = PaymentGatewayApiFp(configuration)
|
|
25823
|
+
return {
|
|
25824
|
+
/**
|
|
25825
|
+
* Creates a payment order using specified or default payment gateway
|
|
25826
|
+
* @summary Create a new payment order
|
|
25827
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25828
|
+
* @param {*} [options] Override http request option.
|
|
25829
|
+
* @throws {RequiredError}
|
|
25830
|
+
*/
|
|
25831
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse> {
|
|
25832
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
25833
|
+
},
|
|
25834
|
+
/**
|
|
25835
|
+
* Returns list of all active credit plans for purchase
|
|
25836
|
+
* @summary Get available credit plans
|
|
25837
|
+
* @param {*} [options] Override http request option.
|
|
25838
|
+
* @throws {RequiredError}
|
|
25839
|
+
*/
|
|
25840
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCreditPlan>> {
|
|
25841
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
25842
|
+
},
|
|
25843
|
+
/**
|
|
25844
|
+
* Returns list of all available payment gateways
|
|
25845
|
+
* @summary Get available payment gateways
|
|
25846
|
+
* @param {*} [options] Override http request option.
|
|
25847
|
+
* @throws {RequiredError}
|
|
25848
|
+
*/
|
|
25849
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGatewayListResponse> {
|
|
25850
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
25851
|
+
},
|
|
25852
|
+
/**
|
|
25853
|
+
* Processes a refund for a completed payment
|
|
25854
|
+
* @summary Process payment refund
|
|
25855
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25856
|
+
* @param {*} [options] Override http request option.
|
|
25857
|
+
* @throws {RequiredError}
|
|
25858
|
+
*/
|
|
25859
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundResponseDto> {
|
|
25860
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
25861
|
+
},
|
|
25862
|
+
/**
|
|
25863
|
+
* Verifies the current status of a payment
|
|
25864
|
+
* @summary Verify payment status
|
|
25865
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25866
|
+
* @param {*} [options] Override http request option.
|
|
25867
|
+
* @throws {RequiredError}
|
|
25868
|
+
*/
|
|
25869
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusResponse> {
|
|
25870
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
25871
|
+
},
|
|
25872
|
+
};
|
|
25873
|
+
};
|
|
25874
|
+
|
|
25875
|
+
/**
|
|
25876
|
+
* PaymentGatewayApi - object-oriented interface
|
|
25877
|
+
* @export
|
|
25878
|
+
* @class PaymentGatewayApi
|
|
25879
|
+
* @extends {BaseAPI}
|
|
25880
|
+
*/
|
|
25881
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
25882
|
+
/**
|
|
25883
|
+
* Creates a payment order using specified or default payment gateway
|
|
25884
|
+
* @summary Create a new payment order
|
|
25885
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25886
|
+
* @param {*} [options] Override http request option.
|
|
25887
|
+
* @throws {RequiredError}
|
|
25888
|
+
* @memberof PaymentGatewayApi
|
|
25889
|
+
*/
|
|
25890
|
+
public paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) {
|
|
25891
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
25892
|
+
}
|
|
25893
|
+
|
|
25894
|
+
/**
|
|
25895
|
+
* Returns list of all active credit plans for purchase
|
|
25896
|
+
* @summary Get available credit plans
|
|
25897
|
+
* @param {*} [options] Override http request option.
|
|
25898
|
+
* @throws {RequiredError}
|
|
25899
|
+
* @memberof PaymentGatewayApi
|
|
25900
|
+
*/
|
|
25901
|
+
public paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig) {
|
|
25902
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
25903
|
+
}
|
|
25904
|
+
|
|
25905
|
+
/**
|
|
25906
|
+
* Returns list of all available payment gateways
|
|
25907
|
+
* @summary Get available payment gateways
|
|
25908
|
+
* @param {*} [options] Override http request option.
|
|
25909
|
+
* @throws {RequiredError}
|
|
25910
|
+
* @memberof PaymentGatewayApi
|
|
25911
|
+
*/
|
|
25912
|
+
public paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig) {
|
|
25913
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
25914
|
+
}
|
|
25915
|
+
|
|
25916
|
+
/**
|
|
25917
|
+
* Processes a refund for a completed payment
|
|
25918
|
+
* @summary Process payment refund
|
|
25919
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25920
|
+
* @param {*} [options] Override http request option.
|
|
25921
|
+
* @throws {RequiredError}
|
|
25922
|
+
* @memberof PaymentGatewayApi
|
|
25923
|
+
*/
|
|
25924
|
+
public paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig) {
|
|
25925
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
25926
|
+
}
|
|
25927
|
+
|
|
25928
|
+
/**
|
|
25929
|
+
* Verifies the current status of a payment
|
|
25930
|
+
* @summary Verify payment status
|
|
25931
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25932
|
+
* @param {*} [options] Override http request option.
|
|
25933
|
+
* @throws {RequiredError}
|
|
25934
|
+
* @memberof PaymentGatewayApi
|
|
25935
|
+
*/
|
|
25936
|
+
public paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
25937
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
25938
|
+
}
|
|
25939
|
+
}
|
|
25940
|
+
|
|
25941
|
+
|
|
25942
|
+
|
|
24801
25943
|
/**
|
|
24802
25944
|
* PaymentsApi - axios parameter creator
|
|
24803
25945
|
* @export
|