@seekora-ai/admin-api 1.0.16 → 1.0.18

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/esm/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,81 @@ 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 DataTypesConfigurationSchemaResponseWrapper
504
+ */
505
+ export interface DataTypesConfigurationSchemaResponseWrapper {
506
+ /**
507
+ *
508
+ * @type {DataTypesConfigurationSchema}
509
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
510
+ */
511
+ 'data'?: DataTypesConfigurationSchema;
512
+ /**
513
+ *
514
+ * @type {string}
515
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
516
+ */
517
+ 'message'?: string;
518
+ /**
519
+ *
520
+ * @type {number}
521
+ * @memberof DataTypesConfigurationSchemaResponseWrapper
522
+ */
523
+ 'status'?: number;
524
+ }
450
525
  /**
451
526
  *
452
527
  * @export
@@ -1076,6 +1151,73 @@ export interface DataTypesCreateUserResponseWrapper {
1076
1151
  */
1077
1152
  'status'?: number;
1078
1153
  }
1154
+ /**
1155
+ *
1156
+ * @export
1157
+ * @interface DataTypesFieldMetadata
1158
+ */
1159
+ export interface DataTypesFieldMetadata {
1160
+ /**
1161
+ *
1162
+ * @type {object}
1163
+ * @memberof DataTypesFieldMetadata
1164
+ */
1165
+ 'default'?: object;
1166
+ /**
1167
+ *
1168
+ * @type {string}
1169
+ * @memberof DataTypesFieldMetadata
1170
+ */
1171
+ 'description'?: string;
1172
+ /**
1173
+ * Available fields from index schema
1174
+ * @type {Array<string>}
1175
+ * @memberof DataTypesFieldMetadata
1176
+ */
1177
+ 'field_options'?: Array<string>;
1178
+ /**
1179
+ * Field grouping for UI
1180
+ * @type {string}
1181
+ * @memberof DataTypesFieldMetadata
1182
+ */
1183
+ 'group'?: string;
1184
+ /**
1185
+ * For int fields
1186
+ * @type {number}
1187
+ * @memberof DataTypesFieldMetadata
1188
+ */
1189
+ 'max'?: number;
1190
+ /**
1191
+ * For int fields
1192
+ * @type {number}
1193
+ * @memberof DataTypesFieldMetadata
1194
+ */
1195
+ 'min'?: number;
1196
+ /**
1197
+ *
1198
+ * @type {string}
1199
+ * @memberof DataTypesFieldMetadata
1200
+ */
1201
+ 'name'?: string;
1202
+ /**
1203
+ * For select/multi-select fields
1204
+ * @type {Array<string>}
1205
+ * @memberof DataTypesFieldMetadata
1206
+ */
1207
+ 'options'?: Array<string>;
1208
+ /**
1209
+ *
1210
+ * @type {boolean}
1211
+ * @memberof DataTypesFieldMetadata
1212
+ */
1213
+ 'required'?: boolean;
1214
+ /**
1215
+ * \"string\", \"int\", \"bool\", \"select\", \"multi-select\"
1216
+ * @type {string}
1217
+ * @memberof DataTypesFieldMetadata
1218
+ */
1219
+ 'type'?: string;
1220
+ }
1079
1221
  /**
1080
1222
  *
1081
1223
  * @export
@@ -1101,212 +1243,466 @@ export interface DataTypesGenericStringArrayResponse {
1101
1243
  */
1102
1244
  'status'?: number;
1103
1245
  }
1246
+ /**
1247
+ *
1248
+ * @export
1249
+ * @interface DataTypesGetStoreResult
1250
+ */
1251
+ export interface DataTypesGetStoreResult {
1252
+ /**
1253
+ * Timestamp for when the store was created
1254
+ * @type {string}
1255
+ * @memberof DataTypesGetStoreResult
1256
+ */
1257
+ 'CreatedAt'?: string;
1258
+ /**
1259
+ * User ID of the creator, nullable
1260
+ * @type {number}
1261
+ * @memberof DataTypesGetStoreResult
1262
+ */
1263
+ 'CreatedBy'?: number;
1264
+ /**
1265
+ * Store active status
1266
+ * @type {boolean}
1267
+ * @memberof DataTypesGetStoreResult
1268
+ */
1269
+ 'IsActive'?: boolean;
1270
+ /**
1271
+ * Store location
1272
+ * @type {string}
1273
+ * @memberof DataTypesGetStoreResult
1274
+ */
1275
+ 'Location'?: string;
1276
+ /**
1277
+ * Timestamp for when the store was last modified
1278
+ * @type {string}
1279
+ * @memberof DataTypesGetStoreResult
1280
+ */
1281
+ 'ModifiedAt'?: string;
1282
+ /**
1283
+ * User ID of the last modifier, nullable
1284
+ * @type {number}
1285
+ * @memberof DataTypesGetStoreResult
1286
+ */
1287
+ 'ModifiedBy'?: number;
1288
+ /**
1289
+ * Foreign key to mOrganizations
1290
+ * @type {number}
1291
+ * @memberof DataTypesGetStoreResult
1292
+ */
1293
+ 'OrgID'?: number;
1294
+ /**
1295
+ * Primary key
1296
+ * @type {number}
1297
+ * @memberof DataTypesGetStoreResult
1298
+ */
1299
+ 'StoreID'?: number;
1300
+ /**
1301
+ * Store name
1302
+ * @type {string}
1303
+ * @memberof DataTypesGetStoreResult
1304
+ */
1305
+ 'StoreName'?: string;
1306
+ /**
1307
+ * Store alias
1308
+ * @type {string}
1309
+ * @memberof DataTypesGetStoreResult
1310
+ */
1311
+ 'alias'?: string;
1312
+ /**
1313
+ *
1314
+ * @type {string}
1315
+ * @memberof DataTypesGetStoreResult
1316
+ */
1317
+ 'index_name'?: string;
1318
+ /**
1319
+ *
1320
+ * @type {DataTypesIndexConfig}
1321
+ * @memberof DataTypesGetStoreResult
1322
+ */
1323
+ 'search_config'?: DataTypesIndexConfig;
1324
+ /**
1325
+ * Include in API responses
1326
+ * @type {string}
1327
+ * @memberof DataTypesGetStoreResult
1328
+ */
1329
+ 'xStoreID'?: string;
1330
+ /**
1331
+ * Include in API responses
1332
+ * @type {string}
1333
+ * @memberof DataTypesGetStoreResult
1334
+ */
1335
+ 'xStoreSecret'?: string;
1336
+ }
1104
1337
  /**
1105
1338
  *
1106
1339
  * @export
1107
1340
  * @interface DataTypesIndexConfig
1108
1341
  */
