Skip to content

Add query parameter docs and reorder some things #1560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions rust/src/api/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@ use crate::{apis::application_api, error::Result, models::*, Configuration};

#[derive(Default)]
pub struct ApplicationListOptions {
pub iterator: Option<String>,
/// Limit the number of returned items
pub limit: Option<i32>,

/// The iterator returned from a prior invocation
pub iterator: Option<String>,

/// The sorting order of the returned items
pub order: Option<Ordering>,
}

Expand All @@ -22,15 +27,16 @@ impl<'a> Application<'a> {
options: Option<ApplicationListOptions>,
) -> Result<ListResponseApplicationOut> {
let ApplicationListOptions {
iterator,
limit,
iterator,
order,
} = options.unwrap_or_default();

application_api::v1_period_application_period_list(
self.cfg,
application_api::V1PeriodApplicationPeriodListParams {
iterator,
limit,
iterator,
order,
},
)
Expand Down Expand Up @@ -94,6 +100,14 @@ impl<'a> Application<'a> {
.await
}

pub async fn delete(&self, app_id: String) -> Result<()> {
application_api::v1_period_application_period_delete(
self.cfg,
application_api::V1PeriodApplicationPeriodDeleteParams { app_id },
)
.await
}

pub async fn patch(
&self,
app_id: String,
Expand All @@ -108,12 +122,4 @@ impl<'a> Application<'a> {
)
.await
}

pub async fn delete(&self, app_id: String) -> Result<()> {
application_api::v1_period_application_period_delete(
self.cfg,
application_api::V1PeriodApplicationPeriodDeleteParams { app_id },
)
.await
}
}
52 changes: 33 additions & 19 deletions rust/src/api/endpoint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,33 @@ use crate::{apis::endpoint_api, error::Result, models::*, Configuration};

#[derive(Default)]
pub struct EndpointListOptions {
pub iterator: Option<String>,
/// Limit the number of returned items
pub limit: Option<i32>,
pub order: Option<Ordering>,
}

pub struct Endpoint<'a> {
cfg: &'a Configuration,
/// The iterator returned from a prior invocation
pub iterator: Option<String>,

/// The sorting order of the returned items
pub order: Option<Ordering>,
}

#[derive(Default)]
pub struct EndpointStatsOptions {
/// Filter the range to data starting from this date
///
/// RFC3339 date string.
pub since: Option<String>,

/// Filter the range to data ending by this date
///
/// RFC3339 date string.
pub until: Option<String>,
}

pub struct Endpoint<'a> {
cfg: &'a Configuration,
}

