@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/api.ts CHANGED
@@ -387,10 +387,10 @@ export interface DataTypesAdminSearchRequest {
387
387
  'max_facet_values'?: number;
388
388
  /**
389
389
  *
390
- * @type {DataTypesSearchConfig}
390
+ * @type {DataTypesIndexConfig}
391
391
  * @memberof DataTypesAdminSearchRequest
392
392
  */
393
- 'override_config'?: DataTypesSearchConfig;
393
+ 'override_config'?: DataTypesIndexConfig;
394
394
  /**
395
395
  *
396
396
  * @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
@@ -1081,6 +1156,73 @@ export interface DataTypesCreateUserResponseWrapper {
1081
1156
  */
1082
1157
  'status'?: number;
1083
1158
  }
1159
+ /**
1160
+ *
1161
+ * @export
1162
+ * @interface DataTypesFieldMetadata
1163
+ */
1164
+ export interface DataTypesFieldMetadata {
1165
+ /**
1166
+ *
1167
+ * @type {object}
1168
+ * @memberof DataTypesFieldMetadata
1169
+ */
1170
+ 'default'?: object;
1171
+ /**
1172
+ *
1173
+ * @type {string}
1174
+ * @memberof DataTypesFieldMetadata
1175
+ */
1176
+ 'description'?: string;
1177
+ /**
1178
+ * Available fields from index schema
1179
+ * @type {Array<string>}
1180
+ * @memberof DataTypesFieldMetadata
1181
+ */
1182
+ 'field_options'?: Array<string>;
1183
+ /**
1184
+ * Field grouping for UI
1185
+ * @type {string}
1186
+ * @memberof DataTypesFieldMetadata
1187
+ */
1188
+ 'group'?: string;
1189
+ /**
1190
+ * For int fields
1191
+ * @type {number}
1192
+ * @memberof DataTypesFieldMetadata
1193
+ */
1194
+ 'max'?: number;
1195
+ /**
1196
+ * For int fields
1197
+ * @type {number}
1198
+ * @memberof DataTypesFieldMetadata
1199
+ */
1200
+ 'min'?: number;
1201
+ /**
1202
+ *
1203
+ * @type {string}
1204
+ * @memberof DataTypesFieldMetadata
1205
+ */
1206
+ 'name'?: string;
1207
+ /**
1208
+ * For select/multi-select fields
1209
+ * @type {Array<string>}
1210
+ * @memberof DataTypesFieldMetadata
1211
+ */
1212
+ 'options'?: Array<string>;
1213
+ /**
1214
+ *
1215
+ * @type {boolean}
1216
+ * @memberof DataTypesFieldMetadata
1217
+ */
1218
+ 'required'?: boolean;
1219
+ /**
1220
+ * \"string\", \"int\", \"bool\", \"select\", \"multi-select\"
1221
+ * @type {string}
1222
+ * @memberof DataTypesFieldMetadata
1223
+ */
1224
+ 'type'?: string;
1225
+ }
1084
1226
  /**
1085
1227
  *
1086
1228
  * @export
@@ -1106,6 +1248,97 @@ export interface DataTypesGenericStringArrayResponse {
1106
1248
  */
1107
1249
  'status'?: number;
1108
1250
  }
1251
+ /**
1252
+ *
1253
+ * @export
1254
+ * @interface DataTypesGetStoreResult
1255
+ */
1256
+ export interface DataTypesGetStoreResult {
1257
+ /**
1258
+ * Timestamp for when the store was created
1259
+ * @type {string}
1260
+ * @memberof DataTypesGetStoreResult
1261
+ */
1262
+ 'CreatedAt'?: string;
1263
+ /**
1264
+ * User ID of the creator, nullable
1265
+ * @type {number}
1266
+ * @memberof DataTypesGetStoreResult
1267
+ */
1268
+ 'CreatedBy'?: number;
1269
+ /**
1270
+ * Store active status
1271
+ * @type {boolean}
1272
+ * @memberof DataTypesGetStoreResult
1273
+ */
1274
+ 'IsActive'?: boolean;
1275
+ /**
1276
+ * Store location
1277
+ * @type {string}
1278
+ * @memberof DataTypesGetStoreResult
1279
+ */
1280
+ 'Location'?: string;
1281
+ /**
1282
+ * Timestamp for when the store was last modified
1283
+ * @type {string}
1284
+ * @memberof DataTypesGetStoreResult
1285
+ */
1286
+ 'ModifiedAt'?: string;
1287
+ /**
1288
+ * User ID of the last modifier, nullable
1289
+ * @type {number}
1290
+ * @memberof DataTypesGetStoreResult
1291
+ */
1292
+ 'ModifiedBy'?: number;
1293
+ /**
1294
+ * Foreign key to mOrganizations
1295
+ * @type {number}
1296
+ * @memberof DataTypesGetStoreResult
1297
+ */
1298
+ 'OrgID'?: number;
1299
+ /**
1300
+ * Primary key
1301
+ * @type {number}
1302
+ * @memberof DataTypesGetStoreResult
1303
+ */
1304
+ 'StoreID'?: number;
1305
+ /**
1306
+ * Store name
1307
+ * @type {string}
1308
+ * @memberof DataTypesGetStoreResult
1309
+ */
1310
+ 'StoreName'?: string;
1311
+ /**
1312
+ * Store alias
1313
+ * @type {string}
1314
+ * @memberof DataTypesGetStoreResult
1315
+ */
1316
+ 'alias'?: string;
1317
+ /**
1318
+ *
1319
+ * @type {string}
1320
+ * @memberof DataTypesGetStoreResult
1321
+ */
1322
+ 'index_name'?: string;
1323
+ /**
1324
+ *
1325
+ * @type {DataTypesIndexConfig}
1326
+ * @memberof DataTypesGetStoreResult
1327
+ */
1328
+ 'search_config'?: DataTypesIndexConfig;
1329
+ /**
1330
+ * Include in API responses
1331
+ * @type {string}
1332
+ * @memberof DataTypesGetStoreResult
1333
+ */
1334
+ 'xStoreID'?: string;
1335
+ /**
1336
+ * Include in API responses
1337
+ * @type {string}
1338
+ * @memberof DataTypesGetStoreResult
1339
+ */
1340
+ 'xStoreSecret'?: string;
1341
+ }
1109
1342
  /**
1110
1343
  *
1111
1344
  * @export
@@ -1114,250 +1347,413 @@ export interface DataTypesGenericStringArrayResponse {
1114
1347
  export interface DataTypesIndexConfig {
1115
1348
  /**
1116
1349
  *
1117
- * @type {boolean}
1350
+ * @type {string}
1118
1351
  * @memberof DataTypesIndexConfig
1119
1352
  */
1120
- 'allowTyposOnNumericTokens'?: boolean;
1353
+ 'collection_alias'?: string;
1121
1354
  /**
1122
1355
  *
1123
- * @type {Array<string>}
1356
+ * @type {string}
1124
1357
  * @memberof DataTypesIndexConfig
1125
1358
  */
1126
- 'alternativesAsExact'?: Array<string>;
1359
+ 'collection_name'?: string;
1127
1360
  /**
1128
1361
  *
1129
- * @type {string}
1362
+ * @type {number}
1130
1363
  * @memberof DataTypesIndexConfig
1131
1364
  */
1132
- 'attributeForDistinct'?: string;
1365
+ 'drop_tokens_threshold'?: number;
1133
1366
  /**
1134
1367
  *
1135
- * @type {Array<string>}
1368
+ * @type {string}
1136
1369
  * @memberof DataTypesIndexConfig
1137
1370
  */
1138
- 'attributesForFaceting'?: Array<string>;
1371
+ 'embed'?: string;
1139
1372
  /**
1140
1373
  *
1141
- * @type {Array<string>}
1374
+ * @type {boolean}
1142
1375
  * @memberof DataTypesIndexConfig
1143
1376
  */
1144
- 'attributesToHighlight'?: Array<string>;
1377
+ 'enable_autocomplete'?: boolean;
1145
1378
  /**
1146
1379
  *
1147
- * @type {Array<string>}
1380
+ * @type {boolean}
1148
1381
  * @memberof DataTypesIndexConfig
1149
1382
  */
1150
- 'attributesToRetrieve'?: Array<string>;
1383
+ 'enable_highlight'?: boolean;
1151
1384
  /**
1152
1385
  *
1153
- * @type {Array<string>}
1386
+ * @type {boolean}
1154
1387
  * @memberof DataTypesIndexConfig
1155
1388
  */
1156
- 'attributesToSnippet'?: Array<string>;
1389
+ 'enable_overrides'?: boolean;
1157
1390
  /**
1158
1391
  *
1159
- * @type {Array<string>}
1392
+ * @type {boolean}
1160
1393
  * @memberof DataTypesIndexConfig
1161
1394
  */
1162
- 'customRanking'?: Array<string>;
1395
+ 'enable_smart_autocomplete'?: boolean;
1163
1396
  /**
1164
1397
  *
1165
- * @type {string}
1398
+ * @type {boolean}
1166
1399
  * @memberof DataTypesIndexConfig
1167
1400
  */
1168
- 'exactOnSingleWordQuery'?: string;
1401
+ 'enable_typo_highlight'?: boolean;
1169
1402
  /**
1170
1403
  *
1171
- * @type {string}
1404
+ * @type {boolean}
1172
1405
  * @memberof DataTypesIndexConfig
1173
1406
  */