1109
1342
  export interface DataTypesIndexConfig {
1343
+ /**
1344
+ *
1345
+ * @type {string}
1346
+ * @memberof DataTypesIndexConfig
1347
+ */
1348
+ 'collection_alias'?: string;
1349
+ /**
1350
+ *
1351
+ * @type {string}
1352
+ * @memberof DataTypesIndexConfig
1353
+ */
1354
+ 'collection_name'?: string;
1355
+ /**
1356
+ *
1357
+ * @type {number}
1358
+ * @memberof DataTypesIndexConfig
1359
+ */
1360
+ 'drop_tokens_threshold'?: number;
1361
+ /**
1362
+ *
1363
+ * @type {string}
1364
+ * @memberof DataTypesIndexConfig
1365
+ */
1366
+ 'embed'?: string;
1367
+ /**
1368
+ *
1369
+ * @type {boolean}
1370
+ * @memberof DataTypesIndexConfig
1371
+ */
1372
+ 'enable_autocomplete'?: boolean;
1373
+ /**
1374
+ *
1375
+ * @type {boolean}
1376
+ * @memberof DataTypesIndexConfig
1377
+ */
1378
+ 'enable_highlight'?: boolean;
1379
+ /**
1380
+ *
1381
+ * @type {boolean}
1382
+ * @memberof DataTypesIndexConfig
1383
+ */
1384
+ 'enable_overrides'?: boolean;
1385
+ /**
1386
+ *
1387
+ * @type {boolean}
1388
+ * @memberof DataTypesIndexConfig
1389
+ */
1390
+ 'enable_smart_autocomplete'?: boolean;
1391
+ /**
1392
+ *
1393
+ * @type {boolean}
1394
+ * @memberof DataTypesIndexConfig
1395
+ */
1396
+ 'enable_typo_highlight'?: boolean;
1110
1397
  /**
1111
1398
  *
1112
1399
  * @type {boolean}
1113
1400
  * @memberof DataTypesIndexConfig
1114
1401
  */
1115
- 'allowTyposOnNumericTokens'?: boolean;
1402
+ 'enable_typo_tolerance'?: boolean;
1116
1403
  /**
1117
1404
  *
1118
1405
  * @type {Array<string>}
1119
1406
  * @memberof DataTypesIndexConfig
1120
1407
  */
1121
- 'alternativesAsExact'?: Array<string>;
1408
+ 'exclude_fields'?: Array<string>;
1409
+ /**
1410
+ *
1411
+ * @type {boolean}
1412
+ * @memberof DataTypesIndexConfig
1413
+ */
1414
+ 'exhaustive_search'?: boolean;
1415
+ /**
1416
+ *
1417
+ * @type {Array<string>}
1418
+ * @memberof DataTypesIndexConfig
1419
+ */
1420
+ 'facet_by'?: Array<string>;
1421
+ /**
1422
+ *
1423
+ * @type {string}
1424
+ * @memberof DataTypesIndexConfig
1425
+ */
1426
+ 'facet_query'?: string;
1427
+ /**
1428
+ *
1429
+ * @type {string}
1430
+ * @memberof DataTypesIndexConfig
1431
+ */
1432
+ 'filter_by'?: string;
1122
1433
  /**
1123
1434
  *
1124
1435
  * @type {string}
1125
1436
  * @memberof DataTypesIndexConfig
1126
1437
  */
1127
- 'attributeForDistinct'?: string;
1438
+ 'group_by'?: string;
1439
+ /**
1440
+ *
1441
+ * @type {number}
1442
+ * @memberof DataTypesIndexConfig
1443
+ */
1444
+ 'group_limit'?: number;
1128
1445
  /**
1129
1446
  *
1130
1447
  * @type {Array<string>}
1131
1448
  * @memberof DataTypesIndexConfig
1132
1449
  */
1133
- 'attributesForFaceting'?: Array<string>;
1450
+ 'hidden_facet_fields'?: Array<string>;
1134
1451
  /**
1135
1452
  *
1136
1453
  * @type {Array<string>}
1137
1454
  * @memberof DataTypesIndexConfig
1138
1455
  */
1139
- 'attributesToHighlight'?: Array<string>;
1456
+ 'hidden_fields'?: Array<string>;
1140
1457
  /**
1141
1458
  *
1142
1459
  * @type {Array<string>}
1143
1460
  * @memberof DataTypesIndexConfig
1144
1461
  */
1145
- 'attributesToRetrieve'?: Array<string>;
1462
+ 'hidden_filter_fields'?: Array<string>;
1463
+ /**
1464
+ *
1465
+ * @type {number}
1466
+ * @memberof DataTypesIndexConfig
1467
+ */
1468
+ 'highlight_affix_num_tokens'?: number;
1469
+ /**
1470
+ *
1471
+ * @type {string}
1472
+ * @memberof DataTypesIndexConfig
1473
+ */
1474
+ 'highlight_end_tag'?: string;
1146
1475
  /**
1147
1476
  *
1148
1477
  * @type {Array<string>}
1149
1478
  * @memberof DataTypesIndexConfig
1150
1479
  */
1151
- 'attributesToSnippet'?: Array<string>;
1480
+ 'highlight_fields'?: Array<string>;
1152
1481
  /**
1153
1482
  *
1154
1483
  * @type {Array<string>}
1155
1484
  * @memberof DataTypesIndexConfig
1156
1485
  */
1157
- 'customRanking'?: Array<string>;
1486
+ 'highlight_full_fields'?: Array<string>;
1158
1487
  /**
1159
1488
  *
1160
1489
  * @type {string}
1161
1490
  * @memberof DataTypesIndexConfig
1162
1491
  */
1163
- 'exactOnSingleWordQuery'?: string;
1492
+ 'highlight_start_tag'?: string;
1164
1493
  /**
1165
1494
  *
1166
- * @type {string}
1495
+ * @type {Array<string>}
1167
1496
  * @memberof DataTypesIndexConfig
1168
1497
  */
1169
- 'highlightPostTag'?: string;
1498
+ 'include_fields'?: Array<string>;
1170
1499
  /**
1171
1500
  *
1172
1501
  * @type {string}
1173
1502
  * @memberof DataTypesIndexConfig
1174
1503
  */
1175
- 'highlightPreTag'?: string;
1504
+ 'locale'?: string;
1176
1505
  /**
1177
1506
  *
1178
1507
  * @type {number}
1179
1508
  * @memberof DataTypesIndexConfig
1180
1509
  */
1181
- 'hitsPerPage'?: number;
1510
+ 'max_candidates'?: number;
1182
1511
  /**
1183
1512
  *
1184
1513
  * @type {number}
1185
1514
  * @memberof DataTypesIndexConfig
1186
1515
  */
1187
- 'indexingGeolocPrecision'?: number;
1516
+ 'max_facet_values'?: number;
1188
1517
  /**
1189
1518
  *
1190
1519
  * @type {number}
1191
1520
  * @memberof DataTypesIndexConfig
1192
1521
  */
1193
- 'maxNbHits'?: number;
1522
+ 'min_len_1typo'?: number;
1194
1523
  /**
1195
1524
  *
1196
1525
  * @type {number}
1197
1526
  * @memberof DataTypesIndexConfig
1198
1527
  */
1199
- 'maxValuesPerFacet'?: number;
1528
+ 'min_len_2typo'?: number;
1200
1529
  /**
1201
1530
  *
1202
1531
  * @type {number}
1203
1532
  * @memberof DataTypesIndexConfig
1204
1533
  */
1205
- 'minWordSizefor1Typo'?: number;
1534
+ 'num_typos'?: number;
1206
1535
  /**
1207
1536
  *
1208
1537
  * @type {number}
1209
1538
  * @memberof DataTypesIndexConfig
1210
1539
  */
1211
- 'minWordSizefor2Typos'?: number;
1540
+ 'page'?: number;
1212
1541
  /**
1213
1542
  *
1214
1543
  * @type {number}
1215
1544
  * @memberof DataTypesIndexConfig
1216
1545
  */
1217
- 'nbShardsAuto'?: number;
1546
+ 'per_page'?: number;
1218
1547
  /**
1219
1548
  *
1220
- * @type {Array<string>}
1549
+ * @type {string}
1221
1550
  * @memberof DataTypesIndexConfig
1222
1551
  */
1223
- 'numericAttributesToIndex'?: Array<string>;
1552
+ 'prefix'?: string;
1224
1553
  /**
1225
1554
  *
1226
- * @type {Array<string>}
1555
+ * @type {string}
1227
1556
  * @memberof DataTypesIndexConfig
1228
1557
  */
1229
- 'optionalWords'?: Array<string>;
1558
+ 'preset'?: string;
1230
1559
  /**
1231
1560
  *
1232
- * @type {number}
1561
+ * @type {boolean}
1233
1562
  * @memberof DataTypesIndexConfig
1234
1563
  */
1235
- 'paginationLimitedTo'?: number;
1564
+ 'prioritize_exact_match'?: boolean;
1236
1565
  /**
1237
- *
1566
+ * Required: Query string
1238
1567
  * @type {string}
1239
1568
  * @memberof DataTypesIndexConfig
1240
1569
  */
1241
- 'primary'?: string;
1570
+ 'q'?: string;
1571
+ /**
1572
+ * Required: Array of search fields
1573
+ * @type {Array<string>}
1574
+ * @memberof DataTypesIndexConfig
1575
+ */
1576
+ 'query_by'?: Array<string>;
1577
+ /**
1578
+ * Optional: Relative field weights as array
1579
+ * @type {Array<number>}
1580
+ * @memberof DataTypesIndexConfig
1581
+ */
1582
+ 'query_by_weights'?: Array<number>;
1242
1583
  /**
1243
1584
  *
1585
+ * @type {boolean}
1586
+ * @memberof DataTypesIndexConfig
1587
+ */
1588
+ 'query_syntax'?: boolean;
1589
+ /**
1590
+ *
1591
+ * @type {number}
1592
+ * @memberof DataTypesIndexConfig
1593
+ */
1594
+ 'search_cutoff_ms'?: number;
1595
+ /**
1596
+ * \"text\", \"vector\", \"hybrid\"
1244
1597
  * @type {string}
1245
1598
  * @memberof DataTypesIndexConfig
1246
1599
  */
1247
- 'queryType'?: string;
1600
+ 'search_strategy'?: string;
1248
1601
  /**
1249
1602
  *
1250
- * @type {Array<string>}
1603
+ * @type {boolean}
1251
1604
  * @memberof DataTypesIndexConfig
1252
1605
  */
1253
- 'ranking'?: Array<string>;
1606
+ 'semantic_ranker'?: boolean;
1254
1607
  /**
1255
1608
  *
1256
- * @type {string}
1609
+ * @type {number}
1257
1610
  * @memberof DataTypesIndexConfig
1258
1611
  */
1259
- 'removeWordsIfNoResults'?: string;
1612
+ 'snippet_threshold'?: number;
1260
1613
  /**
1261
1614
  *
1262
- * @type {Array<string>}
1615
+ * @type {Array<DataTypesSortField>}
1263
1616
  * @memberof DataTypesIndexConfig
1264
1617
  */
1265
- 'searchableAttributes'?: Array<string>;
1618
+ 'sort_by'?: Array<DataTypesSortField>;
1266
1619
  /**
1267
- *
1620
+ * Optional: Search-only scoped API key
1268
1621
  * @type {string}
1269
1622
  * @memberof DataTypesIndexConfig
1270
1623
  */
1271
- 'separatorsToIndex'?: string;
1624
+ 'token'?: string;
1272
1625
  /**
1273
1626
  *
1274
- * @type {Array<string>}
1627
+ * @type {boolean}
1275
1628
  * @memberof DataTypesIndexConfig
1276
1629
  */
1277
- 'unretrievableAttributes'?: Array<string>;
1630
+ 'use_cache'?: boolean;
1278
1631
  /**
1279
1632
  *
1280
- * @type {number}
1633
+ * @type {string}
1281
1634
  * @memberof DataTypesIndexConfig
1282
1635
  */
1283
- 'version'?: number;
1636
+ 'vector_query'?: string;
1284
1637
  }
