geoprox-client 0.4.2

An HTTP client library for interacting with the Geoprox search engine
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

# Rust API client for geoprox-client

Geoprox server implementation providing a HTTP API for geospatial queries and position tracking


## 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.4.2
- Package version: 0.4.2
- Build date: 2024-08-12T18:38:29.738611818-04:00[America/New_York]
- Generator version: 7.7.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

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

```
geoprox-client = { path = "./geoprox-client" }
```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GeohashApiApi* | [**decode_geohash**](docs/GeohashApiApi.md#decode_geohash) | **GET** /api/v1/geohash/{ghash} | Decode geohash into coordinates.
*GeohashApiApi* | [**encode_latlng**](docs/GeohashApiApi.md#encode_latlng) | **GET** /api/v1/geohash | Encode coordinates into geohash
*GeohashApiApi* | [**get_neighbors**](docs/GeohashApiApi.md#get_neighbors) | **GET** /api/v1/geohash/{ghash}/neighbors | Neighboring regions
*GeoshardApiApi* | [**create_index**](docs/GeoshardApiApi.md#create_index) | **POST** /api/v1/shard/{index} | Create geospatial index
*GeoshardApiApi* | [**drop_index**](docs/GeoshardApiApi.md#drop_index) | **DELETE** /api/v1/shard/{index} | Deletes geospatial index
*GeoshardApiApi* | [**insert_key**](docs/GeoshardApiApi.md#insert_key) | **PUT** /api/v1/shard/{index} | Insert key into index
*GeoshardApiApi* | [**insert_key_batch**](docs/GeoshardApiApi.md#insert_key_batch) | **PUT** /api/v1/shard/{index}/batch | Insert multiple keys into index
*GeoshardApiApi* | [**query_range**](docs/GeoshardApiApi.md#query_range) | **GET** /api/v1/shard/{index} | Search index for objects nearby
*GeoshardApiApi* | [**query_range_many**](docs/GeoshardApiApi.md#query_range_many) | **GET** /api/v1/shard | Search multiple indices for objects nearby
*GeoshardApiApi* | [**remove_key**](docs/GeoshardApiApi.md#remove_key) | **PATCH** /api/v1/shard/{index} | Remove key from index
*GeoshardApiApi* | [**remove_key_batch**](docs/GeoshardApiApi.md#remove_key_batch) | **PATCH** /api/v1/shard/{index}/batch | Remove multiple keys from index


## Documentation For Models

 - [CreateIndexResponse](docs/CreateIndexResponse.md)
 - [DecodeGeohashResponse](docs/DecodeGeohashResponse.md)
 - [DropIndexResponse](docs/DropIndexResponse.md)
 - [EncodeLatLng](docs/EncodeLatLng.md)
 - [EncodeLatLngResponse](docs/EncodeLatLngResponse.md)
 - [GeohashNeighborsResponse](docs/GeohashNeighborsResponse.md)
 - [InsertKey](docs/InsertKey.md)
 - [InsertKeyBatch](docs/InsertKeyBatch.md)
 - [InsertKeyBatchResponse](docs/InsertKeyBatchResponse.md)
 - [InsertKeyResponse](docs/InsertKeyResponse.md)
 - [Neighbor](docs/Neighbor.md)
 - [QueryRange](docs/QueryRange.md)
 - [QueryRangeMany](docs/QueryRangeMany.md)
 - [QueryRangeManyResponse](docs/QueryRangeManyResponse.md)
 - [QueryRangeResponse](docs/QueryRangeResponse.md)
 - [RemoveKey](docs/RemoveKey.md)
 - [RemoveKeyBatch](docs/RemoveKeyBatch.md)
 - [RemoveKeyBatchResponse](docs/RemoveKeyBatchResponse.md)
 - [RemoveKeyResponse](docs/RemoveKeyResponse.md)


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

```
cargo doc --open
```

## Author

singhezra@gmail.com