@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/api.ts
CHANGED
|
@@ -4216,6 +4216,173 @@ export interface DataTypesCreateOrganizationRequest {
|
|
|
4216
4216
|
*/
|
|
4217
4217
|
'ZipCode'?: string;
|
|
4218
4218
|
}
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
* @export
|
|
4222
|
+
* @interface DataTypesCreatePaymentOrderRequest
|
|
4223
|
+
*/
|
|
4224
|
+
export interface DataTypesCreatePaymentOrderRequest {
|
|
4225
|
+
/**
|
|
4226
|
+
* Optional for subscription/credit (uses plan price)
|
|
4227
|
+
* @type {number}
|
|
4228
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4229
|
+
*/
|
|
4230
|
+
'amount'?: number;
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {boolean}
|
|
4234
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4235
|
+
*/
|
|
4236
|
+
'auto_renewal'?: boolean;
|
|
4237
|
+
/**
|
|
4238
|
+
* Fields for credit top-up
|
|
4239
|
+
* @type {number}
|
|
4240
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4241
|
+
*/
|
|
4242
|
+
'credit_plan_id'?: number;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4247
|
+
*/
|
|
4248
|
+
'currency': string;
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @type {DataTypesCustomerInfoDto}
|
|
4252
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4253
|
+
*/
|
|
4254
|
+
'customer_info': DataTypesCustomerInfoDto;
|
|
4255
|
+
/**
|
|
4256
|
+
* Optional, auto-generated if not provided
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4259
|
+
*/
|
|
4260
|
+
'description'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* Optional, uses default if not specified
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4265
|
+
*/
|
|
4266
|
+
'gateway'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
*
|
|
4269
|
+
* @type {{ [key: string]: any; }}
|
|
4270
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4271
|
+
*/
|
|
4272
|
+
'metadata'?: { [key: string]: any; };
|
|
4273
|
+
/**
|
|
4274
|
+
* Fields for subscription payments
|
|
4275
|
+
* @type {number}
|
|
4276
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4277
|
+
*/
|
|
4278
|
+
'org_id'?: number;
|
|
4279
|
+
/**
|
|
4280
|
+
*
|
|
4281
|
+
* @type {string}
|
|
4282
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4283
|
+
*/
|
|
4284
|
+
'payment_method'?: string;
|
|
4285
|
+
/**
|
|
4286
|
+
*
|
|
4287
|
+
* @type {string}
|
|
4288
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4289
|
+
*/
|
|
4290
|
+
'payment_type': DataTypesCreatePaymentOrderRequestPaymentTypeEnum;
|
|
4291
|
+
/**
|
|
4292
|
+
*
|
|
4293
|
+
* @type {number}
|
|
4294
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4295
|
+
*/
|
|
4296
|
+
'plan_id'?: number;
|
|
4297
|
+
/**
|
|
4298
|
+
*
|
|
4299
|
+
* @type {string}
|
|
4300
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4301
|
+
*/
|
|
4302
|
+
'return_url'?: string;
|
|
4303
|
+
/**
|
|
4304
|
+
* Required for generic payments
|
|
4305
|
+
* @type {number}
|
|
4306
|
+
* @memberof DataTypesCreatePaymentOrderRequest
|
|
4307
|
+
*/
|
|
4308
|
+
'subs_id'?: number;
|
|
4309
|
+
}
|
|
4310
|
+
|
|
4311
|
+
export const DataTypesCreatePaymentOrderRequestPaymentTypeEnum = {
|
|
4312
|
+
Generic: 'generic',
|
|
4313
|
+
Subscription: 'subscription',
|
|
4314
|
+
CreditTopup: 'credit_topup'
|
|
4315
|
+
} as const;
|
|
4316
|
+
|
|
4317
|
+
export type DataTypesCreatePaymentOrderRequestPaymentTypeEnum = typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum[keyof typeof DataTypesCreatePaymentOrderRequestPaymentTypeEnum];
|
|
4318
|
+
|
|
4319
|
+
/**
|
|
4320
|
+
*
|
|
4321
|
+
* @export
|
|
4322
|
+
* @interface DataTypesCreatePaymentOrderResponse
|
|
4323
|
+
*/
|
|
4324
|
+
export interface DataTypesCreatePaymentOrderResponse {
|
|
4325
|
+
/**
|
|
4326
|
+
*
|
|
4327
|
+
* @type {number}
|
|
4328
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4329
|
+
*/
|
|
4330
|
+
'amount'?: number;
|
|
4331
|
+
/**
|
|
4332
|
+
*
|
|
4333
|
+
* @type {string}
|
|
4334
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4335
|
+
*/
|
|
4336
|
+
'created_at'?: string;
|
|
4337
|
+
/**
|
|
4338
|
+
*
|
|
4339
|
+
* @type {string}
|
|
4340
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4341
|
+
*/
|
|
4342
|
+
'currency'?: string;
|
|
4343
|
+
/**
|
|
4344
|
+
*
|
|
4345
|
+
* @type {string}
|
|
4346
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4347
|
+
*/
|
|
4348
|
+
'expires_at'?: string;
|
|
4349
|
+
/**
|
|
4350
|
+
*
|
|
4351
|
+
* @type {string}
|
|
4352
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4353
|
+
*/
|
|
4354
|
+
'gateway'?: string;
|
|
4355
|
+
/**
|
|
4356
|
+
*
|
|
4357
|
+
* @type {{ [key: string]: any; }}
|
|
4358
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4359
|
+
*/
|
|
4360
|
+
'gateway_response'?: { [key: string]: any; };
|
|
4361
|
+
/**
|
|
4362
|
+
*
|
|
4363
|
+
* @type {string}
|
|
4364
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4365
|
+
*/
|
|
4366
|
+
'order_id'?: string;
|
|
4367
|
+
/**
|
|
4368
|
+
*
|
|
4369
|
+
* @type {string}
|
|
4370
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4371
|
+
*/
|
|
4372
|
+
'payment_id'?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
*
|
|
4375
|
+
* @type {string}
|
|
4376
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4377
|
+
*/
|
|
4378
|
+
'payment_url'?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
*
|
|
4381
|
+
* @type {string}
|
|
4382
|
+
* @memberof DataTypesCreatePaymentOrderResponse
|
|
4383
|
+
*/
|
|
4384
|
+
'status'?: string;
|
|
4385
|
+
}
|
|
4219
4386
|
/**
|
|
4220
4387
|
*
|
|
4221
4388
|
* @export
|
|
@@ -5352,6 +5519,37 @@ export interface DataTypesCustomWordWithStatus {
|
|
|
5352
5519
|
*/
|
|
5353
5520
|
'word'?: string;
|
|
5354
5521
|
}
|
|
5522
|
+
/**
|
|
5523
|
+
*
|
|
5524
|
+
* @export
|
|
5525
|
+
* @interface DataTypesCustomerInfoDto
|
|
5526
|
+
*/
|
|
5527
|
+
export interface DataTypesCustomerInfoDto {
|
|
5528
|
+
/**
|
|
5529
|
+
*
|
|
5530
|
+
* @type {string}
|
|
5531
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5532
|
+
*/
|
|
5533
|
+
'address'?: string;
|
|
5534
|
+
/**
|
|
5535
|
+
*
|
|
5536
|
+
* @type {string}
|
|
5537
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5538
|
+
*/
|
|
5539
|
+
'email': string;
|
|
5540
|
+
/**
|
|
5541
|
+
*
|
|
5542
|
+
* @type {string}
|
|
5543
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5544
|
+
*/
|
|
5545
|
+
'name': string;
|
|
5546
|
+
/**
|
|
5547
|
+
*
|
|
5548
|
+
* @type {string}
|
|
5549
|
+
* @memberof DataTypesCustomerInfoDto
|
|
5550
|
+
*/
|
|
5551
|
+
'phone': string;
|
|
5552
|
+
}
|
|
5355
5553
|
/**
|
|
5356
5554
|
*
|
|
5357
5555
|
* @export
|
|
@@ -5942,6 +6140,50 @@ export interface DataTypesFieldMetadata {
|
|
|
5942
6140
|
*/
|
|
5943
6141
|
'type'?: string;
|
|
5944
6142
|
}
|
|
6143
|
+
/**
|
|
6144
|
+
*
|
|
6145
|
+
* @export
|
|
6146
|
+
* @interface DataTypesGatewayInfo
|
|
6147
|
+
*/
|
|
6148
|
+
export interface DataTypesGatewayInfo {
|
|
6149
|
+
/**
|
|
6150
|
+
*
|
|
6151
|
+
* @type {Array<string>}
|
|
6152
|
+
* @memberof DataTypesGatewayInfo
|
|
6153
|
+
*/
|
|
6154
|
+
'features'?: Array<string>;
|
|
6155
|
+
/**
|
|
6156
|
+
*
|
|
6157
|
+
* @type {boolean}
|
|
6158
|
+
* @memberof DataTypesGatewayInfo
|
|
6159
|
+
*/
|
|
6160
|
+
'is_active'?: boolean;
|
|
6161
|
+
/**
|
|
6162
|
+
*
|
|
6163
|
+
* @type {boolean}
|
|
6164
|
+
* @memberof DataTypesGatewayInfo
|
|
6165
|
+
*/
|
|
6166
|
+
'is_default'?: boolean;
|
|
6167
|
+
/**
|
|
6168
|
+
*
|
|
6169
|
+
* @type {string}
|
|
6170
|
+
* @memberof DataTypesGatewayInfo
|
|
6171
|
+
*/
|
|
6172
|
+
'name'?: string;
|
|
6173
|
+
}
|
|
6174
|
+
/**
|
|
6175
|
+
*
|
|
6176
|
+
* @export
|
|
6177
|
+
* @interface DataTypesGatewayListResponse
|
|
6178
|
+
*/
|
|
6179
|
+
export interface DataTypesGatewayListResponse {
|
|
6180
|
+
/**
|
|
6181
|
+
*
|
|
6182
|
+
* @type {Array<DataTypesGatewayInfo>}
|
|
6183
|
+
* @memberof DataTypesGatewayListResponse
|
|
6184
|
+
*/
|
|
6185
|
+
'gateways'?: Array<DataTypesGatewayInfo>;
|
|
6186
|
+
}
|
|
5945
6187
|
/**
|
|
5946
6188
|
*
|
|
5947
6189
|
* @export
|
|
@@ -8502,6 +8744,67 @@ export interface DataTypesPaymentResponse {
|
|
|
8502
8744
|
*/
|
|
8503
8745
|
'status'?: number;
|
|
8504
8746
|
}
|
|
8747
|
+
/**
|
|
8748
|
+
*
|
|
8749
|
+
* @export
|
|
8750
|
+
* @interface DataTypesPaymentStatusResponse
|
|
8751
|
+
*/
|
|
8752
|
+
export interface DataTypesPaymentStatusResponse {
|
|
8753
|
+
/**
|
|
8754
|
+
*
|
|
8755
|
+
* @type {number}
|
|
8756
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8757
|
+
*/
|
|
8758
|
+
'amount'?: number;
|
|
8759
|
+
/**
|
|
8760
|
+
*
|
|
8761
|
+
* @type {string}
|
|
8762
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8763
|
+
*/
|
|
8764
|
+
'currency'?: string;
|
|
8765
|
+
/**
|
|
8766
|
+
*
|
|
8767
|
+
* @type {string}
|
|
8768
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8769
|
+
*/
|
|
8770
|
+
'failure_reason'?: string;
|
|
8771
|
+
/**
|
|
8772
|
+
*
|
|
8773
|
+
* @type {string}
|
|
8774
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8775
|
+
*/
|
|
8776
|
+
'gateway'?: string;
|
|
8777
|
+
/**
|
|
8778
|
+
*
|
|
8779
|
+
* @type {{ [key: string]: any; }}
|
|
8780
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8781
|
+
*/
|
|
8782
|
+
'gateway_data'?: { [key: string]: any; };
|
|
8783
|
+
/**
|
|
8784
|
+
*
|
|
8785
|
+
* @type {string}
|
|
8786
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8787
|
+
*/
|
|
8788
|
+
'order_id'?: string;
|
|
8789
|
+
/**
|
|
8790
|
+
*
|
|
8791
|
+
* @type {string}
|
|
8792
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8793
|
+
*/
|
|
8794
|
+
'payment_id'?: string;
|
|
8795
|
+
/**
|
|
8796
|
+
*
|
|
8797
|
+
* @type {string}
|
|
8798
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8799
|
+
*/
|
|
8800
|
+
'status'?: string;
|
|
8801
|
+
/**
|
|
8802
|
+
*
|
|
8803
|
+
* @type {string}
|
|
8804
|
+
* @memberof DataTypesPaymentStatusResponse
|
|
8805
|
+
*/
|
|
8806
|
+
'updated_at'?: string;
|
|
8807
|
+
}
|
|
8505
8808
|
/**
|
|
8506
8809
|
*
|
|
8507
8810
|
* @export
|
|
@@ -9028,64 +9331,150 @@ export interface DataTypesPurchaseCreditsResponse {
|
|
|
9028
9331
|
/**
|
|
9029
9332
|
*
|
|
9030
9333
|
* @export
|
|
9031
|
-
* @interface
|
|
9334
|
+
* @interface DataTypesRefundRequestDto
|
|
9032
9335
|
*/
|
|
9033
|
-
export interface
|
|
9336
|
+
export interface DataTypesRefundRequestDto {
|
|
9337
|
+
/**
|
|
9338
|
+
*
|
|
9339
|
+
* @type {number}
|
|
9340
|
+
* @memberof DataTypesRefundRequestDto
|
|
9341
|
+
*/
|
|
9342
|
+
'amount': number;
|
|
9034
9343
|
/**
|
|
9035
9344
|
*
|
|
9036
9345
|
* @type {string}
|
|
9037
|
-
* @memberof
|
|
9346
|
+
* @memberof DataTypesRefundRequestDto
|
|
9038
9347
|
*/
|
|
9039
|
-
'
|
|
9348
|
+
'gateway': string;
|
|
9349
|
+
/**
|
|
9350
|
+
*
|
|
9351
|
+
* @type {{ [key: string]: any; }}
|
|
9352
|
+
* @memberof DataTypesRefundRequestDto
|
|
9353
|
+
*/
|
|
9354
|
+
'metadata'?: { [key: string]: any; };
|
|
9040
9355
|
/**
|
|
9041
9356
|
*
|
|
9042
9357
|
* @type {string}
|
|
9043
|
-
* @memberof
|
|
9358
|
+
* @memberof DataTypesRefundRequestDto
|
|
9044
9359
|
*/
|
|
9045
|
-
'
|
|
9046
|
-
}
|
|
9047
|
-
/**
|
|
9048
|
-
*
|
|
9049
|
-
* @export
|
|
9050
|
-
* @interface DataTypesRemoveWordsFromCustomListRequest
|
|
9051
|
-
*/
|
|
9052
|
-
export interface DataTypesRemoveWordsFromCustomListRequest {
|
|
9360
|
+
'payment_id': string;
|
|
9053
9361
|
/**
|
|
9054
9362
|
*
|
|
9055
|
-
* @type {
|
|
9056
|
-
* @memberof
|
|
9363
|
+
* @type {string}
|
|
9364
|
+
* @memberof DataTypesRefundRequestDto
|
|
9057
9365
|
*/
|
|
9058
|
-
'
|
|
9366
|
+
'reason': string;
|
|
9059
9367
|
}
|
|
9060
9368
|
/**
|
|
9061
9369
|
*
|
|
9062
9370
|
* @export
|
|
9063
|
-
* @interface
|
|
9371
|
+
* @interface DataTypesRefundResponseDto
|
|
9064
9372
|
*/
|
|
9065
|
-
export interface
|
|
9373
|
+
export interface DataTypesRefundResponseDto {
|
|
9066
9374
|
/**
|
|
9067
9375
|
*
|
|
9068
|
-
* @type {
|
|
9069
|
-
* @memberof
|
|
9376
|
+
* @type {number}
|
|
9377
|
+
* @memberof DataTypesRefundResponseDto
|
|
9070
9378
|
*/
|
|
9071
|
-
'
|
|
9072
|
-
}
|
|
9073
|
-
/**
|
|
9074
|
-
*
|
|
9075
|
-
* @export
|
|
9076
|
-
* @interface DataTypesResponse
|
|
9077
|
-
*/
|
|
9078
|
-
export interface DataTypesResponse {
|
|
9379
|
+
'amount'?: number;
|
|
9079
9380
|
/**
|
|
9080
9381
|
*
|
|
9081
9382
|
* @type {string}
|
|
9082
|
-
* @memberof
|
|
9383
|
+
* @memberof DataTypesRefundResponseDto
|
|
9083
9384
|
*/
|
|
9084
|
-
'
|
|
9385
|
+
'created_at'?: string;
|
|
9085
9386
|
/**
|
|
9086
9387
|
*
|
|
9087
9388
|
* @type {string}
|
|
9088
|
-
* @memberof
|
|
9389
|
+
* @memberof DataTypesRefundResponseDto
|
|
9390
|
+
*/
|
|
9391
|
+
'gateway'?: string;
|
|
9392
|
+
/**
|
|
9393
|
+
*
|
|
9394
|
+
* @type {{ [key: string]: any; }}
|
|
9395
|
+
* @memberof DataTypesRefundResponseDto
|
|
9396
|
+
*/
|
|
9397
|
+
'gateway_response'?: { [key: string]: any; };
|
|
9398
|
+
/**
|
|
9399
|
+
*
|
|
9400
|
+
* @type {string}
|
|
9401
|
+
* @memberof DataTypesRefundResponseDto
|
|
9402
|
+
*/
|
|
9403
|
+
'payment_id'?: string;
|
|
9404
|
+
/**
|
|
9405
|
+
*
|
|
9406
|
+
* @type {string}
|
|
9407
|
+
* @memberof DataTypesRefundResponseDto
|
|
9408
|
+
*/
|
|
9409
|
+
'refund_id'?: string;
|
|
9410
|
+
/**
|
|
9411
|
+
*
|
|
9412
|
+
* @type {string}
|
|
9413
|
+
* @memberof DataTypesRefundResponseDto
|
|
9414
|
+
*/
|
|
9415
|
+
'status'?: string;
|
|
9416
|
+
}
|
|
9417
|
+
/**
|
|
9418
|
+
*
|
|
9419
|
+
* @export
|
|
9420
|
+
* @interface DataTypesRegenerateXStoreSecretResponse
|
|
9421
|
+
*/
|
|
9422
|
+
export interface DataTypesRegenerateXStoreSecretResponse {
|
|
9423
|
+
/**
|
|
9424
|
+
*
|
|
9425
|
+
* @type {string}
|
|
9426
|
+
* @memberof DataTypesRegenerateXStoreSecretResponse
|
|
9427
|
+
*/
|
|
9428
|
+
'new_xstore_secret'?: string;
|
|
9429
|
+
/**
|
|
9430
|
+
*
|
|
9431
|
+
* @type {string}
|
|
9432
|
+
* @memberof DataTypesRegenerateXStoreSecretResponse
|
|
9433
|
+
*/
|
|
9434
|
+
'old_xstore_secret'?: string;
|
|
9435
|
+
}
|
|
9436
|
+
/**
|
|
9437
|
+
*
|
|
9438
|
+
* @export
|
|
9439
|
+
* @interface DataTypesRemoveWordsFromCustomListRequest
|
|
9440
|
+
*/
|
|
9441
|
+
export interface DataTypesRemoveWordsFromCustomListRequest {
|
|
9442
|
+
/**
|
|
9443
|
+
*
|
|
9444
|
+
* @type {Array<number>}
|
|
9445
|
+
* @memberof DataTypesRemoveWordsFromCustomListRequest
|
|
9446
|
+
*/
|
|
9447
|
+
'custom_word_ids': Array<number>;
|
|
9448
|
+
}
|
|
9449
|
+
/**
|
|
9450
|
+
*
|
|
9451
|
+
* @export
|
|
9452
|
+
* @interface DataTypesRemoveWordsFromLanguageListRequest
|
|
9453
|
+
*/
|
|
9454
|
+
export interface DataTypesRemoveWordsFromLanguageListRequest {
|
|
9455
|
+
/**
|
|
9456
|
+
*
|
|
9457
|
+
* @type {Array<string>}
|
|
9458
|
+
* @memberof DataTypesRemoveWordsFromLanguageListRequest
|
|
9459
|
+
*/
|
|
9460
|
+
'words': Array<string>;
|
|
9461
|
+
}
|
|
9462
|
+
/**
|
|
9463
|
+
*
|
|
9464
|
+
* @export
|
|
9465
|
+
* @interface DataTypesResponse
|
|
9466
|
+
*/
|
|
9467
|
+
export interface DataTypesResponse {
|
|
9468
|
+
/**
|
|
9469
|
+
*
|
|
9470
|
+
* @type {string}
|
|
9471
|
+
* @memberof DataTypesResponse
|
|
9472
|
+
*/
|
|
9473
|
+
'data'?: string;
|
|
9474
|
+
/**
|
|
9475
|
+
*
|
|
9476
|
+
* @type {string}
|
|
9477
|
+
* @memberof DataTypesResponse
|
|
9089
9478
|
*/
|
|
9090
9479
|
'message'?: string;
|
|
9091
9480
|
/**
|
|
@@ -11475,6 +11864,25 @@ export interface DataTypesVerifyOTPResponseWrapper {
|
|
|
11475
11864
|
*/
|
|
11476
11865
|
'status'?: number;
|
|
11477
11866
|
}
|
|
11867
|
+
/**
|
|
11868
|
+
*
|
|
11869
|
+
* @export
|
|
11870
|
+
* @interface DataTypesVerifyPaymentRequest
|
|
11871
|
+
*/
|
|
11872
|
+
export interface DataTypesVerifyPaymentRequest {
|
|
11873
|
+
/**
|
|
11874
|
+
*
|
|
11875
|
+
* @type {string}
|
|
11876
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11877
|
+
*/
|
|
11878
|
+
'gateway': string;
|
|
11879
|
+
/**
|
|
11880
|
+
*
|
|
11881
|
+
* @type {string}
|
|
11882
|
+
* @memberof DataTypesVerifyPaymentRequest
|
|
11883
|
+
*/
|
|
11884
|
+
'payment_id': string;
|
|
11885
|
+
}
|
|
11478
11886
|
/**
|
|
11479
11887
|
*
|
|
11480
11888
|
* @export
|
|
@@ -13881,12 +14289,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13881
14289
|
};
|
|
13882
14290
|
},
|
|
13883
14291
|
/**
|
|
13884
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
14292
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
13885
14293
|
* @summary Get No-Clicks Queries
|
|
13886
14294
|
* @param {string} xStoreID Store ID
|
|
13887
14295
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
13888
14296
|
* @param {string} [endTime] End time in RFC3339 format
|
|
13889
14297
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14298
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14299
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14300
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14301
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14302
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
13890
14303
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
13891
14304
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
13892
14305
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -13905,7 +14318,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13905
14318
|
* @param {*} [options] Override http request option.
|
|
13906
14319
|
* @throws {RequiredError}
|
|
13907
14320
|
*/
|
|
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> => {
|
|
14321
|
+
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
14322
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
13910
14323
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoClicksGet', 'xStoreID', xStoreID)
|
|
13911
14324
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-clicks`
|
|
@@ -13936,6 +14349,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
13936
14349
|
localVarQueryParameter['search'] = search;
|
|
13937
14350
|
}
|
|
13938
14351
|
|
|
14352
|
+
if (analyticsTags !== undefined) {
|
|
14353
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14354
|
+
}
|
|
14355
|
+
|
|
14356
|
+
if (tagsMatchMode !== undefined) {
|
|
14357
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14358
|
+
}
|
|
14359
|
+
|
|
14360
|
+
if (tagsExclude !== undefined) {
|
|
14361
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14362
|
+
}
|
|
14363
|
+
|
|
14364
|
+
if (tagKeyFilter !== undefined) {
|
|
14365
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14366
|
+
}
|
|
14367
|
+
|
|
14368
|
+
if (tagValueFilter !== undefined) {
|
|
14369
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14370
|
+
}
|
|
14371
|
+
|
|
13939
14372
|
if (compareMode !== undefined) {
|
|
13940
14373
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
13941
14374
|
}
|
|
@@ -14008,12 +14441,17 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14008
14441
|
};
|
|
14009
14442
|
},
|
|
14010
14443
|
/**
|
|
14011
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
14444
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14012
14445
|
* @summary Get No-Results Queries
|
|
14013
14446
|
* @param {string} xStoreID Store ID
|
|
14014
14447
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14015
14448
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14016
14449
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
14450
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14451
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14452
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14453
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14454
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14017
14455
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14018
14456
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14019
14457
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14032,7 +14470,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14032
14470
|
* @param {*} [options] Override http request option.
|
|
14033
14471
|
* @throws {RequiredError}
|
|
14034
14472
|
*/
|
|
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> => {
|
|
14473
|
+
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
14474
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14037
14475
|
assertParamExists('adminAnalyticsStoreXStoreIDQueriesNoResultsGet', 'xStoreID', xStoreID)
|
|
14038
14476
|
const localVarPath = `/admin/analytics/store/{xStoreID}/queries/no-results`
|
|
@@ -14063,6 +14501,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14063
14501
|
localVarQueryParameter['search'] = search;
|
|
14064
14502
|
}
|
|
14065
14503
|
|
|
14504
|
+
if (analyticsTags !== undefined) {
|
|
14505
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14506
|
+
}
|
|
14507
|
+
|
|
14508
|
+
if (tagsMatchMode !== undefined) {
|
|
14509
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14510
|
+
}
|
|
14511
|
+
|
|
14512
|
+
if (tagsExclude !== undefined) {
|
|
14513
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14514
|
+
}
|
|
14515
|
+
|
|
14516
|
+
if (tagKeyFilter !== undefined) {
|
|
14517
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14518
|
+
}
|
|
14519
|
+
|
|
14520
|
+
if (tagValueFilter !== undefined) {
|
|
14521
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14522
|
+
}
|
|
14523
|
+
|
|
14066
14524
|
if (compareMode !== undefined) {
|
|
14067
14525
|
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14068
14526
|
}
|
|
@@ -14186,12 +14644,25 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14186
14644
|
};
|
|
14187
14645
|
},
|
|
14188
14646
|
/**
|
|
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.
|
|
14647
|
+
* 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
14648
|
* @summary Get Top Results Analytics
|
|
14191
14649
|
* @param {string} xStoreID Store ID
|
|
14192
14650
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14193
14651
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14194
14652
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
14653
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
14654
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
14655
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
14656
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
14657
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14658
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14659
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14660
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
14661
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
14662
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
14663
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
14664
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
14665
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14195
14666
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14196
14667
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14197
14668
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -14205,7 +14676,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14205
14676
|
* @param {*} [options] Override http request option.
|
|
14206
14677
|
* @throws {RequiredError}
|
|
14207
14678
|
*/
|
|
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> => {
|
|
14679
|
+
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
14680
|
// verify required parameter 'xStoreID' is not null or undefined
|
|
14210
14681
|
assertParamExists('adminAnalyticsStoreXStoreIDResultsGet', 'xStoreID', xStoreID)
|
|
14211
14682
|
const localVarPath = `/admin/analytics/store/{xStoreID}/results`
|
|
@@ -14236,6 +14707,58 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
14236
14707
|
localVarQueryParameter['item_ids'] = itemIds;
|
|
14237
14708
|
}
|
|
14238
14709
|
|
|
14710
|
+
if (analyticsTags !== undefined) {
|
|
14711
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
14712
|
+
}
|
|
14713
|
+
|
|
14714
|
+
if (tagsMatchMode !== undefined) {
|
|
14715
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
14716
|
+
}
|
|
14717
|
+
|
|
14718
|
+
if (tagsExclude !== undefined) {
|
|
14719
|
+
localVarQueryParameter['tags_exclude'] = tagsExclude;
|
|
14720
|
+
}
|
|
14721
|
+
|
|
14722
|
+
if (tagKeyFilter !== undefined) {
|
|
14723
|
+
localVarQueryParameter['tag_key_filter'] = tagKeyFilter;
|
|
14724
|
+
}
|
|
14725
|
+
|
|
14726
|
+
if (tagValueFilter !== undefined) {
|
|
14727
|
+
localVarQueryParameter['tag_value_filter'] = tagValueFilter;
|
|
14728
|
+
}
|
|
14729
|
+
|
|
14730
|
+
if (compareMode !== undefined) {
|
|
14731
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
14732
|
+
}
|
|
14733
|
+
|
|
14734
|
+
if (compareStartTime !== undefined) {
|
|
14735
|
+
localVarQueryParameter['compare_start_time'] = compareStartTime;
|
|
14736
|
+
}
|
|
14737
|
+
|
|
14738
|
+
if (compareEndTime !== undefined) {
|
|
14739
|
+
localVarQueryParameter['compare_end_time'] = compareEndTime;
|
|
14740
|
+
}
|
|
14741
|
+
|
|
14742
|
+
if (compareAnalyticsTags !== undefined) {
|
|
14743
|
+
localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
|
|
14744
|
+
}
|
|
14745
|
+
|
|
14746
|
+
if (compareTagsMatchMode !== undefined) {
|
|
14747
|
+
localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
|
|
14748
|
+
}
|
|
14749
|
+
|
|
14750
|
+
if (compareTagsExclude !== undefined) {
|
|
14751
|
+
localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
|
|
14752
|
+
}
|
|
14753
|
+
|
|
14754
|
+
if (compareTagKeyFilter !== undefined) {
|
|
14755
|
+
localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
|
|
14756
|
+
}
|
|
14757
|
+
|
|
14758
|
+
if (compareTagValueFilter !== undefined) {
|
|
14759
|
+
localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
|
|
14760
|
+
}
|
|
14761
|
+
|
|
14239
14762
|
if (minImpressions !== undefined) {
|
|
14240
14763
|
localVarQueryParameter['min_impressions'] = minImpressions;
|
|
14241
14764
|
}
|
|
@@ -14732,12 +15255,17 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14732
15255
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14733
15256
|
},
|
|
14734
15257
|
/**
|
|
14735
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
15258
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
14736
15259
|
* @summary Get No-Clicks Queries
|
|
14737
15260
|
* @param {string} xStoreID Store ID
|
|
14738
15261
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14739
15262
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14740
15263
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15264
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15265
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15266
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15267
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15268
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14741
15269
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14742
15270
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14743
15271
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14756,19 +15284,24 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14756
15284
|
* @param {*} [options] Override http request option.
|
|
14757
15285
|
* @throws {RequiredError}
|
|
14758
15286
|
*/
|
|
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);
|
|
15287
|
+
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>> {
|
|
15288
|
+
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
15289
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14762
15290
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoClicksGet']?.[localVarOperationServerIndex]?.url;
|
|
14763
15291
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14764
15292
|
},
|
|
14765
15293
|
/**
|
|
14766
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
15294
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
14767
15295
|
* @summary Get No-Results Queries
|
|
14768
15296
|
* @param {string} xStoreID Store ID
|
|
14769
15297
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14770
15298
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14771
15299
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15300
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15301
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15302
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15303
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15304
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
14772
15305
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
14773
15306
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
14774
15307
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -14787,8 +15320,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14787
15320
|
* @param {*} [options] Override http request option.
|
|
14788
15321
|
* @throws {RequiredError}
|
|
14789
15322
|
*/
|
|
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);
|
|
15323
|
+
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>> {
|
|
15324
|
+
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
15325
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14793
15326
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesNoResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14794
15327
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -14810,12 +15343,25 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14810
15343
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14811
15344
|
},
|
|
14812
15345
|
/**
|
|
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.
|
|
15346
|
+
* 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
15347
|
* @summary Get Top Results Analytics
|
|
14815
15348
|
* @param {string} xStoreID Store ID
|
|
14816
15349
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
14817
15350
|
* @param {string} [endTime] End time in RFC3339 format
|
|
14818
15351
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15352
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15353
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15354
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15355
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15356
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15357
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15358
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15359
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15360
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15361
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15362
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15363
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15364
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
14819
15365
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
14820
15366
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
14821
15367
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -14829,8 +15375,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
14829
15375
|
* @param {*} [options] Override http request option.
|
|
14830
15376
|
* @throws {RequiredError}
|
|
14831
15377
|
*/
|
|
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);
|
|
15378
|
+
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>> {
|
|
15379
|
+
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
15380
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14835
15381
|
const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDResultsGet']?.[localVarOperationServerIndex]?.url;
|
|
14836
15382
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15117,12 +15663,17 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15117
15663
|
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
15664
|
},
|
|
15119
15665
|
/**
|
|
15120
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
15666
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
15121
15667
|
* @summary Get No-Clicks Queries
|
|
15122
15668
|
* @param {string} xStoreID Store ID
|
|
15123
15669
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15124
15670
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15125
15671
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15672
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15673
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15674
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15675
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15676
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15126
15677
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15127
15678
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15128
15679
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15141,16 +15692,21 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15141
15692
|
* @param {*} [options] Override http request option.
|
|
15142
15693
|
* @throws {RequiredError}
|
|
15143
15694
|
*/
|
|
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));
|
|
15695
|
+
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> {
|
|
15696
|
+
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
15697
|
},
|
|
15147
15698
|
/**
|
|
15148
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
15699
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
15149
15700
|
* @summary Get No-Results Queries
|
|
15150
15701
|
* @param {string} xStoreID Store ID
|
|
15151
15702
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15152
15703
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15153
15704
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
15705
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15706
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15707
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15708
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15709
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15154
15710
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15155
15711
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15156
15712
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15169,8 +15725,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15169
15725
|
* @param {*} [options] Override http request option.
|
|
15170
15726
|
* @throws {RequiredError}
|
|
15171
15727
|
*/
|
|
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));
|
|
15728
|
+
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> {
|
|
15729
|
+
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
15730
|
},
|
|
15175
15731
|
/**
|
|
15176
15732
|
* Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
|
|
@@ -15186,12 +15742,25 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15186
15742
|
return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
|
|
15187
15743
|
},
|
|
15188
15744
|
/**
|
|
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.
|
|
15745
|
+
* 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
15746
|
* @summary Get Top Results Analytics
|
|
15191
15747
|
* @param {string} xStoreID Store ID
|
|
15192
15748
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15193
15749
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15194
15750
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15751
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
15752
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
15753
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
15754
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
15755
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15756
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15757
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15758
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
15759
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
15760
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
15761
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
15762
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
15763
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
15195
15764
|
* @param {number} [minImpressions] Minimum number of impressions required
|
|
15196
15765
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
15197
15766
|
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
@@ -15205,8 +15774,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
|
|
|
15205
15774
|
* @param {*} [options] Override http request option.
|
|
15206
15775
|
* @throws {RequiredError}
|
|
15207
15776
|
*/
|
|
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));
|
|
15777
|
+
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> {
|
|
15778
|
+
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
15779
|
},
|
|
15211
15780
|
/**
|
|
15212
15781
|
* Retrieve analytics tags usage data and filtering capabilities
|
|
@@ -15506,12 +16075,17 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15506
16075
|
}
|
|
15507
16076
|
|
|
15508
16077
|
/**
|
|
15509
|
-
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with comparison mode support
|
|
16078
|
+
* Retrieve queries that received searches but no user clicks, indicating poor result relevance with analytics tags filtering and comparison mode support
|
|
15510
16079
|
* @summary Get No-Clicks Queries
|
|
15511
16080
|
* @param {string} xStoreID Store ID
|
|
15512
16081
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15513
16082
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15514
16083
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16084
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16085
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16086
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16087
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16088
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15515
16089
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15516
16090
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15517
16091
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15531,17 +16105,22 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15531
16105
|
* @throws {RequiredError}
|
|
15532
16106
|
* @memberof AnalyticsApi
|
|
15533
16107
|
*/
|
|
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));
|
|
16108
|
+
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) {
|
|
16109
|
+
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
16110
|
}
|
|
15537
16111
|
|
|
15538
16112
|
/**
|
|
15539
|
-
* Retrieve queries that returned no search results, useful for identifying content gaps with comparison mode support
|
|
16113
|
+
* Retrieve queries that returned no search results, useful for identifying content gaps with analytics tags filtering and comparison mode support
|
|
15540
16114
|
* @summary Get No-Results Queries
|
|
15541
16115
|
* @param {string} xStoreID Store ID
|
|
15542
16116
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15543
16117
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15544
16118
|
* @param {string} [search] Search term to filter queries (case-insensitive partial match)
|
|
16119
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16120
|
+
* @param {AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16121
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16122
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16123
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
15545
16124
|
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
15546
16125
|
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
15547
16126
|
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
@@ -15561,8 +16140,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15561
16140
|
* @throws {RequiredError}
|
|
15562
16141
|
* @memberof AnalyticsApi
|
|
15563
16142
|
*/
|
|
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));
|
|
16143
|
+
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) {
|
|
16144
|
+
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
16145
|
}
|
|
15567
16146
|
|
|
15568
16147
|
/**
|
|
@@ -15581,18 +16160,31 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15581
16160
|
}
|
|
15582
16161
|
|
|
15583
16162
|
/**
|
|
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.
|
|
16163
|
+
* 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
16164
|
* @summary Get Top Results Analytics
|
|
15586
16165
|
* @param {string} xStoreID Store ID
|
|
15587
16166
|
* @param {string} [startTime] Start time in RFC3339 format
|
|
15588
16167
|
* @param {string} [endTime] End time in RFC3339 format
|
|
15589
16168
|
* @param {string} [itemIds] Comma-separated list of item IDs to filter
|
|
15590
|
-
* @param {
|
|
15591
|
-
* @param {
|
|
15592
|
-
* @param {
|
|
15593
|
-
* @param {string} [
|
|
15594
|
-
* @param {
|
|
15595
|
-
* @param {boolean} [
|
|
16169
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter (e.g., \'campaign:summer,source:email\')
|
|
16170
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
16171
|
+
* @param {string} [tagsExclude] Comma-separated analytics tags to exclude
|
|
16172
|
+
* @param {string} [tagKeyFilter] Filter by tag key pattern (matches tags starting with key:)
|
|
16173
|
+
* @param {string} [tagValueFilter] Filter by tag value pattern (matches tags ending with :value)
|
|
16174
|
+
* @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
|
|
16175
|
+
* @param {string} [compareStartTime] Comparison period start time in RFC3339 format
|
|
16176
|
+
* @param {string} [compareEndTime] Comparison period end time in RFC3339 format
|
|
16177
|
+
* @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
|
|
16178
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
|
|
16179
|
+
* @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
|
|
16180
|
+
* @param {string} [compareTagKeyFilter] Tag key filter for comparison period
|
|
16181
|
+
* @param {string} [compareTagValueFilter] Tag value filter for comparison period
|
|
16182
|
+
* @param {number} [minImpressions] Minimum number of impressions required
|
|
16183
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortByEnum} [sortBy] Field to sort by
|
|
16184
|
+
* @param {AdminAnalyticsStoreXStoreIDResultsGetSortOrderEnum} [sortOrder] Sort direction
|
|
16185
|
+
* @param {string} [sort] Combined sort parameter in format \'field:direction\'
|
|
16186
|
+
* @param {boolean} [includeDocuments] Whether to include full document data from search index
|
|
16187
|
+
* @param {boolean} [includeWidget] Whether to include widget display fields for UI presentation
|
|
15596
16188
|
* @param {number} [limit] Maximum number of results (legacy - use page_size instead)
|
|
15597
16189
|
* @param {number} [offset] Offset for pagination (legacy - use page instead)
|
|
15598
16190
|
* @param {number} [page] Page number for pagination
|
|
@@ -15601,8 +16193,8 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
15601
16193
|
* @throws {RequiredError}
|
|
15602
16194
|
* @memberof AnalyticsApi
|
|
15603
16195
|
*/
|
|
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));
|
|
16196
|
+
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) {
|
|
16197
|
+
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
16198
|
}
|
|
15607
16199
|
|
|
15608
16200
|
/**
|
|
@@ -15875,6 +16467,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = {
|
|
|
15875
16467
|
Desc: 'desc'
|
|
15876
16468
|
} as const;
|
|
15877
16469
|
export type AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesGetSortOrderEnum];
|
|
16470
|
+
/**
|
|
16471
|
+
* @export
|
|
16472
|
+
*/
|
|
16473
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = {
|
|
16474
|
+
Any: 'any',
|
|
16475
|
+
All: 'all'
|
|
16476
|
+
} as const;
|
|
16477
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetTagsMatchModeEnum];
|
|
15878
16478
|
/**
|
|
15879
16479
|
* @export
|
|
15880
16480
|
*/
|
|
@@ -15900,6 +16500,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = {
|
|
|
15900
16500
|
Desc: 'desc'
|
|
15901
16501
|
} as const;
|
|
15902
16502
|
export type AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoClicksGetSortOrderEnum];
|
|
16503
|
+
/**
|
|
16504
|
+
* @export
|
|
16505
|
+
*/
|
|
16506
|
+
export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = {
|
|
16507
|
+
Any: 'any',
|
|
16508
|
+
All: 'all'
|
|
16509
|
+
} as const;
|
|
16510
|
+
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetTagsMatchModeEnum];
|
|
15903
16511
|
/**
|
|
15904
16512
|
* @export
|
|
15905
16513
|
*/
|
|
@@ -15925,6 +16533,22 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
|
|
|
15925
16533
|
Desc: 'desc'
|
|
15926
16534
|
} as const;
|
|
15927
16535
|
export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
|
|
16536
|
+
/**
|
|
16537
|
+
* @export
|
|
16538
|
+
*/
|
|
16539
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = {
|
|
16540
|
+
Any: 'any',
|
|
16541
|
+
All: 'all'
|
|
16542
|
+
} as const;
|
|
16543
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetTagsMatchModeEnum];
|
|
16544
|
+
/**
|
|
16545
|
+
* @export
|
|
16546
|
+
*/
|
|
16547
|
+
export const AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = {
|
|
16548
|
+
Any: 'any',
|
|
16549
|
+
All: 'all'
|
|
16550
|
+
} as const;
|
|
16551
|
+
export type AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDResultsGetCompareTagsMatchModeEnum];
|
|
15928
16552
|
/**
|
|
15929
16553
|
* @export
|
|
15930
16554
|
*/
|
|
@@ -24798,6 +25422,397 @@ export class ParentMenusApi extends BaseAPI {
|
|
|
24798
25422
|
|
|
24799
25423
|
|
|
24800
25424
|
|
|
25425
|
+
/**
|
|
25426
|
+
* PaymentGatewayApi - axios parameter creator
|
|
25427
|
+
* @export
|
|
25428
|
+
*/
|
|
25429
|
+
export const PaymentGatewayApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
25430
|
+
return {
|
|
25431
|
+
/**
|
|
25432
|
+
* Creates a payment order using specified or default payment gateway
|
|
25433
|
+
* @summary Create a new payment order
|
|
25434
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25435
|
+
* @param {*} [options] Override http request option.
|
|
25436
|
+
* @throws {RequiredError}
|
|
25437
|
+
*/
|
|
25438
|
+
paymentGatewayCreateOrderPost: async (order: DataTypesCreatePaymentOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25439
|
+
// verify required parameter 'order' is not null or undefined
|
|
25440
|
+
assertParamExists('paymentGatewayCreateOrderPost', 'order', order)
|
|
25441
|
+
const localVarPath = `/payment-gateway/create-order`;
|
|
25442
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25443
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25444
|
+
let baseOptions;
|
|
25445
|
+
if (configuration) {
|
|
25446
|
+
baseOptions = configuration.baseOptions;
|
|
25447
|
+
}
|
|
25448
|
+
|
|
25449
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25450
|
+
const localVarHeaderParameter = {} as any;
|
|
25451
|
+
const localVarQueryParameter = {} as any;
|
|
25452
|
+
|
|
25453
|
+
// authentication BearerAuth required
|
|
25454
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25455
|
+
|
|
25456
|
+
|
|
25457
|
+
|
|
25458
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25459
|
+
|
|
25460
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25461
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25462
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25463
|
+
localVarRequestOptions.data = serializeDataIfNeeded(order, localVarRequestOptions, configuration)
|
|
25464
|
+
|
|
25465
|
+
return {
|
|
25466
|
+
url: toPathString(localVarUrlObj),
|
|
25467
|
+
options: localVarRequestOptions,
|
|
25468
|
+
};
|
|
25469
|
+
},
|
|
25470
|
+
/**
|
|
25471
|
+
* Returns list of all active credit plans for purchase
|
|
25472
|
+
* @summary Get available credit plans
|
|
25473
|
+
* @param {*} [options] Override http request option.
|
|
25474
|
+
* @throws {RequiredError}
|
|
25475
|
+
*/
|
|
25476
|
+
paymentGatewayCreditPlansGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25477
|
+
const localVarPath = `/payment-gateway/credit-plans`;
|
|
25478
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25479
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25480
|
+
let baseOptions;
|
|
25481
|
+
if (configuration) {
|
|
25482
|
+
baseOptions = configuration.baseOptions;
|
|
25483
|
+
}
|
|
25484
|
+
|
|
25485
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25486
|
+
const localVarHeaderParameter = {} as any;
|
|
25487
|
+
const localVarQueryParameter = {} as any;
|
|
25488
|
+
|
|
25489
|
+
// authentication BearerAuth required
|
|
25490
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25491
|
+
|
|
25492
|
+
|
|
25493
|
+
|
|
25494
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25495
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25496
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25497
|
+
|
|
25498
|
+
return {
|
|
25499
|
+
url: toPathString(localVarUrlObj),
|
|
25500
|
+
options: localVarRequestOptions,
|
|
25501
|
+
};
|
|
25502
|
+
},
|
|
25503
|
+
/**
|
|
25504
|
+
* Returns list of all available payment gateways
|
|
25505
|
+
* @summary Get available payment gateways
|
|
25506
|
+
* @param {*} [options] Override http request option.
|
|
25507
|
+
* @throws {RequiredError}
|
|
25508
|
+
*/
|
|
25509
|
+
paymentGatewayGatewaysGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25510
|
+
const localVarPath = `/payment-gateway/gateways`;
|
|
25511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25513
|
+
let baseOptions;
|
|
25514
|
+
if (configuration) {
|
|
25515
|
+
baseOptions = configuration.baseOptions;
|
|
25516
|
+
}
|
|
25517
|
+
|
|
25518
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25519
|
+
const localVarHeaderParameter = {} as any;
|
|
25520
|
+
const localVarQueryParameter = {} as any;
|
|
25521
|
+
|
|
25522
|
+
// authentication BearerAuth required
|
|
25523
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25524
|
+
|
|
25525
|
+
|
|
25526
|
+
|
|
25527
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25528
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25529
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25530
|
+
|
|
25531
|
+
return {
|
|
25532
|
+
url: toPathString(localVarUrlObj),
|
|
25533
|
+
options: localVarRequestOptions,
|
|
25534
|
+
};
|
|
25535
|
+
},
|
|
25536
|
+
/**
|
|
25537
|
+
* Processes a refund for a completed payment
|
|
25538
|
+
* @summary Process payment refund
|
|
25539
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25540
|
+
* @param {*} [options] Override http request option.
|
|
25541
|
+
* @throws {RequiredError}
|
|
25542
|
+
*/
|
|
25543
|
+
paymentGatewayRefundPost: async (refund: DataTypesRefundRequestDto, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25544
|
+
// verify required parameter 'refund' is not null or undefined
|
|
25545
|
+
assertParamExists('paymentGatewayRefundPost', 'refund', refund)
|
|
25546
|
+
const localVarPath = `/payment-gateway/refund`;
|
|
25547
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25548
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25549
|
+
let baseOptions;
|
|
25550
|
+
if (configuration) {
|
|
25551
|
+
baseOptions = configuration.baseOptions;
|
|
25552
|
+
}
|
|
25553
|
+
|
|
25554
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25555
|
+
const localVarHeaderParameter = {} as any;
|
|
25556
|
+
const localVarQueryParameter = {} as any;
|
|
25557
|
+
|
|
25558
|
+
// authentication BearerAuth required
|
|
25559
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25560
|
+
|
|
25561
|
+
|
|
25562
|
+
|
|
25563
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25564
|
+
|
|
25565
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25566
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25567
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25568
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refund, localVarRequestOptions, configuration)
|
|
25569
|
+
|
|
25570
|
+
return {
|
|
25571
|
+
url: toPathString(localVarUrlObj),
|
|
25572
|
+
options: localVarRequestOptions,
|
|
25573
|
+
};
|
|
25574
|
+
},
|
|
25575
|
+
/**
|
|
25576
|
+
* Verifies the current status of a payment
|
|
25577
|
+
* @summary Verify payment status
|
|
25578
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25579
|
+
* @param {*} [options] Override http request option.
|
|
25580
|
+
* @throws {RequiredError}
|
|
25581
|
+
*/
|
|
25582
|
+
paymentGatewayVerifyPost: async (verify: DataTypesVerifyPaymentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25583
|
+
// verify required parameter 'verify' is not null or undefined
|
|
25584
|
+
assertParamExists('paymentGatewayVerifyPost', 'verify', verify)
|
|
25585
|
+
const localVarPath = `/payment-gateway/verify`;
|
|
25586
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25587
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25588
|
+
let baseOptions;
|
|
25589
|
+
if (configuration) {
|
|
25590
|
+
baseOptions = configuration.baseOptions;
|
|
25591
|
+
}
|
|
25592
|
+
|
|
25593
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
25594
|
+
const localVarHeaderParameter = {} as any;
|
|
25595
|
+
const localVarQueryParameter = {} as any;
|
|
25596
|
+
|
|
25597
|
+
// authentication BearerAuth required
|
|
25598
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
25599
|
+
|
|
25600
|
+
|
|
25601
|
+
|
|
25602
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25603
|
+
|
|
25604
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25605
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25606
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25607
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verify, localVarRequestOptions, configuration)
|
|
25608
|
+
|
|
25609
|
+
return {
|
|
25610
|
+
url: toPathString(localVarUrlObj),
|
|
25611
|
+
options: localVarRequestOptions,
|
|
25612
|
+
};
|
|
25613
|
+
},
|
|
25614
|
+
}
|
|
25615
|
+
};
|
|
25616
|
+
|
|
25617
|
+
/**
|
|
25618
|
+
* PaymentGatewayApi - functional programming interface
|
|
25619
|
+
* @export
|
|
25620
|
+
*/
|
|
25621
|
+
export const PaymentGatewayApiFp = function(configuration?: Configuration) {
|
|
25622
|
+
const localVarAxiosParamCreator = PaymentGatewayApiAxiosParamCreator(configuration)
|
|
25623
|
+
return {
|
|
25624
|
+
/**
|
|
25625
|
+
* Creates a payment order using specified or default payment gateway
|
|
25626
|
+
* @summary Create a new payment order
|
|
25627
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25628
|
+
* @param {*} [options] Override http request option.
|
|
25629
|
+
* @throws {RequiredError}
|
|
25630
|
+
*/
|
|
25631
|
+
async paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesCreatePaymentOrderResponse>> {
|
|
25632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreateOrderPost(order, options);
|
|
25633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25634
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreateOrderPost']?.[localVarOperationServerIndex]?.url;
|
|
25635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25636
|
+
},
|
|
25637
|
+
/**
|
|
25638
|
+
* Returns list of all active credit plans for purchase
|
|
25639
|
+
* @summary Get available credit plans
|
|
25640
|
+
* @param {*} [options] Override http request option.
|
|
25641
|
+
* @throws {RequiredError}
|
|
25642
|
+
*/
|
|
25643
|
+
async paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DataTypesCreditPlan>>> {
|
|
25644
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayCreditPlansGet(options);
|
|
25645
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25646
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayCreditPlansGet']?.[localVarOperationServerIndex]?.url;
|
|
25647
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25648
|
+
},
|
|
25649
|
+
/**
|
|
25650
|
+
* Returns list of all available payment gateways
|
|
25651
|
+
* @summary Get available payment gateways
|
|
25652
|
+
* @param {*} [options] Override http request option.
|
|
25653
|
+
* @throws {RequiredError}
|
|
25654
|
+
*/
|
|
25655
|
+
async paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesGatewayListResponse>> {
|
|
25656
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayGatewaysGet(options);
|
|
25657
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25658
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayGatewaysGet']?.[localVarOperationServerIndex]?.url;
|
|
25659
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25660
|
+
},
|
|
25661
|
+
/**
|
|
25662
|
+
* Processes a refund for a completed payment
|
|
25663
|
+
* @summary Process payment refund
|
|
25664
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25665
|
+
* @param {*} [options] Override http request option.
|
|
25666
|
+
* @throws {RequiredError}
|
|
25667
|
+
*/
|
|
25668
|
+
async paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesRefundResponseDto>> {
|
|
25669
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayRefundPost(refund, options);
|
|
25670
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25671
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayRefundPost']?.[localVarOperationServerIndex]?.url;
|
|
25672
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25673
|
+
},
|
|
25674
|
+
/**
|
|
25675
|
+
* Verifies the current status of a payment
|
|
25676
|
+
* @summary Verify payment status
|
|
25677
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25678
|
+
* @param {*} [options] Override http request option.
|
|
25679
|
+
* @throws {RequiredError}
|
|
25680
|
+
*/
|
|
25681
|
+
async paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesPaymentStatusResponse>> {
|
|
25682
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.paymentGatewayVerifyPost(verify, options);
|
|
25683
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25684
|
+
const localVarOperationServerBasePath = operationServerMap['PaymentGatewayApi.paymentGatewayVerifyPost']?.[localVarOperationServerIndex]?.url;
|
|
25685
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25686
|
+
},
|
|
25687
|
+
}
|
|
25688
|
+
};
|
|
25689
|
+
|
|
25690
|
+
/**
|
|
25691
|
+
* PaymentGatewayApi - factory interface
|
|
25692
|
+
* @export
|
|
25693
|
+
*/
|
|
25694
|
+
export const PaymentGatewayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
25695
|
+
const localVarFp = PaymentGatewayApiFp(configuration)
|
|
25696
|
+
return {
|
|
25697
|
+
/**
|
|
25698
|
+
* Creates a payment order using specified or default payment gateway
|
|
25699
|
+
* @summary Create a new payment order
|
|
25700
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25701
|
+
* @param {*} [options] Override http request option.
|
|
25702
|
+
* @throws {RequiredError}
|
|
25703
|
+
*/
|
|
25704
|
+
paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesCreatePaymentOrderResponse> {
|
|
25705
|
+
return localVarFp.paymentGatewayCreateOrderPost(order, options).then((request) => request(axios, basePath));
|
|
25706
|
+
},
|
|
25707
|
+
/**
|
|
25708
|
+
* Returns list of all active credit plans for purchase
|
|
25709
|
+
* @summary Get available credit plans
|
|
25710
|
+
* @param {*} [options] Override http request option.
|
|
25711
|
+
* @throws {RequiredError}
|
|
25712
|
+
*/
|
|
25713
|
+
paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig): AxiosPromise<Array<DataTypesCreditPlan>> {
|
|
25714
|
+
return localVarFp.paymentGatewayCreditPlansGet(options).then((request) => request(axios, basePath));
|
|
25715
|
+
},
|
|
25716
|
+
/**
|
|
25717
|
+
* Returns list of all available payment gateways
|
|
25718
|
+
* @summary Get available payment gateways
|
|
25719
|
+
* @param {*} [options] Override http request option.
|
|
25720
|
+
* @throws {RequiredError}
|
|
25721
|
+
*/
|
|
25722
|
+
paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesGatewayListResponse> {
|
|
25723
|
+
return localVarFp.paymentGatewayGatewaysGet(options).then((request) => request(axios, basePath));
|
|
25724
|
+
},
|
|
25725
|
+
/**
|
|
25726
|
+
* Processes a refund for a completed payment
|
|
25727
|
+
* @summary Process payment refund
|
|
25728
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25729
|
+
* @param {*} [options] Override http request option.
|
|
25730
|
+
* @throws {RequiredError}
|
|
25731
|
+
*/
|
|
25732
|
+
paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesRefundResponseDto> {
|
|
25733
|
+
return localVarFp.paymentGatewayRefundPost(refund, options).then((request) => request(axios, basePath));
|
|
25734
|
+
},
|
|
25735
|
+
/**
|
|
25736
|
+
* Verifies the current status of a payment
|
|
25737
|
+
* @summary Verify payment status
|
|
25738
|
+
* @param {DataTypesVerifyPaymentRequest} verify Payment verification details
|
|
25739
|
+
* @param {*} [options] Override http request option.
|
|
25740
|
+
* @throws {RequiredError}
|
|
25741
|
+
*/
|
|
25742
|
+
paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesPaymentStatusResponse> {
|
|
25743
|
+
return localVarFp.paymentGatewayVerifyPost(verify, options).then((request) => request(axios, basePath));
|
|
25744
|
+
},
|
|
25745
|
+
};
|
|
25746
|
+
};
|
|
25747
|
+
|
|
25748
|
+
/**
|
|
25749
|
+
* PaymentGatewayApi - object-oriented interface
|
|
25750
|
+
* @export
|
|
25751
|
+
* @class PaymentGatewayApi
|
|
25752
|
+
* @extends {BaseAPI}
|
|
25753
|
+
*/
|
|
25754
|
+
export class PaymentGatewayApi extends BaseAPI {
|
|
25755
|
+
/**
|
|
25756
|
+
* Creates a payment order using specified or default payment gateway
|
|
25757
|
+
* @summary Create a new payment order
|
|
25758
|
+
* @param {DataTypesCreatePaymentOrderRequest} order Payment order details
|
|
25759
|
+
* @param {*} [options] Override http request option.
|
|
25760
|
+
* @throws {RequiredError}
|
|
25761
|
+
* @memberof PaymentGatewayApi
|
|
25762
|
+
*/
|
|
25763
|
+
public paymentGatewayCreateOrderPost(order: DataTypesCreatePaymentOrderRequest, options?: RawAxiosRequestConfig) {
|
|
25764
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreateOrderPost(order, options).then((request) => request(this.axios, this.basePath));
|
|
25765
|
+
}
|
|
25766
|
+
|
|
25767
|
+
/**
|
|
25768
|
+
* Returns list of all active credit plans for purchase
|
|
25769
|
+
* @summary Get available credit plans
|
|
25770
|
+
* @param {*} [options] Override http request option.
|
|
25771
|
+
* @throws {RequiredError}
|
|
25772
|
+
* @memberof PaymentGatewayApi
|
|
25773
|
+
*/
|
|
25774
|
+
public paymentGatewayCreditPlansGet(options?: RawAxiosRequestConfig) {
|
|
25775
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayCreditPlansGet(options).then((request) => request(this.axios, this.basePath));
|
|
25776
|
+
}
|
|
25777
|
+
|
|
25778
|
+
/**
|
|
25779
|
+
* Returns list of all available payment gateways
|
|
25780
|
+
* @summary Get available payment gateways
|
|
25781
|
+
* @param {*} [options] Override http request option.
|
|
25782
|
+
* @throws {RequiredError}
|
|
25783
|
+
* @memberof PaymentGatewayApi
|
|
25784
|
+
*/
|
|
25785
|
+
public paymentGatewayGatewaysGet(options?: RawAxiosRequestConfig) {
|
|
25786
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayGatewaysGet(options).then((request) => request(this.axios, this.basePath));
|
|
25787
|
+
}
|
|
25788
|
+
|
|
25789
|
+
/**
|
|
25790
|
+
* Processes a refund for a completed payment
|
|
25791
|
+
* @summary Process payment refund
|
|
25792
|
+
* @param {DataTypesRefundRequestDto} refund Refund details
|
|
25793
|
+
* @param {*} [options] Override http request option.
|
|
25794
|
+
* @throws {RequiredError}
|
|
25795
|
+
* @memberof PaymentGatewayApi
|
|
25796
|
+
*/
|
|
25797
|
+
public paymentGatewayRefundPost(refund: DataTypesRefundRequestDto, options?: RawAxiosRequestConfig) {
|
|
25798
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayRefundPost(refund, options).then((request) => request(this.axios, this.basePath));
|
|
25799
|
+
}
|
|
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
|
+
* @memberof PaymentGatewayApi
|
|
25808
|
+
*/
|
|
25809
|
+
public paymentGatewayVerifyPost(verify: DataTypesVerifyPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
25810
|
+
return PaymentGatewayApiFp(this.configuration).paymentGatewayVerifyPost(verify, options).then((request) => request(this.axios, this.basePath));
|
|
25811
|
+
}
|
|
25812
|
+
}
|
|
25813
|
+
|
|
25814
|
+
|
|
25815
|
+
|
|
24801
25816
|
/**
|
|
24802
25817
|
* PaymentsApi - axios parameter creator
|
|
24803
25818
|
* @export
|