1285
1638
  /**
1286
1639
  *
1287
1640
  * @export
1288
- * @interface DataTypesIndexConfigResponse
1641
+ * @interface DataTypesIndexConfigResponseWrapper
1289
1642
  */
1290
- export interface DataTypesIndexConfigResponse {
1643
+ export interface DataTypesIndexConfigResponseWrapper {
1291
1644
  /**
1292
1645
  *
1293
1646
  * @type {DataTypesIndexConfig}
1294
- * @memberof DataTypesIndexConfigResponse
1647
+ * @memberof DataTypesIndexConfigResponseWrapper
1295
1648
  */
1296
1649
  'data'?: DataTypesIndexConfig;
1297
1650
  /**
1298
1651
  *
1299
1652
  * @type {string}
1300
- * @memberof DataTypesIndexConfigResponse
1653
+ * @memberof DataTypesIndexConfigResponseWrapper
1301
1654
  */
1302
1655
  'message'?: string;
1303
1656
  /**
1304
1657
  *
1305
1658
  * @type {number}
1306
- * @memberof DataTypesIndexConfigResponse
1659
+ * @memberof DataTypesIndexConfigResponseWrapper
1307
1660
  */
1308
1661
  'status'?: number;
1309
1662
  }
1663
+ /**
1664
+ *
1665
+ * @export
1666
+ * @interface DataTypesIndexField
1667
+ */
1668
+ export interface DataTypesIndexField {
1669
+ /**
1670
+ *
1671
+ * @type {boolean}
1672
+ * @memberof DataTypesIndexField
1673
+ */
1674
+ 'facet'?: boolean;
1675
+ /**
1676
+ *
1677
+ * @type {boolean}
1678
+ * @memberof DataTypesIndexField
1679
+ */
1680
+ 'index'?: boolean;
1681
+ /**
1682
+ *
1683
+ * @type {string}
1684
+ * @memberof DataTypesIndexField
1685
+ */
1686
+ 'name'?: string;
1687
+ /**
1688
+ *
1689
+ * @type {boolean}
1690
+ * @memberof DataTypesIndexField
1691
+ */
1692
+ 'optional'?: boolean;
1693
+ /**
1694
+ *
1695
+ * @type {boolean}
1696
+ * @memberof DataTypesIndexField
1697
+ */
1698
+ 'sort'?: boolean;
1699
+ /**
1700
+ *
1701
+ * @type {string}
1702
+ * @memberof DataTypesIndexField
1703
+ */
1704
+ 'type'?: string;
1705
+ }
1310
1706
  /**
1311
1707
  *
1312
1708
  * @export
@@ -3402,109 +3798,120 @@ export interface DataTypesSampleDatasetsResponseWrapper {
3402
3798
  /**
3403
3799
  *
3404
3800
  * @export
3405
- * @interface DataTypesSchemaOptionsResponse
3801
+ * @interface DataTypesSchemaBasedDefaults
3406
3802
  */
3407
- export interface DataTypesSchemaOptionsResponse {
3803
+ export interface DataTypesSchemaBasedDefaults {
3408
3804
  /**
3409
3805
  *
3410
3806
  * @type {Array<string>}
3411
- * @memberof DataTypesSchemaOptionsResponse
3807
+ * @memberof DataTypesSchemaBasedDefaults
3412
3808
  */
3413
- 'displayAttributesOptions'?: Array<string>;
3809
+ 'all_fields'?: Array<string>;
3414
3810
  /**
3415
3811
  *
3416
3812
  * @type {Array<string>}
3417
- * @memberof DataTypesSchemaOptionsResponse
3813
+ * @memberof DataTypesSchemaBasedDefaults
3418
3814
  */
3419
- 'relevancyOrderOptions'?: Array<string>;
3815
+ 'facetable_fields'?: Array<string>;
3420
3816
  /**
3421
3817
  *
3422
3818
  * @type {Array<string>}
3423
- * @memberof DataTypesSchemaOptionsResponse
3819
+ * @memberof DataTypesSchemaBasedDefaults
3424
3820
  */
3425
- 'searchableAttributesOptions'?: Array<string>;
3821
+ 'highlightable_fields'?: Array<string>;
3822
+ /**
3823
+ *
3824
+ * @type {Array<string>}
3825
+ * @memberof DataTypesSchemaBasedDefaults
3826
+ */
3827
+ 'include_fields'?: Array<string>;
3828
+ /**
3829
+ *
3830
+ * @type {Array<string>}
3831
+ * @memberof DataTypesSchemaBasedDefaults
3832
+ */
3833
+ 'query_by'?: Array<string>;
3834
+ /**
3835
+ *
3836
+ * @type {Array<DataTypesSortField>}
3837
+ * @memberof DataTypesSchemaBasedDefaults
3838
+ */
3839
+ 'sortable_fields'?: Array<DataTypesSortField>;
3426
3840
  }
3427
3841
  /**
3428
3842
  *
3429
3843
  * @export
3430
- * @interface DataTypesSchemaOptionsResponseWrapper
3844
+ * @interface DataTypesSchemaBasedDefaultsResponseWrapper
3431
3845
  */
3432
- export interface DataTypesSchemaOptionsResponseWrapper {
3846
+ export interface DataTypesSchemaBasedDefaultsResponseWrapper {
3433
3847
  /**
3434
3848
  *
3435
- * @type {DataTypesSchemaOptionsResponse}
3436
- * @memberof DataTypesSchemaOptionsResponseWrapper
3849
+ * @type {DataTypesSchemaBasedDefaults}
3850
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3437
3851
  */
3438
- 'data'?: DataTypesSchemaOptionsResponse;
3852
+ 'data'?: DataTypesSchemaBasedDefaults;
3439
3853
  /**
3440
3854
  *
3441
3855
  * @type {string}
3442
- * @memberof DataTypesSchemaOptionsResponseWrapper
3856
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3443
3857
  */
3444
3858
  'message'?: string;
3445
3859
  /**
3446
3860
  *
3447
3861
  * @type {number}
3448
- * @memberof DataTypesSchemaOptionsResponseWrapper
3862
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3449
3863
  */
3450
3864
  'status'?: number;
3451
3865
  }
3452
3866
  /**
3453
3867
  *
3454
3868
  * @export
3455
- * @interface DataTypesSearchConfig
3869
+ * @interface DataTypesSchemaOptionsResponse
3456
3870
  */
3457
- export interface DataTypesSearchConfig {
3871
+ export interface DataTypesSchemaOptionsResponse {
3458
3872
  /**
3459
3873
  *
3460
3874
  * @type {Array<string>}
3461
- * @memberof DataTypesSearchConfig
3875
+ * @memberof DataTypesSchemaOptionsResponse
3462
3876
  */
3463
- 'attributesToHighlight'?: Array<string>;
3877
+ 'displayAttributesOptions'?: Array<string>;
3464
3878
  /**
3465
3879
  *
3466
3880
  * @type {Array<string>}
3467
- * @memberof DataTypesSearchConfig
3468
- */
3469
- 'attributesToRetrieve'?: Array<string>;
3470
- /**
3471
- *
3472
- * @type {{ [key: string]: any; }}
3473
- * @memberof DataTypesSearchConfig
3881
+ * @memberof DataTypesSchemaOptionsResponse
3474
3882
  */
3475
- 'displayAttributes'?: {
3476
- [key: string]: any;
3477
- };
3883
+ 'relevancyOrderOptions'?: Array<string>;
3478
3884
  /**
3479
3885
  *
3480
- * @type {number}
3481
- * @memberof DataTypesSearchConfig
3886
+ * @type {Array<string>}
3887
+ * @memberof DataTypesSchemaOptionsResponse
3482
3888
  */
3483
- 'hitsPerPage'?: number;
3889
+ 'searchableAttributesOptions'?: Array<string>;
3890
+ }
3891
+ /**
3892
+ *
3893
+ * @export
3894
+ * @interface DataTypesSchemaOptionsResponseWrapper
3895
+ */
3896
+ export interface DataTypesSchemaOptionsResponseWrapper {
3484
3897
  /**
3485
3898
  *
3486
- * @type {number}
3487
- * @memberof DataTypesSearchConfig
3899
+ * @type {DataTypesSchemaOptionsResponse}
3900
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3488
3901
  */
3489
- 'maxNbHits'?: number;
3902
+ 'data'?: DataTypesSchemaOptionsResponse;
3490
3903
  /**
3491
3904
  *
3492
3905
  * @type {string}
3493
- * @memberof DataTypesSearchConfig
3494
- */
3495
- 'query_by'?: string;
3496
- /**
3497
- *
3498
- * @type {Array<string>}
3499
- * @memberof DataTypesSearchConfig
3906
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3500
3907
  */
3501
- 'ranking'?: Array<string>;
3908
+ 'message'?: string;
3502
3909
  /**
3503
3910
  *
3504
- * @type {Array<string>}
3505
- * @memberof DataTypesSearchConfig
3911
+ * @type {number}
3912
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3506
3913
  */
3507
- 'searchableAttributes'?: Array<string>;
3914
+ 'status'?: number;
3508
3915
  }
3509
3916
  /**
3510
3917
  *
@@ -3758,6 +4165,25 @@ export interface DataTypesServiceRequestsListResponse {
3758
4165
  */
3759
4166
  'status'?: number;
3760
4167
  }
4168
+ /**
4169
+ *
4170
+ * @export
4171
+ * @interface DataTypesSortField
4172
+ */
4173
+ export interface DataTypesSortField {
4174
+ /**
4175
+ * \"asc\" or \"desc\"
4176
+ * @type {string}
4177
+ * @memberof DataTypesSortField
4178
+ */
4179
+ 'direction'?: string;
4180
+ /**
4181
+ *
4182
+ * @type {string}
4183
+ * @memberof DataTypesSortField
4184
+ */
4185
+ 'field'?: string;
4186
+ }
3761
4187
  /**
3762
4188
  *
3763
4189
  * @export
@@ -3940,6 +4366,12 @@ export interface DataTypesStore {
3940
4366
  * @memberof DataTypesStore
3941
4367
  */
3942
4368
  'alias'?: string;
4369
+ /**
4370
+ * Include in API responses
4371
+ * @type {string}
4372
+ * @memberof DataTypesStore
4373
+ */
4374
+ 'xStoreID'?: string;
3943
4375
  }
3944
4376
  /**
3945
4377
  *
@@ -4018,10 +4450,10 @@ export interface DataTypesStoreRequestDto {
4018
4450
  export interface DataTypesStoreResponse {
4019
4451
  /**
4020
4452
  *
4021
- * @type {DataTypesStore}
4453
+ * @type {DataTypesGetStoreResult}
4022
4454
  * @memberof DataTypesStoreResponse
4023
4455
  */
4024
- 'data'?: DataTypesStore;
4456
+ 'data'?: DataTypesGetStoreResult;
4025
4457
  /**
4026
4458
  *
4027
4459
  * @type {string}
@@ -9200,13 +9632,20 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
9200
9632
  /**
9201
9633
  * Search documents with optional configuration override and autocomplete suggestions
9202
9634
  * @summary Admin Search API
9203
- * @param {string} xStoreID Store ID for the selected store
9204
- * @param {string} xStoreSecret Store Secret for the selected store
9635
+ * @param {string} xStoreID X-Store ID
9205
9636
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9206
9637
  * @param {*} [options] Override http request option.
9207
9638
  * @throws {RequiredError}
9208
9639
  */
9209
- adminV1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9640
+ adminV1SearchXStoreIDPost: (xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9641
+ /**
9642
+ * Get metadata about all configurable fields for dynamic form generation
9643
+ * @summary Get Configuration Schema
9644
+ * @param {string} [indexname] Index name to get field options from
9645
+ * @param {*} [options] Override http request option.
9646
+ * @throws {RequiredError}
9647
+ */
9648
+ v1IndexConfigSchemaGet: (indexname?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9210
9649
  /**
9211
9650
  * Get the current index configuration
9212
9651
  * @summary Get Index Config
@@ -9234,16 +9673,24 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
9234
9673
  * @throws {RequiredError}
9235
9674
  */
9236
9675
  v1IndexIndexnameConfigPropertyPatch: (indexname: string, property: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9676
+ /**
9677
+ * Get default configuration values computed from the Typesense schema
9678
+ * @summary Get Schema-Based Defaults
9679
+ * @param {string} indexname Index Name
9680
+ * @param {*} [options] Override http request option.
9681
+ * @throws {RequiredError}
9682
+ */
9683
+ v1IndexIndexnameDefaultsGet: (indexname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9237
9684
  /**
9238
9685
  * Search documents using store credentials with optional autocomplete suggestions
9239
9686
  * @summary Public Search API
9240
- * @param {string} xStoreID Store ID
9241
- * @param {string} xStoreSecret Store Secret
9687
+ * @param {string} xStoreid Store ID
9688
+ * @param {string} xStoresecret Store Secret
9242
9689
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9243
9690
  * @param {*} [options] Override http request option.
9244
9691
  * @throws {RequiredError}
9245
9692
  */
9246
- v1SearchPost: (xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9693
+ v1SearchPost: (xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9247
9694
  };
9248
9695
  /**
9249
9696
  * SearchApi - functional programming interface
@@ -9253,13 +9700,20 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9253
9700
  /**
9254
9701
  * Search documents with optional configuration override and autocomplete suggestions
9255
9702
  * @summary Admin Search API
9256
- * @param {string} xStoreID Store ID for the selected store
9257
- * @param {string} xStoreSecret Store Secret for the selected store
9703
+ * @param {string} xStoreID X-Store ID
9258
9704
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9259
9705
  * @param {*} [options] Override http request option.
9260
9706
  * @throws {RequiredError}
9261
9707
  */
9262
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9708
+ adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9709
+ /**
9710
+ * Get metadata about all configurable fields for dynamic form generation
9711
+ * @summary Get Configuration Schema
9712
+ * @param {string} [indexname] Index name to get field options from
9713
+ * @param {*} [options] Override http request option.
9714
+ * @throws {RequiredError}
9715
+ */
9716
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
9263
9717
  /**
9264
9718
  * Get the current index configuration
9265
9719
  * @summary Get Index Config
@@ -9267,7 +9721,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9267
9721
  * @param {*} [options] Override http request option.
9268
9722
  * @throws {RequiredError}
9269
9723
  */
9270
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponse>>;
9724
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
9271
9725
  /**
9272
9726
  * Configure the index for search
9273
9727
  * @summary Index Config
@@ -9287,16 +9741,24 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
9287
9741
  * @throws {RequiredError}
9288
9742
  */
9289
9743
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
9744
+ /**
9745
+ * Get default configuration values computed from the Typesense schema
9746
+ * @summary Get Schema-Based Defaults
9747
+ * @param {string} indexname Index Name
9748
+ * @param {*} [options] Override http request option.
9749
+ * @throws {RequiredError}
9750
+ */
9751
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
9290
9752
  /**
9291
9753
  * Search documents using store credentials with optional autocomplete suggestions
9292
9754
  * @summary Public Search API
9293
- * @param {string} xStoreID Store ID
9294
- * @param {string} xStoreSecret Store Secret
9755
+ * @param {string} xStoreid Store ID
9756
+ * @param {string} xStoresecret Store Secret
9295
9757
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9296
9758
  * @param {*} [options] Override http request option.
9297
9759
  * @throws {RequiredError}
9298
9760
  */
9299
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9761
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>>;
9300
9762
  };
9301
9763
  /**
9302
9764
  * SearchApi - factory interface
@@ -9306,13 +9768,20 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9306
9768
  /**
9307
9769
  * Search documents with optional configuration override and autocomplete suggestions
9308
9770
  * @summary Admin Search API
9309
- * @param {string} xStoreID Store ID for the selected store
9310
- * @param {string} xStoreSecret Store Secret for the selected store
9771
+ * @param {string} xStoreID X-Store ID
9311
9772
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9312
9773
  * @param {*} [options] Override http request option.
9313
9774
  * @throws {RequiredError}
9314
9775
  */
9315
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9776
+ adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9777
+ /**
9778
+ * Get metadata about all configurable fields for dynamic form generation
9779
+ * @summary Get Configuration Schema
9780
+ * @param {string} [indexname] Index name to get field options from
9781
+ * @param {*} [options] Override http request option.
9782
+ * @throws {RequiredError}
9783
+ */
9784
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
9316
9785
  /**
9317
9786
  * Get the current index configuration
9318
9787
  * @summary Get Index Config
@@ -9320,7 +9789,7 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9320
9789
  * @param {*} [options] Override http request option.
9321
9790
  * @throws {RequiredError}
9322
9791
  */
9323
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponse>;
9792
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
9324
9793
  /**
9325
9794
  * Configure the index for search
9326
9795
  * @summary Index Config
@@ -9340,16 +9809,24 @@ export declare const SearchApiFactory: (configuration?: Configuration, basePath?
9340
9809
  * @throws {RequiredError}
9341
9810
  */
9342
9811
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
9812
+ /**
9813
+ * Get default configuration values computed from the Typesense schema
9814
+ * @summary Get Schema-Based Defaults
9815
+ * @param {string} indexname Index Name
9816
+ * @param {*} [options] Override http request option.
9817
+ * @throws {RequiredError}
9818
+ */
9819
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
9343
9820
  /**
9344
9821
  * Search documents using store credentials with optional autocomplete suggestions
9345
9822
  * @summary Public Search API
9346
- * @param {string} xStoreID Store ID
9347
- * @param {string} xStoreSecret Store Secret
9823
+ * @param {string} xStoreid Store ID
9824
+ * @param {string} xStoresecret Store Secret
9348
9825
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9349
9826
  * @param {*} [options] Override http request option.
9350
9827
  * @throws {RequiredError}
9351
9828
  */
9352
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9829
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper>;
9353
9830
  };
9354
9831
  /**
9355
9832
  * SearchApi - object-oriented interface
@@ -9361,14 +9838,22 @@ export declare class SearchApi extends BaseAPI {
9361
9838
  /**
9362
9839
  * Search documents with optional configuration override and autocomplete suggestions
9363
9840
  * @summary Admin Search API
9364
- * @param {string} xStoreID Store ID for the selected store
9365
- * @param {string} xStoreSecret Store Secret for the selected store
9841
+ * @param {string} xStoreID X-Store ID
9366
9842
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
9367
9843
  * @param {*} [options] Override http request option.
9368
9844
  * @throws {RequiredError}
9369
9845
  * @memberof SearchApi
9370
9846
  */
9371
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9847
+ adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9848
+ /**
9849
+ * Get metadata about all configurable fields for dynamic form generation
9850
+ * @summary Get Configuration Schema
9851
+ * @param {string} [indexname] Index name to get field options from
9852
+ * @param {*} [options] Override http request option.
9853
+ * @throws {RequiredError}
9854
+ * @memberof SearchApi
9855
+ */
9856
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any>>;
9372
9857
  /**
9373
9858
  * Get the current index configuration
9374
9859
  * @summary Get Index Config
@@ -9377,7 +9862,7 @@ export declare class SearchApi extends BaseAPI {
9377
9862
  * @throws {RequiredError}
9378
9863
  * @memberof SearchApi
9379
9864
  */
9380
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponse, any>>;
9865
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any>>;
9381
9866
  /**
9382
9867
  * Configure the index for search
9383
9868
  * @summary Index Config
@@ -9399,23 +9884,39 @@ export declare class SearchApi extends BaseAPI {
9399
9884
  * @memberof SearchApi
9400
9885
  */
9401
9886
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
9887
+ /**
9888
+ * Get default configuration values computed from the Typesense schema
9889
+ * @summary Get Schema-Based Defaults
9890
+ * @param {string} indexname Index Name
9891
+ * @param {*} [options] Override http request option.
9892
+ * @throws {RequiredError}
9893
+ * @memberof SearchApi
9894
+ */
9895
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any>>;
9402
9896
  /**
9403
9897
  * Search documents using store credentials with optional autocomplete suggestions
9404
9898
  * @summary Public Search API
9405
- * @param {string} xStoreID Store ID
9406
- * @param {string} xStoreSecret Store Secret
9899
+ * @param {string} xStoreid Store ID
9900
+ * @param {string} xStoresecret Store Secret
9407
9901
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
9408
9902
  * @param {*} [options] Override http request option.
9409
9903
  * @throws {RequiredError}
9410
9904
  * @memberof SearchApi
9411
9905
  */
9412
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9906
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesOfficialSearchResponseWrapper, any>>;
9413
9907
  }
9414
9908
  /**
9415
9909
  * StoresApi - axios parameter creator
9416
9910
  * @export
9417
9911
  */
9418
9912
  export declare const StoresApiAxiosParamCreator: (configuration?: Configuration) => {
9913
+ /**
9914
+ * Fetches list of all stores for the authenticated user\'s organization
9915
+ * @summary Fetches list of all stores
9916
+ * @param {*} [options] Override http request option.
9917
+ * @throws {RequiredError}
9918
+ */
9919
+ adminStoresGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9419
9920
  /**
9420
9921
  * Fetches stores by id
9421
9922
  * @summary Fetches stores by id
@@ -9425,13 +9926,13 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
9425
9926
  */
9426
9927
  adminStoresGetStoreStoreIDGet: (storeID: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9427
9928
  /**
9428
- * Fetches list of all stores
9429
- * @summary Fetches list of all stores
9430
- * @param {number} orgId Org ID
9929
+ * Fetches stores by xStoreID
9930
+ * @summary Fetches stores by xStoreID
9931
+ * @param {string} xStoreID X-Store ID
9431
9932
  * @param {*} [options] Override http request option.
9432
9933
  * @throws {RequiredError}
9433
9934
  */
9434
- adminStoresOrgIdGet: (orgId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9935
+ adminStoresGetStoreXStoreIDGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9435
9936
  /**
9436
9937
  * Adds a new store to the system
9437
9938
  * @summary Creates a new store
@@ -9458,12 +9959,52 @@ export declare const StoresApiAxiosParamCreator: (configuration?: Configuration)
9458
9959
  * @throws {RequiredError}
9459
9960
  */
9460
9961
  adminStoresUpdateStatusIdStatusPut: (id: number, status: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9962
+ /**
9963
+ * Retrieves the store configuration using x-store ID
9964
+ * @summary Get Store Config
9965
+ * @param {string} xStoreID X-Store ID
9966
+ * @param {*} [options] Override http request option.
9967
+ * @throws {RequiredError}
9968
+ */
9969
+ adminStoresXStoreIDConfigGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9970
+ /**
9971
+ * Updates the store configuration using x-store ID
9972
+ * @summary Update Store Config
9973
+ * @param {string} xStoreID X-Store ID
9974
+ * @param {DataTypesIndexConfig} body Store configuration
9975
+ * @param {*} [options] Override http request option.
9976
+ * @throws {RequiredError}
9977
+ */
9978
+ adminStoresXStoreIDConfigPut: (xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9979
+ /**
9980
+ * Get metadata about all configurable fields for store configuration using x-store ID
9981
+ * @summary Get Store Config Schema
9982
+ * @param {string} xStoreID X-Store ID to get field options from
9983
+ * @param {*} [options] Override http request option.
9984
+ * @throws {RequiredError}
9985
+ */
9986
+ adminStoresXStoreIDConfigSchemaGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9987
+ /**
9988
+ * Get default configuration values computed from the store\'s index schema using x-store ID
9989
+ * @summary Get Store Schema-Based Defaults
9990
+ * @param {string} xStoreID X-Store ID
9991
+ * @param {*} [options] Override http request option.
9992
+ * @throws {RequiredError}
9993
+ */
9994
+ adminStoresXStoreIDDefaultsGet: (xStoreID: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9461
9995
  };
9462
9996
  /**
9463
9997
  * StoresApi - functional programming interface
9464
9998
  * @export
9465
9999
  */
9466
10000
  export declare const StoresApiFp: (configuration?: Configuration) => {
10001
+ /**
10002
+ * Fetches list of all stores for the authenticated user\'s organization
10003
+ * @summary Fetches list of all stores
10004
+ * @param {*} [options] Override http request option.
10005
+ * @throws {RequiredError}
10006
+ */
10007
+ adminStoresGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoresListResponse>>;
9467
10008
  /**
9468
10009
  * Fetches stores by id
9469
10010
  * @summary Fetches stores by id
@@ -9473,13 +10014,13 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
9473
10014
  */
9474
10015
  adminStoresGetStoreStoreIDGet(storeID: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreResponse>>;
9475
10016
  /**
9476
- * Fetches list of all stores
9477
- * @summary Fetches list of all stores
9478
- * @param {number} orgId Org ID
10017
+ * Fetches stores by xStoreID
10018
+ * @summary Fetches stores by xStoreID
10019
+ * @param {string} xStoreID X-Store ID
9479
10020
  * @param {*} [options] Override http request option.
9480
10021
  * @throws {RequiredError}
9481
10022
  */
9482
- adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoresListResponse>>;
10023
+ adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreResponse>>;
9483
10024
  /**
9484
10025
  * Adds a new store to the system
9485
10026
  * @summary Creates a new store
@@ -9506,12 +10047,52 @@ export declare const StoresApiFp: (configuration?: Configuration) => {
9506
10047
  * @throws {RequiredError}
9507
10048
  */
9508
10049
  adminStoresUpdateStatusIdStatusPut(id: number, status: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesResponse>>;
10050
+ /**
10051
+ * Retrieves the store configuration using x-store ID
10052
+ * @summary Get Store Config
10053
+ * @param {string} xStoreID X-Store ID
10054
+ * @param {*} [options] Override http request option.
10055
+ * @throws {RequiredError}
10056
+ */
10057
+ adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
10058
+ /**
10059
+ * Updates the store configuration using x-store ID
10060
+ * @summary Update Store Config
10061
+ * @param {string} xStoreID X-Store ID
10062
+ * @param {DataTypesIndexConfig} body Store configuration
10063
+ * @param {*} [options] Override http request option.
10064
+ * @throws {RequiredError}
10065
+ */
10066
+ adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>>;
10067
+ /**
10068
+ * Get metadata about all configurable fields for store configuration using x-store ID
10069
+ * @summary Get Store Config Schema
10070
+ * @param {string} xStoreID X-Store ID to get field options from
10071
+ * @param {*} [options] Override http request option.
10072
+ * @throws {RequiredError}
10073
+ */
10074
+ adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>>;
10075
+ /**
10076
+ * Get default configuration values computed from the store\'s index schema using x-store ID
10077
+ * @summary Get Store Schema-Based Defaults
10078
+ * @param {string} xStoreID X-Store ID
10079
+ * @param {*} [options] Override http request option.
10080
+ * @throws {RequiredError}
10081
+ */
10082
+ adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>>;
9509
10083
  };
9510
10084
  /**
9511
10085
  * StoresApi - factory interface
9512
10086
  * @export
9513
10087
  */
9514
10088
  export declare const StoresApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10089
+ /**
10090
+ * Fetches list of all stores for the authenticated user\'s organization
10091
+ * @summary Fetches list of all stores
10092
+ * @param {*} [options] Override http request option.
10093
+ * @throws {RequiredError}
10094
+ */
10095
+ adminStoresGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoresListResponse>;
9515
10096
  /**
9516
10097
  * Fetches stores by id
9517
10098
  * @summary Fetches stores by id
@@ -9521,13 +10102,13 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
9521
10102
  */
9522
10103
  adminStoresGetStoreStoreIDGet(storeID: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreResponse>;
9523
10104
  /**
9524
- * Fetches list of all stores
9525
- * @summary Fetches list of all stores
9526
- * @param {number} orgId Org ID
10105
+ * Fetches stores by xStoreID
10106
+ * @summary Fetches stores by xStoreID
10107
+ * @param {string} xStoreID X-Store ID
9527
10108
  * @param {*} [options] Override http request option.
9528
10109
  * @throws {RequiredError}
9529
10110
  */
9530
- adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoresListResponse>;
10111
+ adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreResponse>;
9531
10112
  /**
9532
10113
  * Adds a new store to the system
9533
10114
  * @summary Creates a new store
@@ -9554,6 +10135,39 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
9554
10135
  * @throws {RequiredError}
9555
10136
  */
9556
10137
  adminStoresUpdateStatusIdStatusPut(id: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse>;
10138
+ /**
10139
+ * Retrieves the store configuration using x-store ID
10140
+ * @summary Get Store Config
10141
+ * @param {string} xStoreID X-Store ID
10142
+ * @param {*} [options] Override http request option.
10143
+ * @throws {RequiredError}
10144
+ */
10145
+ adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
10146
+ /**
10147
+ * Updates the store configuration using x-store ID
10148
+ * @summary Update Store Config
10149
+ * @param {string} xStoreID X-Store ID
10150
+ * @param {DataTypesIndexConfig} body Store configuration
10151
+ * @param {*} [options] Override http request option.
10152
+ * @throws {RequiredError}
10153
+ */
10154
+ adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper>;
10155
+ /**
10156
+ * Get metadata about all configurable fields for store configuration using x-store ID
10157
+ * @summary Get Store Config Schema
10158
+ * @param {string} xStoreID X-Store ID to get field options from
10159
+ * @param {*} [options] Override http request option.
10160
+ * @throws {RequiredError}
10161
+ */
10162
+ adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>;
10163
+ /**
10164
+ * Get default configuration values computed from the store\'s index schema using x-store ID
10165
+ * @summary Get Store Schema-Based Defaults
10166
+ * @param {string} xStoreID X-Store ID
10167
+ * @param {*} [options] Override http request option.
10168
+ * @throws {RequiredError}
10169
+ */
10170
+ adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>;
9557
10171
  };
9558
10172
  /**
9559
10173
  * StoresApi - object-oriented interface
@@ -9562,6 +10176,14 @@ export declare const StoresApiFactory: (configuration?: Configuration, basePath?
9562
10176
  * @extends {BaseAPI}
9563
10177
  */
9564
10178
  export declare class StoresApi extends BaseAPI {
10179
+ /**
10180
+ * Fetches list of all stores for the authenticated user\'s organization
10181
+ * @summary Fetches list of all stores
10182
+ * @param {*} [options] Override http request option.
10183
+ * @throws {RequiredError}
10184
+ * @memberof StoresApi
10185
+ */
10186
+ adminStoresGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoresListResponse, any>>;
9565
10187
  /**
9566
10188
  * Fetches stores by id
9567
10189
  * @summary Fetches stores by id
@@ -9572,14 +10194,14 @@ export declare class StoresApi extends BaseAPI {
9572
10194
  */
9573
10195
  adminStoresGetStoreStoreIDGet(storeID: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreResponse, any>>;
9574
10196
  /**
9575
- * Fetches list of all stores
9576
- * @summary Fetches list of all stores
9577
- * @param {number} orgId Org ID
10197
+ * Fetches stores by xStoreID
10198
+ * @summary Fetches stores by xStoreID
10199
+ * @param {string} xStoreID X-Store ID
9578
10200
  * @param {*} [options] Override http request option.
9579
10201
  * @throws {RequiredError}
9580
10202
  * @memberof StoresApi
9581
10203
  */
9582
- adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoresListResponse, any>>;
10204
+ adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesStoreResponse, any>>;
9583
10205
  /**
9584
10206
  * Adds a new store to the system
9585
10207
  * @summary Creates a new store
@@ -9609,6 +10231,43 @@ export declare class StoresApi extends BaseAPI {
9609
10231
  * @memberof StoresApi
9610
10232
  */
9611
10233
  adminStoresUpdateStatusIdStatusPut(id: number, status: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesResponse, any>>;
10234
+ /**
10235
+ * Retrieves the store configuration using x-store ID
10236
+ * @summary Get Store Config
10237
+ * @param {string} xStoreID X-Store ID
10238
+ * @param {*} [options] Override http request option.
10239
+ * @throws {RequiredError}
10240
+ * @memberof StoresApi
10241
+ */
10242
+ adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any>>;
10243
+ /**
10244
+ * Updates the store configuration using x-store ID
10245
+ * @summary Update Store Config
10246
+ * @param {string} xStoreID X-Store ID
10247
+ * @param {DataTypesIndexConfig} body Store configuration
10248
+ * @param {*} [options] Override http request option.
10249
+ * @throws {RequiredError}
10250
+ * @memberof StoresApi
10251
+ */
10252
+ adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesIndexConfigResponseWrapper, any>>;
10253
+ /**
10254
+ * Get metadata about all configurable fields for store configuration using x-store ID
10255
+ * @summary Get Store Config Schema
10256
+ * @param {string} xStoreID X-Store ID to get field options from
10257
+ * @param {*} [options] Override http request option.
10258
+ * @throws {RequiredError}
10259
+ * @memberof StoresApi
10260
+ */
10261
+ adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesConfigurationSchemaResponseWrapper, any>>;
10262
+ /**
10263
+ * Get default configuration values computed from the store\'s index schema using x-store ID
10264
+ * @summary Get Store Schema-Based Defaults
10265
+ * @param {string} xStoreID X-Store ID
10266
+ * @param {*} [options] Override http request option.
10267
+ * @throws {RequiredError}
10268
+ * @memberof StoresApi
10269
+ */
10270
+ adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataTypesSchemaBasedDefaultsResponseWrapper, any>>;
9612
10271
  }
9613
10272
  /**
9614
10273
  * SubscriptionsApi - axios parameter creator