/*
* Svix API
*
* Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
*
* The version of the OpenAPI document: 1.4
*
* Generated by: https://openapi-generator.tech
*/
use reqwest;
use crate::apis::ResponseContent;
use super::{Error, configuration};
/// struct for passing parameters to the method `create_integration_api_v1_app_app_id_integration_post`
#[derive(Clone, Debug)]
pub struct CreateIntegrationApiV1AppAppIdIntegrationPostParams {
pub app_id: String,
pub integration_in: crate::models::IntegrationIn,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `delete_integration_api_v1_app_app_id_integration_integ_id_delete`
#[derive(Clone, Debug)]
pub struct DeleteIntegrationApiV1AppAppIdIntegrationIntegIdDeleteParams {
pub integ_id: String,
pub app_id: String,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `get_integration_api_v1_app_app_id_integration_integ_id_get`
#[derive(Clone, Debug)]
pub struct GetIntegrationApiV1AppAppIdIntegrationIntegIdGetParams {
pub integ_id: String,
pub app_id: String,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `get_integration_key_api_v1_app_app_id_integration_integ_id_key_get`
#[derive(Clone, Debug)]
pub struct GetIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGetParams {
pub integ_id: String,
pub app_id: String,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `list_integrations_api_v1_app_app_id_integration_get`
#[derive(Clone, Debug)]
pub struct ListIntegrationsApiV1AppAppIdIntegrationGetParams {
pub app_id: String,
pub iterator: Option<String>,
pub limit: Option<i32>,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `rotate_integration_key_api_v1_app_app_id_integration_integ_id_key_rotate_post`
#[derive(Clone, Debug)]
pub struct RotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePostParams {
pub integ_id: String,
pub app_id: String,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for passing parameters to the method `update_integration_api_v1_app_app_id_integration_integ_id_put`
#[derive(Clone, Debug)]
pub struct UpdateIntegrationApiV1AppAppIdIntegrationIntegIdPutParams {
pub integ_id: String,
pub app_id: String,
pub integration_update: crate::models::IntegrationUpdate,
/// The request's idempotency key
pub idempotency_key: Option<String>
}
/// struct for typed errors of method `create_integration_api_v1_app_app_id_integration_post`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateIntegrationApiV1AppAppIdIntegrationPostError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `delete_integration_api_v1_app_app_id_integration_integ_id_delete`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum DeleteIntegrationApiV1AppAppIdIntegrationIntegIdDeleteError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `get_integration_api_v1_app_app_id_integration_integ_id_get`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetIntegrationApiV1AppAppIdIntegrationIntegIdGetError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `get_integration_key_api_v1_app_app_id_integration_integ_id_key_get`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGetError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `list_integrations_api_v1_app_app_id_integration_get`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListIntegrationsApiV1AppAppIdIntegrationGetError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `rotate_integration_key_api_v1_app_app_id_integration_integ_id_key_rotate_post`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum RotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePostError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method `update_integration_api_v1_app_app_id_integration_integ_id_put`
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum UpdateIntegrationApiV1AppAppIdIntegrationIntegIdPutError {
Status401(crate::models::HttpErrorOut),
Status403(crate::models::HttpErrorOut),
Status404(crate::models::HttpErrorOut),
Status409(crate::models::HttpErrorOut),
Status422(crate::models::HttpValidationError),
Status429(crate::models::HttpErrorOut),
UnknownValue(serde_json::Value),
}
/// Create an integration.
pub async fn create_integration_api_v1_app_app_id_integration_post(configuration: &configuration::Configuration, params: CreateIntegrationApiV1AppAppIdIntegrationPostParams) -> Result<crate::models::IntegrationOut, Error<CreateIntegrationApiV1AppAppIdIntegrationPostError>> {
// unbox the parameters
let app_id = params.app_id;
let integration_in = params.integration_in;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/", configuration.base_path, app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
local_var_req_builder = local_var_req_builder.json(&integration_in);
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<CreateIntegrationApiV1AppAppIdIntegrationPostError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// Delete an integration and revoke it's key.
pub async fn delete_integration_api_v1_app_app_id_integration_integ_id_delete(configuration: &configuration::Configuration, params: DeleteIntegrationApiV1AppAppIdIntegrationIntegIdDeleteParams) -> Result<(), Error<DeleteIntegrationApiV1AppAppIdIntegrationIntegIdDeleteError>> {
// unbox the parameters
let integ_id = params.integ_id;
let app_id = params.app_id;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/{integ_id}/", configuration.base_path, integ_id=crate::apis::urlencode(integ_id), app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
Ok(())
} else {
let local_var_entity: Option<DeleteIntegrationApiV1AppAppIdIntegrationIntegIdDeleteError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// Get an integration.
pub async fn get_integration_api_v1_app_app_id_integration_integ_id_get(configuration: &configuration::Configuration, params: GetIntegrationApiV1AppAppIdIntegrationIntegIdGetParams) -> Result<crate::models::IntegrationOut, Error<GetIntegrationApiV1AppAppIdIntegrationIntegIdGetError>> {
// unbox the parameters
let integ_id = params.integ_id;
let app_id = params.app_id;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/{integ_id}/", configuration.base_path, integ_id=crate::apis::urlencode(integ_id), app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<GetIntegrationApiV1AppAppIdIntegrationIntegIdGetError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// Get an integration's key.
pub async fn get_integration_key_api_v1_app_app_id_integration_integ_id_key_get(configuration: &configuration::Configuration, params: GetIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGetParams) -> Result<crate::models::IntegrationKeyOut, Error<GetIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGetError>> {
// unbox the parameters
let integ_id = params.integ_id;
let app_id = params.app_id;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/{integ_id}/key/", configuration.base_path, integ_id=crate::apis::urlencode(integ_id), app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<GetIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyGetError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// List the application's integrations.
pub async fn list_integrations_api_v1_app_app_id_integration_get(configuration: &configuration::Configuration, params: ListIntegrationsApiV1AppAppIdIntegrationGetParams) -> Result<crate::models::ListResponseIntegrationOut, Error<ListIntegrationsApiV1AppAppIdIntegrationGetError>> {
// unbox the parameters
let app_id = params.app_id;
let iterator = params.iterator;
let limit = params.limit;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/", configuration.base_path, app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
if let Some(ref local_var_str) = iterator {
local_var_req_builder = local_var_req_builder.query(&[("iterator", &local_var_str.to_string())]);
}
if let Some(ref local_var_str) = limit {
local_var_req_builder = local_var_req_builder.query(&[("limit", &local_var_str.to_string())]);
}
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<ListIntegrationsApiV1AppAppIdIntegrationGetError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// Rotate the integration's key. The previous key will be immediately revoked.
pub async fn rotate_integration_key_api_v1_app_app_id_integration_integ_id_key_rotate_post(configuration: &configuration::Configuration, params: RotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePostParams) -> Result<crate::models::IntegrationKeyOut, Error<RotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePostError>> {
// unbox the parameters
let integ_id = params.integ_id;
let app_id = params.app_id;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/{integ_id}/key/rotate/", configuration.base_path, integ_id=crate::apis::urlencode(integ_id), app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<RotateIntegrationKeyApiV1AppAppIdIntegrationIntegIdKeyRotatePostError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}
/// Update an integration.
pub async fn update_integration_api_v1_app_app_id_integration_integ_id_put(configuration: &configuration::Configuration, params: UpdateIntegrationApiV1AppAppIdIntegrationIntegIdPutParams) -> Result<crate::models::IntegrationOut, Error<UpdateIntegrationApiV1AppAppIdIntegrationIntegIdPutError>> {
// unbox the parameters
let integ_id = params.integ_id;
let app_id = params.app_id;
let integration_update = params.integration_update;
let idempotency_key = params.idempotency_key;
let local_var_client = &configuration.client;
let local_var_uri_str = format!("{}/api/v1/app/{app_id}/integration/{integ_id}/", configuration.base_path, integ_id=crate::apis::urlencode(integ_id), app_id=crate::apis::urlencode(app_id));
let mut local_var_req_builder = local_var_client.request(reqwest::Method::PUT, local_var_uri_str.as_str());
if let Some(ref local_var_user_agent) = configuration.user_agent {
local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
}
if let Some(local_var_param_value) = idempotency_key {
local_var_req_builder = local_var_req_builder.header("idempotency-key", local_var_param_value.to_string());
}
if let Some(ref local_var_token) = configuration.bearer_access_token {
local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
};
local_var_req_builder = local_var_req_builder.json(&integration_update);
let local_var_req = local_var_req_builder.build()?;
let local_var_resp = local_var_client.execute(local_var_req).await?;
let local_var_status = local_var_resp.status();
let local_var_content = local_var_resp.text().await?;
if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
serde_json::from_str(&local_var_content).map_err(Error::from)
} else {
let local_var_entity: Option<UpdateIntegrationApiV1AppAppIdIntegrationIntegIdPutError> = serde_json::from_str(&local_var_content).ok();
let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
Err(Error::ResponseError(local_var_error))
}
}