Merge pull request #6 from infobip-community/add-whatsapp

Add Whatsapp support

Author: strosek

Cargo.toml

@@ -7,7 +7,7 @@ homepage = "https://www.infobip.com/"
 license = "MIT OR Apache-2.0"
 name = "infobip_sdk"
 repository = "https://github.com/infobip-community/infobip-api-rust-sdk"
-version = "0.1.1"
+version = "0.2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -19,7 +19,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_derive = "1.0"
 serde_json = "1.0"
 thiserror = "1.0"
-tokio = { version = "1.20", features = ["full"] }
+tokio = { version = "1.21", features = ["full"] }
 validator = { version = "0.16", features = ["derive"] }
 
 [dev-dependencies]

README.md

@@ -2,28 +2,29 @@
 
 ![Workflow](https://github.com/infobip-community/infobip-api-rust-sdk/actions/workflows/rust.yml/badge.svg)
 [![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-MIT)
-![Crates.io](https://img.shields.io/crates/v/infobip_sdk)
+[![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-APACHE)
+[![Crates.io](https://img.shields.io/crates/v/infobip_sdk)](https://crates.io/crates/infobip_sdk)
 ![Crate downlads](https://img.shields.io/crates/d/rust_sdk)
 
 Client SDK to use the Infobip API with pure Rust.
 
-This library enables you to use multiple Infobip communication channels, like SMS, MMS,
-Whatsapp, Email, etc. It abstracts the needed HTTP calls, and models payloads and error
-handling. The module structure is divided by communication channel.
+This crate enables you to use multiple Infobip communication channels, like SMS, MMS,
+WhatsApp, Email, etc. It abstracts the needed HTTP calls, models and validates payloads and
+models errors. The module structure is divided by communication channel.
 
 ---
 
 ## 📡 Supported Channels
 - [SMS](https://www.infobip.com/docs/api/channels/sms)
-- [WhatsApp](https://www.infobip.com/docs/api/channels/whatsapp) (partially, in progress)
+- [WhatsApp](https://www.infobip.com/docs/api/channels/whatsapp)
 
 More Channels to be added in the near future!
 
 ## 🔐 Authentication
-To use the library, you'll need to set up an Infobip account. Then you can use your API Key and
-custom URL to call the endpoints. You can use the `Configuration::from_env_api_key()` method to
-load the configuration from the environment. To do that, export the variables `IB_API_KEY` and
-`IB_BASE_URL`.
+To use the library, you'll need to set up an [Infobip account](https://www.infobip.com/signup).
+Then you can use your API Key and custom base URL to call the endpoints. You can use the
+`Configuration::from_env_api_key()` method to load the configuration from the environment. To
+do that, set the `IB_API_KEY` and `IB_BASE_URL` variables.
 
 ## 📦 Installation
 To use the library, add the dependency to your projects `Cargo.toml`
@@ -67,10 +68,10 @@ async fn main() {
 ```
 
 ## 👀 Examples
-The best way to learn how to use the library is to look at the official docs.rs documentation,
-which has simple examples on how to use every endpoint. You can also look at integration tests
-under the [tests](./tests) directory, which work similarly to how you would use them in a real
-scenario.
+The best way to learn how to use the library is to look at the official
+[docs.rs documentation](https://docs.rs/infobip_sdk/), which has simple examples on how to use
+every endpoint. You can also look at integration tests under the [tests](./tests) directory,
+which work similarly to how you would use them in a real scenario.
 
 ## 🗒 Notes
 
@@ -131,7 +132,7 @@ is done automatically when calling an endpoint, or you can call the `.validate()
 model.
 
 ### Using features
-You can speed up compile-times a bit by turning only the needed channels as library features.
+You can speed up compile time by turning only the needed channels as library features.
 For example, to only build SMS, add the dependency like this:
 ```toml
 infobip_sdk = { version = "0.1", features = ["sms"] }

README.tpl

@@ -2,7 +2,8 @@
 
 ![Workflow](https://github.com/infobip-community/infobip-api-rust-sdk/actions/workflows/rust.yml/badge.svg)
 [![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-MIT)
-![Crates.io](https://img.shields.io/crates/v/infobip_sdk)
+[![Licence](https://img.shields.io/github/license/infobip-community/infobip-api-rust-sdk)](LICENSE-APACHE)
+[![Crates.io](https://img.shields.io/crates/v/infobip_sdk)](https://crates.io/crates/infobip_sdk)
 ![Crate downlads](https://img.shields.io/crates/d/rust_sdk)
 
 {{readme}}

src/api/mod.rs

@@ -52,13 +52,19 @@ impl fmt::Display for ApiError {
 
 /// Holds information about a server-side error.
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
 pub struct ServiceException {
-    #[serde(rename = "messageId")]
+    /// Identifier of the error.
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub message_id: Option<String>,
-    #[serde(rename = "text")]
-    pub text: String,
-    #[serde(rename = "validationErrors", skip_serializing_if = "Option::is_none")]
-    pub validation_errors: Option<String>,
+
+    /// Detailed error description.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub text: Option<String>,
+
+    /// Map of validation errors.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub validation_errors: Option<HashMap<String, Vec<String>>>,
 }
 
 /// Holds the exception produced by a server-side error.

src/api/sms.rs

@@ -50,7 +50,7 @@ impl SmsClient {
     }
 
     /// Check how different message configurations will affect your message text, number of
-    /// characters and message parts.
+    /// characters, and message parts.
     ///
     /// # Example
     ///
@@ -273,7 +273,8 @@ impl SmsClient {
         }
     }
 
-    /// See the status and the scheduled time of your SMS messages.
+    /// See all scheduled messages and their scheduled date and time. To schedule a message, use
+    /// the sendAt field when sending a message.
     ///
     /// # Example
     /// ```no_run
@@ -567,7 +568,8 @@ impl SmsClient {
         }
     }
 
-    /// Change the date and time for sending scheduled messages.
+    /// Change the date and time of already scheduled messages. To schedule a message, use the
+    /// sendAt field when sending a message.
     ///
     /// # Example
     /// ```no_run
@@ -674,7 +676,8 @@ impl SmsClient {
         }
     }
 
-    /// Change status or completely cancel sending of scheduled messages.
+    /// Change status or completely cancel sending of scheduled messages. To schedule a message,
+    /// use the sendAt field when sending a message.
     ///
     /// # Example
     /// ```no_run
@@ -691,6 +694,7 @@ impl SmsClient {
     /// let request_body = UpdateScheduledStatusRequestBody::new(ScheduledStatus::CANCELED);
     ///
     /// let response = sms_client.update_scheduled_status(query_parameters, request_body).await?;
+    ///
     /// assert_eq!(response.status, StatusCode::OK);
     /// # Ok(())
     /// # }
@@ -736,7 +740,7 @@ pub struct BlockingSmsClient {
 }
 
 impl BlockingSmsClient {
-    /// Builds and returns a new `BlockingSmsClient` with specified configuration.
+    /// Builds and returns a new `BlockingSmsClient` with a specified configuration.
     pub fn with_configuration(configuration: Configuration) -> BlockingSmsClient {
         BlockingSmsClient {
             configuration,

src/api/tests/mod.rs

@@ -7,6 +7,9 @@ use crate::configuration::{ApiKey, Configuration};
 #[cfg(test)]
 mod sms;
 
+#[cfg(test)]
+mod whatsapp;
+
 const DUMMY_TEXT: &str = "Some text for tests.";
 
 async fn mock_json_endpoint(

src/api/tests/sms.rs

@@ -128,7 +128,8 @@ async fn test_preview_server_error() {
             .request_error
             .service_exception
             .text
-            .is_empty())
+            .unwrap()
+            .is_empty());
     } else {
         assert!(false, "not an API error")
     }
@@ -235,8 +236,6 @@ async fn test_get_delivery_reports_bad_parameters() {
         .unwrap_err();
     if let SdkError::Validation(validation_error) = error {
         assert!(!validation_error.errors().is_empty());
-    } else {
-        assert!(false, "not validation error")
     }
 }