impl<'a> Endpoint<'a> {
pub(super) fn new(cfg: &'a Configuration) -> Self {
Self { cfg }
Expand All @@ -29,17 +41,18 @@ impl<'a> Endpoint<'a> {
options: Option<EndpointListOptions>,
) -> Result<ListResponseEndpointOut> {
let EndpointListOptions {
iterator,
limit,
iterator,
order,
} = options.unwrap_or_default();

endpoint_api::v1_period_endpoint_period_list(
self.cfg,
endpoint_api::V1PeriodEndpointPeriodListParams {
app_id,
order,
iterator,
limit,
iterator,
order,
},
)
.await
Expand All @@ -52,6 +65,7 @@ impl<'a> Endpoint<'a> {
options: Option<PostOptions>,
) -> Result<EndpointOut> {
let PostOptions { idempotency_key } = options.unwrap_or_default();

endpoint_api::v1_period_endpoint_period_create(
self.cfg,
endpoint_api::V1PeriodEndpointPeriodCreateParams {
Expand Down Expand Up @@ -91,6 +105,17 @@ impl<'a> Endpoint<'a> {
.await
}

pub async fn delete(&self, app_id: String, endpoint_id: String) -> Result<()> {
endpoint_api::v1_period_endpoint_period_delete(
self.cfg,
endpoint_api::V1PeriodEndpointPeriodDeleteParams {
app_id,
endpoint_id,
},
)
.await
}

pub async fn patch(
&self,
app_id: String,
Expand All @@ -108,17 +133,6 @@ impl<'a> Endpoint<'a> {
.await
}

pub async fn delete(&self, app_id: String, endpoint_id: String) -> Result<()> {
endpoint_api::v1_period_endpoint_period_delete(
self.cfg,
endpoint_api::V1PeriodEndpointPeriodDeleteParams {
app_id,
endpoint_id,
},
)
.await
}

pub async fn get_secret(
&self,
app_id: String,
Expand Down
27 changes: 20 additions & 7 deletions rust/src/api/event_type.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,19 @@ use crate::{apis::event_type_api, error::Result, models::*, Configuration};

#[derive(Default)]
pub struct EventTypeListOptions {
pub iterator: Option<String>,
/// Limit the number of returned items
pub limit: Option<i32>,
pub with_content: Option<bool>,

/// The iterator returned from a prior invocation
pub iterator: Option<String>,

/// When `true` archived (deleted but not expunged) items are included in
/// the response
pub include_archived: Option<bool>,

/// When `true` the full item (including the schema) is included in the
/// response
pub with_content: Option<bool>,
}

pub struct EventType<'a> {
Expand All @@ -23,19 +32,21 @@ impl<'a> EventType<'a> {
options: Option<EventTypeListOptions>,
) -> Result<ListResponseEventTypeOut> {
let EventTypeListOptions {
iterator,
limit,
with_content,
iterator,
include_archived,
with_content,
} = options.unwrap_or_default();

event_type_api::v1_period_event_type_period_list(
self.cfg,
event_type_api::V1PeriodEventTypePeriodListParams {
iterator,
limit,
with_content,
include_archived,
iterator,
// FIXME: not included for backwards compatibility, for now
order: None,
include_archived,
with_content,
},
)
.await
Expand All @@ -47,6 +58,7 @@ impl<'a> EventType<'a> {
options: Option<PostOptions>,
) -> Result<EventTypeOut> {
let PostOptions { idempotency_key } = options.unwrap_or_default();

event_type_api::v1_period_event_type_period_create(
self.cfg,
event_type_api::V1PeriodEventTypePeriodCreateParams {
Expand Down Expand Up @@ -112,6 +124,7 @@ impl<'a> EventType<'a> {
options: Option<PostOptions>,
) -> Result<EventTypeImportOpenApiOut> {
let PostOptions { idempotency_key } = options.unwrap_or_default();

event_type_api::v1_period_event_type_period_import_openapi(
self.cfg,
event_type_api::V1PeriodEventTypePeriodImportOpenapiParams {
Expand Down
13 changes: 10 additions & 3 deletions rust/src/api/integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@ use crate::{apis::integration_api, error::Result, models::*, Configuration};

#[derive(Default)]
pub struct IntegrationListOptions {
pub iterator: Option<String>,
/// Limit the number of returned items
pub limit: Option<i32>,

/// The iterator returned from a prior invocation
pub iterator: Option<String>,

/// The sorting order of the returned items
pub order: Option<Ordering>,
}

Expand All @@ -23,16 +28,17 @@ impl<'a> Integration<'a> {
options: Option<IntegrationListOptions>,
) -> Result<ListResponseIntegrationOut> {
let IntegrationListOptions {
iterator,
limit,
iterator,
order,
} = options.unwrap_or_default();

integration_api::v1_period_integration_period_list(
self.cfg,
integration_api::V1PeriodIntegrationPeriodListParams {
app_id,
iterator,
limit,
iterator,
order,
},
)
Expand All @@ -46,6 +52,7 @@ impl<'a> Integration<'a> {
options: Option<PostOptions>,
) -> Result<IntegrationOut> {
let PostOptions { idempotency_key } = options.unwrap_or_default();

integration_api::v1_period_integration_period_create(
self.cfg,
integration_api::V1PeriodIntegrationPeriodCreateParams {
Expand Down
13 changes: 7 additions & 6 deletions rust/src/api/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,27 +31,28 @@ impl<'a> Message<'a> {
options: Option<MessageListOptions>,
) -> Result<ListResponseMessageOut> {
let MessageListOptions {
iterator,
limit,
event_types,
iterator,
channel,
before,
after,
channel,
with_content,
tag,
event_types,
} = options.unwrap_or_default();

message_api::v1_period_message_period_list(
self.cfg,
message_api::V1PeriodMessagePeriodListParams {
app_id,
iterator,
limit,
event_types,
iterator,
channel,
before,
after,
channel,
with_content,
tag,
event_types,
},
)
.await
Expand Down