1174
- 'highlightPostTag'?: string;
1407
+ 'enable_typo_tolerance'?: boolean;
1175
1408
  /**
1176
1409
  *
1177
- * @type {string}
1410
+ * @type {Array<string>}
1178
1411
  * @memberof DataTypesIndexConfig
1179
1412
  */
1180
- 'highlightPreTag'?: string;
1413
+ 'exclude_fields'?: Array<string>;
1181
1414
  /**
1182
1415
  *
1183
- * @type {number}
1416
+ * @type {boolean}
1184
1417
  * @memberof DataTypesIndexConfig
1185
1418
  */
1186
- 'hitsPerPage'?: number;
1419
+ 'exhaustive_search'?: boolean;
1187
1420
  /**
1188
1421
  *
1189
- * @type {number}
1422
+ * @type {Array<string>}
1190
1423
  * @memberof DataTypesIndexConfig
1191
1424
  */
1192
- 'indexingGeolocPrecision'?: number;
1425
+ 'facet_by'?: Array<string>;
1193
1426
  /**
1194
1427
  *
1195
- * @type {number}
1428
+ * @type {string}
1196
1429
  * @memberof DataTypesIndexConfig
1197
1430
  */
1198
- 'maxNbHits'?: number;
1431
+ 'facet_query'?: string;
1199
1432
  /**
1200
1433
  *
1201
- * @type {number}
1434
+ * @type {string}
1202
1435
  * @memberof DataTypesIndexConfig
1203
1436
  */
1204
- 'maxValuesPerFacet'?: number;
1437
+ 'filter_by'?: string;
1205
1438
  /**
1206
1439
  *
1207
- * @type {number}
1440
+ * @type {string}
1208
1441
  * @memberof DataTypesIndexConfig
1209
1442
  */
1210
- 'minWordSizefor1Typo'?: number;
1443
+ 'group_by'?: string;
1211
1444
  /**
1212
1445
  *
1213
1446
  * @type {number}
1214
1447
  * @memberof DataTypesIndexConfig
1215
1448
  */
1216
- 'minWordSizefor2Typos'?: number;
1449
+ 'group_limit'?: number;
1217
1450
  /**
1218
1451
  *
1219
- * @type {number}
1452
+ * @type {Array<string>}
1220
1453
  * @memberof DataTypesIndexConfig
1221
1454
  */
1222
- 'nbShardsAuto'?: number;
1455
+ 'hidden_facet_fields'?: Array<string>;
1223
1456
  /**
1224
1457
  *
1225
1458
  * @type {Array<string>}
1226
1459
  * @memberof DataTypesIndexConfig
1227
1460
  */
1228
- 'numericAttributesToIndex'?: Array<string>;
1461
+ 'hidden_fields'?: Array<string>;
1229
1462
  /**
1230
1463
  *
1231
1464
  * @type {Array<string>}
1232
1465
  * @memberof DataTypesIndexConfig
1233
1466
  */
1234
- 'optionalWords'?: Array<string>;
1467
+ 'hidden_filter_fields'?: Array<string>;
1235
1468
  /**
1236
1469
  *
1237
1470
  * @type {number}
1238
1471
  * @memberof DataTypesIndexConfig
1239
1472
  */
1240
- 'paginationLimitedTo'?: number;
1473
+ 'highlight_affix_num_tokens'?: number;
1241
1474
  /**
1242
1475
  *
1243
1476
  * @type {string}
1244
1477
  * @memberof DataTypesIndexConfig
1245
1478
  */
1246
- 'primary'?: string;
1479
+ 'highlight_end_tag'?: string;
1247
1480
  /**
1248
1481
  *
1249
- * @type {string}
1482
+ * @type {Array<string>}
1250
1483
  * @memberof DataTypesIndexConfig
1251
1484
  */
1252
- 'queryType'?: string;
1485
+ 'highlight_fields'?: Array<string>;
1253
1486
  /**
1254
1487
  *
1255
1488
  * @type {Array<string>}
1256
1489
  * @memberof DataTypesIndexConfig
1257
1490
  */
1258
- 'ranking'?: Array<string>;
1491
+ 'highlight_full_fields'?: Array<string>;
1259
1492
  /**
1260
1493
  *
1261
1494
  * @type {string}
1262
1495
  * @memberof DataTypesIndexConfig
1263
1496
  */
1264
- 'removeWordsIfNoResults'?: string;
1497
+ 'highlight_start_tag'?: string;
1265
1498
  /**
1266
1499
  *
1267
1500
  * @type {Array<string>}
1268
1501
  * @memberof DataTypesIndexConfig
1269
1502
  */
1270
- 'searchableAttributes'?: Array<string>;
1503
+ 'include_fields'?: Array<string>;
1271
1504
  /**
1272
1505
  *
1273
1506
  * @type {string}
1274
1507
  * @memberof DataTypesIndexConfig
1275
1508
  */
1276
- 'separatorsToIndex'?: string;
1509
+ 'locale'?: string;
1277
1510
  /**
1278
1511
  *
1279
- * @type {Array<string>}
1512
+ * @type {number}
1280
1513
  * @memberof DataTypesIndexConfig
1281
1514
  */
1282
- 'unretrievableAttributes'?: Array<string>;
1515
+ 'max_candidates'?: number;
1283
1516
  /**
1284
1517
  *
1285
1518
  * @type {number}
1286
1519
  * @memberof DataTypesIndexConfig
1287
1520
  */
