@seekora-ai/admin-api 1.0.16 → 1.0.17

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/dist/api.d.ts CHANGED
@@ -385,10 +385,10 @@ export interface DataTypesAdminSearchRequest {
385
385
  'max_facet_values'?: number;
386
386
  /**
387
387
  *
388
- * @type {DataTypesSearchConfig}
388
+ * @type {DataTypesIndexConfig}
389
389
  * @memberof DataTypesAdminSearchRequest
390
390
  */
391
- 'override_config'?: DataTypesSearchConfig;
391
+ 'override_config'?: DataTypesIndexConfig;
392
392
  /**
393
393
  *
394
394
  * @type {number}
@@ -447,6 +447,106 @@ export interface DataTypesAutocompleteSuggestion {
447
447
  */
448
448
  'text'?: string;
449
449
  }
450
+ /**
451
+ *
452
+ * @export
453
+ * @interface DataTypesConfigGroup
454
+ */
455
+ export interface DataTypesConfigGroup {
456
+ /**
457
+ *
458
+ * @type {string}
459
+ * @memberof DataTypesConfigGroup
460
+ */
461
+ 'description'?: string;
462
+ /**
463
+ *
464
+ * @type {string}
465
+ * @memberof DataTypesConfigGroup
466
+ */
467
+ 'label'?: string;
468
+ /**
469
+ *
470
+ * @type {string}
471
+ * @memberof DataTypesConfigGroup
472
+ */
473
+ 'name'?: string;
474
+ }
475
+ /**
476
+ *
477
+ * @export
478
+ * @interface DataTypesConfigurationSchema
479
+ */
480
+ export interface DataTypesConfigurationSchema {
481
+ /**
482
+ *
483
+ * @type {Array<DataTypesFieldMetadata>}
484
+ * @memberof DataTypesConfigurationSchema
485
+ */
486
+ 'fields'?: Array<DataTypesFieldMetadata>;
487
+ /**
488
+ *
489
+ * @type {Array<DataTypesConfigGroup>}
490
+ * @memberof DataTypesConfigurationSchema
491
+ */
492
+ 'groups'?: Array<DataTypesConfigGroup>;
493
+ /**
494
+ * Available fields from the index
495
+ * @type {Array<DataTypesIndexField>}
496
+ * @memberof DataTypesConfigurationSchema
497
+ */
498
+ 'index_fields'?: Array<DataTypesIndexField>;
499
+ }
500
+ /**
501
+ *
502
+ * @export
503
+ * @interface DataTypesConfigurationSchemaResponse
504
+ */
505
+ export interface DataTypesConfigurationSchemaResponse {
506
+ /**
507
+ *
508
+ * @type {DataTypesConfigurationSchema}
509
+ * @memberof DataTypesConfigurationSchemaResponse
510
+ */
511
+ 'data'?: DataTypesConfigurationSchema;
512
+ /**
513
+ *
514
+ * @type {string}
515
+ * @memberof DataTypesConfigurationSchemaResponse
516
+ */
517
+ 'message'?: string;
518
+ /**
519
+ *
520
+ * @type {number}
521
+ * @memberof DataTypesConfigurationSchemaResponse
522
+ */
523
+ 'status'?: number;
524
+ }
525
+ /**
526
+ *
527
+ * @export
528
+ * @interface DataTypesConfigurationSchemaResponseWrapper
529
+ */
530
+ export interface DataTypesConfigurationSchemaResponseWrapper {
531
+ /**
532
+ *
533
+ * @type {DataTypesConfigurationSchema}
534
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
535
+ */
536
+ 'data'?: DataTypesConfigurationSchema;
537
+ /**
538
+ *
539
+ * @type {string}
540
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
541
+ */
542
+ 'message'?: string;
543
+ /**
544
+ *
545
+ * @type {number}
546
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
547
+ */
548
+ 'status'?: number;
549
+ }
450
550
  /**
451
551
  *
452
552
  * @export
@@ -1076,6 +1176,73 @@ export interface DataTypesCreateUserResponseWrapper {
1076
1176
  */
1077
1177
  'status'?: number;
1078
1178
  }
1179
+ /**
1180
+ *
1181
+ * @export
1182
+ * @interface DataTypesFieldMetadata
1183
+ */
1184
+ export interface DataTypesFieldMetadata {
1185
+ /**
1186
+ *
1187
+ * @type {object}
1188
+ * @memberof DataTypesFieldMetadata
1189
+ */
1190
+ 'default'?: object;
1191
+ /**
1192
+ *
1193
+ * @type {string}
1194
+ * @memberof DataTypesFieldMetadata
1195
+ */
1196
+ 'description'?: string;
1197
+ /**
1198
+ * Available fields from index schema
1199
+ * @type {Array<string>}
1200
+ * @memberof DataTypesFieldMetadata
1201
+ */
1202
+ 'field_options'?: Array<string>;
1203
+ /**
1204
+ * Field grouping for UI
1205
+ * @type {string}
1206
+ * @memberof DataTypesFieldMetadata
1207
+ */
1208
+ 'group'?: string;
1209
+ /**
1210
+ * For int fields
1211
+ * @type {number}
1212
+ * @memberof DataTypesFieldMetadata
1213
+ */
1214
+ 'max'?: number;
1215
+ /**
1216
+ * For int fields
1217
+ * @type {number}
1218
+ * @memberof DataTypesFieldMetadata
1219
+ */
1220
+ 'min'?: number;
1221
+ /**
1222
+ *
1223
+ * @type {string}
1224
+ * @memberof DataTypesFieldMetadata
1225
+ */
1226
+ 'name'?: string;
1227
+ /**
1228
+ * For select/multi-select fields
1229
+ * @type {Array<string>}
1230
+ * @memberof DataTypesFieldMetadata
1231
+ */
1232
+ 'options'?: Array<string>;
1233
+ /**
1234
+ *
1235
+ * @type {boolean}
1236
+ * @memberof DataTypesFieldMetadata
1237
+ */
1238
+ 'required'?: boolean;
1239
+ /**
1240
+ * \"string\", \"int\", \"bool\", \"select\", \"multi-select\"
1241
+ * @type {string}
1242
+ * @memberof DataTypesFieldMetadata
1243
+ */
1244
+ 'type'?: string;
1245
+ }
1079
1246
  /**
1080
1247
  *
1081
1248
  * @export
@@ -1101,212 +1268,454 @@ export interface DataTypesGenericStringArrayResponse {
1101
1268
  */
