/terminal-sdk-rs

unofficial rust sdk for terminal coffee (https://terminal.shop)

Primary LanguageRustMIT LicenseMIT

Rust API client for Terminal Products, Inc

Unofficial Rust API client for the Terminal API.

The Terminal API gives you access to the same API that powers the award winning Terminal SSH shop (ssh terminal.shop).

Installation

Add the following to Cargo.toml under [dependencies]:

[dependencies]
terminal = { git = "https://github.com/trvswgnr/terminal-sdk-rs.git" }

Using the Client

This SDK provides a convenient Client struct with methods for all API endpoints. The client is auto-generated at build time using the build.rs script, which parses all API modules and creates wrapper methods.

Creating a client

use terminal;

#[tokio::main]
async fn main() {
    let client = terminal::Client::default();
    let result = client.get_product().await;
    println!("{:?}", result);
}

The client provides methods for all API endpoints with proper type checking and documentation.

Contributing

The base SDK is generated using OpenAPI Generator - anything in the openapi folder is generated from the OpenAPI spec and should not be edited directly.

The build-rs folder contains the code that is used to generate the client from the generated OpenAPI code at build time.

Credits

This project is not affiliated with Terminal Products, Inc. and is not endorsed by them. It is an unofficial Rust client for the Terminal API.

The majority of the code for this project was generated by OpenAPI Generator.

Built with 🤬 by Travis Aaron Wagner.

License

This project is licensed under the MIT License. See the LICENSE file for details.