# Rust API for timezynk-bridge-models

API for synchronizing and mapping data from and to Timezynk. Oauth2 authentication, require permission level manager or api-client with scope write:company. Info about authentication [https://developer.timezynk.com](https://developer.timezynk.com/#section/Authentication)

## Overview

This client/server was generated by the [openapi-generator]
(https://openapi-generator.tech) project.  By using the
[OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote
server, you can easily generate a server stub.

To see how to make this your own, look here:

[README]((https://openapi-generator.tech))

- API version: 0.1.4
- Build date: 2019-11-22T09:27:59.558Z[GMT]



This autogenerated project defines an API crate `timezynk-bridge-models` which contains:
* An `Api` trait defining the API in Rust.
* Data types representing the underlying data model.
* A `Client` type which implements `Api` and issues HTTP requests for each operation.
* A router which accepts HTTP requests and invokes the appropriate `Api` method for each operation.

It also contains an example server and client which make use of `timezynk-bridge-models`:

* The example server starts up a web server using the `timezynk-bridge-models`
    router, and supplies a trivial implementation of `Api` which returns failure
    for every operation.
* The example client provides a CLI which lets you invoke
    any single operation on the `timezynk-bridge-models` client by passing appropriate
    arguments on the command line.

You can use the example server and client as a basis for your own code.
See below for [more detail on implementing a server](#writing-a-server).

## Examples

Run examples with:

```
cargo run --example <example-name>
```

To pass in arguments to the examples, put them after `--`, for example:

```
cargo run --example client -- --help
```

### Running the example server
To run the server, follow these simple steps:

```
cargo run --example server
```

### Running the example client
To run a client, follow one of the following simple steps:

```
cargo run --example client DataSinksGet
cargo run --example client DataSinksPost
cargo run --example client DataSourcesGet
cargo run --example client DataSourcesPost
cargo run --example client EntitiesEntityIdChangesGet
cargo run --example client EntitiesEntityIdChangesPost
cargo run --example client EntitiesEntityIdNextSyncGet
cargo run --example client EntitiesEntityIdNextSyncPut
cargo run --example client EntitiesEntityIdPut
cargo run --example client EntitiesGet
cargo run --example client DataSourcesDataSourceIdSynchronizationStateGet
```

### HTTPS
The examples can be run in HTTPS mode by passing in the flag `--https`, for example:

```
cargo run --example server -- --https
```

This will use the keys/certificates from the examples directory. Note that the
server chain is signed with `CN=localhost`.

## Using the generated library

The generated library has a few optional features that can be activated through Cargo.

* `server`
    * This defaults to enabled and creates the basic skeleton of a server implementation based on hyper
    * To create the server stack you'll need to provide an implementation of the API trait to provide the server function.
* `client`
    * This defaults to enabled and creates the basic skeleton of a client implementation based on hyper
    * The constructed client implements the API trait by making remote API call.
* `conversions`
    * This defaults to disabled and creates extra derives on models to allow "transmogrification" between objects of structurally similar types.

See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section for how to use features in your `Cargo.toml`.

## Documentation for API Endpoints

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

Method | HTTP request | Description
------------- | ------------- | -------------
[****](docs/data_sink_api.md#) | **GET** /data-sinks | List registered datasources
[****](docs/data_sink_api.md#) | **POST** /data-sinks | Register a data source
[****](docs/data_source_api.md#) | **GET** /data-sources | List registered datasources
[****](docs/data_source_api.md#) | **POST** /data-sources | Register a data source
[****](docs/entity_api.md#) | **GET** /entities/{entityId}/changes | Sync changes from data source
[****](docs/entity_api.md#) | **POST** /entities/{entityId}/changes | Sync changes from data source
[****](docs/entity_api.md#) | **GET** /entities/{entityId}/next-sync | Next sync
[****](docs/entity_api.md#) | **PUT** /entities/{entityId}/next-sync | Next sync
[****](docs/entity_api.md#) | **PUT** /entities/{entityId} | Update entity
[****](docs/entity_api.md#) | **GET** /entities | List entities
[****](docs/source_api.md#) | **GET** /data-sources/{dataSourceId}/synchronization-state | Lists synchronization status for your data sources


## Documentation For Models

 - [DataSink](docs/DataSink.md)
 - [DataSource](docs/DataSource.md)
 - [Entity](docs/Entity.md)
 - [EntityNextSync](docs/EntityNextSync.md)
 - [EntitySettings](docs/EntitySettings.md)
 - [Field](docs/Field.md)
 - [FieldSettings](docs/FieldSettings.md)
 - [SynchronizationState](docs/SynchronizationState.md)


## Documentation For Authorization
 Endpoints do not require authorization.


## Author