1102
1269
  'status'?: number;
1103
1270
  }
1271
+ /**
1272
+ *
1273
+ * @export
1274
+ * @interface DataTypesGetStoreResult
1275
+ */
1276
+ export interface DataTypesGetStoreResult {
1277
+ /**
1278
+ * Timestamp for when the store was created
1279
+ * @type {string}
1280
+ * @memberof DataTypesGetStoreResult
1281
+ */
1282
+ 'CreatedAt'?: string;
1283
+ /**
1284
+ * User ID of the creator, nullable
1285
+ * @type {number}
1286
+ * @memberof DataTypesGetStoreResult
1287
+ */
1288
+ 'CreatedBy'?: number;
1289
+ /**
1290
+ * Store active status
1291
+ * @type {boolean}
1292
+ * @memberof DataTypesGetStoreResult
1293
+ */
1294
+ 'IsActive'?: boolean;
1295
+ /**
1296
+ * Store location
1297
+ * @type {string}
1298
+ * @memberof DataTypesGetStoreResult
1299
+ */
1300
+ 'Location'?: string;
1301
+ /**
1302
+ * Timestamp for when the store was last modified
1303
+ * @type {string}
1304
+ * @memberof DataTypesGetStoreResult
1305
+ */
1306
+ 'ModifiedAt'?: string;
1307
+ /**
1308
+ * User ID of the last modifier, nullable
1309
+ * @type {number}
1310
+ * @memberof DataTypesGetStoreResult
1311
+ */
1312
+ 'ModifiedBy'?: number;
1313
+ /**
1314
+ * Foreign key to mOrganizations
1315
+ * @type {number}
1316
+ * @memberof DataTypesGetStoreResult
1317
+ */
1318
+ 'OrgID'?: number;
1319
+ /**
1320
+ * Primary key
1321
+ * @type {number}
1322
+ * @memberof DataTypesGetStoreResult
1323
+ */
1324
+ 'StoreID'?: number;
1325
+ /**
1326
+ * Store name
1327
+ * @type {string}
1328
+ * @memberof DataTypesGetStoreResult
1329
+ */
1330
+ 'StoreName'?: string;
1331
+ /**
1332
+ * Store alias
1333
+ * @type {string}
1334
+ * @memberof DataTypesGetStoreResult
1335
+ */
1336
+ 'alias'?: string;
1337
+ /**
1338
+ *
1339
+ * @type {string}
1340
+ * @memberof DataTypesGetStoreResult
1341
+ */
1342
+ 'index_name'?: string;
1343
+ /**
1344
+ *
1345
+ * @type {DataTypesIndexConfig}
1346
+ * @memberof DataTypesGetStoreResult
1347
+ */
1348
+ 'search_config'?: DataTypesIndexConfig;
1349
+ }
1104
1350
  /**
1105
1351
  *
1106
1352
  * @export
1107
1353
  * @interface DataTypesIndexConfig
1108
1354
  */
