Merge pull request #1 from openapi/upkeep

chore: init quality maintenance

Author: francescobianco

.github/REPOINFO.txt

@@ -0,0 +1,15 @@
+Image Description Sheet
+-----------------------
+
+File Name: repo-header-a3.png
+Format: PNG
+Dimensions: 830 x 173 pixels
+
+Short Description:
+A banner image featuring the word "Rust" on the left, Rust code snippet in the background,
+and the Openapi logo on the right.
+
+Purpose:
+This image is intended to be used as a header/banner for documentation or repository README.
+It visually associates Rust programming language with the Openapi SDK/client,
+giving a professional and modern look to the project materials.

.github/assets/repo-header-a3.png

@@ -1,3 +1,7 @@
+# IDE files
+.idea/
+.vscode/
+
 # Generated by Cargo
 # will have compiled files and executables
 debug/
@@ -13,4 +17,6 @@ Cargo.lock
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 
-main.rs
+# Project files
+main.rs
+.env

.github/assets/repo-header-a3.txt

@@ -1,7 +1,16 @@
 [package]
-name = "openapi_client"
-version = "0.1.0"
+name = "openapi-sdk"
+version = "0.1.1"
+authors = ["Michael Cuffaro (@maiku1008)", "Openapi® <hello@openapi.com>"]
 edition = "2021"
+description = "A fully-featured and blazing-fast Rust API client to interact with Openapi®"
+license = "MIT"
+categories = ["api-bindings", "web-programming", "asynchronous", "authentication", "development-tools"]
+documentation = "https://console.openapi.com/"
+homepage = "https://openapi.com/"
+keywords = ["openapi", "sdk", "client"]
+readme = "docs/crates-io.md"
+repository = "https://github.com/openapi/openapi-rust-sdk"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -11,4 +20,4 @@ serde = { version = "1.0", features = ["derive"] }
 base64 = "0.13.0"
 http = "0.2.9"
 tokio = {version="1.28.1", features = ["rt", "macros"]}
-serde_json = "1.0"
+serde_json = "1.0"

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Openapi S.r.l.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Cargo.lock

@@ -0,0 +1,57 @@
+#!make
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#                                                                             #
+#      ____                               _                                   #
+#     / __ \____  ___  ____  ____ _____  (_) ®                                # 
+#    / / / / __ \/ _ \/ __ \/ __ `/ __ \/ /                                   #
+#   / /_/ / /_/ /  __/ / / / /_/ / /_/ / /                                    #
+#   \____/ .___/\___/_/ /_/\__,_/ .___/_/                                     # 
+#       /_/                    /_/                                            #
+#                                                                             #
+#   The Largest Certified API Marketplace                                     #
+#   Accelerate Digital Transformation • Simplify Processes • Lead Industry    #
+#                                                                             #
+#   ═══════════════════════════════════════════════════════════════════════   #
+#                                                                             #
+#   Project:        openapi-rust-sdk                                          #
+#   Version:        0.1.0                                                     #
+#   Author:         Michael Cuffaro (@maiku1008)                              #
+#   Copyright:      (c) 2025 Openapi®. All rights reserved.                   #
+#   License:        MIT                                                       #
+#   Maintainer:     Francesco Bianco                                          #
+#   Contact:        https://openapi.com/                                      #
+#   Repository:     [Repository URL]                                          #
+#   Documentation:  [Docs URL]                                                #
+#                                                                             #
+#   ═══════════════════════════════════════════════════════════════════════   #
+#                                                                             #
+#   "Truth lies at the source of the stream."                                 #
+#                                  — English Proverb                          #
+#                                                                             #
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+
+## ====================
+## Development Commands
+## ====================
+
+dev-push:
+	@git config credential.helper 'cache --timeout=3600'
+	@git add .
+	@git commit -m "$$(read -p 'Commit message: ' msg; echo $$msg)" || true
+	@git push
+
+dev-version:
+	@grep '^version' Cargo.toml | head -n1 | cut -d '"' -f2
+
+## ==================
+## Packaging Commands
+## ==================
+
+publish:
+	@git add .
+	@git commit -m "Update release $$(make -s dev-version)" || true
+	@git push
+	@cargo login
+	@cargo publish

