@seekora-ai/admin-api 1.0.46 → 1.0.47
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 +16 -2
- package/api.ts +1085 -70
- package/dist/api.d.ts +746 -24
- package/dist/api.js +598 -37
- package/dist/esm/api.d.ts +746 -24
- package/dist/esm/api.js +590 -33
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.0.47.tgz +0 -0
- package/seekora-ai-admin-api-1.0.46.tgz +0 -0
package/dist/esm/api.d.ts
CHANGED
|
@@ -4227,6 +4227,174 @@ export interface DataTypesCreateOrganizationRequest {
|
|
|
4227
4227
|
*/
|
|
4228
4228
|
'ZipCode'?: string;
|
|
4229
4229
|
}
|
|
4230
|
+
/**
|
|
4231
|
+
*
|
|
4232
|
+
* @export
|
|
4233
|
+
* @interface DataTypesCreatePaymentOrderRequest
|
|
4234
|
+
*/
|
|
4235
|
+
export interface DataTypesCreatePaymentOrderRequest {
|
|
4236
|
+
/**
|
|
4237
|
+
* Optional for subscription/credit (uses plan price)
|
|
4238
|
+
* @type {number}
|
|
4239
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4240
|
+
*/
|
|
4241
|
+
'amount'?: number;
|
|
4242
|
+
/**
|
|
4243
|
+
*
|
|
4244
|
+
* @type {boolean}
|
|
4245
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4246
|
+
*/
|
|
4247
|
+
'auto_renewal'?: boolean;
|
|
4248
|
+
/**
|
|
4249
|
+
* Fields for credit top-up
|
|
4250
|
+
* @type {number}
|
|
4251
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4252
|
+
*/
|
|
4253
|
+
'credit_plan_id'?: number;
|
|
4254
|
+
/**
|
|
4255
|
+
*
|
|
4256
|
+
* @type {string}
|
|
4257
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4258
|
+
*/
|
|
4259
|
+
'currency': string;
|
|
4260
|
+
/**
|
|
4261
|
+
*
|
|
4262
|
+
* @type {DataTypesCustomerInfoDto}
|
|
4263
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4264
|
+
*/
|
|
4265
|
+
'customer_info': DataTypesCustomerInfoDto;
|
|
4266
|
+
/**
|
|
4267
|
+
* Optional, auto-generated if not provided
|
|
4268
|
+
* @type {string}
|
|
4269
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4270
|
+
*/
|
|
4271
|
+
'description'?: string;
|
|
4272
|
+
/**
|
|
4273
|
+
* Optional, uses default if not specified
|
|
4274
|
+
* @type {string}
|
|
4275
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4276
|
+
*/
|
|
4277
|
+
'gateway'?: string;
|
|
4278
|
+
/**
|
|
4279
|
+
*
|
|
4280
|
+
* @type {{ [key: string]: any; }}
|
|
4281
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4282
|
+
*/
|
|
4283
|
+
'metadata'?: {
|
|
4284
|
+
[key: string]: any;
|
|
4285
|
+
};
|
|
4286
|
+
/**
|
|
4287
|
+
* Fields for subscription payments
|
|
4288
|
+
* @type {number}
|
|
4289
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4290
|
+
*/
|
|
4291
|
+
'org_id'?: number;
|
|
4292
|
+
/**
|
|
4293
|
+
*
|
|
4294
|
+
* @type {string}
|
|
4295
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4296
|
+
*/
|
|
4297
|
+
'payment_method'?: string;
|
|
4298
|
+
/**
|
|
4299
|
+
*
|
|
4300
|
+
* @type {string}
|
|
4301
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4302
|
+
*/
|
|
4303
|
+
'payment_type': DataTypesCreatePaymentOrderRequestPaymentTypeEnum;
|
|
4304
|
+
/**
|
|
4305
|
+
*
|
|
4306
|
+
* @type {number}
|
|
4307
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4308
|
+
*/
|
|
4309
|
+
'plan_id'?: number;
|
|
4310
|
+
/**
|
|
4311
|
+
*
|
|
4312
|
+
* @type {string}
|
|
4313
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4314
|
+
*/
|
|
4315
|
+
'return_url'?: string;
|
|
4316
|
+
/**
|
|
4317
|
+
* Required for generic payments
|
|
4318
|
+
* @type {number}
|
|
4319
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4320
|
+
*/
|
|
4321
|
+
'subs_id'?: number;
|
|
4322
|
+
}
|
|
4323
|
+
export declare const DataTypesCreatePaymentOrderRequestPaymentTypeEnum: {
|
|
4324
|
+
readonly Generic: "generic";
|
|
4325
|
+
readonly Subscription: "subscription";
|
|
4326
|
+
readonly CreditTopup: "credit_topup";
|
|
4327
|
+
};
|
|
4328
|
+
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
4329
|
+
/**
|
|
4330
|
+
*
|
|
4331
|
+
* @export
|
|
4332
|
+
* @interface DataTypesCreatePaymentOrderResponse
|
|
4333
|
+
*/
|
|
4334
|
+
export interface DataTypesCreatePaymentOrderResponse {
|
|
4335
|
+
/**
|
|
4336
|
+
*
|
|
4337
|
+
* @type {number}
|
|
4338
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4339
|
+
*/
|
|
4340
|
+
'amount'?: number;
|
|
4341
|
+
/**
|
|
4342
|
+
*
|
|
4343
|
+
* @type {string}
|
|
4344
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4345
|
+
*/
|
|
4346
|
+
'created_at'?: string;
|
|
4347
|
+
/**
|
|
4348
|
+
*
|
|
4349
|
+
* @type {string}
|
|
4350
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4351
|
+
*/
|
|
4352
|
+
'currency'?: string;
|
|
4353
|
+
/**
|
|
4354
|
+
*
|
|
4355
|
+
* @type {string}
|
|
4356
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4357
|
+
*/
|
|
4358
|
+
'expires_at'?: string;
|
|
4359
|
+
/**
|
|
4360
|
+
*
|
|
4361
|
+
* @type {string}
|
|
4362
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4363
|
+
*/
|
|
4364
|
+
'gateway'?: string;
|
|
4365
|
+
/**
|
|
4366
|
+
*
|
|
4367
|
+
* @type {{ [key: string]: any; }}
|
|
4368
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4369
|
+
*/
|
|
4370
|
+
'gateway_response'?: {
|
|
4371
|
+
[key: string]: any;
|
|
4372
|
+
};
|
|
4373
|
+
/**
|
|
4374
|
+
*
|
|
4375
|
+
* @type {string}
|
|
4376
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4377
|
+
*/
|
|
4378
|
+
'order_id'?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
*
|
|
4381
|
+
* @type {string}
|
|
4382
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4383
|
+
*/
|
|
4384
|
+
'payment_id'?: string;
|
|
4385
|
+
/**
|
|
4386
|
+
*
|
|
4387
|
+
* @type {string}
|
|
4388
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4389
|
+
*/
|
|
4390
|
+
'payment_url'?: string;
|
|
4391
|
+
/**
|
|
4392
|
+
*
|
|
4393
|
+
* @type {string}
|
|
4394
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4395
|
+
*/
|
|
4396
|
+
'status'?: string;
|
|
4397
|
+
}
|
|
4230
4398
|
/**
|
|
4231
4399
|
*
|
|
4232
4400
|
* @export
|
|
@@ -5360,6 +5528,37 @@ export interface DataTypesCustomWordWithStatus {
|
|
|
5360
5528
|
*/
|
|
5361
5529
|
'word'?: string;
|
|
5362
5530
|
}
|
|
5531
|
+
/**
|
|
5532
|
+
*
|
|
5533
|
+
* @export
|
|
5534
|
+
* @interface DataTypesCustomerInfoDto
|
|
5535
|
+
*/
|
|
5536
|
+
export interface DataTypesCustomerInfoDto {
|
|
5537
|
+
/**
|
|
5538
|
+
*
|
|
5539
|
+
* @type {string}
|
|
5540
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5541
|
+
*/
|
|
5542
|
+
'address'?: string;
|
|
5543
|
+
/**
|
|
5544
|
+
*
|
|
5545
|
+
* @type {string}
|
|
5546
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5547
|
+
*/
|
|
5548
|
+
'email': string;
|
|
5549
|
+
/**
|
|
5550
|
+
*
|
|
5551
|
+
* @type {string}
|
|
5552
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5553
|
+
*/
|
|
5554
|
+
'name': string;
|
|
5555
|
+
/**
|
|
5556
|
+
*
|
|
5557
|
+
* @type {string}
|
|
5558
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5559
|
+
*/
|
|
5560
|
+
'phone': string;
|
|
5561
|
+
}
|
|
5363
5562
|
/**
|
|
5364
5563
|
*
|
|
5365
5564
|
* @export
|
|
@@ -5956,6 +6155,50 @@ export interface DataTypesFieldMetadata {
|
|
|
5956
6155
|
*/
|
|
5957
6156
|
'type'?: string;
|
|
5958
6157
|
}
|
|
6158
|
+
/**
|
|
6159
|
+
*
|
|
6160
|
+
* @export
|
|
6161
|
+
* @interface DataTypesGatewayInfo
|
|
6162
|
+
*/
|
|
6163
|
+
export interface DataTypesGatewayInfo {
|
|
6164
|
+
/**
|
|
6165
|
+
*
|
|
6166
|
+
* @type {Array<string>}
|
|
6167
|
+
* @memberof DataTypesGatewayInfo
|
|
6168
|
+
*/
|
|
6169
|
+
'features'?: Array<string>;
|
|
6170
|
+
/**
|
|
6171
|
+
*
|
|
6172
|
+
* @type {boolean}
|
|
6173
|
+
* @memberof DataTypesGatewayInfo
|
|
6174
|
+
*/
|
|
6175
|
+
'is_active'?: boolean;
|
|
6176
|
+
/**
|
|
6177
|
+
*
|
|
6178
|
+
* @type {boolean}
|
|
6179
|
+
* @memberof DataTypesGatewayInfo
|
|
6180
|
+
*/
|
|
6181
|
+
'is_default'?: boolean;
|
|
6182
|
+
/**
|
|
6183
|
+
*
|
|
6184
|
+
* @type {string}
|
|
6185
|
+
* @memberof DataTypesGatewayInfo
|
|
6186
|
+
*/
|
|
6187
|
+
'name'?: string;
|
|
6188
|
+
}
|
|
6189
|
+
/**
|
|
6190
|
+
*
|
|
6191
|
+
* @export
|
|
6192
|
+
* @interface DataTypesGatewayListResponse
|
|
6193
|
+
*/
|
|
6194
|
+
export interface DataTypesGatewayListResponse {
|
|
6195
|
+
/**
|
|
6196
|
+
*
|
|
6197
|
+
* @type {Array<DataTypesGatewayInfo>}
|
|
6198
|
+
* @memberof DataTypesGatewayListResponse
|
|
6199
|
+
*/
|
|
6200
|
+
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
6201
|
+
}
|
|
5959
6202
|
/**
|
|
5960
6203
|
*
|
|
5961
6204
|
* @export
|
|
@@ -8526,6 +8769,69 @@ export interface DataTypesPaymentResponse {
|
|
|
8526
8769
|
*/
|
|
8527
8770
|
'status'?: number;
|
|
8528
8771
|
}
|
|
8772
|
+
/**
|
|
8773
|
+
*
|
|
8774
|
+
* @export
|
|
8775
|
+
* @interface DataTypesPaymentStatusResponse
|
|
8776
|
+
*/
|
|
8777
|
+
export interface DataTypesPaymentStatusResponse {
|
|
8778
|
+
/**
|
|
8779
|
+
*
|
|
8780
|
+
* @type {number}
|
|
8781
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8782
|
+
*/
|
|
8783
|
+
'amount'?: number;
|
|
8784
|
+
/**
|
|
8785
|
+
*
|
|
8786
|
+
* @type {string}
|
|
8787
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8788
|
+
*/
|
|
8789
|
+
'currency'?: string;
|
|
8790
|
+
/**
|
|
8791
|
+
*
|
|
8792
|
+
* @type {string}
|
|
8793
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8794
|
+
*/
|
|
8795
|
+
'failure_reason'?: string;
|
|
8796
|
+
/**
|
|
8797
|
+
*
|
|
8798
|
+
* @type {string}
|
|
8799
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8800
|
+
*/
|
|
8801
|
+
'gateway'?: string;
|
|
8802
|
+
/**
|
|
8803
|
+
*
|
|
8804
|
+
* @type {{ [key: string]: any; }}
|
|
8805
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8806
|
+
*/
|
|
8807
|
+
'gateway_data'?: {
|
|
8808
|
+
[key: string]: any;
|
|
8809
|
+
};
|
|
8810
|
+
/**
|
|
8811
|
+
*
|
|
8812
|
+
* @type {string}
|
|
8813
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8814
|
+
*/
|
|
8815
|
+
'order_id'?: string;
|
|
8816
|
+
/**
|
|
8817
|
+
*
|
|
8818
|
+
* @type {string}
|
|
8819
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8820
|
+
*/
|
|
8821
|
+
'payment_id'?: string;
|
|
8822
|
+
/**
|
|
8823
|
+
*
|
|
8824
|
+
* @type {string}
|
|
8825
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8826
|
+
*/
|
|
8827
|
+
'status'?: string;
|
|
8828
|
+
/**
|
|
8829
|
+
*
|
|
8830
|
+
* @type {string}
|
|
8831
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8832
|
+
*/
|
|
8833
|
+
'updated_at'?: string;
|
|
8834
|
+
}
|
|
8529
8835
|
/**
|
|
8530
8836
|
*
|
|
8531
8837
|
* @export
|
|
@@ -9049,6 +9355,96 @@ export interface DataTypesPurchaseCreditsResponse {
|
|
|
9049
9355
|
*/
|
|
9050
9356
|
'updated_balance'?: DataTypesCreditBalance;
|
|
9051
9357
|
}
|
|
9358
|
+
/**
|
|
9359
|
+
*
|
|
9360
|
+
* @export
|
|
9361
|
+
* @interface DataTypesRefundRequestDto
|
|
9362
|
+
*/
|
|
9363
|
+
export interface DataTypesRefundRequestDto {
|
|
9364
|
+
/**
|
|
9365
|
+
*
|
|
9366
|
+
* @type {number}
|
|
9367
|
+
* @memberof DataTypesRefundRequestDto
|
|
9368
|
+
*/
|
|
9369
|
+
'amount': number;
|
|
9370
|
+
/**
|
|
9371
|
+
*
|
|
9372
|
+
* @type {string}
|
|
9373
|
+
* @memberof DataTypesRefundRequestDto
|
|
9374
|
+
*/
|
|
9375
|
+
'gateway': string;
|
|
9376
|
+
/**
|
|
9377
|
+
*
|
|
9378
|
+
* @type {{ [key: string]: any; }}
|
|
9379
|
+
* @memberof DataTypesRefundRequestDto
|
|
9380
|
+
*/
|
|
9381
|
+
'metadata'?: {
|
|
9382
|
+
[key: string]: any;
|
|
9383
|
+
};
|
|
9384
|
+
/**
|
|
9385
|
+
*
|
|
9386
|
+
* @type {string}
|
|
9387
|
+
* @memberof DataTypesRefundRequestDto
|
|
9388
|
+
*/
|
|
9389
|
+
'payment_id': string;
|
|
9390
|
+
/**
|
|
9391
|
+
*
|
|
9392
|
+
* @type {string}
|
|
9393
|
+
* @memberof DataTypesRefundRequestDto
|
|
9394
|
+
*/
|
|
9395
|
+
'reason': string;
|
|
9396
|
+
}
|
|
9397
|
+
/**
|
|
9398
|
+
*
|
|
9399
|
+
* @export
|
|
9400
|
+
* @interface DataTypesRefundResponseDto
|
|
9401
|
+
*/
|
|
9402
|
+
export interface DataTypesRefundResponseDto {
|
|
9403
|
+
/**
|
|
9404
|
+
*
|
|
9405
|
+
* @type {number}
|
|
9406
|
+
* @memberof DataTypesRefundResponseDto
|
|
9407
|
+
*/
|
|
9408
|
+
'amount'?: number;
|
|
9409
|
+
/**
|
|
9410
|
+
*
|
|
9411
|
+
* @type {string}
|
|
9412
|
+
* @memberof DataTypesRefundResponseDto
|
|
9413
|
+
*/
|
|
9414
|
+
'created_at'?: string;
|
|
9415
|
+
/**
|
|
9416
|
+
*
|
|
9417
|
+
* @type {string}
|
|
9418
|
+
* @memberof DataTypesRefundResponseDto
|
|
9419
|
+
*/
|
|
9420
|
+
'gateway'?: string;
|
|
9421
|
+
/**
|
|
9422
|
+
*
|
|
9423
|
+
* @type {{ [key: string]: any; }}
|
|
9424
|
+
* @memberof DataTypesRefundResponseDto
|
|
9425
|
+
*/
|
|
9426
|
+
'gateway_response'?: {
|
|
9427
|
+
[key: string]: any;
|
|
9428
|
+
};
|
|
9429
|
+
/**
|
|
9430
|
+
*
|
|
9431
|
+
* @type {string}
|
|
9432
|
+
* @memberof DataTypesRefundResponseDto
|
|
9433
|
+
*/
|
|
9434
|
+
'payment_id'?: string;
|
|
9435
|
+
/**
|
|
9436
|
+
*
|
|
9437
|
+
* @type {string}
|
|
9438
|
+
* @memberof DataTypesRefundResponseDto
|
|
9439
|
+
*/
|
|
9440
|
+
'refund_id'?: string;
|
|
9441
|
+
/**
|
|
9442
|
+
*
|
|
9443
|
+
* @type {string}
|
|
9444
|
+
* @memberof DataTypesRefundResponseDto
|
|
9445
|
+
*/
|
|
9446
|
+
'status'?: string;
|
|
9447
|
+
}
|
|
9052
9448
|
/**
|
|
9053
9449
|
*
|
|
9054
9450
|
* @export
|
|
@@ -11493,6 +11889,25 @@ export interface DataTypesVerifyOTPResponseWrapper {
|
|
|
11493
11889
|
*/
|
|
11494
11890
|
'status'?: number;
|
|
11495
11891
|
}
|
|
11892
|
+
/**
|
|
11893
|
+
*
|
|
11894
|
+
* @export
|
|
11895
|
+
* @interface DataTypesVerifyPaymentRequest
|
|
11896
|
+
*/
|
|
11897
|
+
export interface DataTypesVerifyPaymentRequest {
|
|
11898
|
+
/**
|
|
11899
|
+
*
|
|
11900
|
+
* @type {string}
|
|
11901
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11902
|
+
*/
|
|
11903
|
+
'gateway': string;
|
|
11904
|
+
/**
|
|
11905
|
+
*
|
|
11906
|
+
* @type {string}
|
|
11907
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11908
|
+
*/
|
|
11909
|
+
'payment_id': string;
|
|
11910
|
+
}
|
|
11496
11911
|
/**
|
|
11497
11912
|
*
|
|
11498
11913
|
* @export
|
|
@@ -12627,12 +13042,17 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12627
13042
|
*/
|
|
12628
13043
|
adminAnalyticsStoreXStoreIDQueriesGet: (xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12629
13044
|
/**
|
|
12630
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
13045
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
12631
13046
|
* @summary Get No-Clicks Queries
|
|
12632
13047
|
* @param {string} xStoreID Store ID
|
|
12633
13048
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12634
13049
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12635
13050
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13051
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13052
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13053
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13054
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13055
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12636
13056
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12637
13057
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12638
13058
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -12651,14 +13071,19 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12651
13071
|
* @param {*} [options] Override http request option.
|
|
12652
13072
|
* @throws {RequiredError}
|
|
12653
13073
|
*/
|
|
12654
|
-
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<RequestArgs>;
|
|
13074
|
+
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<RequestArgs>;
|
|
12655
13075
|
/**
|
|
12656
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
13076
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
12657
13077
|
* @summary Get No-Results Queries
|
|
12658
13078
|
* @param {string} xStoreID Store ID
|
|
12659
13079
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12660
13080
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12661
13081
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13082
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13083
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13084
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13085
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13086
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12662
13087
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12663
13088
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12664
13089
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -12677,7 +13102,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12677
13102
|
* @param {*} [options] Override http request option.
|
|
12678
13103
|
* @throws {RequiredError}
|
|
12679
13104
|
*/
|
|
12680
|
-
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<RequestArgs>;
|
|
13105
|
+
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<RequestArgs>;
|
|
12681
13106
|
/**
|
|
12682
13107
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
12683
13108
|
* @summary Get Query Insights
|
|
@@ -12690,12 +13115,25 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12690
13115
|
*/
|
|
12691
13116
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: (xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12692
13117
|
/**
|
|
12693
|
-
* 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.
|
|
13118
|
+
* 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.
|
|
12694
13119
|
* @summary Get Top Results Analytics
|
|
12695
13120
|
* @param {string} xStoreID Store ID
|
|
12696
13121
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12697
13122
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12698
13123
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13124
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13125
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13126
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13127
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13128
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13129
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13130
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13131
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13132
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13133
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13134
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13135
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13136
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
12699
13137
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
12700
13138
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
12701
13139
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -12709,7 +13147,7 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
12709
13147
|
* @param {*} [options] Override http request option.
|
|
12710
13148
|
* @throws {RequiredError}
|
|
12711
13149
|
*/
|
|
12712
|
-
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<RequestArgs>;
|
|
13150
|
+
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<RequestArgs>;
|
|
12713
13151
|
/**
|
|
12714
13152
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
12715
13153
|
* @summary Get Analytics Tags
|
|
@@ -12956,12 +13394,17 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12956
13394
|
*/
|
|
12957
13395
|
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>>;
|
|
12958
13396
|
/**
|
|
12959
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
13397
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
12960
13398
|
* @summary Get No-Clicks Queries
|
|
12961
13399
|
* @param {string} xStoreID Store ID
|
|
12962
13400
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12963
13401
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12964
13402
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13403
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13404
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13405
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13406
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13407
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12965
13408
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12966
13409
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12967
13410
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -12980,14 +13423,19 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
12980
13423
|
* @param {*} [options] Override http request option.
|
|
12981
13424
|
* @throws {RequiredError}
|
|
12982
13425
|
*/
|
|
12983
|
-
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>>;
|
|
13426
|
+
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>>;
|
|
12984
13427
|
/**
|
|
12985
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
13428
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
12986
13429
|
* @summary Get No-Results Queries
|
|
12987
13430
|
* @param {string} xStoreID Store ID
|
|
12988
13431
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
12989
13432
|
* @param {string} [endTime] End time in RFC3339 format
|
|
12990
13433
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13434
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13435
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13436
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13437
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13438
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
12991
13439
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
12992
13440
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
12993
13441
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13006,7 +13454,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13006
13454
|
* @param {*} [options] Override http request option.
|
|
13007
13455
|
* @throws {RequiredError}
|
|
13008
13456
|
*/
|
|
13009
|
-
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>>;
|
|
13457
|
+
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>>;
|
|
13010
13458
|
/**
|
|
13011
13459
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
13012
13460
|
* @summary Get Query Insights
|
|
@@ -13019,12 +13467,25 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13019
13467
|
*/
|
|
13020
13468
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>>;
|
|
13021
13469
|
/**
|
|
13022
|
-
* 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.
|
|
13470
|
+
* 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.
|
|
13023
13471
|
* @summary Get Top Results Analytics
|
|
13024
13472
|
* @param {string} xStoreID Store ID
|
|
13025
13473
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13026
13474
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13027
13475
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13476
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13477
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13478
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13479
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13480
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13481
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13482
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13483
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13484
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13485
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13486
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13487
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13488
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13028
13489
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
13029
13490
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13030
13491
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -13038,7 +13499,7 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
|
|
|
13038
13499
|
* @param {*} [options] Override http request option.
|
|
13039
13500
|
* @throws {RequiredError}
|
|
13040
13501
|
*/
|
|
13041
|
-
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>>;
|
|
13502
|
+
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>>;
|
|
13042
13503
|
/**
|
|
13043
13504
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
13044
13505
|
* @summary Get Analytics Tags
|
|
@@ -13285,12 +13746,17 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13285
13746
|
*/
|
|
13286
13747
|
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesGet200Response>;
|
|
13287
13748
|
/**
|
|
13288
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
13749
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13289
13750
|
* @summary Get No-Clicks Queries
|
|
13290
13751
|
* @param {string} xStoreID Store ID
|
|
13291
13752
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13292
13753
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13293
13754
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13755
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13756
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13757
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13758
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13759
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13294
13760
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13295
13761
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13296
13762
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13309,14 +13775,19 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13309
13775
|
* @param {*} [options] Override http request option.
|
|
13310
13776
|
* @throws {RequiredError}
|
|
13311
13777
|
*/
|
|
13312
|
-
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>;
|
|
13778
|
+
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>;
|
|
13313
13779
|
/**
|
|
13314
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
13780
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
13315
13781
|
* @summary Get No-Results Queries
|
|
13316
13782
|
* @param {string} xStoreID Store ID
|
|
13317
13783
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13318
13784
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13319
13785
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
13786
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13787
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13788
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13789
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13790
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13320
13791
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13321
13792
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13322
13793
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13335,7 +13806,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13335
13806
|
* @param {*} [options] Override http request option.
|
|
13336
13807
|
* @throws {RequiredError}
|
|
13337
13808
|
*/
|
|
13338
|
-
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>;
|
|
13809
|
+
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>;
|
|
13339
13810
|
/**
|
|
13340
13811
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
13341
13812
|
* @summary Get Query Insights
|
|
@@ -13348,12 +13819,25 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13348
13819
|
*/
|
|
13349
13820
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>;
|
|
13350
13821
|
/**
|
|
13351
|
-
* 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.
|
|
13822
|
+
* 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.
|
|
13352
13823
|
* @summary Get Top Results Analytics
|
|
13353
13824
|
* @param {string} xStoreID Store ID
|
|
13354
13825
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13355
13826
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13356
13827
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
13828
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
13829
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
13830
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
13831
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
13832
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13833
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13834
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13835
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
13836
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
13837
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
13838
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
13839
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
13840
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13357
13841
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
13358
13842
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13359
13843
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -13367,7 +13851,7 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
|
|
|
13367
13851
|
* @param {*} [options] Override http request option.
|
|
13368
13852
|
* @throws {RequiredError}
|
|
13369
13853
|
*/
|
|
13370
|
-
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>;
|
|
13854
|
+
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>;
|
|
13371
13855
|
/**
|
|
13372
13856
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
13373
13857
|
* @summary Get Analytics Tags
|
|
@@ -13627,12 +14111,17 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13627
14111
|
*/
|
|
13628
14112
|
adminAnalyticsStoreXStoreIDQueriesGet(xStoreID: string, startTime?: string, endTime?: string, granularity?: AdminAnalyticsStoreXStoreIDQueriesGetGranularityEnum, search?: string, analyticsTags?: string, tagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetTagsMatchModeEnum, tagsExclude?: string, tagKeyFilter?: string, tagValueFilter?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, limit?: number, offset?: number, page?: number, pageSize?: number, orderBy?: string, sortBy?: AdminAnalyticsStoreXStoreIDQueriesGetSortByEnum, sortOrder?: AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum, sort?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesGet200Response, any>>;
|
|
13629
14113
|
/**
|
|
13630
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
14114
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13631
14115
|
* @summary Get No-Clicks Queries
|
|
13632
14116
|
* @param {string} xStoreID Store ID
|
|
13633
14117
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13634
14118
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13635
14119
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14120
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14121
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14122
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14123
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14124
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13636
14125
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13637
14126
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13638
14127
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13652,14 +14141,19 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13652
14141
|
* @throws {RequiredError}
|
|
13653
14142
|
* @memberof AnalyticsApi
|
|
13654
14143
|
*/
|
|
13655
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
14144
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
13656
14145
|
/**
|
|
13657
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
14146
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
13658
14147
|
* @summary Get No-Results Queries
|
|
13659
14148
|
* @param {string} xStoreID Store ID
|
|
13660
14149
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13661
14150
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13662
14151
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14152
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14153
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14154
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14155
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14156
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13663
14157
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13664
14158
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13665
14159
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13679,7 +14173,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13679
14173
|
* @throws {RequiredError}
|
|
13680
14174
|
* @memberof AnalyticsApi
|
|
13681
14175
|
*/
|
|
13682
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
14176
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesNoClicksGet200Response, any>>;
|
|
13683
14177
|
/**
|
|
13684
14178
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
13685
14179
|
* @summary Get Query Insights
|
|
@@ -13693,12 +14187,25 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13693
14187
|
*/
|
|
13694
14188
|
adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response, any>>;
|
|
13695
14189
|
/**
|
|
13696
|
-
* 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.
|
|
14190
|
+
* 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.
|
|
13697
14191
|
* @summary Get Top Results Analytics
|
|
13698
14192
|
* @param {string} xStoreID Store ID
|
|
13699
14193
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13700
14194
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13701
14195
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
14196
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14197
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14198
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14199
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14200
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14201
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14202
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14203
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14204
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14205
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14206
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14207
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14208
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
13702
14209
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
13703
14210
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
13704
14211
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -13713,7 +14220,7 @@ export declare class AnalyticsApi extends BaseAPI {
|
|
|
13713
14220
|
* @throws {RequiredError}
|
|
13714
14221
|
* @memberof AnalyticsApi
|
|
13715
14222
|
*/
|
|
13716
|
-
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any>>;
|
|
14223
|
+
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<import("axios").AxiosResponse<AdminAnalyticsStoreXStoreIDItemsPerformanceGet200Response, any>>;
|
|
13717
14224
|
/**
|
|
13718
14225
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
13719
14226
|
* @summary Get Analytics Tags
|
|
@@ -13978,6 +14485,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum: {
|
|
|
13978
14485
|
readonly Desc: "desc";
|
|
13979
14486
|
};
|
|
13980
14487
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
14488
|
+
/**
|
|
14489
|
+
* @export
|
|
14490
|
+
*/
|
|
14491
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum: {
|
|
14492
|
+
readonly Any: "any";
|
|
14493
|
+
readonly All: "all";
|
|
14494
|
+
};
|
|
14495
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum];
|
|
13981
14496
|
/**
|
|
13982
14497
|
* @export
|
|
13983
14498
|
*/
|
|
@@ -14003,6 +14518,14 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum:
|
|
|
14003
14518
|
readonly Desc: "desc";
|
|
14004
14519
|
};
|
|
14005
14520
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
14521
|
+
/**
|
|
14522
|
+
* @export
|
|
14523
|
+
*/
|
|
14524
|
+
export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum: {
|
|
14525
|
+
readonly Any: "any";
|
|
14526
|
+
readonly All: "all";
|
|
14527
|
+
};
|
|
14528
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum];
|
|
14006
14529
|
/**
|
|
14007
14530
|
* @export
|
|
14008
14531
|
*/
|
|
@@ -14028,6 +14551,22 @@ export declare const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum
|
|
|
14028
14551
|
readonly Desc: "desc";
|
|
14029
14552
|
};
|
|
14030
14553
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
14554
|
+
/**
|
|
14555
|
+
* @export
|
|
14556
|
+
*/
|
|
14557
|
+
export declare const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum: {
|
|
14558
|
+
readonly Any: "any";
|
|
14559
|
+
readonly All: "all";
|
|
14560
|
+
};
|
|
14561
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum];
|
|
14562
|
+
/**
|
|
14563
|
+
* @export
|
|
14564
|
+
*/
|
|
14565
|
+
export declare const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum: {
|
|
14566
|
+
readonly Any: "any";
|
|
14567
|
+
readonly All: "all";
|
|
14568
|
+
};
|
|
14569
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum];
|
|
14031
14570
|
/**
|
|
14032
14571
|
* @export
|
|
14033
14572
|
*/
|
|
@@ -18345,6 +18884,189 @@ export declare class ParentMenusApi extends BaseAPI {
|
|
|
18345
18884
|
*/
|
|
18346
18885
|
miscParentMenusPost(parentMenu: DataTypesParentMenu, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
|
|
18347
18886
|
}
|
|
18887
|
+
/**
|
|
18888
|
+
* PaymentGatewayApi - axios parameter creator
|
|
18889
|
+
* @export
|
|
18890
|
+
*/
|
|
18891
|
+
export declare const PaymentGatewayApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18892
|
+
/**
|
|
18893
|
+
* Creates a payment order using specified or default payment gateway
|
|
18894
|
+
* @summary Create a new payment order
|
|
18895
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18896
|
+
* @param {*} [options] Override http request option.
|
|
18897
|
+
* @throws {RequiredError}
|
|
18898
|
+
*/
|
|
18899
|
+
paymentGatewayCreateOrderPost: (order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18900
|
+
/**
|
|
18901
|
+
* Returns list of all active credit plans for purchase
|
|
18902
|
+
* @summary Get available credit plans
|
|
18903
|
+
* @param {*} [options] Override http request option.
|
|
18904
|
+
* @throws {RequiredError}
|
|
18905
|
+
*/
|
|
18906
|
+
paymentGatewayCreditPlansGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18907
|
+
/**
|
|
18908
|
+
* Returns list of all available payment gateways
|
|
18909
|
+
* @summary Get available payment gateways
|
|
18910
|
+
* @param {*} [options] Override http request option.
|
|
18911
|
+
* @throws {RequiredError}
|
|
18912
|
+
*/
|
|
18913
|
+
paymentGatewayGatewaysGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18914
|
+
/**
|
|
18915
|
+
* Processes a refund for a completed payment
|
|
18916
|
+
* @summary Process payment refund
|
|
18917
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
18918
|
+
* @param {*} [options] Override http request option.
|
|
18919
|
+
* @throws {RequiredError}
|
|
18920
|
+
*/
|
|
18921
|
+
paymentGatewayRefundPost: (refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18922
|
+
/**
|
|
18923
|
+
* Verifies the current status of a payment
|
|
18924
|
+
* @summary Verify payment status
|
|
18925
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
18926
|
+
* @param {*} [options] Override http request option.
|
|
18927
|
+
* @throws {RequiredError}
|
|
18928
|
+
*/
|
|
18929
|
+
paymentGatewayVerifyPost: (verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18930
|
+
};
|
|
18931
|
+
/**
|
|
18932
|
+
* PaymentGatewayApi - functional programming interface
|
|
18933
|
+
* @export
|
|
18934
|
+
*/
|
|
18935
|
+
export declare const PaymentGatewayApiFp: (configuration?: Configuration) => {
|
|
18936
|
+
/**
|
|
18937
|
+
* Creates a payment order using specified or default payment gateway
|
|
18938
|
+
* @summary Create a new payment order
|
|
18939
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18940
|
+
* @param {*} [options] Override http request option.
|
|
18941
|
+
* @throws {RequiredError}
|
|
18942
|
+
*/
|
|
18943
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>>;
|
|
18944
|
+
/**
|
|
18945
|
+
* Returns list of all active credit plans for purchase
|
|
18946
|
+
* @summary Get available credit plans
|
|
18947
|
+
* @param {*} [options] Override http request option.
|
|
18948
|
+
* @throws {RequiredError}
|
|
18949
|
+
*/
|
|
18950
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCreditPlan>>>;
|
|
18951
|
+
/**
|
|
18952
|
+
* Returns list of all available payment gateways
|
|
18953
|
+
* @summary Get available payment gateways
|
|
18954
|
+
* @param {*} [options] Override http request option.
|
|
18955
|
+
* @throws {RequiredError}
|
|
18956
|
+
*/
|
|
18957
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGatewayListResponse>>;
|
|
18958
|
+
/**
|
|
18959
|
+
* Processes a refund for a completed payment
|
|
18960
|
+
* @summary Process payment refund
|
|
18961
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
18962
|
+
* @param {*} [options] Override http request option.
|
|
18963
|
+
* @throws {RequiredError}
|
|
18964
|
+
*/
|
|
18965
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundResponseDto>>;
|
|
18966
|
+
/**
|
|
18967
|
+
* Verifies the current status of a payment
|
|
18968
|
+
* @summary Verify payment status
|
|
18969
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
18970
|
+
* @param {*} [options] Override http request option.
|
|
18971
|
+
* @throws {RequiredError}
|
|
18972
|
+
*/
|
|
18973
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusResponse>>;
|
|
18974
|
+
};
|
|
18975
|
+
/**
|
|
18976
|
+
* PaymentGatewayApi - factory interface
|
|
18977
|
+
* @export
|
|
18978
|
+
*/
|
|
18979
|
+
export declare const PaymentGatewayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18980
|
+
/**
|
|
18981
|
+
* Creates a payment order using specified or default payment gateway
|
|
18982
|
+
* @summary Create a new payment order
|
|
18983
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
18984
|
+
* @param {*} [options] Override http request option.
|
|
18985
|
+
* @throws {RequiredError}
|
|
18986
|
+
*/
|
|
18987
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse>;
|
|
18988
|
+
/**
|
|
18989
|
+
* Returns list of all active credit plans for purchase
|
|
18990
|
+
* @summary Get available credit plans
|
|
18991
|
+
* @param {*} [options] Override http request option.
|
|
18992
|
+
* @throws {RequiredError}
|
|
18993
|
+
*/
|
|
18994
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCreditPlan>>;
|
|
18995
|
+
/**
|
|
18996
|
+
* Returns list of all available payment gateways
|
|
18997
|
+
* @summary Get available payment gateways
|
|
18998
|
+
* @param {*} [options] Override http request option.
|
|
18999
|
+
* @throws {RequiredError}
|
|
19000
|
+
*/
|
|
19001
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGatewayListResponse>;
|
|
19002
|
+
/**
|
|
19003
|
+
* Processes a refund for a completed payment
|
|
19004
|
+
* @summary Process payment refund
|
|
19005
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
19006
|
+
* @param {*} [options] Override http request option.
|
|
19007
|
+
* @throws {RequiredError}
|
|
19008
|
+
*/
|
|
19009
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundResponseDto>;
|
|
19010
|
+
/**
|
|
19011
|
+
* Verifies the current status of a payment
|
|
19012
|
+
* @summary Verify payment status
|
|
19013
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
19014
|
+
* @param {*} [options] Override http request option.
|
|
19015
|
+
* @throws {RequiredError}
|
|
19016
|
+
*/
|
|
19017
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusResponse>;
|
|
19018
|
+
};
|
|
19019
|
+
/**
|
|
19020
|
+
* PaymentGatewayApi - object-oriented interface
|
|
19021
|
+
* @export
|
|
19022
|
+
* @class PaymentGatewayApi
|
|
19023
|
+
* @extends {BaseAPI}
|
|
19024
|
+
*/
|
|
19025
|
+
export declare class PaymentGatewayApi extends BaseAPI {
|
|
19026
|
+
/**
|
|
19027
|
+
* Creates a payment order using specified or default payment gateway
|
|
19028
|
+
* @summary Create a new payment order
|
|
19029
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
19030
|
+
* @param {*} [options] Override http request option.
|
|
19031
|
+
* @throws {RequiredError}
|
|
19032
|
+
* @memberof PaymentGatewayApi
|
|
19033
|
+
*/
|
|
19034
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreatePaymentOrderResponse, any>>;
|
|
19035
|
+
/**
|
|
19036
|
+
* Returns list of all active credit plans for purchase
|
|
19037
|
+
* @summary Get available credit plans
|
|
19038
|
+
* @param {*} [options] Override http request option.
|
|
19039
|
+
* @throws {RequiredError}
|
|
19040
|
+
* @memberof PaymentGatewayApi
|
|
19041
|
+
*/
|
|
19042
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesCreditPlan[], any>>;
|
|
19043
|
+
/**
|
|
19044
|
+
* Returns list of all available payment gateways
|
|
19045
|
+
* @summary Get available payment gateways
|
|
19046
|
+
* @param {*} [options] Override http request option.
|
|
19047
|
+
* @throws {RequiredError}
|
|
19048
|
+
* @memberof PaymentGatewayApi
|
|
19049
|
+
*/
|
|
19050
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesGatewayListResponse, any>>;
|
|
19051
|
+
/**
|
|
19052
|
+
* Processes a refund for a completed payment
|
|
19053
|
+
* @summary Process payment refund
|
|
19054
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
19055
|
+
* @param {*} [options] Override http request option.
|
|
19056
|
+
* @throws {RequiredError}
|
|
19057
|
+
* @memberof PaymentGatewayApi
|
|
19058
|
+
*/
|
|
19059
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesRefundResponseDto, any>>;
|
|
19060
|
+
/**
|
|
19061
|
+
* Verifies the current status of a payment
|
|
19062
|
+
* @summary Verify payment status
|
|
19063
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
19064
|
+
* @param {*} [options] Override http request option.
|
|
19065
|
+
* @throws {RequiredError}
|
|
19066
|
+
* @memberof PaymentGatewayApi
|
|
19067
|
+
*/
|
|
19068
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesPaymentStatusResponse, any>>;
|
|
19069
|
+
}
|
|
18348
19070
|
/**
|
|
18349
19071
|
* PaymentsApi - axios parameter creator
|
|
18350
19072
|
* @export
|