@seekora-ai/admin-api 1.1.80 → 1.1.82

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.
Files changed (29) hide show
  1. package/README.md +64 -52
  2. package/api.ts +1924 -990
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +1241 -733
  7. package/dist/api.js +1776 -1039
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +1241 -733
  15. package/dist/esm/api.js +1776 -1039
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/index.ts +1 -1
  27. package/package.json +1 -1
  28. package/seekora-ai-admin-api-1.1.82.tgz +0 -0
  29. package/seekora-ai-admin-api-1.1.80.tgz +0 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @seekora-ai/admin-api@1.1.80
1
+ ## @seekora-ai/admin-api@1.1.82
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @seekora-ai/admin-api@1.1.80 --save
39
+ npm install @seekora-ai/admin-api@1.1.82 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -200,6 +200,7 @@ Class | Method | HTTP request | Description
200
200
  *BillingDashboardApi* | [**adminBillingInvoicesIdDelete**](docs/BillingDashboardApi.md#adminbillinginvoicesiddelete) | **DELETE** /admin/billing/invoices/{id} | Delete invoice
201
201
  *BillingDashboardApi* | [**adminBillingInvoicesIdDownloadGet**](docs/BillingDashboardApi.md#adminbillinginvoicesiddownloadget) | **GET** /admin/billing/invoices/{id}/download | Download invoice
202
202
  *BillingDashboardApi* | [**adminBillingInvoicesIdGet**](docs/BillingDashboardApi.md#adminbillinginvoicesidget) | **GET** /admin/billing/invoices/{id} | Get invoice
203
+ *BillingDashboardApi* | [**adminBillingInvoicesIdPdfUrlGet**](docs/BillingDashboardApi.md#adminbillinginvoicesidpdfurlget) | **GET** /admin/billing/invoices/{id}/pdf-url | Get invoice PDF signed URL
203
204
  *BillingDashboardApi* | [**adminBillingInvoicesIdPut**](docs/BillingDashboardApi.md#adminbillinginvoicesidput) | **PUT** /admin/billing/invoices/{id} | Update invoice
204
205
  *BillingDashboardApi* | [**adminBillingInvoicesInvoiceIdPayPost**](docs/BillingDashboardApi.md#adminbillinginvoicesinvoiceidpaypost) | **POST** /admin/billing/invoices/{invoice_id}/pay | Pay a pending invoice
205
206
  *BillingDashboardApi* | [**adminBillingOrdersGet**](docs/BillingDashboardApi.md#adminbillingordersget) | **GET** /admin/billing/orders | Get orders
@@ -214,6 +215,7 @@ Class | Method | HTTP request | Description
214
215
  *BillingDashboardApi* | [**adminBillingReceiptsGet**](docs/BillingDashboardApi.md#adminbillingreceiptsget) | **GET** /admin/billing/receipts | List receipts
215
216
  *BillingDashboardApi* | [**adminBillingReceiptsIdDownloadGet**](docs/BillingDashboardApi.md#adminbillingreceiptsiddownloadget) | **GET** /admin/billing/receipts/{id}/download | Download receipt PDF
216
217
  *BillingDashboardApi* | [**adminBillingReceiptsIdGet**](docs/BillingDashboardApi.md#adminbillingreceiptsidget) | **GET** /admin/billing/receipts/{id} | Get receipt by ID
218
+ *BillingDashboardApi* | [**adminBillingReceiptsIdPdfUrlGet**](docs/BillingDashboardApi.md#adminbillingreceiptsidpdfurlget) | **GET** /admin/billing/receipts/{id}/pdf-url | Get receipt PDF signed URL
217
219
  *BillingDashboardApi* | [**adminBillingSavedCardsGet**](docs/BillingDashboardApi.md#adminbillingsavedcardsget) | **GET** /admin/billing/saved-cards | Get saved payment cards
218
220
  *BillingDashboardApi* | [**adminBillingUsageDetailsGet**](docs/BillingDashboardApi.md#adminbillingusagedetailsget) | **GET** /admin/billing/usage-details | Get usage details with granularity and pagination
219
221
  *BillingDashboardApi* | [**apiAdminBillingCancelledSubscriptionsGet**](docs/BillingDashboardApi.md#apiadminbillingcancelledsubscriptionsget) | **GET** /api/admin/billing/cancelled-subscriptions | Get cancelled subscriptions history
@@ -229,24 +231,24 @@ Class | Method | HTTP request | Description
229
231
  *CommonApi* | [**v1CommonLanguagesGet**](docs/CommonApi.md#v1commonlanguagesget) | **GET** /v1/common/languages | Get Supported Languages
230
232
  *CompanyConfigApi* | [**adminV1ConfigCompanyGet**](docs/CompanyConfigApi.md#adminv1configcompanyget) | **GET** /admin/v1/config/company | Get company configuration
231
233
  *CompanyConfigApi* | [**adminV1ConfigCompanyPut**](docs/CompanyConfigApi.md#adminv1configcompanyput) | **PUT** /admin/v1/config/company | Update company configuration
232
- *ConnectorsApi* | [**v1ConnectorsGet**](docs/ConnectorsApi.md#v1connectorsget) | **GET** /v1/connectors | List Connectors
233
- *ConnectorsApi* | [**v1ConnectorsIdDelete**](docs/ConnectorsApi.md#v1connectorsiddelete) | **DELETE** /v1/connectors/{id} | Delete Connector
234
- *ConnectorsApi* | [**v1ConnectorsIdGet**](docs/ConnectorsApi.md#v1connectorsidget) | **GET** /v1/connectors/{id} | Get Connector
235
- *ConnectorsApi* | [**v1ConnectorsIdHistoryGet**](docs/ConnectorsApi.md#v1connectorsidhistoryget) | **GET** /v1/connectors/{id}/history | Get Sync History
236
- *ConnectorsApi* | [**v1ConnectorsIdPut**](docs/ConnectorsApi.md#v1connectorsidput) | **PUT** /v1/connectors/{id} | Update Connector
237
- *ConnectorsApi* | [**v1ConnectorsIdSyncPost**](docs/ConnectorsApi.md#v1connectorsidsyncpost) | **POST** /v1/connectors/{id}/sync | Trigger Sync
238
- *ConnectorsApi* | [**v1ConnectorsIdTestPost**](docs/ConnectorsApi.md#v1connectorsidtestpost) | **POST** /v1/connectors/{id}/test | Test Connection
234
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsGet**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsget) | **GET** /admin/analytics/store/{xStoreID}/connectors | List Connectors
235
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdDelete**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsiddelete) | **DELETE** /admin/analytics/store/{xStoreID}/connectors/{id} | Delete Connector
236
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdGet**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsidget) | **GET** /admin/analytics/store/{xStoreID}/connectors/{id} | Get Connector
237
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdHistoryGet**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsidhistoryget) | **GET** /admin/analytics/store/{xStoreID}/connectors/{id}/history | Get Sync History
238
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdPut**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsidput) | **PUT** /admin/analytics/store/{xStoreID}/connectors/{id} | Update Connector
239
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdSyncPost**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsidsyncpost) | **POST** /admin/analytics/store/{xStoreID}/connectors/{id}/sync | Trigger Sync
240
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsIdTestPost**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsidtestpost) | **POST** /admin/analytics/store/{xStoreID}/connectors/{id}/test | Test Connection
241
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsPost**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorspost) | **POST** /admin/analytics/store/{xStoreID}/connectors | Create Connector
242
+ *ConnectorsApi* | [**adminAnalyticsStoreXStoreIDConnectorsProvidersGet**](docs/ConnectorsApi.md#adminanalyticsstorexstoreidconnectorsprovidersget) | **GET** /admin/analytics/store/{xStoreID}/connectors/providers | Get Available Providers
239
243
  *ConnectorsApi* | [**v1ConnectorsJobstatusJobidValidationErrorsGet**](docs/ConnectorsApi.md#v1connectorsjobstatusjobidvalidationerrorsget) | **GET** /v1/connectors/jobstatus/{jobid}/validation-errors | Get validation errors for a job
240
- *ConnectorsApi* | [**v1ConnectorsPost**](docs/ConnectorsApi.md#v1connectorspost) | **POST** /v1/connectors | Create Connector
241
- *ConnectorsApi* | [**v1ConnectorsProvidersGet**](docs/ConnectorsApi.md#v1connectorsprovidersget) | **GET** /v1/connectors/providers | Get Available Providers
242
- *ConnectorsApi* | [**v1ConnectorsSearchIndexGet**](docs/ConnectorsApi.md#v1connectorssearchindexget) | **GET** /v1/connectors/search/{index} | Test search
243
- *ConnectorsApi* | [**v1ConnectorsSourcesGet**](docs/ConnectorsApi.md#v1connectorssourcesget) | **GET** /v1/connectors/sources | Get all sources
244
- *ConnectorsApi* | [**v1ConnectorsSourcesPost**](docs/ConnectorsApi.md#v1connectorssourcespost) | **POST** /v1/connectors/sources | Create source
245
- *ConnectorsApi* | [**v1ConnectorsSourcesSourceIdConfigPut**](docs/ConnectorsApi.md#v1connectorssourcessourceidconfigput) | **PUT** /v1/connectors/sources/:source_id/config | Update source config by id
246
- *ConnectorsApi* | [**v1ConnectorsSourcesSourceIdGet**](docs/ConnectorsApi.md#v1connectorssourcessourceidget) | **GET** /v1/connectors/sources/:source_id | Get source by id
247
- *ConnectorsApi* | [**v1ConnectorsSourcesSourceidUpdateschemaPost**](docs/ConnectorsApi.md#v1connectorssourcessourceidupdateschemapost) | **POST** /v1/connectors/sources/:sourceid/updateschema | Update Index schema
244
+ *ConnectorsApi* | [**v1ConnectorsSearchIndexGet**](docs/ConnectorsApi.md#v1connectorssearchindexget) | **GET** /v1/connectors/search/{index} | Test search for an index
245
+ *ConnectorsApi* | [**v1ConnectorsSourcesGet**](docs/ConnectorsApi.md#v1connectorssourcesget) | **GET** /v1/connectors/sources | List data sources
246
+ *ConnectorsApi* | [**v1ConnectorsSourcesPost**](docs/ConnectorsApi.md#v1connectorssourcespost) | **POST** /v1/connectors/sources | Create data source
247
+ *ConnectorsApi* | [**v1ConnectorsSourcesSourceIdConfigPut**](docs/ConnectorsApi.md#v1connectorssourcessourceidconfigput) | **PUT** /v1/connectors/sources/:source_id/config | Update source config
248
+ *ConnectorsApi* | [**v1ConnectorsSourcesSourceIdGet**](docs/ConnectorsApi.md#v1connectorssourcessourceidget) | **GET** /v1/connectors/sources/:source_id | Get source by ID
249
+ *ConnectorsApi* | [**v1ConnectorsSourcesSourceidUpdateschemaPost**](docs/ConnectorsApi.md#v1connectorssourcessourceidupdateschemapost) | **POST** /v1/connectors/sources/:sourceid/updateschema | Update source index schema
248
250
  *ConnectorsApi* | [**v1ConnectorsSourcesSourceidUploaddataPost**](docs/ConnectorsApi.md#v1connectorssourcessourceiduploaddatapost) | **POST** /v1/connectors/sources/:sourceid/uploaddata | Upload source data
249
- *ConnectorsApi* | [**v1ConnectorsTasksPost**](docs/ConnectorsApi.md#v1connectorstaskspost) | **POST** /v1/connectors/tasks | Create task
251
+ *ConnectorsApi* | [**v1ConnectorsTasksPost**](docs/ConnectorsApi.md#v1connectorstaskspost) | **POST** /v1/connectors/tasks | Create connector task
250
252
  *ConnectorsApi* | [**v1ConnectorsTasksTaskIdRunPost**](docs/ConnectorsApi.md#v1connectorstaskstaskidrunpost) | **POST** /v1/connectors/tasks/{task_id}/run | Trigger task run
251
253
  *CreditsApi* | [**creditsAdminAdjustPost**](docs/CreditsApi.md#creditsadminadjustpost) | **POST** /credits/admin/adjust | Manually adjust organization credits
252
254
  *CreditsApi* | [**creditsBalanceDetailedGet**](docs/CreditsApi.md#creditsbalancedetailedget) | **GET** /credits/balance/detailed | Get detailed organization credit balance
@@ -257,16 +259,16 @@ Class | Method | HTTP request | Description
257
259
  *CreditsApi* | [**creditsPlansGet**](docs/CreditsApi.md#creditsplansget) | **GET** /credits/plans | Get available credit plans
258
260
  *CreditsApi* | [**creditsPurchasePost**](docs/CreditsApi.md#creditspurchasepost) | **POST** /credits/purchase | Purchase credits
259
261
  *CreditsApi* | [**creditsTransactionsGet**](docs/CreditsApi.md#creditstransactionsget) | **GET** /credits/transactions | Get organization credit transactions
260
- *CustomEventsApi* | [**v1AnalyticsCustomEventsGet**](docs/CustomEventsApi.md#v1analyticscustomeventsget) | **GET** /v1/analytics/custom-events | List Custom Event Types
261
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdDelete**](docs/CustomEventsApi.md#v1analyticscustomeventsiddelete) | **DELETE** /v1/analytics/custom-events/{id} | Delete Custom Event Type
262
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdFieldsFidDelete**](docs/CustomEventsApi.md#v1analyticscustomeventsidfieldsfiddelete) | **DELETE** /v1/analytics/custom-events/{id}/fields/{fid} | Remove Field
263
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdFieldsFidPut**](docs/CustomEventsApi.md#v1analyticscustomeventsidfieldsfidput) | **PUT** /v1/analytics/custom-events/{id}/fields/{fid} | Update Field
264
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdFieldsPost**](docs/CustomEventsApi.md#v1analyticscustomeventsidfieldspost) | **POST** /v1/analytics/custom-events/{id}/fields | Add Field to Custom Event Type
265
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdGet**](docs/CustomEventsApi.md#v1analyticscustomeventsidget) | **GET** /v1/analytics/custom-events/{id} | Get Custom Event Type
266
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdPut**](docs/CustomEventsApi.md#v1analyticscustomeventsidput) | **PUT** /v1/analytics/custom-events/{id} | Update Custom Event Type
267
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdSlotsGet**](docs/CustomEventsApi.md#v1analyticscustomeventsidslotsget) | **GET** /v1/analytics/custom-events/{id}/slots | Get Available Slots
268
- *CustomEventsApi* | [**v1AnalyticsCustomEventsIdValidatePost**](docs/CustomEventsApi.md#v1analyticscustomeventsidvalidatepost) | **POST** /v1/analytics/custom-events/{id}/validate | Validate Event Payload
269
- *CustomEventsApi* | [**v1AnalyticsCustomEventsPost**](docs/CustomEventsApi.md#v1analyticscustomeventspost) | **POST** /v1/analytics/custom-events | Create Custom Event Type
262
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsGet**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsget) | **GET** /admin/analytics/store/{xStoreID}/custom-events | List Custom Event Types
263
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdDelete**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsiddelete) | **DELETE** /admin/analytics/store/{xStoreID}/custom-events/{id} | Delete Custom Event Type
264
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidDelete**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidfieldsfiddelete) | **DELETE** /admin/analytics/store/{xStoreID}/custom-events/{id}/fields/{fid} | Remove Field
265
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdFieldsFidPut**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidfieldsfidput) | **PUT** /admin/analytics/store/{xStoreID}/custom-events/{id}/fields/{fid} | Update Field
266
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdFieldsPost**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidfieldspost) | **POST** /admin/analytics/store/{xStoreID}/custom-events/{id}/fields | Add Field to Custom Event Type
267
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdGet**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidget) | **GET** /admin/analytics/store/{xStoreID}/custom-events/{id} | Get Custom Event Type
268
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdPut**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidput) | **PUT** /admin/analytics/store/{xStoreID}/custom-events/{id} | Update Custom Event Type
269
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdSlotsGet**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidslotsget) | **GET** /admin/analytics/store/{xStoreID}/custom-events/{id}/slots | Get Available Slots
270
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsIdValidatePost**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventsidvalidatepost) | **POST** /admin/analytics/store/{xStoreID}/custom-events/{id}/validate | Validate Event Payload
271
+ *CustomEventsApi* | [**adminAnalyticsStoreXStoreIDCustomEventsPost**](docs/CustomEventsApi.md#adminanalyticsstorexstoreidcustomeventspost) | **POST** /admin/analytics/store/{xStoreID}/custom-events | Create Custom Event Type
270
272
  *CustomStopwordsApi* | [**adminStoresXStoreIDStopwordsCustomWordlistsCustomWordListIDDelete**](docs/CustomStopwordsApi.md#adminstoresxstoreidstopwordscustomwordlistscustomwordlistiddelete) | **DELETE** /admin/Stores/{xStoreID}/stopwords/custom-wordlists/{customWordListID} | Delete custom word list
271
273
  *CustomStopwordsApi* | [**adminStoresXStoreIDStopwordsCustomWordlistsCustomWordListIDGet**](docs/CustomStopwordsApi.md#adminstoresxstoreidstopwordscustomwordlistscustomwordlistidget) | **GET** /admin/Stores/{xStoreID}/stopwords/custom-wordlists/{customWordListID} | Get custom word list by ID
272
274
  *CustomStopwordsApi* | [**adminStoresXStoreIDStopwordsCustomWordlistsCustomWordListIDPut**](docs/CustomStopwordsApi.md#adminstoresxstoreidstopwordscustomwordlistscustomwordlistidput) | **PUT** /admin/Stores/{xStoreID}/stopwords/custom-wordlists/{customWordListID} | Update custom word list
@@ -294,7 +296,7 @@ Class | Method | HTTP request | Description
294
296
  *DocumentationApi* | [**v1DocsRecreateCollectionPost**](docs/DocumentationApi.md#v1docsrecreatecollectionpost) | **POST** /v1/docs/recreate-collection | Recreate docs collection for infix search
295
297
  *DocumentationApi* | [**v1DocsScrapePost**](docs/DocumentationApi.md#v1docsscrapepost) | **POST** /v1/docs/scrape | Scrape and index documentation
296
298
  *DocumentationApi* | [**v1DocsSearchPost**](docs/DocumentationApi.md#v1docssearchpost) | **POST** /v1/docs/search | Search documentation
297
- *DocumentationApi* | [**v1DocsSuggestionsGet**](docs/DocumentationApi.md#v1docssuggestionsget) | **GET** /v1/docs/suggestions | Get search suggestions
299
+ *DocumentationApi* | [**v1DocsSuggestionsGet**](docs/DocumentationApi.md#v1docssuggestionsget) | **GET** /v1/docs/suggestions | Get doc search suggestions
298
300
  *DocumentationApi* | [**v1DocsUpdatePut**](docs/DocumentationApi.md#v1docsupdateput) | **PUT** /v1/docs/update | Update documentation
299
301
  *DocumentsApi* | [**adminStoresXStoreIDUploadPost**](docs/DocumentsApi.md#adminstoresxstoreiduploadpost) | **POST** /admin/Stores/{xStoreID}/upload | Upload a document
300
302
  *ExternalAPINotificationsApi* | [**v1ExternalNotificationsSchedulePost**](docs/ExternalAPINotificationsApi.md#v1externalnotificationsschedulepost) | **POST** /v1/external/notifications/schedule | Schedule notification (External API)
@@ -440,9 +442,9 @@ Class | Method | HTTP request | Description
440
442
  *PluralsDeclensionsApi* | [**adminStoresXStoreIDPluralsDeclensionsPost**](docs/PluralsDeclensionsApi.md#adminstoresxstoreidpluralsdeclensionspost) | **POST** /admin/Stores/{xStoreID}/plurals-declensions | Create plural/declension group
441
443
  *PluralsDeclensionsApi* | [**adminStoresXStoreIDPluralsDeclensionsUploadCsvPost**](docs/PluralsDeclensionsApi.md#adminstoresxstoreidpluralsdeclensionsuploadcsvpost) | **POST** /admin/Stores/{xStoreID}/plurals-declensions/upload-csv | Upload plural/declension groups from CSV file
442
444
  *PluralsDeclensionsApi* | [**adminStoresXStoreIDPluralsDeclensionsUploadJsonPost**](docs/PluralsDeclensionsApi.md#adminstoresxstoreidpluralsdeclensionsuploadjsonpost) | **POST** /admin/Stores/{xStoreID}/plurals-declensions/upload-json | Upload plural/declension groups from JSON file
443
- *QuerySuggestionsApi* | [**v1SuggestionsConfigGet**](docs/QuerySuggestionsApi.md#v1suggestionsconfigget) | **GET** /v1/suggestions/config | Get Query Suggestions Configuration
444
- *QuerySuggestionsApi* | [**v1SuggestionsQueriesGet**](docs/QuerySuggestionsApi.md#v1suggestionsqueriesget) | **GET** /v1/suggestions/queries | Get Query Suggestions
445
- *QuerySuggestionsApi* | [**v1SuggestionsQueriesPost**](docs/QuerySuggestionsApi.md#v1suggestionsqueriespost) | **POST** /v1/suggestions/queries | Post Query Suggestions
445
+ *QuerySuggestionsApi* | [**v1SuggestionsConfigGet**](docs/QuerySuggestionsApi.md#v1suggestionsconfigget) | **GET** /v1/suggestions/config | Get suggestions configuration
446
+ *QuerySuggestionsApi* | [**v1SuggestionsQueriesGet**](docs/QuerySuggestionsApi.md#v1suggestionsqueriesget) | **GET** /v1/suggestions/queries | Get query suggestions (GET)
447
+ *QuerySuggestionsApi* | [**v1SuggestionsQueriesPost**](docs/QuerySuggestionsApi.md#v1suggestionsqueriespost) | **POST** /v1/suggestions/queries | Get query suggestions (POST)
446
448
  *QuerySuggestionsManagementApi* | [**adminV1QuerySuggestionsMigrateAllPost**](docs/QuerySuggestionsManagementApi.md#adminv1querysuggestionsmigrateallpost) | **POST** /admin/v1/query-suggestions/migrate-all | Migrate All Stores Data
447
449
  *QuerySuggestionsManagementApi* | [**adminV1QuerySuggestionsXStoreIDApplyFiltersPost**](docs/QuerySuggestionsManagementApi.md#adminv1querysuggestionsxstoreidapplyfilterspost) | **POST** /admin/v1/query-suggestions/{xStoreID}/apply-filters | Apply Suggestion Filters
448
450
  *QuerySuggestionsManagementApi* | [**adminV1QuerySuggestionsXStoreIDBannedExpressionsExpressionIDDelete**](docs/QuerySuggestionsManagementApi.md#adminv1querysuggestionsxstoreidbannedexpressionsexpressioniddelete) | **DELETE** /admin/v1/query-suggestions/{xStoreID}/banned-expressions/{expressionID} | Delete Banned Expression
@@ -508,26 +510,27 @@ Class | Method | HTTP request | Description
508
510
  *RolesApi* | [**adminRolesRoleIdPermissionsBackfillPost**](docs/RolesApi.md#adminrolesroleidpermissionsbackfillpost) | **POST** /admin/roles/{roleId}/permissions/backfill | Backfill missing store permissions for a role
509
511
  *RolesApi* | [**adminRolesRoleIdPermissionsGet**](docs/RolesApi.md#adminrolesroleidpermissionsget) | **GET** /admin/roles/{roleId}/permissions | Get role permissions with org-level and store-level separation
510
512
  *RolesApi* | [**adminRolesRoleIdPermissionsPut**](docs/RolesApi.md#adminrolesroleidpermissionsput) | **PUT** /admin/roles/{roleId}/permissions | Update role permissions
511
- *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsBulkPost**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentsbulkpost) | **POST** /api/v1/stores/{xStoreID}/documents/bulk | Bulk index documents (Public SDK API)
512
- *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsDocumentIDDelete**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentsdocumentiddelete) | **DELETE** /api/v1/stores/{xStoreID}/documents/{documentID} | Delete a document (Public SDK API)
513
- *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsPost**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentspost) | **POST** /api/v1/stores/{xStoreID}/documents | Index a single document (Public SDK API)
514
- *SDKQuerySuggestionsConfigApi* | [**apiV1StoresXStoreIDQuerySuggestionsConfigGet**](docs/SDKQuerySuggestionsConfigApi.md#apiv1storesxstoreidquerysuggestionsconfigget) | **GET** /api/v1/stores/{xStoreID}/query-suggestions/config | Get Query Suggestions Config (Public SDK API)
515
- *SDKQuerySuggestionsConfigApi* | [**apiV1StoresXStoreIDQuerySuggestionsConfigPut**](docs/SDKQuerySuggestionsConfigApi.md#apiv1storesxstoreidquerysuggestionsconfigput) | **PUT** /api/v1/stores/{xStoreID}/query-suggestions/config | Update Query Suggestions Config (Public SDK API)
516
- *SDKSchemaApi* | [**apiV1StoresXStoreIDDocumentsDelete**](docs/SDKSchemaApi.md#apiv1storesxstoreiddocumentsdelete) | **DELETE** /api/v1/stores/{xStoreID}/documents | Clear All Documents (Public SDK API)
517
- *SDKSchemaApi* | [**apiV1StoresXStoreIDSchemaGet**](docs/SDKSchemaApi.md#apiv1storesxstoreidschemaget) | **GET** /api/v1/stores/{xStoreID}/schema | Get Collection Schema (Public SDK API)
518
- *SDKSchemaApi* | [**apiV1StoresXStoreIDSchemaPost**](docs/SDKSchemaApi.md#apiv1storesxstoreidschemapost) | **POST** /api/v1/stores/{xStoreID}/schema | Create or Update Collection Schema (Public SDK API)
519
- *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigGet**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigget) | **GET** /api/v1/stores/{xStoreID}/config | Get Store Config (Public SDK API)
520
- *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigPut**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigput) | **PUT** /api/v1/stores/{xStoreID}/config | Update Store Config (Public SDK API)
521
- *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigSchemaGet**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigschemaget) | **GET** /api/v1/stores/{xStoreID}/config-schema | Get Store Config Schema (Public SDK API)
513
+ *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsBulkPost**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentsbulkpost) | **POST** /api/v1/stores/{xStoreID}/documents/bulk | Bulk index documents
514
+ *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsDocumentIDDelete**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentsdocumentiddelete) | **DELETE** /api/v1/stores/{xStoreID}/documents/{documentID} | Delete a document
515
+ *SDKDocumentsApi* | [**apiV1StoresXStoreIDDocumentsPost**](docs/SDKDocumentsApi.md#apiv1storesxstoreiddocumentspost) | **POST** /api/v1/stores/{xStoreID}/documents | Index a single document
516
+ *SDKQuerySuggestionsConfigApi* | [**apiV1StoresXStoreIDQuerySuggestionsConfigGet**](docs/SDKQuerySuggestionsConfigApi.md#apiv1storesxstoreidquerysuggestionsconfigget) | **GET** /api/v1/stores/{xStoreID}/query-suggestions/config | Get query suggestions configuration
517
+ *SDKQuerySuggestionsConfigApi* | [**apiV1StoresXStoreIDQuerySuggestionsConfigPut**](docs/SDKQuerySuggestionsConfigApi.md#apiv1storesxstoreidquerysuggestionsconfigput) | **PUT** /api/v1/stores/{xStoreID}/query-suggestions/config | Update query suggestions configuration
518
+ *SDKSchemaApi* | [**apiV1StoresXStoreIDDocumentsDelete**](docs/SDKSchemaApi.md#apiv1storesxstoreiddocumentsdelete) | **DELETE** /api/v1/stores/{xStoreID}/documents | Clear all documents
519
+ *SDKSchemaApi* | [**apiV1StoresXStoreIDSchemaGet**](docs/SDKSchemaApi.md#apiv1storesxstoreidschemaget) | **GET** /api/v1/stores/{xStoreID}/schema | Get index schema
520
+ *SDKSchemaApi* | [**apiV1StoresXStoreIDSchemaPost**](docs/SDKSchemaApi.md#apiv1storesxstoreidschemapost) | **POST** /api/v1/stores/{xStoreID}/schema | Create or update index schema
521
+ *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigGet**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigget) | **GET** /api/v1/stores/{xStoreID}/config | Get store configuration
522
+ *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigPut**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigput) | **PUT** /api/v1/stores/{xStoreID}/config | Update store configuration
523
+ *SDKStoreConfigApi* | [**apiV1StoresXStoreIDConfigSchemaGet**](docs/SDKStoreConfigApi.md#apiv1storesxstoreidconfigschemaget) | **GET** /api/v1/stores/{xStoreID}/config-schema | Get store config schema
522
524
  *SDKStoreCreationApi* | [**apiV1StoresPost**](docs/SDKStoreCreationApi.md#apiv1storespost) | **POST** /api/v1/stores | Create Store (Public SDK API)
523
- *SDKStoreInfoApi* | [**apiV1StoresXStoreIDGet**](docs/SDKStoreInfoApi.md#apiv1storesxstoreidget) | **GET** /api/v1/stores/{xStoreID} | Get Store Info (Public SDK API)
525
+ *SDKStoreInfoApi* | [**apiV1StoresXStoreIDGet**](docs/SDKStoreInfoApi.md#apiv1storesxstoreidget) | **GET** /api/v1/stores/{xStoreID} | Get store info
524
526
  *SearchApi* | [**adminV1SearchXStoreIDPost**](docs/SearchApi.md#adminv1searchxstoreidpost) | **POST** /admin/v1/search/{xStoreID} | Admin Search API
525
527
  *SearchApi* | [**v1IndexConfigSchemaGet**](docs/SearchApi.md#v1indexconfigschemaget) | **GET** /v1/index/config-schema | Get Configuration Schema
526
528
  *SearchApi* | [**v1IndexIndexnameConfigGet**](docs/SearchApi.md#v1indexindexnameconfigget) | **GET** /v1/index/{indexname}/config | Get Index Config
527
529
  *SearchApi* | [**v1IndexIndexnameConfigPost**](docs/SearchApi.md#v1indexindexnameconfigpost) | **POST** /v1/index/{indexname}/config | Index Config
528
530
  *SearchApi* | [**v1IndexIndexnameConfigPropertyPatch**](docs/SearchApi.md#v1indexindexnameconfigpropertypatch) | **PATCH** /v1/index/{indexname}/config/{property} | Update Index Config Property
529
531
  *SearchApi* | [**v1IndexIndexnameDefaultsGet**](docs/SearchApi.md#v1indexindexnamedefaultsget) | **GET** /v1/index/{indexname}/defaults | Get Schema-Based Defaults
530
- *SearchApi* | [**v1SearchPost**](docs/SearchApi.md#v1searchpost) | **POST** /v1/search | Public Search API
532
+ *SearchApi* | [**v1SearchGet**](docs/SearchApi.md#v1searchget) | **GET** /v1/search | Search (GET)
533
+ *SearchApi* | [**v1SearchPost**](docs/SearchApi.md#v1searchpost) | **POST** /v1/search | Search (POST)
531
534
  *StopwordsApi* | [**adminStoresStopwordsLanguagesGet**](docs/StopwordsApi.md#adminstoresstopwordslanguagesget) | **GET** /admin/Stores/stopwords/languages | Get available languages
532
535
  *StopwordsApi* | [**adminStoresXStoreIDStopwordsWordStatusPut**](docs/StopwordsApi.md#adminstoresxstoreidstopwordswordstatusput) | **PUT** /admin/Stores/{xStoreID}/stopwords/word-status | Update word status for store
533
536
  *StopwordsApi* | [**adminStoresXStoreIDStopwordsWordlistsGet**](docs/StopwordsApi.md#adminstoresxstoreidstopwordswordlistsget) | **GET** /admin/Stores/{xStoreID}/stopwords/wordlists | Get word lists by language
@@ -624,13 +627,13 @@ Class | Method | HTTP request | Description
624
627
  *UserApi* | [**adminUsersUserIdPermissionsPut**](docs/UserApi.md#adminusersuseridpermissionsput) | **PUT** /admin/users/{userId}/permissions | Update user\'s custom permissions
625
628
  *UserApi* | [**adminUsersUserIdPermissionsRoleGet**](docs/UserApi.md#adminusersuseridpermissionsroleget) | **GET** /admin/users/{userId}/permissions/role | Get user-specific role permissions with org-level and store-level separation
626
629
  *UserApi* | [**adminUsersUserIdPermissionsRolePut**](docs/UserApi.md#adminusersuseridpermissionsroleput) | **PUT** /admin/users/{userId}/permissions/role | Update user-specific role permissions
627
- *UserProfilesApi* | [**v1AnalyticsProfilesByAuthTokenAuthTokenGet**](docs/UserProfilesApi.md#v1analyticsprofilesbyauthtokenauthtokenget) | **GET** /v1/analytics/profiles/by-auth-token/{authToken} | Get User Profile by Auth Token
628
- *UserProfilesApi* | [**v1AnalyticsProfilesMergePost**](docs/UserProfilesApi.md#v1analyticsprofilesmergepost) | **POST** /v1/analytics/profiles/merge | Merge User Profiles
629
- *UserProfilesApi* | [**v1AnalyticsProfilesUserKeyEventsGet**](docs/UserProfilesApi.md#v1analyticsprofilesuserkeyeventsget) | **GET** /v1/analytics/profiles/{userKey}/events | Get User Events
630
- *UserProfilesApi* | [**v1AnalyticsProfilesUserKeyGet**](docs/UserProfilesApi.md#v1analyticsprofilesuserkeyget) | **GET** /v1/analytics/profiles/{userKey} | Get User Profile
631
- *UserProfilesApi* | [**v1AnalyticsProfilesUserKeyPersonalizationGet**](docs/UserProfilesApi.md#v1analyticsprofilesuserkeypersonalizationget) | **GET** /v1/analytics/profiles/{userKey}/personalization | Get Personalization Context
632
- *UserProfilesApi* | [**v1AnalyticsProfilesUserKeySegmentsGet**](docs/UserProfilesApi.md#v1analyticsprofilesuserkeysegmentsget) | **GET** /v1/analytics/profiles/{userKey}/segments | Get User Segments
633
- *UserProfilesApi* | [**v1AnalyticsProfilesUserKeySimilarGet**](docs/UserProfilesApi.md#v1analyticsprofilesuserkeysimilarget) | **GET** /v1/analytics/profiles/{userKey}/similar | Get Similar Users
630
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesByAuthTokenAuthTokenGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesbyauthtokenauthtokenget) | **GET** /admin/analytics/store/{xStoreID}/profiles/by-auth-token/{authToken} | Get User Profile by Auth Token
631
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesMergePost**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesmergepost) | **POST** /admin/analytics/store/{xStoreID}/profiles/merge | Merge User Profiles
632
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesUserKeyEventsGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesuserkeyeventsget) | **GET** /admin/analytics/store/{xStoreID}/profiles/{userKey}/events | Get User Events
633
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesUserKeyGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesuserkeyget) | **GET** /admin/analytics/store/{xStoreID}/profiles/{userKey} | Get User Profile
634
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesUserKeyPersonalizationGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesuserkeypersonalizationget) | **GET** /admin/analytics/store/{xStoreID}/profiles/{userKey}/personalization | Get Personalization Context
635
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesUserKeySegmentsGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesuserkeysegmentsget) | **GET** /admin/analytics/store/{xStoreID}/profiles/{userKey}/segments | Get User Segments
636
+ *UserProfilesApi* | [**adminAnalyticsStoreXStoreIDProfilesUserKeySimilarGet**](docs/UserProfilesApi.md#adminanalyticsstorexstoreidprofilesuserkeysimilarget) | **GET** /admin/analytics/store/{xStoreID}/profiles/{userKey}/similar | Get Similar Users
634
637
  *WebhooksApi* | [**v1WebhooksProviderOrgCodePost**](docs/WebhooksApi.md#v1webhooksproviderorgcodepost) | **POST** /v1/webhooks/{provider}/{org_code} | Handle Webhook
635
638
 
636
639
 
@@ -1222,6 +1225,7 @@ Class | Method | HTTP request | Description
1222
1225
  - [DataTypesSetPasswordRequest](docs/DataTypesSetPasswordRequest.md)
1223
1226
  - [DataTypesSetUserCustomPermissionsRequest](docs/DataTypesSetUserCustomPermissionsRequest.md)
1224
1227
  - [DataTypesSortField](docs/DataTypesSortField.md)
1228
+ - [DataTypesSortOption](docs/DataTypesSortOption.md)
1225
1229
  - [DataTypesSource](docs/DataTypesSource.md)
1226
1230
  - [DataTypesSourcesListResponse](docs/DataTypesSourcesListResponse.md)
1227
1231
  - [DataTypesStopwordEntry](docs/DataTypesStopwordEntry.md)
@@ -1341,6 +1345,7 @@ Class | Method | HTTP request | Description
1341
1345
  - [ModelsCreateCustomEventFieldRequest](docs/ModelsCreateCustomEventFieldRequest.md)
1342
1346
  - [ModelsCreateCustomEventTypeRequest](docs/ModelsCreateCustomEventTypeRequest.md)
1343
1347
  - [ModelsMergeProfilesResponse](docs/ModelsMergeProfilesResponse.md)
1348
+ - [ModelsNestedPropertyDefinition](docs/ModelsNestedPropertyDefinition.md)
1344
1349
  - [ModelsPersonalizationContext](docs/ModelsPersonalizationContext.md)
1345
1350
  - [ModelsSimilarUser](docs/ModelsSimilarUser.md)
1346
1351
  - [ModelsUpdateCustomEventFieldRequest](docs/ModelsUpdateCustomEventFieldRequest.md)
@@ -1428,6 +1433,13 @@ Class | Method | HTTP request | Description
1428
1433
 
1429
1434
 
1430
1435
  Authentication schemes defined for the API:
1436
+ <a id="ApiKeyAuth"></a>
1437
+ ### ApiKeyAuth
1438
+
1439
+ - **Type**: API key
1440
+ - **API key parameter name**: x-storesecret
1441
+ - **Location**: HTTP header
1442
+
1431
1443
  <a id="BearerAuth"></a>
1432
1444
  ### BearerAuth
1433
1445