Add optional clap feature

… with some useful initial clap trait implementations.

Author: svix-jplatte

rust/Cargo.toml

@@ -14,6 +14,7 @@ categories = ["development-tools", "asynchronous", "network-programming", "web-p
 [features]
 default = ["http1", "native-tls"]
 
+clap = ["dep:clap"]
 http1 = ["hyper-util/http1", "hyper-rustls?/http1"]
 http2 = ["hyper-util/http2", "hyper-rustls?/http2"]
 native-tls = ["dep:hyper-tls"]
@@ -39,6 +40,7 @@ time = "0.3"
 url = "2.2"
 tokio = { version = "1.41.0", features = ["time"] }
 serde_with = { version = "^3.8", default-features = false, features = ["base64", "std", "macros"] }
+clap = { version = "4.5.23", default-features = false, features = ["derive", "std"], optional = true }
 
 [dev-dependencies]
 tokio = { version = "1.41.0", features = ["macros"] }

rust/src/api/application.rs

@@ -2,9 +2,18 @@ use super::PostOptions;
 use crate::{apis::application_api, error::Result, models::*, Configuration};
 
 #[derive(Default)]
+#[cfg_attr(feature = "clap", derive(clap::Args))]
 pub struct ApplicationListOptions {
-    pub iterator: Option<String>,
+    /// Limit the number of returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub limit: Option<i32>,
+
+    /// The iterator returned from a prior invocation
+    #[cfg_attr(feature = "clap", clap(long))]
+    pub iterator: Option<String>,
+
+    /// The sorting order of the returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub order: Option<Ordering>,
 }
 

rust/src/api/endpoint.rs

@@ -2,9 +2,18 @@ use super::PostOptions;
 use crate::{apis::endpoint_api, error::Result, models::*, Configuration};
 
 #[derive(Default)]
+#[cfg_attr(feature = "clap", derive(clap::Args))]
 pub struct EndpointListOptions {
-    pub iterator: Option<String>,
+    /// Limit the number of returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub limit: Option<i32>,
+
+    /// The iterator returned from a prior invocation
+    #[cfg_attr(feature = "clap", clap(long))]
+    pub iterator: Option<String>,
+
+    /// The sorting order of the returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub order: Option<Ordering>,
 }
 

rust/src/api/event_type.rs

@@ -2,11 +2,25 @@ use super::PostOptions;
 use crate::{apis::event_type_api, error::Result, models::*, Configuration};
 
 #[derive(Default)]
+#[cfg_attr(feature = "clap", derive(clap::Args))]
 pub struct EventTypeListOptions {
-    pub iterator: Option<String>,
+    /// Limit the number of returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub limit: Option<i32>,
-    pub with_content: Option<bool>,
+
+    /// The iterator returned from a prior invocation
+    #[cfg_attr(feature = "clap", clap(long))]
+    pub iterator: Option<String>,
+
+    /// When `true` archived (deleted but not expunged) items are included in
+    /// the response
+    #[cfg_attr(feature = "clap", clap(long))]
     pub include_archived: Option<bool>,
+
+    /// When `true` the full item (including the schema) is included in the
+    /// response
+    #[cfg_attr(feature = "clap", clap(long))]
+    pub with_content: Option<bool>,
 }
 
 pub struct EventType<'a> {
@@ -35,6 +49,7 @@ impl<'a> EventType<'a> {
                 limit,
                 with_content,
                 include_archived,
+                // FIXME: Not part of EventTypeListOptions for backwards compat, for now.
                 order: None,
             },
         )

rust/src/api/integration.rs

@@ -2,9 +2,18 @@ use super::PostOptions;
 use crate::{apis::integration_api, error::Result, models::*, Configuration};
 
 #[derive(Default)]
+#[cfg_attr(feature = "clap", derive(clap::Args))]
 pub struct IntegrationListOptions {
-    pub iterator: Option<String>,
+    /// Limit the number of returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub limit: Option<i32>,
+
+    /// The iterator returned from a prior invocation
+    #[cfg_attr(feature = "clap", clap(long))]
+    pub iterator: Option<String>,
+
+    /// The sorting order of the returned items
+    #[cfg_attr(feature = "clap", clap(long))]
     pub order: Option<Ordering>,
 }
 

rust/src/model_ext.rs

@@ -1,8 +1,10 @@
 //! Extensions of the auto-generated "models" (schema structs).
 
+use std::str::FromStr;
+
 use serde_json::json;
 
-use crate::models::MessageIn;
+use crate::{api::Ordering, models::MessageIn};
 
 impl MessageIn {
     /// Create a new message with a pre-serialized payload.
@@ -38,3 +40,19 @@ impl MessageIn {
         self
     }
 }
+
+#[derive(Debug, thiserror::Error)]
+#[error("invalid value for ordering")]
+pub struct OrderingFromStrError;
+
+impl FromStr for Ordering {
+    type Err = OrderingFromStrError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "ascending" => Ok(Self::Ascending),
+            "descending" => Ok(Self::Descending),
+            _ => Err(OrderingFromStrError),
+        }
+    }
+}