// This file is auto-generated by oagen. Do not edit.
use crate::client::Client;
#[allow(unused_imports)]
use crate::enums::*;
use crate::error::Error;
#[allow(unused_imports)]
use crate::models::*;
#[allow(unused_imports)]
use serde::Serialize;
pub struct CommunityConnectionsApi<'a> {
pub(crate) client: &'a Client,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct ListParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
#[derive(Debug, Clone, Serialize)]
pub struct StartParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkStartCommunityConnectionRequestApplicationJson,
}
impl StartParams {
/// Construct a new `StartParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkStartCommunityConnectionRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct PollParams {
/// Required.
pub status_token: crate::SecretString,
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
impl PollParams {
/// Construct a new `PollParams` with the required fields set.
#[allow(deprecated)]
pub fn new(status_token: impl Into<crate::SecretString>) -> Self {
Self {
status_token: status_token.into(),
x_store: Default::default(),
}
}
}
#[derive(Debug, Clone, Serialize)]
pub struct CompleteParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
/// Request body sent with this call.
///
/// Required.
#[serde(skip)]
pub body: SdkCompleteCommunityConnectionRequestApplicationJson,
}
impl CompleteParams {
/// Construct a new `CompleteParams` with the required fields set.
#[allow(deprecated)]
pub fn new(body: SdkCompleteCommunityConnectionRequestApplicationJson) -> Self {
Self {
x_store: Default::default(),
body,
}
}
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct VerifyParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct DisconnectParams {
/// Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "X-STORE")]
pub x_store: Option<String>,
}
impl<'a> CommunityConnectionsApi<'a> {
/// List community connections
///
/// List Discord, Telegram, Slack, and WhatsApp connection and persisted health status for the authenticated store without contacting providers. Credentials and provider secrets are never returned. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn list(
&self,
params: ListParams,
) -> Result<SdkListCommunityConnectionsResponseValue200ApplicationJson, Error> {
self.list_with_options(params, None).await
}
/// Variant of [`Self::list`] that accepts per-request [`crate::RequestOptions`].
pub async fn list_with_options(
&self,
params: ListParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkListCommunityConnectionsResponseValue200ApplicationJson, Error> {
self.list_raw(params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn list_raw(
&self,
params: ListParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkListCommunityConnectionsResponseValue200ApplicationJson>, Error>
{
let path = "/v2/community-connections".to_string();
let method = http::Method::GET;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("listCommunityConnections".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"GET /v2/community-connections",
)
.await
}
/// Start a community connection
///
/// Start the provider-specific connection flow. OAuth providers return a connect URL containing encrypted state bound to the authenticated actor, store, platform, and purpose; that state expires after 15 minutes and securely authorizes the provider callback without forwarding the API bearer token or requiring a SellApp dashboard session. Open the URL exactly as issued, then poll the connection list with the original bearer token after the provider redirects. Do not append credentials, reconstruct, or reuse the URL. Legacy unsigned Slack URLs are rejected, so clients must call this endpoint again to restart those flows. Telegram returns a short-lived verification token, and WhatsApp returns a pollable QR session. The provider application must be configured, and Discord server connections require a connected Discord account. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn start(
&self,
platform: &str,
params: StartParams,
) -> Result<SdkStartCommunityConnectionResponseValue200ApplicationJson, Error> {
self.start_with_options(platform, params, None).await
}
/// Variant of [`Self::start`] that accepts per-request [`crate::RequestOptions`].
pub async fn start_with_options(
&self,
platform: &str,
params: StartParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkStartCommunityConnectionResponseValue200ApplicationJson, Error> {
self.start_raw(platform, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn start_raw(
&self,
platform: &str,
params: StartParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkStartCommunityConnectionResponseValue200ApplicationJson>, Error>
{
let platform = crate::client::path_segment(platform);
let path = format!("/v2/community-connections/{platform}/connect");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("startCommunityConnection".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/community-connections/{platform}/connect",
)
.await
}
/// Poll a community connection
///
/// Poll a pending Telegram verification or WhatsApp QR connection using the encrypted status token returned by the connect operation. Tokens are bound to the authenticated store and initiating user. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn poll(
&self,
platform: &str,
params: PollParams,
) -> Result<SdkPollCommunityConnectionResponseValue200ApplicationJson, Error> {
self.poll_with_options(platform, params, None).await
}
/// Variant of [`Self::poll`] that accepts per-request [`crate::RequestOptions`].
pub async fn poll_with_options(
&self,
platform: &str,
params: PollParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkPollCommunityConnectionResponseValue200ApplicationJson, Error> {
self.poll_raw(platform, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn poll_raw(
&self,
platform: &str,
params: PollParams,
options: Option<&crate::RequestOptions>,
) -> Result<crate::RawResponse<SdkPollCommunityConnectionResponseValue200ApplicationJson>, Error>
{
let platform = crate::client::path_segment(platform);
let path = format!("/v2/community-connections/{platform}/status");
let method = http::Method::GET;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("pollCommunityConnection".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"GET /v2/community-connections/{platform}/status",
)
.await
}
/// Complete a community connection
///
/// Complete an authenticated WhatsApp QR connection by selecting a group returned by the status operation. The encrypted status token binds the session to the authenticated store and initiating user, and the server ID is revalidated against the provider response. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn complete(
&self,
platform: &str,
params: CompleteParams,
) -> Result<SdkCompleteCommunityConnectionResponseValue200ApplicationJson, Error> {
self.complete_with_options(platform, params, None).await
}
/// Variant of [`Self::complete`] that accepts per-request [`crate::RequestOptions`].
pub async fn complete_with_options(
&self,
platform: &str,
params: CompleteParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkCompleteCommunityConnectionResponseValue200ApplicationJson, Error> {
self.complete_raw(platform, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn complete_raw(
&self,
platform: &str,
params: CompleteParams,
options: Option<&crate::RequestOptions>,
) -> Result<
crate::RawResponse<SdkCompleteCommunityConnectionResponseValue200ApplicationJson>,
Error,
> {
let platform = crate::client::path_segment(platform);
let path = format!("/v2/community-connections/{platform}/complete");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("completeCommunityConnection".to_string());
let options = Some(&merged);
self.client
.request_with_body_schema_opts_raw(
method,
&path,
¶ms,
Some(¶ms.body),
options,
"POST /v2/community-connections/{platform}/complete",
)
.await
}
/// Verify a community connection
///
/// Recheck provider and server health, then safely requeue eligible failed community grants. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn verify(
&self,
platform: &str,
params: VerifyParams,
) -> Result<SdkVerifyCommunityConnectionResponseValue200ApplicationJson, Error> {
self.verify_with_options(platform, params, None).await
}
/// Variant of [`Self::verify`] that accepts per-request [`crate::RequestOptions`].
pub async fn verify_with_options(
&self,
platform: &str,
params: VerifyParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkVerifyCommunityConnectionResponseValue200ApplicationJson, Error> {
self.verify_raw(platform, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn verify_raw(
&self,
platform: &str,
params: VerifyParams,
options: Option<&crate::RequestOptions>,
) -> Result<
crate::RawResponse<SdkVerifyCommunityConnectionResponseValue200ApplicationJson>,
Error,
> {
let platform = crate::client::path_segment(platform);
let path = format!("/v2/community-connections/{platform}/verify");
let method = http::Method::POST;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("verifyCommunityConnection".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"POST /v2/community-connections/{platform}/verify",
)
.await
}
/// Disconnect a community platform
///
/// Idempotently disconnect the selected platform for the authenticated store and remove only that store's associated servers, channels, groups, or account links. Requires the `community` Sanctum ability. OAuth callers use the admin grant and select a store with X-STORE. Current membership and role permissions apply to every request.
pub async fn disconnect(
&self,
platform: &str,
params: DisconnectParams,
) -> Result<SdkDisconnectCommunityPlatformResponseValue200ApplicationJson, Error> {
self.disconnect_with_options(platform, params, None).await
}
/// Variant of [`Self::disconnect`] that accepts per-request [`crate::RequestOptions`].
pub async fn disconnect_with_options(
&self,
platform: &str,
params: DisconnectParams,
options: Option<&crate::RequestOptions>,
) -> Result<SdkDisconnectCommunityPlatformResponseValue200ApplicationJson, Error> {
self.disconnect_raw(platform, params, options)
.await
.map(|response| response.data)
}
/// Returns the typed result together with status, headers, and request ID.
pub async fn disconnect_raw(
&self,
platform: &str,
params: DisconnectParams,
options: Option<&crate::RequestOptions>,
) -> Result<
crate::RawResponse<SdkDisconnectCommunityPlatformResponseValue200ApplicationJson>,
Error,
> {
let platform = crate::client::path_segment(platform);
let path = format!("/v2/community-connections/{platform}");
let method = http::Method::DELETE;
let mut merged = options.cloned().unwrap_or_default();
merged.idempotency_supported = false;
merged.operation_id = Some("disconnectCommunityPlatform".to_string());
let options = Some(&merged);
self.client
.request_with_query_schema_opts_raw(
method,
&path,
¶ms,
options,
"DELETE /v2/community-connections/{platform}",
)
.await
}
}