Cargo.toml

@@ -1,26 +1,58 @@
+<div align="center">
+  <a href="https://openapi.com/">
+    <img alt="Openapi SDK for Rust" src=".github/assets/repo-header-a3.png" >
+  </a>
 
-# OpenApi IT Rust Client 
+  <h1>Openapi® client for Rust</h1>
+  <h4>The perfect starting point to integrate <a href="https://openapi.com/">Openapi®</a> within your Rust project</h4>
 
-This client is used to interact with the API found at [openapi.it](https://openapi.it/)
+  [![Build Status](https://img.shields.io/github/actions/workflow/status/<username>/<repo>/rust.yml?branch=main)](https://github.com/<username>/<repo>/actions)
+  [![Crates.io](https://img.shields.io/crates/v/<crate_name>.svg)](https://crates.io/crates/<crate_name>)
+  [![Docs.rs](https://img.shields.io/docsrs/<crate_name>)](https://docs.rs/<crate_name>)
+  [![License](https://img.shields.io/github/license/<username>/<repo>)](LICENSE)
+  [![Rust Version](https://img.shields.io/badge/rust-1.80+-orange.svg)](https://www.rust-lang.org/)
+</div>
+
+## Overview
+
+This client provides an idiomatic Rust interface to the APIs available at [Openapi](https://openapi.com).
+It simplifies integration with the Openapi Marketplace, offering typed requests, async support, and built-in error handling.
+With this SDK you can quickly connect to hundreds of certified APIs and accelerate your digital transformation projects.
 
 ## Pre-requisites
 
-Before using the OpenApi IT Rust Client, you will need an account at [openapi.it](https://openapi.it/) and an API key to the sandbox and/or production environment
+Before using the Openapi Rust Client, you will need an account at [Openapi](https://console.openapi.com/) and an API key to the sandbox and/or production environment
+
+## What you can do
+
+With the Openapi Rust Client, you can easily interact with a variety of services in the Openapi Marketplace. For example, you can:
+
+- 📩 **Send SMS messages** with delivery reports and custom sender IDs
+- 💸 **Process bills and payments** in real time via API
+- 🧾 **Send electronic invoices** securely to the Italian Revenue Agency
+- 📄 **Generate PDFs** from HTML content, including JavaScript rendering
+- ✉️ **Manage certified emails** and legal communications via Italian Legalmail
+
+For a complete list of all available services, check out the [Openapi Marketplace](https://console.openapi.com/) 🌐
 
 ## Installation
 
-You can add the OpenApi IT Rust Client to your project with the following command:
+You can add the Openapi Rust Client to your project with the following command:
 
 ```bash
-cargo add openapiit-cli-rust
+cargo add openapi-sdk
 ```
 
 ## Usage
 
-```rust
-use std::collections::HashMap;
+The client has two main operational modes:
+
+### 1. Token Generation (OAuth Client)
+
+Use the `OauthClient` to generate access tokens for API access:
 
-use openapi_client::{Client, OauthClient};
+```rust
+use openapi_sdk::OauthClient;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Serialize, Deserialize)]
@@ -30,9 +62,8 @@ struct TokenResponse {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    // Initialize the oauthclient
-    let oauth_client =
-        OauthClient::new("<your_username>", "<your_apikey>", true).unwrap();
+    // Initialize the OAuth client
+    let oauth_client = OauthClient::new("<your_username>", "<your_apikey>", true)?;
 
     // Create a token for a list of scopes
     let scopes = vec![
@@ -44,18 +75,36 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     // The string response can be parsed into a custom object
     let resp: TokenResponse = serde_json::from_str(&result)?;
-    let token = resp.token;
+    println!("Generated token: {}", resp.token);
+
+    // Delete the token when done
+    let _result = oauth_client.delete_token(resp.token).await?;
+
+    Ok(())
+}
+```
+
+### 2. API Calls (Using Access Tokens)
+
+Use the `Client` to make API calls with your access tokens:
+
+```rust
+use openapi_sdk::Client;
+use serde::Serialize;
+use std::collections::HashMap;
 
-    // Initialize the client
-    let client = Client::new(token.clone()).unwrap();
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    // Initialize the client with your access token
+    let client = Client::new("<your_access_token>".to_string())?;
 
-    // Make a request with Params
+    // Make a request with parameters
     let mut params = HashMap::new();
     params.insert("denominazione", "altravia");
     params.insert("provincia", "RM");
     params.insert("codice_ateco", "6201");
 
-    let _result = client
+    let result = client
         .request::<serde_json::Value>(
             "GET",
             "https://test.imprese.openapi.it/advance",
@@ -64,7 +113,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         )
         .await?;
 
-    // Make a request with a payload, a nested json
+    println!("API Response: {}", result);
+
+    // Make a request with a JSON payload
     #[derive(Serialize)]
     struct Query {
         country_code: String,
@@ -79,9 +130,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let query = Query {
         country_code: "IT".to_string(),
     };
-    let payload = Payload { limit: 0, query };
+    let payload = Payload { limit: 10, query };
 
-    let _result = client
+    let result = client
         .request(
             "POST",
             "https://test.postontarget.com/fields/country",
@@ -90,28 +141,66 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         )
         .await?;
 
-    // Delete the token
-    let _result = oauth_client.delete_token(token).await?;
+    println!("POST Response: {}", result);
 
     Ok(())
 }
 ```
 
+## Examples
+
+You can find complete examples in the `examples/` directory:
+
+- `examples/token_generation.rs` - Token generation example
+- `examples/api_calls.rs` - API calls example
+
+Run examples with:
+```bash
+cargo run --example token_generation
+cargo run --example api_calls
+```
+
+## Testing
+
+Run tests with:
+```bash
+cargo test
+```
+
 ## Contributing
 
-Contributions are always welcome!
+Contributions are always welcome! Whether you want to report bugs, suggest new features, improve documentation, or contribute code, your help is appreciated.
+
+See [docs/contributing.md](docs/contributing.md) for detailed instructions on how to get started. Please make sure to follow this project's [docs/code-of-conduct.md](docs/code-of-conduct.md) to help maintain a welcoming and collaborative environment.
 
-See `contributing.md` for ways to get started.
+## Authors
+
+Meet the project authors:
+
+- Michael Cuffaro ([@maiku1008](https://www.github.com/maiku1008))
+- Openapi Team ([@openapi-it](https://github.com/openapi-it))
 
-Please adhere to this project's `code of conduct`.
+## Partners
 
+Meet our partners using Openapi or contributing to this SDK:
+
+- [Blank](https://www.blank.app/)
+- [Credit Safe](https://www.creditsafe.com/)
+- [Deliveroo](https://deliveroo.it/)
+- [Gruppo MOL](https://molgroupitaly.it/it/)
+- [Jakala](https://www.jakala.com/)
+- [Octotelematics](https://www.octotelematics.com/)
+- [OTOQI](https://otoqi.com/)
+- [PWC](https://www.pwc.com/)
+- [QOMODO S.R.L.](https://www.qomodo.me/)
+- [SOUNDREEF S.P.A.](https://www.soundreef.com/)
 
 ## License
 
-[MIT](https://choosealicense.com/licenses/mit/)
+This project is licensed under the [MIT License](LICENSE).
 
+The MIT License is a permissive open-source license that allows you to freely use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided that the original copyright notice and this permission notice are included in all copies or substantial portions of the software.
 
-## Authors
+In short, you are free to use this SDK in your personal, academic, or commercial projects, with minimal restrictions. The project is provided "as-is", without any warranty of any kind, either expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
 
-- [@maiku1008](https://www.github.com/maiku1008)
-- [@openapi-it](https://github.com/openapi-it)
+For more details, see the full license text at the [MIT License page](https://choosealicense.com/licenses/mit/).