1109
1355
  export interface DataTypesIndexConfig {
1356
+ /**
1357
+ *
1358
+ * @type {string}
1359
+ * @memberof DataTypesIndexConfig
1360
+ */
1361
+ 'collection_alias'?: string;
1362
+ /**
1363
+ *
1364
+ * @type {string}
1365
+ * @memberof DataTypesIndexConfig
1366
+ */
1367
+ 'collection_name'?: string;
1368
+ /**
1369
+ *
1370
+ * @type {number}
1371
+ * @memberof DataTypesIndexConfig
1372
+ */
1373
+ 'drop_tokens_threshold'?: number;
1374
+ /**
1375
+ *
1376
+ * @type {string}
1377
+ * @memberof DataTypesIndexConfig
1378
+ */
1379
+ 'embed'?: string;
1380
+ /**
1381
+ *
1382
+ * @type {boolean}
1383
+ * @memberof DataTypesIndexConfig
1384
+ */
1385
+ 'enable_autocomplete'?: boolean;
1386
+ /**
1387
+ *
1388
+ * @type {boolean}
1389
+ * @memberof DataTypesIndexConfig
1390
+ */
1391
+ 'enable_highlight'?: boolean;
1392
+ /**
1393
+ *
1394
+ * @type {boolean}
1395
+ * @memberof DataTypesIndexConfig
1396
+ */
1397
+ 'enable_overrides'?: boolean;
1398
+ /**
1399
+ *
1400
+ * @type {boolean}
1401
+ * @memberof DataTypesIndexConfig
1402
+ */
1403
+ 'enable_smart_autocomplete'?: boolean;
1404
+ /**
1405
+ *
1406
+ * @type {boolean}
1407
+ * @memberof DataTypesIndexConfig
1408
+ */
1409
+ 'enable_typo_highlight'?: boolean;
1110
1410
  /**
1111
1411
  *
1112
1412
  * @type {boolean}
1113
1413
  * @memberof DataTypesIndexConfig
1114
1414
  */
1115
- 'allowTyposOnNumericTokens'?: boolean;
1415
+ 'enable_typo_tolerance'?: boolean;
1116
1416
  /**
1117
1417
  *
1118
1418
  * @type {Array<string>}
1119
1419
  * @memberof DataTypesIndexConfig
1120
1420
  */
1121
- 'alternativesAsExact'?: Array<string>;
1421
+ 'exclude_fields'?: Array<string>;
1422
+ /**
1423
+ *
1424
+ * @type {boolean}
1425
+ * @memberof DataTypesIndexConfig
1426
+ */
1427
+ 'exhaustive_search'?: boolean;
1428
+ /**
1429
+ *
1430
+ * @type {Array<string>}
1431
+ * @memberof DataTypesIndexConfig
1432
+ */
1433
+ 'facet_by'?: Array<string>;
1122
1434
  /**
1123
1435
  *
1124
1436
  * @type {string}
1125
1437
  * @memberof DataTypesIndexConfig
1126
1438
  */
1127
- 'attributeForDistinct'?: string;
1439
+ 'facet_query'?: string;
1440
+ /**
1441
+ *
1442
+ * @type {string}
1443
+ * @memberof DataTypesIndexConfig
1444
+ */
1445
+ 'filter_by'?: string;
1446
+ /**
1447
+ *
1448
+ * @type {string}
1449
+ * @memberof DataTypesIndexConfig
1450
+ */
1451
+ 'group_by'?: string;
1452
+ /**
1453
+ *
1454
+ * @type {number}
1455
+ * @memberof DataTypesIndexConfig
1456
+ */
1457
+ 'group_limit'?: number;
1128
1458
  /**
1129
1459
  *
1130
1460
  * @type {Array<string>}
1131
1461
  * @memberof DataTypesIndexConfig
1132
1462
  */
1133
- 'attributesForFaceting'?: Array<string>;
1463
+ 'hidden_facet_fields'?: Array<string>;
1134
1464
  /**
1135
1465
  *
1136
1466
  * @type {Array<string>}
1137
1467
  * @memberof DataTypesIndexConfig
1138
1468
  */
1139
- 'attributesToHighlight'?: Array<string>;
1469
+ 'hidden_fields'?: Array<string>;
1140
1470
  /**
1141
1471
  *
1142
1472
  * @type {Array<string>}
1143
1473
  * @memberof DataTypesIndexConfig
1144
1474
  */
1145
- 'attributesToRetrieve'?: Array<string>;
1475
+ 'hidden_filter_fields'?: Array<string>;
1476
+ /**
1477
+ *
1478
+ * @type {number}
1479
+ * @memberof DataTypesIndexConfig
1480
+ */
1481
+ 'highlight_affix_num_tokens'?: number;
1482
+ /**
1483
+ *
1484
+ * @type {string}
1485
+ * @memberof DataTypesIndexConfig
1486
+ */
1487
+ 'highlight_end_tag'?: string;
1146
1488
  /**
1147
1489
  *
1148
1490
  * @type {Array<string>}
1149
1491
  * @memberof DataTypesIndexConfig
1150
1492
  */
1151
- 'attributesToSnippet'?: Array<string>;
1493
+ 'highlight_fields'?: Array<string>;
1152
1494
  /**
1153
1495
  *
1154
1496
  * @type {Array<string>}
1155
1497
  * @memberof DataTypesIndexConfig
1156
1498
  */
1157
- 'customRanking'?: Array<string>;
1499
+ 'highlight_full_fields'?: Array<string>;
1158
1500
  /**
1159
1501
  *
1160
1502
  * @type {string}
1161
1503
  * @memberof DataTypesIndexConfig
1162
1504
  */
1163
- 'exactOnSingleWordQuery'?: string;
1505
+ 'highlight_start_tag'?: string;
1164
1506
  /**
1165
1507
  *
1166
- * @type {string}
1508
+ * @type {Array<string>}
1167
1509
  * @memberof DataTypesIndexConfig
1168
1510
  */
1169
- 'highlightPostTag'?: string;
1511
+ 'include_fields'?: Array<string>;
1170
1512
  /**
1171
1513
  *
1172
1514
  * @type {string}
1173
1515
  * @memberof DataTypesIndexConfig
1174
1516
  */
1175
- 'highlightPreTag'?: string;
1517
+ 'locale'?: string;
1518
+ /**
1519
+ *
1520
+ * @type {number}
1521
+ * @memberof DataTypesIndexConfig
1522
+ */
1523
+ 'max_candidates'?: number;
1524
+ /**
1525
+ *
1526
+ * @type {number}
1527
+ * @memberof DataTypesIndexConfig
1528
+ */
1529
+ 'max_facet_values'?: number;
1176
1530
  /**
1177
1531
  *
1178
1532
  * @type {number}
1179
1533
  * @memberof DataTypesIndexConfig
1180
1534
  */
1181
- 'hitsPerPage'?: number;
1535
+ 'min_len_1typo'?: number;
1182
1536
  /**
1183
1537
  *
1184
1538
  * @type {number}
1185
1539
  * @memberof DataTypesIndexConfig
1186
1540
  */
1187
- 'indexingGeolocPrecision'?: number;
1541
+ 'min_len_2typo'?: number;
1188
1542
  /**
1189
1543
  *
1190
1544
  * @type {number}
1191
1545
  * @memberof DataTypesIndexConfig
1192
1546
  */
1193
- 'maxNbHits'?: number;
1547
+ 'num_typos'?: number;
1548
+ /**
1549
+ *
1550
+ * @type {number}
1551
+ * @memberof DataTypesIndexConfig
1552
+ */
1553
+ 'page'?: number;
1554
+ /**
1555
+ *
1556
+ * @type {number}
1557
+ * @memberof DataTypesIndexConfig
1558
+ */
1559
+ 'per_page'?: number;
1194
1560
  /**
1195
1561
  *
1196
- * @type {number}
1562
+ * @type {string}
1197
1563
  * @memberof DataTypesIndexConfig
1198
1564
  */
1199
- 'maxValuesPerFacet'?: number;
1565
+ 'prefix'?: string;
1200
1566
  /**
1201
1567
  *
1202
- * @type {number}
1568
+ * @type {string}
1203
1569
  * @memberof DataTypesIndexConfig
1204
1570
  */
1205
- 'minWordSizefor1Typo'?: number;
1571
+ 'preset'?: string;
1206
1572
  /**
1207
1573
  *
1208
- * @type {number}
1574
+ * @type {boolean}
1209
1575
  * @memberof DataTypesIndexConfig
1210
1576
  */
1211
- 'minWordSizefor2Typos'?: number;
1577
+ 'prioritize_exact_match'?: boolean;
1212
1578
  /**
1213
- *
1214
- * @type {number}
1579
+ * Required: Query string
1580
+ * @type {string}
1215
1581
  * @memberof DataTypesIndexConfig
1216
1582
  */
1217
- 'nbShardsAuto'?: number;
1583
+ 'q'?: string;
1218
1584
  /**
1219
- *
1585
+ * Required: Array of search fields
1220
1586
  * @type {Array<string>}
1221
1587
  * @memberof DataTypesIndexConfig
1222
1588
  */
1223
- 'numericAttributesToIndex'?: Array<string>;
1589
+ 'query_by'?: Array<string>;
1224
1590
  /**
1225
- *
1226
- * @type {Array<string>}
1591
+ * Optional: Relative field weights as array
1592
+ * @type {Array<number>}
1227
1593
  * @memberof DataTypesIndexConfig
1228
1594
  */
1229
- 'optionalWords'?: Array<string>;
1595
+ 'query_by_weights'?: Array<number>;
1230
1596
  /**
1231
1597
  *
1232
- * @type {number}
1598
+ * @type {boolean}
1233
1599
  * @memberof DataTypesIndexConfig
1234
1600
  */
1235
- 'paginationLimitedTo'?: number;
1601
+ 'query_syntax'?: boolean;
1236
1602
  /**
1237
1603
  *
1238
- * @type {string}
1604
+ * @type {number}
1239
1605
  * @memberof DataTypesIndexConfig
1240
1606
  */
1241
- 'primary'?: string;
1607
+ 'search_cutoff_ms'?: number;
1242
1608
  /**
1243
- *
1609
+ * \"text\", \"vector\", \"hybrid\"
1244
1610
  * @type {string}
1245
1611
  * @memberof DataTypesIndexConfig
1246
1612
  */
1247
- 'queryType'?: string;
1613
+ 'search_strategy'?: string;
1248
1614
  /**
1249
1615
  *
1250
- * @type {Array<string>}
1616
+ * @type {boolean}
1251
1617
  * @memberof DataTypesIndexConfig
1252
1618
  */
1253
- 'ranking'?: Array<string>;
1619
+ 'semantic_ranker'?: boolean;
1254
1620
  /**
1255
1621
  *
1256
- * @type {string}
1622
+ * @type {number}
1257
1623
  * @memberof DataTypesIndexConfig
1258
1624
  */
1259
- 'removeWordsIfNoResults'?: string;
1625
+ 'snippet_threshold'?: number;
1260
1626
  /**
1261
1627
  *
1262
- * @type {Array<string>}
1628
+ * @type {Array<DataTypesSortField>}
1263
1629
  * @memberof DataTypesIndexConfig
1264
1630
  */
1265
- 'searchableAttributes'?: Array<string>;
1631
+ 'sort_by'?: Array<DataTypesSortField>;
1266
1632
  /**
1267
- *
1633
+ * Optional: Search-only scoped API key
1268
1634
  * @type {string}
1269
1635
  * @memberof DataTypesIndexConfig
1270
1636
  */
1271
- 'separatorsToIndex'?: string;
1637
+ 'token'?: string;
1272
1638
  /**
1273
1639
  *
1274
- * @type {Array<string>}
1640
+ * @type {boolean}
1275
1641
  * @memberof DataTypesIndexConfig
1276
1642
  */
1277
- 'unretrievableAttributes'?: Array<string>;
1643
+ 'use_cache'?: boolean;
1278
1644
  /**
1279
1645
  *
1280
- * @type {number}
1646
+ * @type {string}
1281
1647
  * @memberof DataTypesIndexConfig
1282
1648
  */
1283
- 'version'?: number;
1649
+ 'vector_query'?: string;
1284
1650
  }
