typesense_codegen 0.25.1

Types for typesense generated with openapi spec
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# Rust API client for openapi

An open source search engine for building delightful search experiences.


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 0.25.0
- Package version: 0.25.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:

```
openapi = { path = "./openapi" }
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AnalyticsApi* | [**create_analytics_rule**](docs/AnalyticsApi.md#create_analytics_rule) | **POST** /analytics/rules | Creates an analytics rule
*AnalyticsApi* | [**delete_analytics_rule**](docs/AnalyticsApi.md#delete_analytics_rule) | **DELETE** /analytics/rules/{ruleName} | Delete an analytics rule
*AnalyticsApi* | [**retrieve_analytics_rule**](docs/AnalyticsApi.md#retrieve_analytics_rule) | **GET** /analytics/rules/{ruleName} | Retrieves an analytics rule
*AnalyticsApi* | [**retrieve_analytics_rules**](docs/AnalyticsApi.md#retrieve_analytics_rules) | **GET** /analytics/rules | Retrieves all analytics rules
*CollectionsApi* | [**create_collection**](docs/CollectionsApi.md#create_collection) | **POST** /collections | Create a new collection
*CollectionsApi* | [**delete_alias**](docs/CollectionsApi.md#delete_alias) | **DELETE** /aliases/{aliasName} | Delete an alias
*CollectionsApi* | [**delete_collection**](docs/CollectionsApi.md#delete_collection) | **DELETE** /collections/{collectionName} | Delete a collection
*CollectionsApi* | [**get_alias**](docs/CollectionsApi.md#get_alias) | **GET** /aliases/{aliasName} | Retrieve an alias
*CollectionsApi* | [**get_aliases**](docs/CollectionsApi.md#get_aliases) | **GET** /aliases | List all aliases
*CollectionsApi* | [**get_collection**](docs/CollectionsApi.md#get_collection) | **GET** /collections/{collectionName} | Retrieve a single collection
*CollectionsApi* | [**get_collections**](docs/CollectionsApi.md#get_collections) | **GET** /collections | List all collections
*CollectionsApi* | [**update_collection**](docs/CollectionsApi.md#update_collection) | **PATCH** /collections/{collectionName} | Update a collection
*CollectionsApi* | [**upsert_alias**](docs/CollectionsApi.md#upsert_alias) | **PUT** /aliases/{aliasName} | Create or update a collection alias
*DebugApi* | [**debug**](docs/DebugApi.md#debug) | **GET** /debug | Print debugging information
*DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /collections/{collectionName}/documents/{documentId} | Delete a document
*DocumentsApi* | [**delete_documents**](docs/DocumentsApi.md#delete_documents) | **DELETE** /collections/{collectionName}/documents | Delete a bunch of documents
*DocumentsApi* | [**delete_search_override**](docs/DocumentsApi.md#delete_search_override) | **DELETE** /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection
*DocumentsApi* | [**delete_search_synonym**](docs/DocumentsApi.md#delete_search_synonym) | **DELETE** /collections/{collectionName}/synonyms/{synonymId} | Delete a synonym associated with a collection
*DocumentsApi* | [**export_documents**](docs/DocumentsApi.md#export_documents) | **GET** /collections/{collectionName}/documents/export | Export all documents in a collection
*DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /collections/{collectionName}/documents/{documentId} | Retreive a document
*DocumentsApi* | [**get_search_override**](docs/DocumentsApi.md#get_search_override) | **GET** /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override
*DocumentsApi* | [**get_search_overrides**](docs/DocumentsApi.md#get_search_overrides) | **GET** /collections/{collectionName}/overrides | List all collection overrides
*DocumentsApi* | [**get_search_synonym**](docs/DocumentsApi.md#get_search_synonym) | **GET** /collections/{collectionName}/synonyms/{synonymId} | Retrieve a single search synonym
*DocumentsApi* | [**get_search_synonyms**](docs/DocumentsApi.md#get_search_synonyms) | **GET** /collections/{collectionName}/synonyms | List all collection synonyms
*DocumentsApi* | [**import_documents**](docs/DocumentsApi.md#import_documents) | **POST** /collections/{collectionName}/documents/import | Import documents into a collection
*DocumentsApi* | [**index_document**](docs/DocumentsApi.md#index_document) | **POST** /collections/{collectionName}/documents | Index a document
*DocumentsApi* | [**multi_search**](docs/DocumentsApi.md#multi_search) | **POST** /multi_search | send multiple search requests in a single HTTP request
*DocumentsApi* | [**search_collection**](docs/DocumentsApi.md#search_collection) | **GET** /collections/{collectionName}/documents/search | Search for documents in a collection
*DocumentsApi* | [**update_document**](docs/DocumentsApi.md#update_document) | **PATCH** /collections/{collectionName}/documents/{documentId} | Update a document
*DocumentsApi* | [**update_documents**](docs/DocumentsApi.md#update_documents) | **PATCH** /collections/{collectionName}/documents | Update documents with conditional query
*DocumentsApi* | [**upsert_search_override**](docs/DocumentsApi.md#upsert_search_override) | **PUT** /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others
*DocumentsApi* | [**upsert_search_synonym**](docs/DocumentsApi.md#upsert_search_synonym) | **PUT** /collections/{collectionName}/synonyms/{synonymId} | Create or update a synonym
*HealthApi* | [**health**](docs/HealthApi.md#health) | **GET** /health | Checks if Typesense server is ready to accept requests.
*KeysApi* | [**create_key**](docs/KeysApi.md#create_key) | **POST** /keys | Create an API Key
*KeysApi* | [**delete_key**](docs/KeysApi.md#delete_key) | **DELETE** /keys/{keyId} | Delete an API key given its ID.
*KeysApi* | [**get_key**](docs/KeysApi.md#get_key) | **GET** /keys/{keyId} | Retrieve (metadata about) a key
*KeysApi* | [**get_keys**](docs/KeysApi.md#get_keys) | **GET** /keys | Retrieve (metadata about) all keys.
*OperationsApi* | [**take_snapshot**](docs/OperationsApi.md#take_snapshot) | **POST** /operations/snapshot | Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.
*OperationsApi* | [**vote**](docs/OperationsApi.md#vote) | **POST** /operations/vote | Triggers a follower node to initiate the raft voting process, which triggers leader re-election.
*OverrideApi* | [**get_search_override**](docs/OverrideApi.md#get_search_override) | **GET** /collections/{collectionName}/overrides/{overrideId} | Retrieve a single search override
*PromoteApi* | [**delete_search_override**](docs/PromoteApi.md#delete_search_override) | **DELETE** /collections/{collectionName}/overrides/{overrideId} | Delete an override associated with a collection
*PromoteApi* | [**get_search_overrides**](docs/PromoteApi.md#get_search_overrides) | **GET** /collections/{collectionName}/overrides | List all collection overrides
*PromoteApi* | [**upsert_search_override**](docs/PromoteApi.md#upsert_search_override) | **PUT** /collections/{collectionName}/overrides/{overrideId} | Create or update an override to promote certain documents over others


## Documentation For Models

 - [AnalyticsRuleParameters](docs/AnalyticsRuleParameters.md)
 - [AnalyticsRuleParametersDestination](docs/AnalyticsRuleParametersDestination.md)
 - [AnalyticsRuleParametersSource](docs/AnalyticsRuleParametersSource.md)
 - [AnalyticsRuleSchema](docs/AnalyticsRuleSchema.md)
 - [AnalyticsRulesRetrieveSchema](docs/AnalyticsRulesRetrieveSchema.md)
 - [ApiKey](docs/ApiKey.md)
 - [ApiKeySchema](docs/ApiKeySchema.md)
 - [ApiKeysResponse](docs/ApiKeysResponse.md)
 - [ApiResponse](docs/ApiResponse.md)
 - [CollectionAlias](docs/CollectionAlias.md)
 - [CollectionAliasSchema](docs/CollectionAliasSchema.md)
 - [CollectionAliasesResponse](docs/CollectionAliasesResponse.md)
 - [CollectionResponse](docs/CollectionResponse.md)
 - [CollectionSchema](docs/CollectionSchema.md)
 - [CollectionUpdateSchema](docs/CollectionUpdateSchema.md)
 - [Debug200Response](docs/Debug200Response.md)
 - [DeleteDocuments200Response](docs/DeleteDocuments200Response.md)
 - [DeleteDocumentsDeleteDocumentsParametersParameter](docs/DeleteDocumentsDeleteDocumentsParametersParameter.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [ExportDocumentsExportDocumentsParametersParameter](docs/ExportDocumentsExportDocumentsParametersParameter.md)
 - [FacetCounts](docs/FacetCounts.md)
 - [FacetCountsCountsInner](docs/FacetCountsCountsInner.md)
 - [FacetCountsStats](docs/FacetCountsStats.md)
 - [Field](docs/Field.md)
 - [FieldEmbed](docs/FieldEmbed.md)
 - [FieldEmbedModelConfig](docs/FieldEmbedModelConfig.md)
 - [HealthStatus](docs/HealthStatus.md)
 - [ImportDocumentsImportDocumentsParametersParameter](docs/ImportDocumentsImportDocumentsParametersParameter.md)
 - [MultiSearchCollectionParameters](docs/MultiSearchCollectionParameters.md)
 - [MultiSearchParameters](docs/MultiSearchParameters.md)
 - [MultiSearchResult](docs/MultiSearchResult.md)
 - [MultiSearchSearchesParameter](docs/MultiSearchSearchesParameter.md)
 - [ScopedKeyParameters](docs/ScopedKeyParameters.md)
 - [SearchGroupedHit](docs/SearchGroupedHit.md)
 - [SearchHighlight](docs/SearchHighlight.md)
 - [SearchOverride](docs/SearchOverride.md)
 - [SearchOverrideExclude](docs/SearchOverrideExclude.md)
 - [SearchOverrideInclude](docs/SearchOverrideInclude.md)
 - [SearchOverrideRule](docs/SearchOverrideRule.md)
 - [SearchOverrideSchema](docs/SearchOverrideSchema.md)
 - [SearchOverridesResponse](docs/SearchOverridesResponse.md)
 - [SearchParameters](docs/SearchParameters.md)
 - [SearchResult](docs/SearchResult.md)
 - [SearchResultHit](docs/SearchResultHit.md)
 - [SearchResultRequestParams](docs/SearchResultRequestParams.md)
 - [SearchSynonym](docs/SearchSynonym.md)
 - [SearchSynonymSchema](docs/SearchSynonymSchema.md)
 - [SearchSynonymsResponse](docs/SearchSynonymsResponse.md)
 - [SnapshotParameters](docs/SnapshotParameters.md)
 - [SuccessStatus](docs/SuccessStatus.md)
 - [UpdateDocuments200Response](docs/UpdateDocuments200Response.md)
 - [UpdateDocumentsUpdateDocumentsParametersParameter](docs/UpdateDocumentsUpdateDocumentsParametersParameter.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author