1288
- 'version'?: number;
1289
- }
1290
- /**
1291
- *
1292
- * @export
1293
- * @interface DataTypesIndexConfigResponse
1294
- */
1295
- export interface DataTypesIndexConfigResponse {
1521
+ 'max_facet_values'?: number;
1296
1522
  /**
1297
1523
  *
1298
- * @type {DataTypesIndexConfig}
1299
- * @memberof DataTypesIndexConfigResponse
1524
+ * @type {number}
1525
+ * @memberof DataTypesIndexConfig
1300
1526
  */
1301
- 'data'?: DataTypesIndexConfig;
1527
+ 'min_len_1typo'?: number;
1302
1528
  /**
1303
1529
  *
1304
- * @type {string}
1305
- * @memberof DataTypesIndexConfigResponse
1530
+ * @type {number}
1531
+ * @memberof DataTypesIndexConfig
1306
1532
  */
1307
- 'message'?: string;
1533
+ 'min_len_2typo'?: number;
1308
1534
  /**
1309
1535
  *
1310
1536
  * @type {number}
1311
- * @memberof DataTypesIndexConfigResponse
1537
+ * @memberof DataTypesIndexConfig
1312
1538
  */
1313
- 'status'?: number;
1314
- }
1315
- /**
1316
- *
1317
- * @export
1318
- * @interface DataTypesJobStatusResponse
1319
- */
1320
- export interface DataTypesJobStatusResponse {
1539
+ 'num_typos'?: number;
1321
1540
  /**
1322
1541
  *
1323
- * @type {string}
1324
- * @memberof DataTypesJobStatusResponse
1542
+ * @type {number}
1543
+ * @memberof DataTypesIndexConfig
1325
1544
  */
1326
- 'jobId'?: string;
1545
+ 'page'?: number;
1327
1546
  /**
1328
1547
  *
1329
- * @type {string}
1330
- * @memberof DataTypesJobStatusResponse
1548
+ * @type {number}
1549
+ * @memberof DataTypesIndexConfig
1331
1550
  */
1332
- 'jobStatus'?: string;
1333
- }
1334
- /**
1335
- *
1336
- * @export
1337
- * @interface DataTypesJobStatusResponseWrapper
1338
- */
1339
- export interface DataTypesJobStatusResponseWrapper {
1551
+ 'per_page'?: number;
1340
1552
  /**
1341
1553
  *
1342
- * @type {DataTypesJobStatusResponse}
1343
- * @memberof DataTypesJobStatusResponseWrapper
1554
+ * @type {string}
1555
+ * @memberof DataTypesIndexConfig
1344
1556
  */
1345
- 'data'?: DataTypesJobStatusResponse;
1557
+ 'prefix'?: string;
1346
1558
  /**
1347
1559
  *
1348
1560
  * @type {string}
1349
- * @memberof DataTypesJobStatusResponseWrapper
1561
+ * @memberof DataTypesIndexConfig
1350
1562
  */
1351
- 'message'?: string;
1563
+ 'preset'?: string;
1352
1564
  /**
1353
1565
  *
1354
- * @type {number}
1355
- * @memberof DataTypesJobStatusResponseWrapper
1566
+ * @type {boolean}
1567
+ * @memberof DataTypesIndexConfig
1356
1568
  */
1357
- 'status'?: number;
1358
- }
1359
- /**
1360
- *
1569
+ 'prioritize_exact_match'?: boolean;
1570
+ /**
1571
+ * Required: Query string
1572
+ * @type {string}
1573
+ * @memberof DataTypesIndexConfig
1574
+ */
1575
+ 'q'?: string;
1576
+ /**
1577
+ * Required: Array of search fields
1578
+ * @type {Array<string>}
1579
+ * @memberof DataTypesIndexConfig
1580
+ */
1581
+ 'query_by'?: Array<string>;
1582
+ /**
1583
+ * Optional: Relative field weights as array
1584
+ * @type {Array<number>}
1585
+ * @memberof DataTypesIndexConfig
1586
+ */
1587
+ 'query_by_weights'?: Array<number>;
1588
+ /**
1589
+ *
1590
+ * @type {boolean}
1591
+ * @memberof DataTypesIndexConfig
1592
+ */
1593
+ 'query_syntax'?: boolean;
1594
+ /**
1595
+ *
1596
+ * @type {number}
1597
+ * @memberof DataTypesIndexConfig
1598
+ */
1599
+ 'search_cutoff_ms'?: number;
1600
+ /**
1601
+ * \"text\", \"vector\", \"hybrid\"
1602
+ * @type {string}
1603
+ * @memberof DataTypesIndexConfig
1604
+ */
1605
+ 'search_strategy'?: string;
1606
+ /**
1607
+ *
1608
+ * @type {boolean}
1609
+ * @memberof DataTypesIndexConfig
1610
+ */
1611
+ 'semantic_ranker'?: boolean;
1612
+ /**
1613
+ *
1614
+ * @type {number}
1615
+ * @memberof DataTypesIndexConfig
1616
+ */
1617
+ 'snippet_threshold'?: number;
1618
+ /**
1619
+ *
1620
+ * @type {Array<DataTypesSortField>}
1621
+ * @memberof DataTypesIndexConfig
1622
+ */
1623
+ 'sort_by'?: Array<DataTypesSortField>;
1624
+ /**
1625
+ * Optional: Search-only scoped API key
1626
+ * @type {string}
1627
+ * @memberof DataTypesIndexConfig
1628
+ */
1629
+ 'token'?: string;
1630
+ /**
1631
+ *
1632
+ * @type {boolean}
1633
+ * @memberof DataTypesIndexConfig
1634
+ */
1635
+ 'use_cache'?: boolean;
1636
+ /**
1637
+ *
1638
+ * @type {string}
1639
+ * @memberof DataTypesIndexConfig
1640
+ */
1641
+ 'vector_query'?: string;
1642
+ }
1643
+ /**
1644
+ *
1645
+ * @export
1646
+ * @interface DataTypesIndexConfigResponseWrapper
1647
+ */
1648
+ export interface DataTypesIndexConfigResponseWrapper {
1649
+ /**
1650
+ *
1651
+ * @type {DataTypesIndexConfig}
1652
+ * @memberof DataTypesIndexConfigResponseWrapper
1653
+ */
1654
+ 'data'?: DataTypesIndexConfig;
1655
+ /**
1656
+ *
1657
+ * @type {string}
1658
+ * @memberof DataTypesIndexConfigResponseWrapper
1659
+ */
1660
+ 'message'?: string;
1661
+ /**
1662
+ *
1663
+ * @type {number}
1664
+ * @memberof DataTypesIndexConfigResponseWrapper
1665
+ */
1666
+ 'status'?: number;
1667
+ }
1668
+ /**
1669
+ *
1670
+ * @export
1671
+ * @interface DataTypesIndexField
1672
+ */
1673
+ export interface DataTypesIndexField {
1674
+ /**
1675
+ *
1676
+ * @type {boolean}
1677
+ * @memberof DataTypesIndexField
1678
+ */
1679
+ 'facet'?: boolean;
1680
+ /**
1681
+ *
1682
+ * @type {boolean}
1683
+ * @memberof DataTypesIndexField
1684
+ */
1685
+ 'index'?: boolean;
1686
+ /**
1687
+ *
1688
+ * @type {string}
1689
+ * @memberof DataTypesIndexField
1690
+ */
1691
+ 'name'?: string;
1692
+ /**
1693
+ *
1694
+ * @type {boolean}
1695
+ * @memberof DataTypesIndexField
1696
+ */
1697
+ 'optional'?: boolean;
1698
+ /**
1699
+ *
1700
+ * @type {boolean}
1701
+ * @memberof DataTypesIndexField
1702
+ */
1703
+ 'sort'?: boolean;
1704
+ /**
1705
+ *
1706
+ * @type {string}
1707
+ * @memberof DataTypesIndexField
1708
+ */
1709
+ 'type'?: string;
1710
+ }
1711
+ /**
1712
+ *
1713
+ * @export
1714
+ * @interface DataTypesJobStatusResponse
1715
+ */
1716
+ export interface DataTypesJobStatusResponse {
1717
+ /**
1718
+ *
1719
+ * @type {string}
1720
+ * @memberof DataTypesJobStatusResponse
1721
+ */
1722
+ 'jobId'?: string;
1723
+ /**
1724
+ *
1725
+ * @type {string}
1726
+ * @memberof DataTypesJobStatusResponse
1727
+ */
1728
+ 'jobStatus'?: string;
1729
+ }
1730
+ /**
1731
+ *
1732
+ * @export
1733
+ * @interface DataTypesJobStatusResponseWrapper
1734
+ */
1735
+ export interface DataTypesJobStatusResponseWrapper {
1736
+ /**
1737
+ *
1738
+ * @type {DataTypesJobStatusResponse}
1739
+ * @memberof DataTypesJobStatusResponseWrapper
1740
+ */
1741
+ 'data'?: DataTypesJobStatusResponse;
1742
+ /**
1743
+ *
1744
+ * @type {string}
1745
+ * @memberof DataTypesJobStatusResponseWrapper
1746
+ */
1747
+ 'message'?: string;
1748
+ /**
1749
+ *
1750
+ * @type {number}
1751
+ * @memberof DataTypesJobStatusResponseWrapper
1752
+ */
1753
+ 'status'?: number;
1754
+ }
1755
+ /**
1756
+ *
1361
1757
  * @export
1362
1758
  * @interface DataTypesLimit
1363
1759
  */