1285
1651
  /**
1286
1652
  *
1287
1653
  * @export
1288
- * @interface DataTypesIndexConfigResponse
1654
+ * @interface DataTypesIndexConfigResponseWrapper
1289
1655
  */
1290
- export interface DataTypesIndexConfigResponse {
1656
+ export interface DataTypesIndexConfigResponseWrapper {
1291
1657
  /**
1292
1658
  *
1293
1659
  * @type {DataTypesIndexConfig}
1294
- * @memberof DataTypesIndexConfigResponse
1660
+ * @memberof DataTypesIndexConfigResponseWrapper
1295
1661
  */
1296
1662
  'data'?: DataTypesIndexConfig;
1297
1663
  /**
1298
1664
  *
1299
1665
  * @type {string}
1300
- * @memberof DataTypesIndexConfigResponse
1666
+ * @memberof DataTypesIndexConfigResponseWrapper
1301
1667
  */
1302
1668
  'message'?: string;
1303
1669
  /**
1304
1670
  *
1305
1671
  * @type {number}
1306
- * @memberof DataTypesIndexConfigResponse
1672
+ * @memberof DataTypesIndexConfigResponseWrapper
1307
1673
  */
1308
1674
  'status'?: number;
1309
1675
  }
1676
+ /**
1677
+ *
1678
+ * @export
1679
+ * @interface DataTypesIndexField
1680
+ */
1681
+ export interface DataTypesIndexField {
1682
+ /**
1683
+ *
1684
+ * @type {boolean}
1685
+ * @memberof DataTypesIndexField
1686
+ */
1687
+ 'facet'?: boolean;
1688
+ /**
1689
+ *
1690
+ * @type {boolean}
1691
+ * @memberof DataTypesIndexField
1692
+ */
1693
+ 'index'?: boolean;
1694
+ /**
1695
+ *
1696
+ * @type {string}
1697
+ * @memberof DataTypesIndexField
1698
+ */
1699
+ 'name'?: string;
1700
+ /**
1701
+ *
1702
+ * @type {boolean}
1703
+ * @memberof DataTypesIndexField
1704
+ */
1705
+ 'optional'?: boolean;
1706
+ /**
1707
+ *
1708
+ * @type {boolean}
1709
+ * @memberof DataTypesIndexField
1710
+ */
1711
+ 'sort'?: boolean;
1712
+ /**
1713
+ *
1714
+ * @type {string}
1715
+ * @memberof DataTypesIndexField
1716
+ */
1717
+ 'type'?: string;
1718
+ }
1310
1719
  /**
1311
1720
  *
1312
1721
  * @export
@@ -3402,109 +3811,145 @@ export interface DataTypesSampleDatasetsResponseWrapper {
3402
3811
  /**
3403
3812
  *
3404
3813
  * @export
3405
- * @interface DataTypesSchemaOptionsResponse
3814
+ * @interface DataTypesSchemaBasedDefaults
3406
3815
  */
3407
- export interface DataTypesSchemaOptionsResponse {
3816
+ export interface DataTypesSchemaBasedDefaults {
3408
3817
  /**
3409
3818
  *
3410
3819
  * @type {Array<string>}
3411
- * @memberof DataTypesSchemaOptionsResponse
3820
+ * @memberof DataTypesSchemaBasedDefaults
3412
3821
  */
3413
- 'displayAttributesOptions'?: Array<string>;
3822
+ 'all_fields'?: Array<string>;
3414
3823
  /**
3415
3824
  *
3416
3825
  * @type {Array<string>}
3417
- * @memberof DataTypesSchemaOptionsResponse
3826
+ * @memberof DataTypesSchemaBasedDefaults
3418
3827
  */
3419
- 'relevancyOrderOptions'?: Array<string>;
3828
+ 'facetable_fields'?: Array<string>;
3420
3829
  /**
3421
3830
  *
3422
3831
  * @type {Array<string>}
3423
- * @memberof DataTypesSchemaOptionsResponse
3832
+ * @memberof DataTypesSchemaBasedDefaults
3424
3833
  */
3425
- 'searchableAttributesOptions'?: Array<string>;
3834
+ 'highlightable_fields'?: Array<string>;
3835
+ /**
3836
+ *
3837
+ * @type {Array<string>}
3838
+ * @memberof DataTypesSchemaBasedDefaults
3839
+ */
3840
+ 'include_fields'?: Array<string>;
3841
+ /**
3842
+ *
3843
+ * @type {Array<string>}
3844
+ * @memberof DataTypesSchemaBasedDefaults
3845
+ */
3846
+ 'query_by'?: Array<string>;
3847
+ /**
3848
+ *
3849
+ * @type {Array<DataTypesSortField>}
3850
+ * @memberof DataTypesSchemaBasedDefaults
3851
+ */
3852
+ 'sortable_fields'?: Array<DataTypesSortField>;
3426
3853
  }
3427
3854
  /**
3428
3855
  *
3429
3856
  * @export
3430
- * @interface DataTypesSchemaOptionsResponseWrapper
3857
+ * @interface DataTypesSchemaBasedDefaultsResponse
3431
3858
  */
3432
- export interface DataTypesSchemaOptionsResponseWrapper {
3859
+ export interface DataTypesSchemaBasedDefaultsResponse {
3433
3860
  /**
3434
3861
  *
3435
- * @type {DataTypesSchemaOptionsResponse}
3436
- * @memberof DataTypesSchemaOptionsResponseWrapper
3862
+ * @type {DataTypesSchemaBasedDefaults}
3863
+ * @memberof DataTypesSchemaBasedDefaultsResponse
3437
3864
  */
3438
- 'data'?: DataTypesSchemaOptionsResponse;
3865
+ 'data'?: DataTypesSchemaBasedDefaults;
3439
3866
  /**
3440
3867
  *
3441
3868
  * @type {string}
3442
- * @memberof DataTypesSchemaOptionsResponseWrapper
3869
+ * @memberof DataTypesSchemaBasedDefaultsResponse
3443
3870
  */
3444
3871
  'message'?: string;
3445
3872
  /**
3446
3873
  *
3447
3874
  * @type {number}
3448
- * @memberof DataTypesSchemaOptionsResponseWrapper
3875
+ * @memberof DataTypesSchemaBasedDefaultsResponse
3449
3876
  */
3450
3877
  'status'?: number;
3451
3878
  }
3452
3879
  /**
3453
3880
  *
3454
3881
  * @export
3455
- * @interface DataTypesSearchConfig
3882
+ * @interface DataTypesSchemaBasedDefaultsResponseWrapper
3456
3883
  */
3457
- export interface DataTypesSearchConfig {
3884
+ export interface DataTypesSchemaBasedDefaultsResponseWrapper {
3458
3885
  /**
3459
3886
  *
3460
- * @type {Array<string>}
3461
- * @memberof DataTypesSearchConfig
3887
+ * @type {DataTypesSchemaBasedDefaults}
3888
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3462
3889
  */
3463
- 'attributesToHighlight'?: Array<string>;
3890
+ 'data'?: DataTypesSchemaBasedDefaults;
3464
3891
  /**
3465
3892
  *
3466
- * @type {Array<string>}
3467
- * @memberof DataTypesSearchConfig
3893
+ * @type {string}
3894
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3468
3895
  */
3469
- 'attributesToRetrieve'?: Array<string>;
3896
+ 'message'?: string;
3470
3897
  /**
3471
3898
  *
3472
- * @type {{ [key: string]: any; }}
3473
- * @memberof DataTypesSearchConfig
3899
+ * @type {number}
3900
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3474
3901
  */
3475
- 'displayAttributes'?: {
3476
- [key: string]: any;
3477
- };
3902
+ 'status'?: number;
3903
+ }
3904
+ /**
3905
+ *
3906
+ * @export
3907
+ * @interface DataTypesSchemaOptionsResponse
3908
+ */
3909
+ export interface DataTypesSchemaOptionsResponse {
3478
3910
  /**
3479
3911
  *
3480
- * @type {number}
3481
- * @memberof DataTypesSearchConfig
3912
+ * @type {Array<string>}
3913
+ * @memberof DataTypesSchemaOptionsResponse
3482
3914
  */
3483
- 'hitsPerPage'?: number;
3915
+ 'displayAttributesOptions'?: Array<string>;
3484
3916
  /**
3485
3917
  *
3486
- * @type {number}
3487
- * @memberof DataTypesSearchConfig
3918
+ * @type {Array<string>}
3919
+ * @memberof DataTypesSchemaOptionsResponse
3488
3920
  */
3489
- 'maxNbHits'?: number;
3921
+ 'relevancyOrderOptions'?: Array<string>;
3490
3922
  /**
3491
3923
  *
3492
- * @type {string}
3493
- * @memberof DataTypesSearchConfig
3924
+ * @type {Array<string>}
3925
+ * @memberof DataTypesSchemaOptionsResponse
3494
3926
  */
3495
- 'query_by'?: string;
3927
+ 'searchableAttributesOptions'?: Array<string>;
3928
+ }
3929
+ /**
3930
+ *
3931
+ * @export
3932
+ * @interface DataTypesSchemaOptionsResponseWrapper
3933
+ */
3934
+ export interface DataTypesSchemaOptionsResponseWrapper {
3496
3935
  /**
3497
3936
  *
3498
- * @type {Array<string>}
3499
- * @memberof DataTypesSearchConfig
3937
+ * @type {DataTypesSchemaOptionsResponse}
3938
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3500
3939
  */
3501
- 'ranking'?: Array<string>;
3940
+ 'data'?: DataTypesSchemaOptionsResponse;
3502
3941
  /**
3503
3942
  *
3504
- * @type {Array<string>}
3505
- * @memberof DataTypesSearchConfig
3943
+ * @type {string}
3944
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3945
+ */
3946
+ 'message'?: string;
3947
+ /**
3948
+ *
3949
+ * @type {number}
3950
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3506
3951
  */
3507
- 'searchableAttributes'?: Array<string>;
3952
+ 'status'?: number;
3508
3953
  }
3509
3954
  /**
3510
3955
  *
@@ -3758,6 +4203,25 @@ export interface DataTypesServiceRequestsListResponse {
3758
4203
  */
3759
4204
  'status'?: number;
3760
4205
  }
4206
+ /**
4207
+ *
4208
+ * @export
4209
+ * @interface DataTypesSortField
4210
+ */
4211
+ export interface DataTypesSortField {
4212
+ /**
4213
+ * \"asc\" or \"desc\"
4214
+ * @type {string}
4215
+ * @memberof DataTypesSortField
4216
+ */
4217
+ 'direction'?: string;
4218
+ /**
4219
+ *
4220
+ * @type {string}
4221
+ * @memberof DataTypesSortField
4222
+ */
4223
+ 'field'?: string;
4224
+ }
3761
4225
  /**
3762
4226
  *
3763
4227
  * @export
@@ -4018,10 +4482,10 @@ export interface DataTypesStoreRequestDto {
4018
4482
  export interface DataTypesStoreResponse {
4019
4483
  /**
4020
4484
  *
4021
- * @type {DataTypesStore}
4485
+ * @type {DataTypesGetStoreResult}
4022
4486
  * @memberof DataTypesStoreResponse
4023
4487
  */
4024
- 'data'?: DataTypesStore;
4488
+ 'data'?: DataTypesGetStoreResult;
4025
4489
  /**
4026
4490
  *
4027
4491
  * @type {string}
@@ -9200,13 +9664,20 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
9200
9664
  /**
9201
9665
  * Search documents with optional configuration override and autocomplete suggestions
9202
9666
  * @summary Admin Search API
9203
- * @param {string} xStoreID Store ID for the selected store
9204
- * @param {string} xStoreSecret Store Secret for the selected store
9667
+ * @param {number} storeid Store ID
9205
9668
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9206
9669
  * @param {*} [options] Override http request option.
9207
9670
  * @throws {RequiredError}
9208
9671
  */
9209
- adminV1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9672
+ adminV1SearchStoreidPost: (storeid: number, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9673
+ /**
9674
+ * Get metadata about all configurable fields for dynamic form generation
9675
+ * @summary Get Configuration Schema
9676
+ * @param {string} [indexname] Index name to get field options from
9677
+ * @param {*} [options] Override http request option.
9678
+ * @throws {RequiredError}
9679
+ */
9680
+ v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9210
9681
  /**
9211
9682
  * Get the current index configuration
9212
9683
  * @summary Get Index Config
@@ -9234,16 +9705,24 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
9234
9705
  * @throws {RequiredError}
9235
9706
  */
9236
9707
  v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9708
+ /**
9709
+ * Get default configuration values computed from the Typesense schema
9710
+ * @summary Get Schema-Based Defaults
9711
+ * @param {string} indexname Index Name
9712
+ * @param {*} [options] Override http request option.
9713
+ * @throws {RequiredError}
9714
+ */
9715
+ v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9237
9716
  /**
9238
9717
  * Search documents using store credentials with optional autocomplete suggestions
9239
9718
  * @summary Public Search API
9240
- * @param {string} xStoreID Store ID
9241
- * @param {string} xStoreSecret Store Secret
9719
+ * @param {string} xStoreid Store ID
9720
+ * @param {string} xStoresecret Store Secret
9242
9721
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9243
9722
  * @param {*} [options] Override http request option.
9244
9723
  * @throws {RequiredError}
9245
9724
  */
9246
- v1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9725
+ v1SearchPost: (xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9247
9726
  };
9248
9727
  /**
9249
9728
  * SearchApi - functional programming interface
@@ -9253,13 +9732,20 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9253
9732
  /**
9254
9733
  * Search documents with optional configuration override and autocomplete suggestions
9255
9734
  * @summary Admin Search API
9256
- * @param {string} xStoreID Store ID for the selected store
9257
- * @param {string} xStoreSecret Store Secret for the selected store
9735
+ * @param {number} storeid Store ID
9258
9736
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9259
9737
  * @param {*} [options] Override http request option.
9260
9738
  * @throws {RequiredError}
9261
9739
  */
9262
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9740
+ adminV1SearchStoreidPost(storeid: number, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9741
+ /**
9742
+ * Get metadata about all configurable fields for dynamic form generation
9743
+ * @summary Get Configuration Schema
9744
+ * @param {string} [indexname] Index name to get field options from
9745
+ * @param {*} [options] Override http request option.
9746
+ * @throws {RequiredError}
9747
+ */
9748
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
9263
9749
  /**
9264
9750
  * Get the current index configuration
9265
9751
  * @summary Get Index Config
@@ -9267,7 +9753,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9267
9753
  * @param {*} [options] Override http request option.
9268
9754
  * @throws {RequiredError}
9269
9755
  */
9270
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponse>>;
9756
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
9271
9757
  /**
9272
9758
  * Configure the index for search
9273
9759
  * @summary Index Config
@@ -9287,16 +9773,24 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9287
9773
  * @throws {RequiredError}
9288
9774
  */
9289
9775
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9776
+ /**
9777
+ * Get default configuration values computed from the Typesense schema
9778
+ * @summary Get Schema-Based Defaults
9779
+ * @param {string} indexname Index Name
9780
+ * @param {*} [options] Override http request option.
9781
+ * @throws {RequiredError}
9782
+ */
9783
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
9290
9784
  /**
9291
9785
  * Search documents using store credentials with optional autocomplete suggestions
9292
9786
  * @summary Public Search API
9293
- * @param {string} xStoreID Store ID
9294
- * @param {string} xStoreSecret Store Secret
9787
+ * @param {string} xStoreid Store ID
9788
+ * @param {string} xStoresecret Store Secret
9295
9789
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9296
9790
  * @param {*} [options] Override http request option.
9297
9791
  * @throws {RequiredError}
9298
9792
  */
9299
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9793
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9300
9794
  };
9301
9795
  /**
9302
9796
  * SearchApi - factory interface
@@ -9306,13 +9800,20 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9306
9800
  /**
9307
9801
  * Search documents with optional configuration override and autocomplete suggestions
9308
9802
  * @summary Admin Search API
9309
- * @param {string} xStoreID Store ID for the selected store
9310
- * @param {string} xStoreSecret Store Secret for the selected store
9803
+ * @param {number} storeid Store ID
9311
9804
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9312
9805
  * @param {*} [options] Override http request option.
9313
9806
  * @throws {RequiredError}
9314
9807
  */
9315
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9808
+ adminV1SearchStoreidPost(storeid: number, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9809
+ /**
9810
+ * Get metadata about all configurable fields for dynamic form generation
9811
+ * @summary Get Configuration Schema
9812
+ * @param {string} [indexname] Index name to get field options from
9813
+ * @param {*} [options] Override http request option.
9814
+ * @throws {RequiredError}
9815
+ */
9816
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
9316
9817
  /**
9317
9818
  * Get the current index configuration
9318
9819
  * @summary Get Index Config
@@ -9320,7 +9821,7 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9320
9821
  * @param {*} [options] Override http request option.
9321
9822
  * @throws {RequiredError}
9322
9823
  */
9323
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponse>;
9824
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
9324
9825
  /**
9325
9826
  * Configure the index for search
9326
9827
  * @summary Index Config
@@ -9340,16 +9841,24 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9340
9841
  * @throws {RequiredError}
9341
9842
  */
9342
9843
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9844
+ /**
9845
+ * Get default configuration values computed from the Typesense schema
9846
+ * @summary Get Schema-Based Defaults
9847
+ * @param {string} indexname Index Name
9848
+ * @param {*} [options] Override http request option.
9849
+ * @throws {RequiredError}
9850
+ */
9851
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
9343
9852
  /**
9344
9853
  * Search documents using store credentials with optional autocomplete suggestions
9345
9854
  * @summary Public Search API
9346
- * @param {string} xStoreID Store ID
9347
- * @param {string} xStoreSecret Store Secret
9855
+ * @param {string} xStoreid Store ID
9856
+ * @param {string} xStoresecret Store Secret
9348
9857
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9349
9858
  * @param {*} [options] Override http request option.
9350
9859
  * @throws {RequiredError}
9351
9860
  */
9352
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9861
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9353
9862
  };
9354
9863
  /**
9355
9864
  * SearchApi - object-oriented interface
@@ -9361,14 +9870,22 @@ export declare class SearchApi extends BaseAPI {
9361
9870
  /**
9362
9871
  * Search documents with optional configuration override and autocomplete suggestions
9363
9872
  * @summary Admin Search API
9364
- * @param {string} xStoreID Store ID for the selected store
9365
- * @param {string} xStoreSecret Store Secret for the selected store
9873
+ * @param {number} storeid Store ID
9366
9874
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9367
9875
  * @param {*} [options] Override http request option.
9368
9876
  * @throws {RequiredError}
9369
9877
  * @memberof SearchApi
9370
9878
  */
9371
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9879
+ adminV1SearchStoreidPost(storeid: number, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9880
+ /**
9881
+ * Get metadata about all configurable fields for dynamic form generation
9882
+ * @summary Get Configuration Schema
9883
+ * @param {string} [indexname] Index name to get field options from
9884
+ * @param {*} [options] Override http request option.
9885
+ * @throws {RequiredError}
9886
+ * @memberof SearchApi
9887
+ */
9888
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any>>;
9372
9889
  /**
9373
9890
  * Get the current index configuration
9374
9891
  * @summary Get Index Config
@@ -9377,7 +9894,7 @@ export declare class SearchApi extends BaseAPI {
9377
9894
  * @throws {RequiredError}
9378
9895
  * @memberof SearchApi
9379
9896
  */
9380
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponse, any>>;
9897
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any>>;
9381
9898
  /**
9382
9899
  * Configure the index for search
9383
9900
  * @summary Index Config
@@ -9399,17 +9916,26 @@ export declare class SearchApi extends BaseAPI {
9399
9916
  * @memberof SearchApi
9400
9917
  */
9401
9918
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9919
+ /**
9920
+ * Get default configuration values computed from the Typesense schema
9921
+ * @summary Get Schema-Based Defaults
9922
+ * @param {string} indexname Index Name
9923
+ * @param {*} [options] Override http request option.
9924
+ * @throws {RequiredError}
9925
+ * @memberof SearchApi
9926
+ */
9927
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any>>;
9402
9928
  /**
9403
9929
  * Search documents using store credentials with optional autocomplete suggestions
9404
9930
  * @summary Public Search API
9405
- * @param {string} xStoreID Store ID
9406
- * @param {string} xStoreSecret Store Secret
9931
+ * @param {string} xStoreid Store ID
9932
+ * @param {string} xStoresecret Store Secret
9407
9933
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9408
9934
  * @param {*} [options] Override http request option.
9409
9935
  * @throws {RequiredError}
9410
9936
  * @memberof SearchApi
9411
9937
  */
9412
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9938
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9413
9939
  }
9414
9940
  /**
9415
9941
  * StoresApi - axios parameter creator
@@ -9440,6 +9966,39 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
9440
9966
  * @throws {RequiredError}
9441
9967
  */
9442
9968
  adminStoresPost: (store: DataTypesStoreRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9969
+ /**
9970
+ * Retrieves the store configuration
9971
+ * @summary Get Store Config
9972
+ * @param {number} storeID Store ID
9973
+ * @param {*} [options] Override http request option.
9974
+ * @throws {RequiredError}
9975
+ */
9976
+ adminStoresStoreIDConfigGet: (storeID: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9977
+ /**
9978
+ * Updates the store configuration
9979
+ * @summary Update Store Config
9980
+ * @param {number} storeID Store ID
9981
+ * @param {DataTypesIndexConfig} body Store configuration
9982
+ * @param {*} [options] Override http request option.
9983
+ * @throws {RequiredError}
9984
+ */
9985
+ adminStoresStoreIDConfigPut: (storeID: number, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9986
+ /**
9987
+ * Get metadata about all configurable fields for store configuration
9988
+ * @summary Get Store Config Schema
9989
+ * @param {number} storeID Store ID to get field options from
9990
+ * @param {*} [options] Override http request option.
9991
+ * @throws {RequiredError}
9992
+ */
9993
+ adminStoresStoreIDConfigSchemaGet: (storeID: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9994
+ /**
9995
+ * Get default configuration values computed from the store\'s index schema
9996
+ * @summary Get Store Schema-Based Defaults
9997
+ * @param {number} storeID Store ID
9998
+ * @param {*} [options] Override http request option.
9999
+ * @throws {RequiredError}
10000
+ */
10001
+ adminStoresStoreIDDefaultsGet: (storeID: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9443
10002
  /**
9444
10003
  * Updates store information by ID.
9445
10004
  * @summary Update an existing store
@@ -9488,6 +10047,39 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
9488
10047
  * @throws {RequiredError}
9489
10048
  */
9490
10049
  adminStoresPost(store: DataTypesStoreRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
10050
+ /**
10051
+ * Retrieves the store configuration
10052
+ * @summary Get Store Config
10053
+ * @param {number} storeID Store ID
10054
+ * @param {*} [options] Override http request option.
10055
+ * @throws {RequiredError}
10056
+ */
10057
+ adminStoresStoreIDConfigGet(storeID: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
10058
+ /**
10059
+ * Updates the store configuration
10060
+ * @summary Update Store Config
10061
+ * @param {number} storeID Store ID
10062
+ * @param {DataTypesIndexConfig} body Store configuration
10063
+ * @param {*} [options] Override http request option.
10064
+ * @throws {RequiredError}
10065
+ */
10066
+ adminStoresStoreIDConfigPut(storeID: number, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
10067
+ /**
10068
+ * Get metadata about all configurable fields for store configuration
10069
+ * @summary Get Store Config Schema
10070
+ * @param {number} storeID Store ID to get field options from
10071
+ * @param {*} [options] Override http request option.
10072
+ * @throws {RequiredError}
10073
+ */
10074
+ adminStoresStoreIDConfigSchemaGet(storeID: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponse>>;
10075
+ /**
10076
+ * Get default configuration values computed from the store\'s index schema
10077
+ * @summary Get Store Schema-Based Defaults
10078
+ * @param {number} storeID Store ID
10079
+ * @param {*} [options] Override http request option.
10080
+ * @throws {RequiredError}
10081
+ */
10082
+ adminStoresStoreIDDefaultsGet(storeID: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponse>>;
9491
10083
  /**
9492
10084
  * Updates store information by ID.
9493
10085
  * @summary Update an existing store
@@ -9536,6 +10128,39 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
9536
10128
  * @throws {RequiredError}
9537
10129
  */
9538
10130
  adminStoresPost(store: DataTypesStoreRequestDto, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
10131
+ /**
10132
+ * Retrieves the store configuration
10133
+ * @summary Get Store Config
10134
+ * @param {number} storeID Store ID
10135
+ * @param {*} [options] Override http request option.
10136
+ * @throws {RequiredError}
10137
+ */
10138
+ adminStoresStoreIDConfigGet(storeID: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
10139
+ /**
10140
+ * Updates the store configuration
10141
+ * @summary Update Store Config
10142
+ * @param {number} storeID Store ID
10143
+ * @param {DataTypesIndexConfig} body Store configuration
10144
+ * @param {*} [options] Override http request option.
10145
+ * @throws {RequiredError}
10146
+ */
10147
+ adminStoresStoreIDConfigPut(storeID: number, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
10148
+ /**
10149
+ * Get metadata about all configurable fields for store configuration
10150
+ * @summary Get Store Config Schema
10151
+ * @param {number} storeID Store ID to get field options from
10152
+ * @param {*} [options] Override http request option.
10153
+ * @throws {RequiredError}
10154
+ */
10155
+ adminStoresStoreIDConfigSchemaGet(storeID: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponse>;
10156
+ /**
10157
+ * Get default configuration values computed from the store\'s index schema
10158
+ * @summary Get Store Schema-Based Defaults
10159
+ * @param {number} storeID Store ID
10160
+ * @param {*} [options] Override http request option.
10161
+ * @throws {RequiredError}
10162
+ */
10163
+ adminStoresStoreIDDefaultsGet(storeID: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponse>;
9539
10164
  /**
9540
10165
  * Updates store information by ID.
9541
10166
  * @summary Update an existing store
@@ -9589,6 +10214,43 @@ export declare class StoresApi extends BaseAPI {
9589
10214
  * @memberof StoresApi
9590
10215
  */
9591
10216
  adminStoresPost(store: DataTypesStoreRequestDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
10217
+ /**
10218
+ * Retrieves the store configuration
10219
+ * @summary Get Store Config
10220
+ * @param {number} storeID Store ID
10221
+ * @param {*} [options] Override http request option.
10222
+ * @throws {RequiredError}
10223
+ * @memberof StoresApi
10224
+ */
10225
+ adminStoresStoreIDConfigGet(storeID: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any>>;
10226
+ /**
10227
+ * Updates the store configuration
10228
+ * @summary Update Store Config
10229
+ * @param {number} storeID Store ID
10230
+ * @param {DataTypesIndexConfig} body Store configuration
10231
+ * @param {*} [options] Override http request option.
10232
+ * @throws {RequiredError}
10233
+ * @memberof StoresApi
10234
+ */
10235
+ adminStoresStoreIDConfigPut(storeID: number, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
10236
+ /**
10237
+ * Get metadata about all configurable fields for store configuration
10238
+ * @summary Get Store Config Schema
10239
+ * @param {number} storeID Store ID to get field options from
10240
+ * @param {*} [options] Override http request option.
10241
+ * @throws {RequiredError}
10242
+ * @memberof StoresApi
10243
+ */
10244
+ adminStoresStoreIDConfigSchemaGet(storeID: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponse, any>>;
10245
+ /**
10246
+ * Get default configuration values computed from the store\'s index schema
10247
+ * @summary Get Store Schema-Based Defaults
10248
+ * @param {number} storeID Store ID
10249
+ * @param {*} [options] Override http request option.
10250
+ * @throws {RequiredError}
10251
+ * @memberof StoresApi
10252
+ */
10253
+ adminStoresStoreIDDefaultsGet(storeID: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponse, any>>;
9592
10254
  /**
9593
10255
  * Updates store information by ID.
9594
10256
  * @summary Update an existing store