@@ -3399,107 +3795,120 @@ export interface DataTypesSampleDatasetsResponseWrapper {
3399
3795
  /**
3400
3796
  *
3401
3797
  * @export
3402
- * @interface DataTypesSchemaOptionsResponse
3798
+ * @interface DataTypesSchemaBasedDefaults
3403
3799
  */
3404
- export interface DataTypesSchemaOptionsResponse {
3800
+ export interface DataTypesSchemaBasedDefaults {
3405
3801
  /**
3406
3802
  *
3407
3803
  * @type {Array<string>}
3408
- * @memberof DataTypesSchemaOptionsResponse
3804
+ * @memberof DataTypesSchemaBasedDefaults
3409
3805
  */
3410
- 'displayAttributesOptions'?: Array<string>;
3806
+ 'all_fields'?: Array<string>;
3411
3807
  /**
3412
3808
  *
3413
3809
  * @type {Array<string>}
3414
- * @memberof DataTypesSchemaOptionsResponse
3810
+ * @memberof DataTypesSchemaBasedDefaults
3415
3811
  */
3416
- 'relevancyOrderOptions'?: Array<string>;
3812
+ 'facetable_fields'?: Array<string>;
3417
3813
  /**
3418
3814
  *
3419
3815
  * @type {Array<string>}
3420
- * @memberof DataTypesSchemaOptionsResponse
3816
+ * @memberof DataTypesSchemaBasedDefaults
3421
3817
  */
3422
- 'searchableAttributesOptions'?: Array<string>;
3818
+ 'highlightable_fields'?: Array<string>;
3819
+ /**
3820
+ *
3821
+ * @type {Array<string>}
3822
+ * @memberof DataTypesSchemaBasedDefaults
3823
+ */
3824
+ 'include_fields'?: Array<string>;
3825
+ /**
3826
+ *
3827
+ * @type {Array<string>}
3828
+ * @memberof DataTypesSchemaBasedDefaults
3829
+ */
3830
+ 'query_by'?: Array<string>;
3831
+ /**
3832
+ *
3833
+ * @type {Array<DataTypesSortField>}
3834
+ * @memberof DataTypesSchemaBasedDefaults
3835
+ */
3836
+ 'sortable_fields'?: Array<DataTypesSortField>;
3423
3837
  }
3424
3838
  /**
3425
3839
  *
3426
3840
  * @export
3427
- * @interface DataTypesSchemaOptionsResponseWrapper
3841
+ * @interface DataTypesSchemaBasedDefaultsResponseWrapper
3428
3842
  */
3429
- export interface DataTypesSchemaOptionsResponseWrapper {
3843
+ export interface DataTypesSchemaBasedDefaultsResponseWrapper {
3430
3844
  /**
3431
3845
  *
3432
- * @type {DataTypesSchemaOptionsResponse}
3433
- * @memberof DataTypesSchemaOptionsResponseWrapper
3846
+ * @type {DataTypesSchemaBasedDefaults}
3847
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3434
3848
  */
3435
- 'data'?: DataTypesSchemaOptionsResponse;
3849
+ 'data'?: DataTypesSchemaBasedDefaults;
3436
3850
  /**
3437
3851
  *
3438
3852
  * @type {string}
3439
- * @memberof DataTypesSchemaOptionsResponseWrapper
3853
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3440
3854
  */
3441
3855
  'message'?: string;
3442
3856
  /**
3443
3857
  *
3444
3858
  * @type {number}
3445
- * @memberof DataTypesSchemaOptionsResponseWrapper
3859
+ * @memberof DataTypesSchemaBasedDefaultsResponseWrapper
3446
3860
  */
3447
3861
  'status'?: number;
3448
3862
  }
3449
3863
  /**
3450
3864
  *
3451
3865
  * @export
3452
- * @interface DataTypesSearchConfig
3866
+ * @interface DataTypesSchemaOptionsResponse
3453
3867
  */
3454
- export interface DataTypesSearchConfig {
3868
+ export interface DataTypesSchemaOptionsResponse {
3455
3869
  /**
3456
3870
  *
3457
3871
  * @type {Array<string>}
3458
- * @memberof DataTypesSearchConfig
3872
+ * @memberof DataTypesSchemaOptionsResponse
3459
3873
  */
3460
- 'attributesToHighlight'?: Array<string>;
3874
+ 'displayAttributesOptions'?: Array<string>;
3461
3875
  /**
3462
3876
  *
3463
3877
  * @type {Array<string>}
3464
- * @memberof DataTypesSearchConfig
3465
- */
3466
- 'attributesToRetrieve'?: Array<string>;
3467
- /**
3468
- *
3469
- * @type {{ [key: string]: any; }}
3470
- * @memberof DataTypesSearchConfig
3878
+ * @memberof DataTypesSchemaOptionsResponse
3471
3879
  */
3472
- 'displayAttributes'?: { [key: string]: any; };
3880
+ 'relevancyOrderOptions'?: Array<string>;
3473
3881
  /**
3474
3882
  *
3475
- * @type {number}
3476
- * @memberof DataTypesSearchConfig
3883
+ * @type {Array<string>}
3884
+ * @memberof DataTypesSchemaOptionsResponse
3477
3885
  */
3478
- 'hitsPerPage'?: number;
3886
+ 'searchableAttributesOptions'?: Array<string>;
3887
+ }
3888
+ /**
3889
+ *
3890
+ * @export
3891
+ * @interface DataTypesSchemaOptionsResponseWrapper
3892
+ */
3893
+ export interface DataTypesSchemaOptionsResponseWrapper {
3479
3894
  /**
3480
3895
  *
3481
- * @type {number}
3482
- * @memberof DataTypesSearchConfig
3896
+ * @type {DataTypesSchemaOptionsResponse}
3897
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3483
3898
  */
3484
- 'maxNbHits'?: number;
3899
+ 'data'?: DataTypesSchemaOptionsResponse;
3485
3900
  /**
3486
3901
  *
3487
3902
  * @type {string}
3488
- * @memberof DataTypesSearchConfig
3489
- */
3490
- 'query_by'?: string;
3491
- /**
3492
- *
3493
- * @type {Array<string>}
3494
- * @memberof DataTypesSearchConfig
3903
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3495
3904
  */
3496
- 'ranking'?: Array<string>;
3905
+ 'message'?: string;
3497
3906
  /**
3498
3907
  *
3499
- * @type {Array<string>}
3500
- * @memberof DataTypesSearchConfig
3908
+ * @type {number}
3909
+ * @memberof DataTypesSchemaOptionsResponseWrapper
3501
3910
  */
3502
- 'searchableAttributes'?: Array<string>;
3911
+ 'status'?: number;
3503
3912
  }
3504
3913
  /**
3505
3914
  *
@@ -3753,6 +4162,25 @@ export interface DataTypesServiceRequestsListResponse {
3753
4162
  */
3754
4163
  'status'?: number;
3755
4164
  }
4165
+ /**
4166
+ *
4167
+ * @export
4168
+ * @interface DataTypesSortField
4169
+ */
4170
+ export interface DataTypesSortField {
4171
+ /**
4172
+ * \"asc\" or \"desc\"
4173
+ * @type {string}
4174
+ * @memberof DataTypesSortField
4175
+ */
4176
+ 'direction'?: string;
4177
+ /**
4178
+ *
4179
+ * @type {string}
4180
+ * @memberof DataTypesSortField
4181
+ */
4182
+ 'field'?: string;
4183
+ }
3756
4184
  /**
3757
4185
  *
3758
4186
  * @export
@@ -3935,6 +4363,12 @@ export interface DataTypesStore {
3935
4363
  * @memberof DataTypesStore
3936
4364
  */
3937
4365
  'alias'?: string;
4366
+ /**
4367
+ * Include in API responses
4368
+ * @type {string}
4369
+ * @memberof DataTypesStore
4370
+ */
4371
+ 'xStoreID'?: string;
3938
4372
  }
3939
4373
  /**
3940
4374
  *
@@ -4013,10 +4447,10 @@ export interface DataTypesStoreRequestDto {
4013
4447
  export interface DataTypesStoreResponse {
4014
4448
  /**
4015
4449
  *
4016
- * @type {DataTypesStore}
4450
+ * @type {DataTypesGetStoreResult}
4017
4451
  * @memberof DataTypesStoreResponse
4018
4452
  */
4019
- 'data'?: DataTypesStore;
4453
+ 'data'?: DataTypesGetStoreResult;
4020
4454
  /**
4021
4455
  *
4022
4456
  * @type {string}
@@ -13714,20 +14148,18 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13714
14148
  /**
13715
14149
  * Search documents with optional configuration override and autocomplete suggestions
13716
14150
  * @summary Admin Search API
13717
- * @param {string} xStoreID Store ID for the selected store
13718
- * @param {string} xStoreSecret Store Secret for the selected store
14151
+ * @param {string} xStoreID X-Store ID
13719
14152
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
13720
14153
  * @param {*} [options] Override http request option.
13721
14154
  * @throws {RequiredError}
13722
14155
  */
13723
- adminV1SearchPost: async (xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14156
+ adminV1SearchXStoreIDPost: async (xStoreID: string, body: DataTypesAdminSearchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13724
14157
  // verify required parameter 'xStoreID' is not null or undefined
13725
- assertParamExists('adminV1SearchPost', 'xStoreID', xStoreID)
13726
- // verify required parameter 'xStoreSecret' is not null or undefined
13727
- assertParamExists('adminV1SearchPost', 'xStoreSecret', xStoreSecret)
14158
+ assertParamExists('adminV1SearchXStoreIDPost', 'xStoreID', xStoreID)
13728
14159
  // verify required parameter 'body' is not null or undefined
13729
- assertParamExists('adminV1SearchPost', 'body', body)
13730
- const localVarPath = `/admin/v1/search`;
14160
+ assertParamExists('adminV1SearchXStoreIDPost', 'body', body)
14161
+ const localVarPath = `/admin/v1/search/{xStoreID}`
14162
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
13731
14163
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13732
14164
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13733
14165
  let baseOptions;
@@ -13746,12 +14178,6 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13746
14178
 
13747
14179
  localVarHeaderParameter['Content-Type'] = 'application/json';
13748
14180
 
13749
- if (xStoreID != null) {
13750
- localVarHeaderParameter['X-Store-ID'] = String(xStoreID);
13751
- }
13752
- if (xStoreSecret != null) {
13753
- localVarHeaderParameter['X-Store-Secret'] = String(xStoreSecret);
13754
- }
13755
14181
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13756
14182
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
13757
14183
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -13763,17 +14189,14 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13763
14189
  };
13764
14190
  },
13765
14191
  /**
13766
- * Get the current index configuration
13767
- * @summary Get Index Config
13768
- * @param {string} indexname Index Name
14192
+ * Get metadata about all configurable fields for dynamic form generation
14193
+ * @summary Get Configuration Schema
14194
+ * @param {string} [indexname] Index name to get field options from
13769
14195
  * @param {*} [options] Override http request option.
13770
14196
  * @throws {RequiredError}
13771
14197
  */
13772
- v1IndexIndexnameConfigGet: async (indexname: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13773
- // verify required parameter 'indexname' is not null or undefined
13774
- assertParamExists('v1IndexIndexnameConfigGet', 'indexname', indexname)
13775
- const localVarPath = `/v1/index/{indexname}/config`
13776
- .replace(`{${"indexname"}}`, encodeURIComponent(String(indexname)));
14198
+ v1IndexConfigSchemaGet: async (indexname?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14199
+ const localVarPath = `/v1/index/config-schema`;
13777
14200
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13778
14201
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
13779
14202
  let baseOptions;
@@ -13785,6 +14208,10 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13785
14208
  const localVarHeaderParameter = {} as any;
13786
14209
  const localVarQueryParameter = {} as any;
13787
14210
 
14211
+ if (indexname !== undefined) {
14212
+ localVarQueryParameter['indexname'] = indexname;
14213
+ }
14214
+
13788
14215
 
13789
14216
 
13790
14217
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -13797,18 +14224,52 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13797
14224
  };
13798
14225
  },
13799
14226
  /**
13800
- * Configure the index for search
13801
- * @summary Index Config
14227
+ * Get the current index configuration
14228
+ * @summary Get Index Config
13802
14229
  * @param {string} indexname Index Name
13803
- * @param {DataTypesIndexConfig} body Index configuration
13804
14230
  * @param {*} [options] Override http request option.
13805
14231
  * @throws {RequiredError}
13806
14232
  */
13807
- v1IndexIndexnameConfigPost: async (indexname: string, body: DataTypesIndexConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14233
+ v1IndexIndexnameConfigGet: async (indexname: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13808
14234
  // verify required parameter 'indexname' is not null or undefined
13809
- assertParamExists('v1IndexIndexnameConfigPost', 'indexname', indexname)
13810
- // verify required parameter 'body' is not null or undefined
13811
- assertParamExists('v1IndexIndexnameConfigPost', 'body', body)
14235
+ assertParamExists('v1IndexIndexnameConfigGet', 'indexname', indexname)
14236
+ const localVarPath = `/v1/index/{indexname}/config`
14237
+ .replace(`{${"indexname"}}`, encodeURIComponent(String(indexname)));
14238
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14239
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14240
+ let baseOptions;
14241
+ if (configuration) {
14242
+ baseOptions = configuration.baseOptions;
14243
+ }
14244
+
14245
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14246
+ const localVarHeaderParameter = {} as any;
14247
+ const localVarQueryParameter = {} as any;
14248
+
14249
+
14250
+
14251
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14252
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14253
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14254
+
14255
+ return {
14256
+ url: toPathString(localVarUrlObj),
14257
+ options: localVarRequestOptions,
14258
+ };
14259
+ },
14260
+ /**
14261
+ * Configure the index for search
14262
+ * @summary Index Config
14263
+ * @param {string} indexname Index Name
14264
+ * @param {DataTypesIndexConfig} body Index configuration
14265
+ * @param {*} [options] Override http request option.
14266
+ * @throws {RequiredError}
14267
+ */
14268
+ v1IndexIndexnameConfigPost: async (indexname: string, body: DataTypesIndexConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14269
+ // verify required parameter 'indexname' is not null or undefined
14270
+ assertParamExists('v1IndexIndexnameConfigPost', 'indexname', indexname)
14271
+ // verify required parameter 'body' is not null or undefined
14272
+ assertParamExists('v1IndexIndexnameConfigPost', 'body', body)
13812
14273
  const localVarPath = `/v1/index/{indexname}/config`
13813
14274
  .replace(`{${"indexname"}}`, encodeURIComponent(String(indexname)));
13814
14275
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -13880,20 +14341,54 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13880
14341
  options: localVarRequestOptions,
13881
14342
  };
13882
14343
  },
14344
+ /**
14345
+ * Get default configuration values computed from the Typesense schema
14346
+ * @summary Get Schema-Based Defaults
14347
+ * @param {string} indexname Index Name
14348
+ * @param {*} [options] Override http request option.
14349
+ * @throws {RequiredError}
14350
+ */
14351
+ v1IndexIndexnameDefaultsGet: async (indexname: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14352
+ // verify required parameter 'indexname' is not null or undefined
14353
+ assertParamExists('v1IndexIndexnameDefaultsGet', 'indexname', indexname)
14354
+ const localVarPath = `/v1/index/{indexname}/defaults`
14355
+ .replace(`{${"indexname"}}`, encodeURIComponent(String(indexname)));
14356
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14357
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14358
+ let baseOptions;
14359
+ if (configuration) {
14360
+ baseOptions = configuration.baseOptions;
14361
+ }
14362
+
14363
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14364
+ const localVarHeaderParameter = {} as any;
14365
+ const localVarQueryParameter = {} as any;
14366
+
14367
+
14368
+
14369
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14370
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14371
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14372
+
14373
+ return {
14374
+ url: toPathString(localVarUrlObj),
14375
+ options: localVarRequestOptions,
14376
+ };
14377
+ },
13883
14378
  /**
13884
14379
  * Search documents using store credentials with optional autocomplete suggestions
13885
14380
  * @summary Public Search API
13886
- * @param {string} xStoreID Store ID
13887
- * @param {string} xStoreSecret Store Secret
14381
+ * @param {string} xStoreid Store ID
14382
+ * @param {string} xStoresecret Store Secret
13888
14383
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
13889
14384
  * @param {*} [options] Override http request option.
13890
14385
  * @throws {RequiredError}
13891
14386
  */
13892
- v1SearchPost: async (xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13893
- // verify required parameter 'xStoreID' is not null or undefined
13894
- assertParamExists('v1SearchPost', 'xStoreID', xStoreID)
13895
- // verify required parameter 'xStoreSecret' is not null or undefined
13896
- assertParamExists('v1SearchPost', 'xStoreSecret', xStoreSecret)
14387
+ v1SearchPost: async (xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14388
+ // verify required parameter 'xStoreid' is not null or undefined
14389
+ assertParamExists('v1SearchPost', 'xStoreid', xStoreid)
14390
+ // verify required parameter 'xStoresecret' is not null or undefined
14391
+ assertParamExists('v1SearchPost', 'xStoresecret', xStoresecret)
13897
14392
  // verify required parameter 'body' is not null or undefined
13898
14393
  assertParamExists('v1SearchPost', 'body', body)
13899
14394
  const localVarPath = `/v1/search`;
@@ -13912,11 +14407,11 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
13912
14407
 
13913
14408
  localVarHeaderParameter['Content-Type'] = 'application/json';
13914
14409
 
13915
- if (xStoreID != null) {
13916
- localVarHeaderParameter['X-Store-ID'] = String(xStoreID);
14410
+ if (xStoreid != null) {
14411
+ localVarHeaderParameter['x-storeid'] = String(xStoreid);
13917
14412
  }
13918
- if (xStoreSecret != null) {
13919
- localVarHeaderParameter['X-Store-Secret'] = String(xStoreSecret);
14413
+ if (xStoresecret != null) {
14414
+ localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
13920
14415
  }
13921
14416
  setSearchParams(localVarUrlObj, localVarQueryParameter);
13922
14417
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -13941,16 +14436,28 @@ export const SearchApiFp = function(configuration?: Configuration) {
13941
14436
  /**
13942
14437
  * Search documents with optional configuration override and autocomplete suggestions
13943
14438
  * @summary Admin Search API
13944
- * @param {string} xStoreID Store ID for the selected store
13945
- * @param {string} xStoreSecret Store Secret for the selected store
14439
+ * @param {string} xStoreID X-Store ID
13946
14440
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
13947
14441
  * @param {*} [options] Override http request option.
13948
14442
  * @throws {RequiredError}
13949
14443
  */
13950
- async adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>> {
13951
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1SearchPost(xStoreID, xStoreSecret, body, options);
14444
+ async adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>> {
14445
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminV1SearchXStoreIDPost(xStoreID, body, options);
14446
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14447
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.adminV1SearchXStoreIDPost']?.[localVarOperationServerIndex]?.url;
14448
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14449
+ },
14450
+ /**
14451
+ * Get metadata about all configurable fields for dynamic form generation
14452
+ * @summary Get Configuration Schema
14453
+ * @param {string} [indexname] Index name to get field options from
14454
+ * @param {*} [options] Override http request option.
14455
+ * @throws {RequiredError}
14456
+ */
14457
+ async v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>> {
14458
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1IndexConfigSchemaGet(indexname, options);
13952
14459
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13953
- const localVarOperationServerBasePath = operationServerMap['SearchApi.adminV1SearchPost']?.[localVarOperationServerIndex]?.url;
14460
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexConfigSchemaGet']?.[localVarOperationServerIndex]?.url;
13954
14461
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13955
14462
  },
13956
14463
  /**
@@ -13960,7 +14467,7 @@ export const SearchApiFp = function(configuration?: Configuration) {
13960
14467
  * @param {*} [options] Override http request option.
13961
14468
  * @throws {RequiredError}
13962
14469
  */
13963
- async v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponse>> {
14470
+ async v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>> {
13964
14471
  const localVarAxiosArgs = await localVarAxiosParamCreator.v1IndexIndexnameConfigGet(indexname, options);
13965
14472
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13966
14473
  const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexIndexnameConfigGet']?.[localVarOperationServerIndex]?.url;
@@ -13995,17 +14502,30 @@ export const SearchApiFp = function(configuration?: Configuration) {
13995
14502
  const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexIndexnameConfigPropertyPatch']?.[localVarOperationServerIndex]?.url;
13996
14503
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13997
14504
  },
14505
+ /**
14506
+ * Get default configuration values computed from the Typesense schema
14507
+ * @summary Get Schema-Based Defaults
14508
+ * @param {string} indexname Index Name
14509
+ * @param {*} [options] Override http request option.
14510
+ * @throws {RequiredError}
14511
+ */
14512
+ async v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>> {
14513
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1IndexIndexnameDefaultsGet(indexname, options);
14514
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14515
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.v1IndexIndexnameDefaultsGet']?.[localVarOperationServerIndex]?.url;
14516
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14517
+ },
13998
14518
  /**
13999
14519
  * Search documents using store credentials with optional autocomplete suggestions
14000
14520
  * @summary Public Search API
14001
- * @param {string} xStoreID Store ID
14002
- * @param {string} xStoreSecret Store Secret
14521
+ * @param {string} xStoreid Store ID
14522
+ * @param {string} xStoresecret Store Secret
14003
14523
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
14004
14524
  * @param {*} [options] Override http request option.
14005
14525
  * @throws {RequiredError}
14006
14526
  */
14007
- async v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>> {
14008
- const localVarAxiosArgs = await localVarAxiosParamCreator.v1SearchPost(xStoreID, xStoreSecret, body, options);
14527
+ async v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesOfficialSearchResponseWrapper>> {
14528
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1SearchPost(xStoreid, xStoresecret, body, options);
14009
14529
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14010
14530
  const localVarOperationServerBasePath = operationServerMap['SearchApi.v1SearchPost']?.[localVarOperationServerIndex]?.url;
14011
14531
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -14023,14 +14543,23 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
14023
14543
  /**
14024
14544
  * Search documents with optional configuration override and autocomplete suggestions
14025
14545
  * @summary Admin Search API
14026
- * @param {string} xStoreID Store ID for the selected store
14027
- * @param {string} xStoreSecret Store Secret for the selected store
14546
+ * @param {string} xStoreID X-Store ID
14028
14547
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
14029
14548
  * @param {*} [options] Override http request option.
14030
14549
  * @throws {RequiredError}
14031
14550
  */
14032
- adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper> {
14033
- return localVarFp.adminV1SearchPost(xStoreID, xStoreSecret, body, options).then((request) => request(axios, basePath));
14551
+ adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper> {
14552
+ return localVarFp.adminV1SearchXStoreIDPost(xStoreID, body, options).then((request) => request(axios, basePath));
14553
+ },
14554
+ /**
14555
+ * Get metadata about all configurable fields for dynamic form generation
14556
+ * @summary Get Configuration Schema
14557
+ * @param {string} [indexname] Index name to get field options from
14558
+ * @param {*} [options] Override http request option.
14559
+ * @throws {RequiredError}
14560
+ */
14561
+ v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper> {
14562
+ return localVarFp.v1IndexConfigSchemaGet(indexname, options).then((request) => request(axios, basePath));
14034
14563
  },
14035
14564
  /**
14036
14565
  * Get the current index configuration
@@ -14039,7 +14568,7 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
14039
14568
  * @param {*} [options] Override http request option.
14040
14569
  * @throws {RequiredError}
14041
14570
  */
14042
- v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponse> {
14571
+ v1IndexIndexnameConfigGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper> {
14043
14572
  return localVarFp.v1IndexIndexnameConfigGet(indexname, options).then((request) => request(axios, basePath));
14044
14573
  },
14045
14574
  /**
@@ -14065,17 +14594,27 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
14065
14594
  v1IndexIndexnameConfigPropertyPatch(indexname: string, property: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
14066
14595
  return localVarFp.v1IndexIndexnameConfigPropertyPatch(indexname, property, body, options).then((request) => request(axios, basePath));
14067
14596
  },
14597
+ /**
14598
+ * Get default configuration values computed from the Typesense schema
14599
+ * @summary Get Schema-Based Defaults
14600
+ * @param {string} indexname Index Name
14601
+ * @param {*} [options] Override http request option.
14602
+ * @throws {RequiredError}
14603
+ */
14604
+ v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper> {
14605
+ return localVarFp.v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(axios, basePath));
14606
+ },
14068
14607
  /**
14069
14608
  * Search documents using store credentials with optional autocomplete suggestions
14070
14609
  * @summary Public Search API
14071
- * @param {string} xStoreID Store ID
14072
- * @param {string} xStoreSecret Store Secret
14610
+ * @param {string} xStoreid Store ID
14611
+ * @param {string} xStoresecret Store Secret
14073
14612
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
14074
14613
  * @param {*} [options] Override http request option.
14075
14614
  * @throws {RequiredError}
14076
14615
  */
14077
- v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper> {
14078
- return localVarFp.v1SearchPost(xStoreID, xStoreSecret, body, options).then((request) => request(axios, basePath));
14616
+ v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesOfficialSearchResponseWrapper> {
14617
+ return localVarFp.v1SearchPost(xStoreid, xStoresecret, body, options).then((request) => request(axios, basePath));
14079
14618
  },
14080
14619
  };
14081
14620
  };
@@ -14090,15 +14629,26 @@ export class SearchApi extends BaseAPI {
14090
14629
  /**
14091
14630
  * Search documents with optional configuration override and autocomplete suggestions
14092
14631
  * @summary Admin Search API
14093
- * @param {string} xStoreID Store ID for the selected store
14094
- * @param {string} xStoreSecret Store Secret for the selected store
14632
+ * @param {string} xStoreID X-Store ID
14095
14633
  * @param {DataTypesAdminSearchRequest} body Admin search request (set include_suggestions: true for autocomplete)
14096
14634
  * @param {*} [options] Override http request option.
14097
14635
  * @throws {RequiredError}
14098
14636
  * @memberof SearchApi
14099
14637
  */
14100
- public adminV1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) {
14101
- return SearchApiFp(this.configuration).adminV1SearchPost(xStoreID, xStoreSecret, body, options).then((request) => request(this.axios, this.basePath));
14638
+ public adminV1SearchXStoreIDPost(xStoreID: string, body: DataTypesAdminSearchRequest, options?: RawAxiosRequestConfig) {
14639
+ return SearchApiFp(this.configuration).adminV1SearchXStoreIDPost(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
14640
+ }
14641
+
14642
+ /**
14643
+ * Get metadata about all configurable fields for dynamic form generation
14644
+ * @summary Get Configuration Schema
14645
+ * @param {string} [indexname] Index name to get field options from
14646
+ * @param {*} [options] Override http request option.
14647
+ * @throws {RequiredError}
14648
+ * @memberof SearchApi
14649
+ */
14650
+ public v1IndexConfigSchemaGet(indexname?: string, options?: RawAxiosRequestConfig) {
14651
+ return SearchApiFp(this.configuration).v1IndexConfigSchemaGet(indexname, options).then((request) => request(this.axios, this.basePath));
14102
14652
  }
14103
14653
 
14104
14654
  /**
@@ -14140,18 +14690,30 @@ export class SearchApi extends BaseAPI {
14140
14690
  return SearchApiFp(this.configuration).v1IndexIndexnameConfigPropertyPatch(indexname, property, body, options).then((request) => request(this.axios, this.basePath));
14141
14691
  }
14142
14692
 
14693
+ /**
14694
+ * Get default configuration values computed from the Typesense schema
14695
+ * @summary Get Schema-Based Defaults
14696
+ * @param {string} indexname Index Name
14697
+ * @param {*} [options] Override http request option.
14698
+ * @throws {RequiredError}
14699
+ * @memberof SearchApi
14700
+ */
14701
+ public v1IndexIndexnameDefaultsGet(indexname: string, options?: RawAxiosRequestConfig) {
14702
+ return SearchApiFp(this.configuration).v1IndexIndexnameDefaultsGet(indexname, options).then((request) => request(this.axios, this.basePath));
14703
+ }
14704
+
14143
14705
  /**
14144
14706
  * Search documents using store credentials with optional autocomplete suggestions
14145
14707
  * @summary Public Search API
14146
- * @param {string} xStoreID Store ID
14147
- * @param {string} xStoreSecret Store Secret
14708
+ * @param {string} xStoreid Store ID
14709
+ * @param {string} xStoresecret Store Secret
14148
14710
  * @param {DataTypesPublicSearchRequest} body Search request (set include_suggestions: true for autocomplete)
14149
14711
  * @param {*} [options] Override http request option.
14150
14712
  * @throws {RequiredError}
14151
14713
  * @memberof SearchApi
14152
14714
  */
14153
- public v1SearchPost(xStoreID: string, xStoreSecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) {
14154
- return SearchApiFp(this.configuration).v1SearchPost(xStoreID, xStoreSecret, body, options).then((request) => request(this.axios, this.basePath));
14715
+ public v1SearchPost(xStoreid: string, xStoresecret: string, body: DataTypesPublicSearchRequest, options?: RawAxiosRequestConfig) {
14716
+ return SearchApiFp(this.configuration).v1SearchPost(xStoreid, xStoresecret, body, options).then((request) => request(this.axios, this.basePath));
14155
14717
  }
14156
14718
  }
14157
14719
 
@@ -14163,6 +14725,39 @@ export class SearchApi extends BaseAPI {
14163
14725
  */
14164
14726
  export const StoresApiAxiosParamCreator = function (configuration?: Configuration) {
14165
14727
  return {
14728
+ /**
14729
+ * Fetches list of all stores for the authenticated user\'s organization
14730
+ * @summary Fetches list of all stores
14731
+ * @param {*} [options] Override http request option.
14732
+ * @throws {RequiredError}
14733
+ */
14734
+ adminStoresGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14735
+ const localVarPath = `/admin/Stores`;
14736
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14737
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14738
+ let baseOptions;
14739
+ if (configuration) {
14740
+ baseOptions = configuration.baseOptions;
14741
+ }
14742
+
14743
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14744
+ const localVarHeaderParameter = {} as any;
14745
+ const localVarQueryParameter = {} as any;
14746
+
14747
+ // authentication BearerAuth required
14748
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
14749
+
14750
+
14751
+
14752
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14753
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14754
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14755
+
14756
+ return {
14757
+ url: toPathString(localVarUrlObj),
14758
+ options: localVarRequestOptions,
14759
+ };
14760
+ },
14166
14761
  /**
14167
14762
  * Fetches stores by id
14168
14763
  * @summary Fetches stores by id
@@ -14201,17 +14796,17 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
14201
14796
  };
14202
14797
  },
14203
14798
  /**
14204
- * Fetches list of all stores
14205
- * @summary Fetches list of all stores
14206
- * @param {number} orgId Org ID
14799
+ * Fetches stores by xStoreID
14800
+ * @summary Fetches stores by xStoreID
14801
+ * @param {string} xStoreID X-Store ID
14207
14802
  * @param {*} [options] Override http request option.
14208
14803
  * @throws {RequiredError}
14209
14804
  */
14210
- adminStoresOrgIdGet: async (orgId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14211
- // verify required parameter 'orgId' is not null or undefined
14212
- assertParamExists('adminStoresOrgIdGet', 'orgId', orgId)
14213
- const localVarPath = `/admin/Stores/{OrgId}`
14214
- .replace(`{${"OrgId"}}`, encodeURIComponent(String(orgId)));
14805
+ adminStoresGetStoreXStoreIDGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14806
+ // verify required parameter 'xStoreID' is not null or undefined
14807
+ assertParamExists('adminStoresGetStoreXStoreIDGet', 'xStoreID', xStoreID)
14808
+ const localVarPath = `/admin/Stores/GetStore/{xStoreID}`
14809
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
14215
14810
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
14216
14811
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14217
14812
  let baseOptions;
@@ -14351,6 +14946,160 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
14351
14946
 
14352
14947
 
14353
14948
 
14949
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14950
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14951
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14952
+
14953
+ return {
14954
+ url: toPathString(localVarUrlObj),
14955
+ options: localVarRequestOptions,
14956
+ };
14957
+ },
14958
+ /**
14959
+ * Retrieves the store configuration using x-store ID
14960
+ * @summary Get Store Config
14961
+ * @param {string} xStoreID X-Store ID
14962
+ * @param {*} [options] Override http request option.
14963
+ * @throws {RequiredError}
14964
+ */
14965
+ adminStoresXStoreIDConfigGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14966
+ // verify required parameter 'xStoreID' is not null or undefined
14967
+ assertParamExists('adminStoresXStoreIDConfigGet', 'xStoreID', xStoreID)
14968
+ const localVarPath = `/admin/Stores/{xStoreID}/config`
14969
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
14970
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14971
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14972
+ let baseOptions;
14973
+ if (configuration) {
14974
+ baseOptions = configuration.baseOptions;
14975
+ }
14976
+
14977
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14978
+ const localVarHeaderParameter = {} as any;
14979
+ const localVarQueryParameter = {} as any;
14980
+
14981
+ // authentication BearerAuth required
14982
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
14983
+
14984
+
14985
+
14986
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14987
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14988
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14989
+
14990
+ return {
14991
+ url: toPathString(localVarUrlObj),
14992
+ options: localVarRequestOptions,
14993
+ };
14994
+ },
14995
+ /**
14996
+ * Updates the store configuration using x-store ID
14997
+ * @summary Update Store Config
14998
+ * @param {string} xStoreID X-Store ID
14999
+ * @param {DataTypesIndexConfig} body Store configuration
15000
+ * @param {*} [options] Override http request option.
15001
+ * @throws {RequiredError}
15002
+ */
15003
+ adminStoresXStoreIDConfigPut: async (xStoreID: string, body: DataTypesIndexConfig, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
15004
+ // verify required parameter 'xStoreID' is not null or undefined
15005
+ assertParamExists('adminStoresXStoreIDConfigPut', 'xStoreID', xStoreID)
15006
+ // verify required parameter 'body' is not null or undefined
15007
+ assertParamExists('adminStoresXStoreIDConfigPut', 'body', body)
15008
+ const localVarPath = `/admin/Stores/{xStoreID}/config`
15009
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
15010
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
15011
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
15012
+ let baseOptions;
15013
+ if (configuration) {
15014
+ baseOptions = configuration.baseOptions;
15015
+ }
15016
+
15017
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
15018
+ const localVarHeaderParameter = {} as any;
15019
+ const localVarQueryParameter = {} as any;
15020
+
15021
+ // authentication BearerAuth required
15022
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15023
+
15024
+
15025
+
15026
+ localVarHeaderParameter['Content-Type'] = 'application/json';
15027
+
15028
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
15029
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
15030
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
15031
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
15032
+
15033
+ return {
15034
+ url: toPathString(localVarUrlObj),
15035
+ options: localVarRequestOptions,
15036
+ };
15037
+ },
15038
+ /**
15039
+ * Get metadata about all configurable fields for store configuration using x-store ID
15040
+ * @summary Get Store Config Schema
15041
+ * @param {string} xStoreID X-Store ID to get field options from
15042
+ * @param {*} [options] Override http request option.
15043
+ * @throws {RequiredError}
15044
+ */
15045
+ adminStoresXStoreIDConfigSchemaGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
15046
+ // verify required parameter 'xStoreID' is not null or undefined
15047
+ assertParamExists('adminStoresXStoreIDConfigSchemaGet', 'xStoreID', xStoreID)
15048
+ const localVarPath = `/admin/Stores/{xStoreID}/config-schema`
15049
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
15050
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
15051
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
15052
+ let baseOptions;
15053
+ if (configuration) {
15054
+ baseOptions = configuration.baseOptions;
15055
+ }
15056
+
15057
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
15058
+ const localVarHeaderParameter = {} as any;
15059
+ const localVarQueryParameter = {} as any;
15060
+
15061
+ // authentication BearerAuth required
15062
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15063
+
15064
+
15065
+
15066
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
15067
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
15068
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
15069
+
15070
+ return {
15071
+ url: toPathString(localVarUrlObj),
15072
+ options: localVarRequestOptions,
15073
+ };
15074
+ },
15075
+ /**
15076
+ * Get default configuration values computed from the store\'s index schema using x-store ID
15077
+ * @summary Get Store Schema-Based Defaults
15078
+ * @param {string} xStoreID X-Store ID
15079
+ * @param {*} [options] Override http request option.
15080
+ * @throws {RequiredError}
15081
+ */
15082
+ adminStoresXStoreIDDefaultsGet: async (xStoreID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
15083
+ // verify required parameter 'xStoreID' is not null or undefined
15084
+ assertParamExists('adminStoresXStoreIDDefaultsGet', 'xStoreID', xStoreID)
15085
+ const localVarPath = `/admin/Stores/{xStoreID}/defaults`
15086
+ .replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
15087
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
15088
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
15089
+ let baseOptions;
15090
+ if (configuration) {
15091
+ baseOptions = configuration.baseOptions;
15092
+ }
15093
+
15094
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
15095
+ const localVarHeaderParameter = {} as any;
15096
+ const localVarQueryParameter = {} as any;
15097
+
15098
+ // authentication BearerAuth required
15099
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
15100
+
15101
+
15102
+
14354
15103
  setSearchParams(localVarUrlObj, localVarQueryParameter);
14355
15104
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14356
15105
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -14370,6 +15119,18 @@ export const StoresApiAxiosParamCreator = function (configuration?: Configuratio
14370
15119
  export const StoresApiFp = function(configuration?: Configuration) {
14371
15120
  const localVarAxiosParamCreator = StoresApiAxiosParamCreator(configuration)
14372
15121
  return {
15122
+ /**
15123
+ * Fetches list of all stores for the authenticated user\'s organization
15124
+ * @summary Fetches list of all stores
15125
+ * @param {*} [options] Override http request option.
15126
+ * @throws {RequiredError}
15127
+ */
15128
+ async adminStoresGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoresListResponse>> {
15129
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresGet(options);
15130
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15131
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresGet']?.[localVarOperationServerIndex]?.url;
15132
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15133
+ },
14373
15134
  /**
14374
15135
  * Fetches stores by id
14375
15136
  * @summary Fetches stores by id
@@ -14384,16 +15145,16 @@ export const StoresApiFp = function(configuration?: Configuration) {
14384
15145
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14385
15146
  },
14386
15147
  /**
14387
- * Fetches list of all stores
14388
- * @summary Fetches list of all stores
14389
- * @param {number} orgId Org ID
15148
+ * Fetches stores by xStoreID
15149
+ * @summary Fetches stores by xStoreID
15150
+ * @param {string} xStoreID X-Store ID
14390
15151
  * @param {*} [options] Override http request option.
14391
15152
  * @throws {RequiredError}
14392
15153
  */
14393
- async adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoresListResponse>> {
14394
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresOrgIdGet(orgId, options);
15154
+ async adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesStoreResponse>> {
15155
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresGetStoreXStoreIDGet(xStoreID, options);
14395
15156
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14396
- const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresOrgIdGet']?.[localVarOperationServerIndex]?.url;
15157
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresGetStoreXStoreIDGet']?.[localVarOperationServerIndex]?.url;
14397
15158
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14398
15159
  },
14399
15160
  /**
@@ -14437,6 +15198,59 @@ export const StoresApiFp = function(configuration?: Configuration) {
14437
15198
  const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresUpdateStatusIdStatusPut']?.[localVarOperationServerIndex]?.url;
14438
15199
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14439
15200
  },
15201
+ /**
15202
+ * Retrieves the store configuration using x-store ID
15203
+ * @summary Get Store Config
15204
+ * @param {string} xStoreID X-Store ID
15205
+ * @param {*} [options] Override http request option.
15206
+ * @throws {RequiredError}
15207
+ */
15208
+ async adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>> {
15209
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDConfigGet(xStoreID, options);
15210
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15211
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDConfigGet']?.[localVarOperationServerIndex]?.url;
15212
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15213
+ },
15214
+ /**
15215
+ * Updates the store configuration using x-store ID
15216
+ * @summary Update Store Config
15217
+ * @param {string} xStoreID X-Store ID
15218
+ * @param {DataTypesIndexConfig} body Store configuration
15219
+ * @param {*} [options] Override http request option.
15220
+ * @throws {RequiredError}
15221
+ */
15222
+ async adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesIndexConfigResponseWrapper>> {
15223
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDConfigPut(xStoreID, body, options);
15224
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15225
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDConfigPut']?.[localVarOperationServerIndex]?.url;
15226
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15227
+ },
15228
+ /**
15229
+ * Get metadata about all configurable fields for store configuration using x-store ID
15230
+ * @summary Get Store Config Schema
15231
+ * @param {string} xStoreID X-Store ID to get field options from
15232
+ * @param {*} [options] Override http request option.
15233
+ * @throws {RequiredError}
15234
+ */
15235
+ async adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesConfigurationSchemaResponseWrapper>> {
15236
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDConfigSchemaGet(xStoreID, options);
15237
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15238
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDConfigSchemaGet']?.[localVarOperationServerIndex]?.url;
15239
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15240
+ },
15241
+ /**
15242
+ * Get default configuration values computed from the store\'s index schema using x-store ID
15243
+ * @summary Get Store Schema-Based Defaults
15244
+ * @param {string} xStoreID X-Store ID
15245
+ * @param {*} [options] Override http request option.
15246
+ * @throws {RequiredError}
15247
+ */
15248
+ async adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper>> {
15249
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminStoresXStoreIDDefaultsGet(xStoreID, options);
15250
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15251
+ const localVarOperationServerBasePath = operationServerMap['StoresApi.adminStoresXStoreIDDefaultsGet']?.[localVarOperationServerIndex]?.url;
15252
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15253
+ },
14440
15254
  }
14441
15255
  };
14442
15256
 
@@ -14447,6 +15261,15 @@ export const StoresApiFp = function(configuration?: Configuration) {
14447
15261
  export const StoresApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14448
15262
  const localVarFp = StoresApiFp(configuration)
14449
15263
  return {
15264
+ /**
15265
+ * Fetches list of all stores for the authenticated user\'s organization
15266
+ * @summary Fetches list of all stores
15267
+ * @param {*} [options] Override http request option.
15268
+ * @throws {RequiredError}
15269
+ */
15270
+ adminStoresGet(options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoresListResponse> {
15271
+ return localVarFp.adminStoresGet(options).then((request) => request(axios, basePath));
15272
+ },
14450
15273
  /**
14451
15274
  * Fetches stores by id
14452
15275
  * @summary Fetches stores by id
@@ -14458,14 +15281,14 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
14458
15281
  return localVarFp.adminStoresGetStoreStoreIDGet(storeID, options).then((request) => request(axios, basePath));
14459
15282
  },
14460
15283
  /**
14461
- * Fetches list of all stores
14462
- * @summary Fetches list of all stores
14463
- * @param {number} orgId Org ID
15284
+ * Fetches stores by xStoreID
15285
+ * @summary Fetches stores by xStoreID
15286
+ * @param {string} xStoreID X-Store ID
14464
15287
  * @param {*} [options] Override http request option.
14465
15288
  * @throws {RequiredError}
14466
15289
  */
14467
- adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoresListResponse> {
14468
- return localVarFp.adminStoresOrgIdGet(orgId, options).then((request) => request(axios, basePath));
15290
+ adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesStoreResponse> {
15291
+ return localVarFp.adminStoresGetStoreXStoreIDGet(xStoreID, options).then((request) => request(axios, basePath));
14469
15292
  },
14470
15293
  /**
14471
15294
  * Adds a new store to the system
@@ -14499,6 +15322,47 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
14499
15322
  adminStoresUpdateStatusIdStatusPut(id: number, status: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesResponse> {
14500
15323
  return localVarFp.adminStoresUpdateStatusIdStatusPut(id, status, options).then((request) => request(axios, basePath));
14501
15324
  },
15325
+ /**
15326
+ * Retrieves the store configuration using x-store ID
15327
+ * @summary Get Store Config
15328
+ * @param {string} xStoreID X-Store ID
15329
+ * @param {*} [options] Override http request option.
15330
+ * @throws {RequiredError}
15331
+ */
15332
+ adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper> {
15333
+ return localVarFp.adminStoresXStoreIDConfigGet(xStoreID, options).then((request) => request(axios, basePath));
15334
+ },
15335
+ /**
15336
+ * Updates the store configuration using x-store ID
15337
+ * @summary Update Store Config
15338
+ * @param {string} xStoreID X-Store ID
15339
+ * @param {DataTypesIndexConfig} body Store configuration
15340
+ * @param {*} [options] Override http request option.
15341
+ * @throws {RequiredError}
15342
+ */
15343
+ adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesIndexConfigResponseWrapper> {
15344
+ return localVarFp.adminStoresXStoreIDConfigPut(xStoreID, body, options).then((request) => request(axios, basePath));
15345
+ },
15346
+ /**
15347
+ * Get metadata about all configurable fields for store configuration using x-store ID
15348
+ * @summary Get Store Config Schema
15349
+ * @param {string} xStoreID X-Store ID to get field options from
15350
+ * @param {*} [options] Override http request option.
15351
+ * @throws {RequiredError}
15352
+ */
15353
+ adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesConfigurationSchemaResponseWrapper> {
15354
+ return localVarFp.adminStoresXStoreIDConfigSchemaGet(xStoreID, options).then((request) => request(axios, basePath));
15355
+ },
15356
+ /**
15357
+ * Get default configuration values computed from the store\'s index schema using x-store ID
15358
+ * @summary Get Store Schema-Based Defaults
15359
+ * @param {string} xStoreID X-Store ID
15360
+ * @param {*} [options] Override http request option.
15361
+ * @throws {RequiredError}
15362
+ */
15363
+ adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig): AxiosPromise<DataTypesSchemaBasedDefaultsResponseWrapper> {
15364
+ return localVarFp.adminStoresXStoreIDDefaultsGet(xStoreID, options).then((request) => request(axios, basePath));
15365
+ },
14502
15366
  };
14503
15367
  };
14504
15368
 
@@ -14509,6 +15373,17 @@ export const StoresApiFactory = function (configuration?: Configuration, basePat
14509
15373
  * @extends {BaseAPI}
14510
15374
  */
14511
15375
  export class StoresApi extends BaseAPI {
15376
+ /**
15377
+ * Fetches list of all stores for the authenticated user\'s organization
15378
+ * @summary Fetches list of all stores
15379
+ * @param {*} [options] Override http request option.
15380
+ * @throws {RequiredError}
15381
+ * @memberof StoresApi
15382
+ */
15383
+ public adminStoresGet(options?: RawAxiosRequestConfig) {
15384
+ return StoresApiFp(this.configuration).adminStoresGet(options).then((request) => request(this.axios, this.basePath));
15385
+ }
15386
+
14512
15387
  /**
14513
15388
  * Fetches stores by id
14514
15389
  * @summary Fetches stores by id
@@ -14522,15 +15397,15 @@ export class StoresApi extends BaseAPI {
14522
15397
  }
14523
15398
 
14524
15399
  /**
14525
- * Fetches list of all stores
14526
- * @summary Fetches list of all stores
14527
- * @param {number} orgId Org ID
15400
+ * Fetches stores by xStoreID
15401
+ * @summary Fetches stores by xStoreID
15402
+ * @param {string} xStoreID X-Store ID
14528
15403
  * @param {*} [options] Override http request option.
14529
15404
  * @throws {RequiredError}
14530
15405
  * @memberof StoresApi
14531
15406
  */
14532
- public adminStoresOrgIdGet(orgId: number, options?: RawAxiosRequestConfig) {
14533
- return StoresApiFp(this.configuration).adminStoresOrgIdGet(orgId, options).then((request) => request(this.axios, this.basePath));
15407
+ public adminStoresGetStoreXStoreIDGet(xStoreID: string, options?: RawAxiosRequestConfig) {
15408
+ return StoresApiFp(this.configuration).adminStoresGetStoreXStoreIDGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
14534
15409
  }
14535
15410
 
14536
15411
  /**
@@ -14570,6 +15445,55 @@ export class StoresApi extends BaseAPI {
14570
15445
  public adminStoresUpdateStatusIdStatusPut(id: number, status: boolean, options?: RawAxiosRequestConfig) {
14571
15446
  return StoresApiFp(this.configuration).adminStoresUpdateStatusIdStatusPut(id, status, options).then((request) => request(this.axios, this.basePath));
14572
15447
  }
15448
+
15449
+ /**
15450
+ * Retrieves the store configuration using x-store ID
15451
+ * @summary Get Store Config
15452
+ * @param {string} xStoreID X-Store ID
15453
+ * @param {*} [options] Override http request option.
15454
+ * @throws {RequiredError}
15455
+ * @memberof StoresApi
15456
+ */
15457
+ public adminStoresXStoreIDConfigGet(xStoreID: string, options?: RawAxiosRequestConfig) {
15458
+ return StoresApiFp(this.configuration).adminStoresXStoreIDConfigGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
15459
+ }
15460
+
15461
+ /**
15462
+ * Updates the store configuration using x-store ID
15463
+ * @summary Update Store Config
15464
+ * @param {string} xStoreID X-Store ID
15465
+ * @param {DataTypesIndexConfig} body Store configuration
15466
+ * @param {*} [options] Override http request option.
15467
+ * @throws {RequiredError}
15468
+ * @memberof StoresApi
15469
+ */
15470
+ public adminStoresXStoreIDConfigPut(xStoreID: string, body: DataTypesIndexConfig, options?: RawAxiosRequestConfig) {
15471
+ return StoresApiFp(this.configuration).adminStoresXStoreIDConfigPut(xStoreID, body, options).then((request) => request(this.axios, this.basePath));
15472
+ }
15473
+
15474
+ /**
15475
+ * Get metadata about all configurable fields for store configuration using x-store ID
15476
+ * @summary Get Store Config Schema
15477
+ * @param {string} xStoreID X-Store ID to get field options from
15478
+ * @param {*} [options] Override http request option.
15479
+ * @throws {RequiredError}
15480
+ * @memberof StoresApi
15481
+ */
15482
+ public adminStoresXStoreIDConfigSchemaGet(xStoreID: string, options?: RawAxiosRequestConfig) {
15483
+ return StoresApiFp(this.configuration).adminStoresXStoreIDConfigSchemaGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
15484
+ }
15485
+
15486
+ /**
15487
+ * Get default configuration values computed from the store\'s index schema using x-store ID
15488
+ * @summary Get Store Schema-Based Defaults
15489
+ * @param {string} xStoreID X-Store ID
15490
+ * @param {*} [options] Override http request option.
15491
+ * @throws {RequiredError}
15492
+ * @memberof StoresApi
15493
+ */
15494
+ public adminStoresXStoreIDDefaultsGet(xStoreID: string, options?: RawAxiosRequestConfig) {
15495
+ return StoresApiFp(this.configuration).adminStoresXStoreIDDefaultsGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
15496
+ }
14573
15497
  }
14574
15498
 
14575
15499