//! Generated ChurchTools models.
//!
//! Generated by codegen/generate.py from the OpenAPI spec of ChurchTools 3.138.1 (build 32938). Do not edit. The spec is licensed under CC BY 4.0 (<https://creativecommons.org/licenses/by/4.0/>); see NOTICE.
#![allow(clippy::all, deprecated)]
use serde::{Deserialize, Serialize};
/// An absence from service planning for one person, such as vacation or sickness. Both boundaries are stored in the application time zone. If both are midnight, startTime and endTime are `null`; otherwise both contain full UTC timestamps. startDate and endDate always contain the local calendar dates.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Absence {
/// Installation-specific category of absence, such as vacation or sickness. Use its id as absenceReasonId. Labels are configurable and must not be treated as an enum.
#[serde(rename = "absenceReason")]
pub absence_reason: AbsenceReason,
/// Stored comment; absent comments are returned as an empty string.
#[serde(deserialize_with = "crate::lenient::string")]
pub comment: String,
/// When this absence ends.
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
/// When this absence ends. Is null if absence is all-day.
#[serde(rename = "endTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub end_time: Option<chrono::DateTime<chrono::Utc>>,
/// ID of Record
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// When this absence begins.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// When this absence begins. Is null if absence is all-day.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start_time: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates an absence for the person identified by the path. A Time field takes precedence over the corresponding Date field, but every supplied boundary participates in chronological validation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AbsenceCreate {
/// ID of an existing, installation-specific absence reason. Reasons are master data and are not a fixed enum.
#[serde(rename = "absenceReasonId", deserialize_with = "crate::lenient::number")]
pub absence_reason_id: i64,
/// Comment about the absence.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Calendar date (`YYYY-MM-DD`), interpreted at midnight in the application time zone, or a UTC timestamp ending in `Z`. Timestamp values for `startDate` and `endDate` use whole-minute precision.
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<crate::DateOrDateTime>,
/// Takes precedence over `endDate`.
#[serde(rename = "endTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub end_time: Option<chrono::DateTime<chrono::Utc>>,
/// Calendar date (`YYYY-MM-DD`), interpreted at midnight in the application time zone, or a UTC timestamp ending in `Z`. Timestamp values for `startDate` and `endDate` use whole-minute precision.
#[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<crate::DateOrDateTime>,
/// Takes precedence over `startDate`.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start_time: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Installation-specific category of absence, such as vacation or sickness. Use its id as absenceReasonId. Labels are configurable and must not be treated as an enum.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AbsenceReason {
/// ID of the absence reason.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Stored label or translation key.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Label translated for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Display order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces an existing absence belonging to the person identified by the path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AbsenceUpdate {
/// ID of an existing, installation-specific absence reason. Reasons are master data and are not a fixed enum.
#[serde(rename = "absenceReasonId", deserialize_with = "crate::lenient::number")]
pub absence_reason_id: i64,
/// Comment about the absence.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Calendar date (`YYYY-MM-DD`), interpreted at midnight in the application time zone, or a UTC timestamp ending in `Z`. Timestamp values for `startDate` and `endDate` use whole-minute precision.
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<crate::DateOrDateTime>,
/// Takes precedence over `endDate`.
#[serde(rename = "endTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub end_time: Option<chrono::DateTime<chrono::Utc>>,
/// Calendar date (`YYYY-MM-DD`), interpreted at midnight in the application time zone, or a UTC timestamp ending in `Z`. Timestamp values for `startDate` and `endDate` use whole-minute precision.
#[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<crate::DateOrDateTime>,
/// Takes precedence over `startDate`.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start_time: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A ledger account belongs to one accounting period and one account group. The group links it to an account class and account type. Transactions post amounts between an account and a contra account. Amounts and budgets use integer minor currency units, for example cents.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Account {
#[serde(rename = "accountGroupId", deserialize_with = "crate::lenient::number")]
pub account_group_id: i64,
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Calculated account balance in minor currency units. When calculation is disabled, the current in-memory value is returned, initially 0.
#[serde(deserialize_with = "crate::lenient::number")]
pub balance: i64,
/// Budget of account in cent.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<i64>,
/// Budget (or 0 without a budget) minus debit plus credit, in minor currency units. A value is returned even without a budget.
#[serde(rename = "budgetBalance", deserialize_with = "crate::lenient::number")]
pub budget_balance: i64,
/// Budget balance of the matching account in the preceding period, in minor currency units. Defaults to 0 when unavailable or not calculated.
#[serde(rename = "budgetBalanceLastPeriod", deserialize_with = "crate::lenient::number")]
pub budget_balance_last_period: i64,
/// Budget of the account with the same number in the preceding period of this client, in minor currency units. Null when unavailable or not calculated.
#[serde(rename = "budgetLastPeriod", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_last_period: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub identifier: Option<String>,
#[serde(rename = "isDonationAccount")]
pub is_donation_account: bool,
/// Flag indicating if this account must be included in euBP submissions.
#[serde(rename = "isMandatoryEubp")]
pub is_mandatory_eubp: bool,
/// Flag indicating if isMandatoryEubp was set by a ChurchTools account template and cannot be edited manually.
#[serde(rename = "isMandatoryEubpLocked")]
pub is_mandatory_eubp_locked: bool,
#[serde(rename = "isOpeningBalanceAccount")]
pub is_opening_balance_account: bool,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Posting permission for the current caller, separate from permission to view or edit account definitions.
pub permissions: AccountPermissions,
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account classes group account groups within one account type. The hierarchy is account type → account class → account group → account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountClass {
/// ID of the related account type.
#[serde(rename = "accountTypeId", deserialize_with = "crate::lenient::number")]
pub account_type_id: i64,
/// Adds the profit-and-loss total to this class in reports. At most one account class in the installation may enable this flag; it is not restricted by account type. Omitted values default to false, including on update.
#[serde(rename = "includeProfitLoss", default, skip_serializing_if = "Option::is_none")]
pub include_profit_loss: Option<bool>,
/// Unique account-class name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order of the account class.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account classes group account groups within one account type. The hierarchy is account type → account class → account group → account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountClassCreate {
/// ID of the related account type.
#[serde(rename = "accountTypeId", deserialize_with = "crate::lenient::number")]
pub account_type_id: i64,
/// Adds the profit-and-loss total to this class in reports. At most one account class in the installation may enable this flag; it is not restricted by account type. Omitted values default to false, including on update.
#[serde(rename = "includeProfitLoss", default, skip_serializing_if = "Option::is_none")]
pub include_profit_loss: Option<bool>,
/// Unique account-class name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order of the account class.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for an existing account class. Optional fields use the creation defaults when omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountClassUpdate {
/// ID of the related account type.
#[serde(rename = "accountTypeId", deserialize_with = "crate::lenient::number")]
pub account_type_id: i64,
/// Adds the profit-and-loss total to this class in reports. At most one account class in the installation may enable this flag; it is not restricted by account type. Omitted values default to false, including on update.
#[serde(rename = "includeProfitLoss", default, skip_serializing_if = "Option::is_none")]
pub include_profit_loss: Option<bool>,
/// Unique account-class name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order of the account class.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A ledger account belongs to one accounting period and one account group. The group links it to an account class and account type. Transactions post amounts between an account and a contra account. Amounts and budgets use integer minor currency units, for example cents.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountCreate {
/// Existing parent account group from /finance/accountgroups.
#[serde(rename = "accountGroupId", deserialize_with = "crate::lenient::number")]
pub account_group_id: i64,
/// Optional trimmed note. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<Option<String>>,
/// Budget in minor currency units. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<Option<i64>>,
/// Optional account identifier, for example an IBAN. All spaces are removed before storage; no IBAN-format validation is performed. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub identifier: Option<Option<String>>,
/// Whether transactions on this account can be recorded as donations. Omission resets the flag to false.
#[serde(rename = "isDonationAccount", default, skip_serializing_if = "Option::is_none")]
pub is_donation_account: Option<bool>,
/// Whether the account is included in electronically supported employer audits (euBP). On update, an existing lock forces this flag to true.
#[serde(rename = "isMandatoryEubp", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory_eubp: Option<bool>,
/// Whether this account is used for opening-balance postings. Omission resets the flag to false.
#[serde(rename = "isOpeningBalanceAccount", default, skip_serializing_if = "Option::is_none")]
pub is_opening_balance_account: Option<bool>,
/// Trimmed, nonblank account name. Creation checks uniqueness within the accounting period.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Trimmed account number. The value 9999 is reserved for the profit-and-loss total in reports. On creation, number must be unique within the accounting period.
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Optional default tax rate from /finance/taxrates. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Existing, open accounting period. Required for creation and cannot be changed by PUT.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Initial euBP lock. When already locked, later updates force isMandatoryEubp to true. PUT validates but does not change this lock.
#[serde(rename = "isMandatoryEubpLocked", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory_eubp_locked: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account groups collect individual ledger accounts within one account class. isCashAssetAccount identifies groups of cash or bank accounts.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountGroup {
/// Existing parent account class, obtainable from /finance/accountclasses.
#[serde(rename = "accountClassId", deserialize_with = "crate::lenient::number")]
pub account_class_id: i64,
/// Whether accounts in this group represent cash or bank assets.
#[serde(rename = "isCashAssetAccount")]
pub is_cash_asset_account: bool,
/// Unique account-group name, trimmed before storage. Supply a nonblank name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account groups collect individual ledger accounts within one account class. isCashAssetAccount identifies groups of cash or bank accounts.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountGroupCreate {
/// Existing parent account class, obtainable from /finance/accountclasses.
#[serde(rename = "accountClassId", deserialize_with = "crate::lenient::number")]
pub account_class_id: i64,
/// Whether accounts in this group represent cash or bank assets.
#[serde(rename = "isCashAssetAccount")]
pub is_cash_asset_account: bool,
/// Unique account-group name, trimmed before storage. Supply a nonblank name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for an existing account group. Optional fields use the creation defaults when omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountGroupUpdate {
/// Existing parent account class, obtainable from /finance/accountclasses.
#[serde(rename = "accountClassId", deserialize_with = "crate::lenient::number")]
pub account_class_id: i64,
/// Whether accounts in this group represent cash or bank assets.
#[serde(rename = "isCashAssetAccount")]
pub is_cash_asset_account: bool,
/// Unique account-group name, trimmed before storage. Supply a nonblank name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Selection for an XLSX account-import workbook. All fields are optional.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountImportTemplateCreate {
/// Filter existing accounts by client. Ignored when templateId is supplied.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "clientId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub client_id: Option<Option<i64>>,
/// Finance-template file ID. Takes precedence over year and clientId; account rows are read from the template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "templateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub template_id: Option<Option<i64>>,
/// Prepend client and booking-year columns. With templateId, these cells are left blank.
#[serde(rename = "withClients", default, skip_serializing_if = "Option::is_none")]
pub with_clients: Option<bool>,
/// Calendar year of the accounting-period start date. Without year or templateId, the workbook contains headings and instructions but no accounts.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub year: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Posting permission for the current caller, separate from permission to view or edit account definitions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountPermissions {
/// Flag, if user can use this account to post a transaction.
#[serde(rename = "allowPosting")]
pub allow_posting: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Imported bank statement with balances and movement counts. Actual finance transactions are created separately when movements are booked.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountStatement {
/// Number of source movements skipped as duplicates during import.
#[serde(deserialize_with = "crate::lenient::number")]
pub duplicates: i64,
/// Balance in minor currency units (cents for EUR), which can be negative.
#[serde(rename = "endAmount", deserialize_with = "crate::lenient::number")]
pub end_amount: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Account identifier detected in the source, such as an IBAN; null if the format provides none.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub identifier: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Balance in minor currency units (cents for EUR), which can be negative.
#[serde(rename = "startAmount", deserialize_with = "crate::lenient::number")]
pub start_amount: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
pub statistics: StatementStatistics,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Parsed statement preview. Amounts are in minor currency units.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountStatementPreview {
/// Movements matching existing movements across all accounts in the parsed date range.
#[serde(deserialize_with = "crate::lenient::number")]
pub duplicates: i64,
/// End balance in cents.
#[serde(rename = "endAmount", deserialize_with = "crate::lenient::number")]
pub end_amount: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
#[serde(rename = "fileName", deserialize_with = "crate::lenient::string")]
pub file_name: String,
/// Detected parser format.
/// Allowed values: `camt`, `mt940`, `paypal`.
#[serde(rename = "fileType", deserialize_with = "crate::lenient::string")]
pub file_type: String,
/// Account identifier detected in the source, such as an IBAN; null if the format provides none.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub identifier: Option<String>,
/// Movement count after cross-account duplicate comparison.
#[serde(deserialize_with = "crate::lenient::number")]
pub movements: i64,
/// Start balance in cents.
#[serde(rename = "startAmount", deserialize_with = "crate::lenient::number")]
pub start_amount: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Number of movements with an amount of zero that would be skipped on import.
#[serde(rename = "withoutAmount", deserialize_with = "crate::lenient::number")]
pub without_amount: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Optional account-report options. A missing body selects the entire accounting period as a PDF.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountStatementReportCreate {
/// Last document date to include. Omission or null defaults to the corresponding accounting-period boundary. The final endDate must be on or after startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "endDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<Option<chrono::NaiveDate>>,
/// PDF creates a file and returns its URL with HTTP 201. CSV/XLSX return the file directly with HTTP 200. Accept: text/html overrides this selection.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub format: Option<String>,
/// First document date to include. Omission or null defaults to the corresponding accounting-period boundary. The final endDate must be on or after startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "startDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<Option<chrono::NaiveDate>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Movement counts for one account. States without movements are omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountStatementStatistics {
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Number of movements that have been booked.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub booked: Option<i64>,
/// Number of movements that have been ignored.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ignored: Option<i64>,
/// Number of movements that are still open.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub open: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// New display name for an imported statement.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountStatementUpdate {
/// Stored as supplied; whitespace and an empty string are accepted.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account types are the top level of the finance chart of accounts. They distinguish assets, liabilities and profit-and-loss accounts. Each account class belongs to one account type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountType {
/// Balance-sheet side: assets or liabilities. Omit this field for a profit-and-loss account type. On update, omission also clears the balance-sheet classification.
/// Allowed values: `assets`, `liabilities`.
#[serde(rename = "balanceType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub balance_type: Option<String>,
/// Unique account-type name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Legacy flag: true when balanceType is non-null. Use balanceType instead.
#[serde(rename = "isBalanceAccount", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use balanceType instead."]
pub is_balance_account: Option<bool>,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Account types are the top level of the finance chart of accounts. They distinguish assets, liabilities and profit-and-loss accounts. Each account class belongs to one account type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountTypeCreate {
/// Balance-sheet side: assets or liabilities. Omit this field for a profit-and-loss account type. On update, omission also clears the balance-sheet classification.
/// Allowed values: `assets`, `liabilities`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "balanceType", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub balance_type: Option<Option<String>>,
/// Unique account-type name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for an existing account type. Optional fields use the creation defaults when omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountTypeUpdate {
/// Balance-sheet side: assets or liabilities. Omit this field for a profit-and-loss account type. On update, omission also clears the balance-sheet classification.
/// Allowed values: `assets`, `liabilities`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "balanceType", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub balance_type: Option<Option<String>>,
/// Unique account-type name. The controller does not trim the name or enforce a length limit.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ascending display order. Omission resets it to 0, including on update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for an account in an open accounting period. The period cannot be changed here. Omitted optional fields reset to false or null. A donation account with existing donation transactions cannot have isDonationAccount disabled through this single-update endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountUpdate {
/// Existing parent account group from /finance/accountgroups.
#[serde(rename = "accountGroupId", deserialize_with = "crate::lenient::number")]
pub account_group_id: i64,
/// Optional trimmed note. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<Option<String>>,
/// Budget in minor currency units. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<Option<i64>>,
/// Optional account identifier, for example an IBAN. All spaces are removed before storage; no IBAN-format validation is performed. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub identifier: Option<Option<String>>,
/// Whether transactions on this account can be recorded as donations. Omission resets the flag to false.
#[serde(rename = "isDonationAccount", default, skip_serializing_if = "Option::is_none")]
pub is_donation_account: Option<bool>,
/// Whether the account is included in electronically supported employer audits (euBP). On update, an existing lock forces this flag to true.
#[serde(rename = "isMandatoryEubp", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory_eubp: Option<bool>,
/// Whether this account is used for opening-balance postings. Omission resets the flag to false.
#[serde(rename = "isOpeningBalanceAccount", default, skip_serializing_if = "Option::is_none")]
pub is_opening_balance_account: Option<bool>,
/// Trimmed, nonblank account name. Creation checks uniqueness within the accounting period.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Trimmed account number. The value 9999 is reserved for the profit-and-loss total in reports. On creation, number must be unique within the accounting period.
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Optional default tax rate from /finance/taxrates. Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An accounting period is the date range for one finance client’s books, usually a financial year. Accounts and cost centers belong to a period. Closing a period prevents ordinary account and transaction changes; it is separate from making individual transactions immutable.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountingPeriod {
/// Finance client owning this period.
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// Last date of the period.
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
/// Whether document numbers are incremented automatically. Required in both creation and update.
#[serde(rename = "incrementDocumentNumber")]
pub increment_document_number: bool,
/// Whether the period is closed for ordinary accounting changes. This flag alone does not make transactions immutable.
#[serde(rename = "isClosed")]
pub is_closed: bool,
/// First date of the period. Used to match the previous period by subtracting exactly one year.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Timestamp when donation receipts were marked as created, or null when not yet marked.
#[serde(rename = "donationReceiptsCreated", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub donation_receipts_created: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
pub permissions: AccountingPeriodPermissions,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Optional opening-balance transfer. Both an openingBalanceAccount and a nonempty from list are needed to start a transfer. The previous period must have the same client and a start date exactly one year earlier.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountingPeriodBalanceTransfer {
/// Source balance-sheet account IDs from the previous period. Matching target accounts must have the same numbers. Profit-and-loss accounts are not allowed. The transfer posts only the difference between closing balances and already existing opening balances; zero differences are skipped.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub from: Option<Vec<i64>>,
/// ID of an existing account whose number identifies an opening-balance account in the target period. The source ID itself need not belong to the target period; its number is used for matching.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "openingBalanceAccount", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub opening_balance_account: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An accounting period is the date range for one finance client’s books, usually a financial year. Accounts and cost centers belong to a period. Closing a period prevents ordinary account and transaction changes; it is separate from making individual transactions immutable.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountingPeriodCreate {
/// Finance client owning this period.
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// Last date of the period.
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
/// Whether document numbers are incremented automatically. Required in both creation and update.
#[serde(rename = "incrementDocumentNumber")]
pub increment_document_number: bool,
/// Whether the period is closed for ordinary accounting changes. This flag alone does not make transactions immutable.
#[serde(rename = "isClosed")]
pub is_closed: bool,
/// First date of the period. Used to match the previous period by subtracting exactly one year.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Optional opening-balance transfer. Both an openingBalanceAccount and a nonempty from list are needed to start a transfer. The previous period must have the same client and a start date exactly one year earlier.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub balances: Option<AccountingPeriodBalanceTransfer>,
/// Copy the previous period’s accounts, cost centers and related finance master data. The previous period is matched by client and a start date exactly one year earlier. Without a match, an empty period is created. Ordinary transactions are not copied. The current copy implementation retains the previous incrementDocumentNumber setting.
#[serde(rename = "copyMasterData", default, skip_serializing_if = "Option::is_none")]
pub copy_master_data: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountingPeriodPermissions {
/// Whether the caller has resolved edit permission for finance expert-mode operations in this period. This does not replace finance master-data permission for changing period settings.
#[serde(rename = "canUseExpertMode")]
pub can_use_expert_mode: bool,
/// Whether the caller has global finance edit accounting period permission for this period.
#[serde(rename = "edit accounting period")]
pub edit_accounting_period: bool,
/// Whether the caller has global finance view accounting period permission for this period. Visibility may also come from other permissions.
#[serde(rename = "view accounting period")]
pub view_accounting_period: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement period settings. All AccountingPeriodBase fields are required. Optional balance transfer and transaction immutability are applied after saving the period.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AccountingPeriodUpdate {
/// Finance client owning this period.
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// Last date of the period.
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
/// Whether document numbers are incremented automatically. Required in both creation and update.
#[serde(rename = "incrementDocumentNumber")]
pub increment_document_number: bool,
/// Whether the period is closed for ordinary accounting changes. This flag alone does not make transactions immutable.
#[serde(rename = "isClosed")]
pub is_closed: bool,
/// First date of the period. Used to match the previous period by subtracting exactly one year.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Optional opening-balance transfer. Both an openingBalanceAccount and a nonempty from list are needed to start a transfer. The previous period must have the same client and a start date exactly one year earlier.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub balances: Option<AccountingPeriodBalanceTransfer>,
/// When isClosed=true, make currently mutable transactions in the period immutable. Ignored when isClosed=false. Reopening the period does not undo transaction immutability.
#[serde(rename = "setImmutability", default, skip_serializing_if = "Option::is_none")]
pub set_immutability: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Action {
#[serde(rename = "actionMetaData")]
pub action_meta_data: ActionMetaData,
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<ActionGroup>,
/// Allowed values: `add-member-to-group`, `archive-member`, `change-member-status-active-requested`, `change-member-status-active-to_delete`, `change-member-status-requested-active`, `change-member-status-requested-to_delete`, `change-member-status-requested-waiting`, `change-member-status-to_delete-active`, `change-member-status-to_delete-requested`, `change-member-status-waiting-active`, `change-member-status-waiting-requested`, `change-member-status-waiting-to_delete`, `create-follow-up`, `edit-group-membership`, `edit-member`, `edit-tags-for-member`, `invite-member`, `remove-member`, `send-member-email`, `special:repeat`, `special:wait`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ActionGroup {
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ActionMetaData {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Address {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// A country's ISO-code
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
/// The identifier of the domain object. This field is set automatically from the path parameter and should not be included in the request body.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// The domain type of the address. This field is set automatically from the path parameter and should not be included in the request body.
/// Allowed values: `appointment`, `campus`, `church`, `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Legacy field mappings emitted by the address serializer.
#[serde(rename = "@deprecated")]
pub deprecated: AddressDeprecated,
/// Use `latitude` instead
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub geo_lat: Option<String>,
/// Use `longitude` instead
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub geo_lng: Option<String>,
/// Use `latitude` instead
#[serde(rename = "latitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub latitude_loose: Option<String>,
/// Use `longitude` instead
#[serde(rename = "longitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub longitude_loose: Option<String>,
/// Allowed values: `default`, `parent`, `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(rename = "markerColor", default, skip_serializing_if = "serde_json::Value::is_null")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_color: serde_json::Value,
/// Use `icon` instead
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `icon` instead"]
pub marker_icon: Option<String>,
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_url: Option<String>,
/// Use `name` instead
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `name` instead"]
pub meeting_at: Option<String>,
/// Use `zip` instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `zip` instead"]
pub postalcode: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy field mappings emitted by the address serializer.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AddressDeprecated {
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::string")]
pub geo_lat: String,
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::string")]
pub geo_lng: String,
#[serde(rename = "markerColor", deserialize_with = "crate::lenient::string")]
pub marker_color: String,
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::string")]
pub marker_icon: String,
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::string")]
pub marker_url: String,
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::string")]
pub meeting_at: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub postalcode: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AddressInterface {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AddressSearchResult {
pub address: AddressInterface,
#[serde(rename = "domainObject", default, skip_serializing_if = "serde_json::Value::is_null")]
pub domain_object: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An age range used to describe the intended ages for a group, for example ages 3 to 5. A group can reference several ranges through information.ageGroupIds. These are configured ranges, not the calculated ages of its current members.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgeGroup {
/// Upper age boundary in years, inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub end: i64,
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Lower age boundary in years, inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub start: i64,
/// ID of this master-data record in this ChurchTools installation. Use it when assigning this classification to a group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgeGroupCreate {
/// Upper age boundary in years, inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub end: i64,
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Lower age boundary in years, inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub start: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Ordered running plan for an event, such as a worship service, or a reusable agenda template. Several events can share the same agenda and item IDs. Their dates and hidden items can differ, so item `startTimes` are calculated separately for each event. Changes to shared content and the lock state affect every linked event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Agenda {
/// Compatibility mapping included in the response.
#[serde(rename = "@deprecated")]
pub deprecated: AgendaDeprecated,
/// Calendar assigned to the agenda. Linking another event does not replace this value with the target event's calendar ID.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Zero-based index in the complete ordered items array where the event begins. Earlier items are marked isBeforeEvent and their visible, non-header durations are subtracted from the event start. Hidden items and headers still occupy positions in the array.
#[serde(rename = "eventStartPosition", deserialize_with = "crate::lenient::number")]
pub event_start_position: i64,
/// ID of the shared agenda, not the event. Integrated events return the same agenda ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Use `isLocked` instead.
#[serde(rename = "isFinal", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `isLocked` instead."]
pub is_final: Option<bool>,
/// Shared lock state. Content editing is blocked while `true`; linking or detaching events is still possible.
#[serde(rename = "isLocked")]
pub is_locked: bool,
/// All agenda items ordered by sort key, including headers and items hidden for the requested event. Use `startTimes`\[`eventId`\] to identify hidden items.
pub items: Vec<serde_json::Value>,
pub meta: MetaDataEntityId,
/// For an event agenda, a display name derived from the requested event's date and appointment title. For templates, the stored template name. The display name can differ between events sharing one agenda.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Optional free-text series name, for example a sermon series. This is independent of calendar recurrence.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub series: Option<String>,
/// Number of non-header items in the complete shared agenda, including items hidden for the requested event. This is a count, not a duration.
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create an agenda without copying a template or another event. Supply `calendarId` explicitly; it is not inferred from the event. Items are optional, so an empty agenda can be created.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaCreate {
/// Calendar assigned to this agenda. It is not automatically taken from the event.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub calendar_id: Option<i64>,
/// Zero-based index in the complete items array where the event begins, including headers and hidden items.
#[serde(rename = "eventStartPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_start_position: Option<i64>,
/// Complete replacement list in the intended order. Existing IDs retain and update those items; entries without IDs create new ones. An empty array deletes all items. Cannot be combined with either copy-source query parameter.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<AgendaItemListUpdate>>,
/// Free-text series name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub series: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility mapping included in the response.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaDeprecated {
/// Allowed values: `isLocked`.
#[serde(rename = "isFinal", deserialize_with = "crate::lenient::string")]
pub is_final: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Generated presenter archive and information about ambiguous song-file choices. The response is JSON, not the archive itself.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaExport {
/// Labels in the form "song title - arrangement name" for agenda items whose selected arrangement has multiple files matching the target format. The exporter still selects the first file.
#[serde(rename = "songsWithMultipleFiles")]
pub songs_with_multiple_files: Vec<String>,
/// Relative URL of the stored export file. Resolve it against the ChurchTools installation URL and fetch it separately. Download access is checked against the template or a linked event's agenda permissions.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Options for generating a presenter archive.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaExportCreate {
/// Append the selected arrangement name to exported song captions and generated fallback file names. Existing attached files retain their file names.
#[serde(rename = "appendArrangement")]
pub append_arrangement: bool,
/// Include available song files for the target software. The first matching file of the selected arrangement is used. For SongBeamer, the song's default arrangement can provide a fallback `.sng` file. When disabled, song references point to files expected in the presenter library. No song-file conversion is performed.
#[serde(rename = "exportSongs")]
pub export_songs: bool,
/// For `SONG_BEAMER` with `exportSongs`=`false`, prefix generated song file references with the song category as a directory. Has no effect with embedded song files or for either ProPresenter format.
#[serde(rename = "withCategory")]
pub with_category: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Response fields shared by header, text and song items. Positions and timing are calculated by ChurchTools from the shared item order and the linked events.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemHeader {
/// Compatibility marker included in each serialized agenda item.
#[serde(rename = "@deprecated")]
pub deprecated: AgendaItemTextDeprecated,
/// Stored duration in seconds. For headers, zero selects `calculatedDuration` for display. Header duration is not added to the running time. An item hidden for an event does not consume time.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the item precedes `eventStartPosition`. This is based on the shared item order, independently of visibility in a particular event.
#[serde(rename = "isBeforeEvent")]
pub is_before_event: bool,
pub meta: MetaDataEntityId,
/// Deprecated zero-based index in the complete shared items array, including headers and hidden items.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub position: Option<i64>,
/// Calculated position time for the requested event, or the first linked event when no event context is selected. Can still contain a time when the item is hidden; use `startTimes`\[`eventId`\] to determine visibility. `null` when there is no event timing, as for templates.
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start: Option<chrono::DateTime<chrono::Utc>>,
/// Calculated start times keyed by linked event ID, also for agendas with only one event. Null means the item is hidden for that event. Empty for an agenda without linked event timing, such as a template.
#[serde(rename = "startTimes", deserialize_with = "crate::lenient::map")]
pub start_times: std::collections::BTreeMap<String, Option<chrono::DateTime<chrono::Utc>>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Total duration in seconds of visible content items up to the next visible header or event start, calculated independently of the stored duration. Use for display when `duration` is zero.
#[serde(rename = "calculatedDuration", deserialize_with = "crate::lenient::number")]
pub calculated_duration: i64,
/// Allowed values: `header`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemInputHeader {
/// Duration in seconds. For headers, zero selects automatic calculation from the section's visible items; a positive value overrides it. Header duration does not contribute to the running time.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// Responses represent a missing title as an empty string.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub title: Option<Option<String>>,
/// Allowed values: `header`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemInputSong {
/// Duration in seconds
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// Responses represent a missing title as an empty string.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub title: Option<Option<String>>,
/// Note text.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Free text with optional service placeholders, such as \[Worship Leader\].
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub responsible: Option<Option<String>>,
/// Notes to associate with service groups.
#[serde(rename = "serviceGroupNotes", default, skip_serializing_if = "Option::is_none")]
pub service_group_notes: Option<Vec<AgendaServiceGroupNoteCreate>>,
/// Existing song arrangement to use. An unknown arrangement ID causes `422`.
#[serde(rename = "arrangementId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub arrangement_id: Option<i64>,
/// Allowed values: `song`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemInputText {
/// Duration in seconds
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// Responses represent a missing title as an empty string.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub title: Option<Option<String>>,
/// Note text.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Free text with optional service placeholders, such as \[Worship Leader\].
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub responsible: Option<Option<String>>,
/// Notes to associate with service groups.
#[serde(rename = "serviceGroupNotes", default, skip_serializing_if = "Option::is_none")]
pub service_group_notes: Option<Vec<AgendaServiceGroupNoteCreate>>,
/// Allowed values: `text`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One entry in a complete replacement list. Each existing ID may occur only once. Array order determines the final item order.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemListUpdate {
/// Existing item ID in this agenda. Unknown IDs, IDs from another agenda and repeated existing IDs cause `422`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Response fields shared by header, text and song items. Positions and timing are calculated by ChurchTools from the shared item order and the linked events.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemSong {
/// Compatibility marker included in each serialized agenda item.
#[serde(rename = "@deprecated")]
pub deprecated: AgendaItemTextDeprecated,
/// Stored duration in seconds. For headers, zero selects `calculatedDuration` for display. Header duration is not added to the running time. An item hidden for an event does not consume time.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the item precedes `eventStartPosition`. This is based on the shared item order, independently of visibility in a particular event.
#[serde(rename = "isBeforeEvent")]
pub is_before_event: bool,
pub meta: MetaDataEntityId,
/// Deprecated zero-based index in the complete shared items array, including headers and hidden items.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub position: Option<i64>,
/// Calculated position time for the requested event, or the first linked event when no event context is selected. Can still contain a time when the item is hidden; use `startTimes`\[`eventId`\] to determine visibility. `null` when there is no event timing, as for templates.
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start: Option<chrono::DateTime<chrono::Utc>>,
/// Calculated start times keyed by linked event ID, also for agendas with only one event. Null means the item is hidden for that event. Empty for an agenda without linked event timing, such as a template.
#[serde(rename = "startTimes", deserialize_with = "crate::lenient::map")]
pub start_times: std::collections::BTreeMap<String, Option<chrono::DateTime<chrono::Utc>>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Raw responsibility text and optional resolved service assignments. `GET /events/{eventId}/agenda` resolves placeholders against that event; write responses do not perform this resolution and can return an empty persons array.
pub responsible: AgendaResponsible,
/// Notes for service groups. The event-agenda GET filters these to visible service groups; agenda write responses do not apply that filtering step.
#[serde(rename = "serviceGroupNotes")]
pub service_group_notes: Vec<AgendaServiceGroupNote>,
/// The selected song arrangement, or `null` if no arrangement is assigned. `text` and `header` items do not include this field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub song: Option<AgendaItemSongArrangement>,
/// Allowed values: `song`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Selected arrangement of a song for this agenda item. A song can have multiple arrangements with different musical settings.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemSongArrangement {
#[serde(deserialize_with = "crate::lenient::string")]
pub arrangement: String,
#[serde(rename = "arrangementId", deserialize_with = "crate::lenient::number")]
pub arrangement_id: i64,
/// Stored tempo in beats per minute, or `null`.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub bpm: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub category: String,
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Stored musical key as free text, or `null`. Values are not restricted to a fixed enum.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key: Option<String>,
#[serde(rename = "songId", deserialize_with = "crate::lenient::number")]
pub song_id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Response fields shared by header, text and song items. Positions and timing are calculated by ChurchTools from the shared item order and the linked events.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemText {
/// Compatibility marker included in each serialized agenda item.
#[serde(rename = "@deprecated")]
pub deprecated: AgendaItemTextDeprecated,
/// Stored duration in seconds. For headers, zero selects `calculatedDuration` for display. Header duration is not added to the running time. An item hidden for an event does not consume time.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the item precedes `eventStartPosition`. This is based on the shared item order, independently of visibility in a particular event.
#[serde(rename = "isBeforeEvent")]
pub is_before_event: bool,
pub meta: MetaDataEntityId,
/// Deprecated zero-based index in the complete shared items array, including headers and hidden items.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub position: Option<i64>,
/// Calculated position time for the requested event, or the first linked event when no event context is selected. Can still contain a time when the item is hidden; use `startTimes`\[`eventId`\] to determine visibility. `null` when there is no event timing, as for templates.
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start: Option<chrono::DateTime<chrono::Utc>>,
/// Calculated start times keyed by linked event ID, also for agendas with only one event. Null means the item is hidden for that event. Empty for an agenda without linked event timing, such as a template.
#[serde(rename = "startTimes", deserialize_with = "crate::lenient::map")]
pub start_times: std::collections::BTreeMap<String, Option<chrono::DateTime<chrono::Utc>>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Raw responsibility text and optional resolved service assignments. `GET /events/{eventId}/agenda` resolves placeholders against that event; write responses do not perform this resolution and can return an empty persons array.
pub responsible: AgendaResponsible,
/// Notes for service groups. The event-agenda GET filters these to visible service groups; agenda write responses do not apply that filtering step.
#[serde(rename = "serviceGroupNotes")]
pub service_group_notes: Vec<AgendaServiceGroupNote>,
/// Allowed values: `text`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility marker included in each serialized agenda item.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaItemTextDeprecated {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub position: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy agenda-email request. Prefer `POST /events/send` with EventMailCreate.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaMailCreate {
/// HTML email body. ChurchTools appends buttons for all supplied events and any requested, available agenda and file links.
#[serde(deserialize_with = "crate::lenient::string")]
pub body: String,
/// Events used to resolve participating recipients and message links. Every supplied event must exist. Events are not required to share an agenda.
#[serde(rename = "eventIds")]
pub event_ids: Vec<i64>,
/// Selected person IDs. Only selected participants in visible service groups of the loaded events, or selected people the sender may otherwise view, receive the message. The response reports other IDs as rejected. Participants are not added automatically.
pub recipients: Vec<i64>,
/// Also include the currently logged-in person as a recipient, even if their ID is absent from recipients.
#[serde(rename = "sendCopyToMe", default, skip_serializing_if = "Option::is_none")]
pub send_copy_to_me: Option<bool>,
/// Email subject.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Append links for supplied events that have an agenda and for whose calendar the sender has "view agenda" permission.
#[serde(rename = "appendAgendaButton", default, skip_serializing_if = "Option::is_none")]
pub append_agenda_button: Option<bool>,
/// File IDs to list as links in the message body. Only files associated with one of the supplied events are used. These are links, not binary email attachments.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub files: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Raw responsibility text and optional resolved service assignments. `GET /events/{eventId}/agenda` resolves placeholders against that event; write responses do not perform this resolution and can return an empty persons array.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaResponsible {
/// Assignments resolved from bracketed service names. Multiple slots can produce several entries for one placeholder. An unknown or unassigned service can produce a `null` person. An empty array can mean that this endpoint did not resolve responsibilities.
pub persons: Vec<AgendaResponsiblePerson>,
/// Free text with optional service-name placeholders in square brackets, for example \[Leader\]. The text is returned unchanged; persons contains separately resolved assignments.
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaResponsiblePerson {
/// Flag to indicate if the person has accepted the service or is requested.
pub accepted: bool,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub person: serde_json::Value,
/// Service placeholder including square brackets, for example \[Leader\]. If no matching assignment was found, a question mark is appended, for example \[Leader\]?. Service names are configurable and are not an enum.
#[serde(deserialize_with = "crate::lenient::string")]
pub service: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Note intended for one service group, such as sound or music.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaServiceGroupNote {
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaServiceGroupNoteCreate {
/// The note text for the service group
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update or remove the note for the service group in the path. Other service-group notes on the item remain unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaServiceGroupNoteUpdate {
/// Note text for the service group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reusable running-plan template. Items use the same header, text and song types as event agendas. Templates have no event date; copying one into an event creates independent agenda items.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaTemplateCreate {
/// Calendar that determines template visibility and editing permissions.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Zero-based index in the complete item list where the event begins when this template is copied.
#[serde(rename = "eventStartPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_start_position: Option<i64>,
/// Initial template items in their intended order. Items are not linked to any event.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<serde_json::Value>>,
/// Template name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional free-text series name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub series: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update an existing template. The optional items array replaces the complete list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaTemplateUpdate {
/// Calendar that determines template visibility and editing permissions.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Zero-based index in the complete item list where the event begins when this template is copied.
#[serde(rename = "eventStartPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_start_position: Option<i64>,
/// Complete replacement list in the intended order. An empty array deletes all items.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<AgendaItemListUpdate>>,
/// Template name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional free-text series name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub series: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields accepted when updating an existing event agenda or copying an agenda. The optional items array replaces the complete item list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AgendaUpdate {
/// Calendar assigned to this agenda. It is not automatically taken from the event.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub calendar_id: Option<i64>,
/// Zero-based index in the complete items array where the event begins, including headers and hidden items.
#[serde(rename = "eventStartPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_start_position: Option<i64>,
/// Complete replacement list in the intended order. Existing IDs retain and update those items; entries without IDs create new ones. An empty array deletes all items. Cannot be combined with either copy-source query parameter.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<AgendaItemListUpdate>>,
/// Free-text series name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub series: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An additional occurrence on a calendar date, using the base appointment’s local start time and duration. With isRepeated=true, the recurrence rule also runs from this additional date, for example to add a second weekday to a weekly series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentAdditionalCreate {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
#[serde(rename = "isRepeated")]
pub is_repeated: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored additional date for a series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentAdditionals {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
#[serde(rename = "isRepeated")]
pub is_repeated: bool,
/// ID of the stored recurrence entry.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Location entered with an appointment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentAddressCreate {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// A country's ISO-code
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub country: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub district: Option<Option<String>>,
/// Latitude of the appointment location.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<Option<f64>>,
/// Longitude of the appointment location.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<Option<f64>>,
/// Legacy alias for name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub meeting_at: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored calendar appointment defining a single occurrence or a series. id identifies the whole stored appointment; pair it with a local occurrence start date to address a particular occurrence. startDate/endDate are the base occurrence, not necessarily the occurrence currently being displayed. Service-planning events, registration groups, bookings and meeting requests are separate linked resources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBase {
pub additionals: Vec<AppointmentAdditionals>,
/// Use 'additionals' instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'additionals' instead"]
pub additions: Option<Vec<AppointmentAdditionals>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// True when the appointment is all-day. The serialized endDate is inclusive.
#[serde(rename = "allDay")]
pub all_day: bool,
/// Calendar containing the appointment.
pub calendar: AppointmentBaseCalendar,
/// Use 'title' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'title' instead"]
pub caption: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<AppointmentExeptions>,
/// ID of the stored appointment or series.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image: Option<Image>,
/// Use 'description' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'description' instead"]
pub information: Option<String>,
#[serde(rename = "isInternal")]
pub is_internal: bool,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
pub meta: MetaDataEntityId,
/// Use 'subtitle' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'subtitle' instead"]
pub note: Option<String>,
/// Person on whose behalf the appointment was entered, or null.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Registration-group configuration, or null if the appointment has none.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignup>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Revision counter increased by updates; not an input precondition or a per-occurrence ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calendar containing the appointment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBaseCalendar {
/// Campus associated with this calendar, or null for no campus. A campus represents a ChurchTools location/site, not a calendar permission group.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Display color, normally a CSS hex color such as #336699.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub color: Option<String>,
/// Event type ID used by the Evangelische Termine integration, or null. This is an external event classification, not a ChurchTools calendar type.
#[serde(rename = "evTermineEventTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ev_termine_event_type_id: Option<i64>,
/// Configured service-planning event template ID for this calendar, or null. This differs from an appointment template.
#[serde(rename = "eventTemplateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_template_id: Option<i64>,
/// External iCalendar feed to import. webcal:// and ical:// are normalized to https://; addresses without a scheme receive https://.
#[serde(rename = "iCalSourceUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub i_cal_source_url: Option<String>,
/// Calendar display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. The calendar list is sorted by this value in ascending order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the Evangelische Termine integration should synchronize this calendar. This is separate from importing an iCalendar feed.
#[serde(rename = "syncToEvTermine")]
pub sync_to_ev_termine: bool,
/// Calendar category used by ChurchTools: church for a church calendar, group for a group calendar, personal for a personal calendar. The category determines which administration permissions apply; it does not by itself grant public access or link the calendar to a particular group or person. Access is controlled separately. The type is chosen on creation and cannot be changed by PUT.
/// Allowed values: `church`, `group`, `personal`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Legacy response metadata mapping isPublic and isPrivate to type.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Calendar ID used in /calendars/{calendarId} and appointment URLs.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Legacy category flag: true for personal calendars. Use type instead.
#[serde(rename = "isPrivate", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead."]
pub is_private: Option<bool>,
/// Legacy category flag: true for church calendars. Use type; this flag does not replace access-permission checks.
#[serde(rename = "isPublic", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type; this flag does not replace access-permission checks."]
pub is_public: Option<bool>,
pub meta: MetaDataEntityId,
/// Localized display name, falling back to the stored name for ordinary calendar names.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Generated token used by calendar subscription/export links. This is not a complete URL and is not the external import source address.
#[serde(rename = "randomUrl", deserialize_with = "crate::lenient::string")]
pub random_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBooking {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub minpost: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub minpre: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub resource_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A reported conflict involving a resource reservation. base and conflict describe booking occurrences and may be null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBookingChangeImpact {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub base: Option<AppointmentBookingImpactOccurrence>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub conflict: Option<AppointmentBookingImpactOccurrence>,
/// Allowed values: `booking`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// An individual bookable resource, such as a room, vehicle or item of equipment. A resource type groups similar resources. Bookings reserve this resource for specific dates.
pub resource: Resource,
/// Allowed values: `conflict`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Book one resource for the appointment and its recurrence pattern. leadTimeMinutes and afterwardMinutes extend the resource reservation around each occurrence.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBookingCreate {
/// Minutes after the appointment during which the resource is blocked.
#[serde(rename = "afterwardMinutes", deserialize_with = "crate::lenient::number")]
pub afterward_minutes: i64,
/// Minutes before the appointment during which the resource is blocked.
#[serde(rename = "leadTimeMinutes", deserialize_with = "crate::lenient::number")]
pub lead_time_minutes: i64,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// ID of the resource to reserve; use each resource only once.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Resource booking state: 1 = pending, 2 = approved, 3 = rejected. The requested state is subject to booking permissions.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentBookingImpactOccurrence {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
/// Booking ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A stored appointment plus all calculated occurrence dates keyed by local YYYY-MM-DD. Unlike occurrence endpoints, dates inside calculatedDates are always UTC timestamps, including all-day appointments. Optional enrichments are attached to their occurrence; tags are returned in additionalInfos.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentCalculated {
/// Series-level enrichments, currently tags when requested.
#[serde(rename = "additionalInfos", default, skip_serializing_if = "serde_json::Value::is_null")]
pub additional_infos: serde_json::Value,
/// Stored calendar appointment defining a single occurrence or a series. id identifies the whole stored appointment; pair it with a local occurrence start date to address a particular occurrence. startDate/endDate are the base occurrence, not necessarily the occurrence currently being displayed. Service-planning events, registration groups, bookings and meeting requests are separate linked resources.
pub appointment: AppointmentBase,
/// Occurrences keyed by their local start date.
#[serde(rename = "calculatedDates", default, skip_serializing_if = "serde_json::Value::is_null")]
pub calculated_dates: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentCalculatedCalculatedDatesVariant1Value {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<BookingCalculated>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
/// Event as Domain Object
#[serde(default, skip_serializing_if = "Option::is_none")]
pub event: Option<DomainObjectEvent>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<DomainObjectGroup>,
#[serde(rename = "iCalUid", deserialize_with = "crate::lenient::string")]
pub i_cal_uid: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "titleSuffix", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title_suffix: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Proposed schedule to inspect without saving the appointment. This endpoint reports supported impacts, not a complete validation of an update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentChangeImpactCreate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Optional local date at which the series would be split.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "splitDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub split_date: Option<Option<chrono::NaiveDate>>,
/// When splitting, use true for this and future occurrences or false for this occurrence only.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "splitUntilEnd", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub split_until_end: Option<Option<bool>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create the base appointment and optional linked resources in the calendar selected by the path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentCreate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Location entered with an appointment.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentAddressCreate>,
/// Resource reservations matched by resourceId.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<AppointmentBookingCreate>>,
/// Description of the appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Only new service-planning events to create. Existing linked events are updated separately when the appointment changes; events no longer matching the series may be deleted.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<AppointmentEventCreate>>,
/// Send an information email to the person on whose behalf the appointment is managed, or its original creator. The workflow skips inactive recipients, the acting user and changes without notable differences.
#[serde(rename = "informOwner", default, skip_serializing_if = "Option::is_none")]
pub inform_owner: Option<bool>,
/// Set `false` for a regular appointment. Use `true` only when the appointment is intended to be visible exclusively to signed-in users.
#[serde(rename = "isInternal")]
pub is_internal: bool,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub link: Option<Option<String>>,
/// Invitees for the appointment or series. The field name is lowercase.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meetingrequests: Option<Vec<MeetingRequestCreate>>,
/// Person ID on whose behalf the appointment is created. This person is also used as inviter for meeting requests.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Configure groups used to collect registrations for individual appointment occurrences. These are separate ChurchTools groups, not meeting invitations or service-planning events.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignupCreate>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Appointment tags to add, as IDs, names or objects containing id.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<serde_json::Value>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEvent {
#[serde(rename = "eventTemplate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub event_template: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An existing service-planning event would no longer match the resulting series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEventChangeImpact {
/// Allowed values: `event`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
pub event: AppointmentEventChangeImpactEvent,
/// Allowed values: `deletion`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEventChangeImpactEvent {
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create a service-planning event for one occurrence. This is a separate ChurchTools resource linked to the calendar appointment; existing events must not be submitted again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEventCreate {
/// Person IDs of the event administrators.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Optional service-planning event template to apply.
#[serde(rename = "eventTemplateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_template_id: Option<i64>,
/// Event fact values keyed by configured fact ID. Allowed values depend on the fact’s number or select type.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub facts: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Use `description` instead.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `description` instead."]
pub note: Option<Option<String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub services: Option<Vec<AppointmentEventCreateServicesItem>>,
/// Exact UTC start of an occurrence in the resulting appointment; seconds are discarded. A duplicate event or a date outside the series produces 422.
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEventCreateServicesItem {
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An accepted service assignment associated with the appointment. The calculator reports these as move impacts; this is not a detailed before/after diff.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentEventServiceChangeImpact {
/// Allowed values: `eventService`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "eventService")]
pub event_service: EventService,
/// Start of the assignment’s current event.
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Allowed values: `move`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Exclude occurrences starting on this local calendar date, including matches generated from additionals.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentExceptionCreate {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored exclusion date for a series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentExeptions {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
/// ID of the stored recurrence entry.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One calculated occurrence and optional linked resources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrence {
pub appointment: AppointmentOccurrenceListAppointment,
/// Resource-booking occurrences, when requested and visible.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<BookingCalculated>>,
/// Service-planning event for this occurrence, or null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub event: Option<DomainObjectEvent>,
/// Visible registration group for this occurrence, or null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<DomainObjectGroup>,
/// Requests for the whole appointment or series.
#[serde(rename = "meetingRequests", default, skip_serializing_if = "Option::is_none")]
pub meeting_requests: Option<Vec<MeetingRequest>>,
/// Tags assigned to the stored appointment, included with tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Text derived from configured service assignments, included with titleSuffix.
#[serde(rename = "titleSuffix", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title_suffix: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calculated start/end for one occurrence. All-day dates use YYYY-MM-DD with an inclusive end; timed dates use UTC timestamps.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrenceDate {
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
/// Stable iCalendar UID for this occurrence.
#[serde(rename = "iCalUid", deserialize_with = "crate::lenient::string")]
pub i_cal_uid: String,
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calculated occurrence returned by appointment list endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrenceList {
pub appointment: AppointmentOccurrenceListAppointment,
/// Resource-booking occurrences, when requested and visible.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<BookingCalculated>>,
/// Service-planning event for this occurrence, or null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub event: Option<DomainObjectEvent>,
/// Visible registration group for this occurrence, or null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<DomainObjectGroup>,
/// Requests for the whole appointment or series.
#[serde(rename = "meetingRequests", default, skip_serializing_if = "Option::is_none")]
pub meeting_requests: Option<Vec<MeetingRequest>>,
/// Tags assigned to the stored appointment, included with tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Text derived from configured service assignments, included with titleSuffix.
#[serde(rename = "titleSuffix", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title_suffix: Option<String>,
/// Legacy alias for appointment.base.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub base: Option<AppointmentOccurrenceListBase>,
/// Legacy alias for appointment.calculated.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub calculated: Option<AppointmentOccurrenceListCalculated>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrenceListAppointment {
/// Stored calendar appointment defining a single occurrence or a series. id identifies the whole stored appointment; pair it with a local occurrence start date to address a particular occurrence. startDate/endDate are the base occurrence, not necessarily the occurrence currently being displayed. Service-planning events, registration groups, bookings and meeting requests are separate linked resources.
pub base: AppointmentBase,
/// Calculated start/end for one occurrence. All-day dates use YYYY-MM-DD with an inclusive end; timed dates use UTC timestamps.
pub calculated: AppointmentOccurrenceDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy alias for appointment.base.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrenceListBase {
pub additionals: Vec<AppointmentAdditionals>,
/// Use 'additionals' instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'additionals' instead"]
pub additions: Option<Vec<AppointmentAdditionals>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// True when the appointment is all-day. The serialized endDate is inclusive.
#[serde(rename = "allDay")]
pub all_day: bool,
/// Calendar containing the appointment.
pub calendar: AppointmentBaseCalendar,
/// Use 'title' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'title' instead"]
pub caption: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<AppointmentExeptions>,
/// ID of the stored appointment or series.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image: Option<Image>,
/// Use 'description' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'description' instead"]
pub information: Option<String>,
#[serde(rename = "isInternal")]
pub is_internal: bool,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
pub meta: MetaDataEntityId,
/// Use 'subtitle' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'subtitle' instead"]
pub note: Option<String>,
/// Person on whose behalf the appointment was entered, or null.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Registration-group configuration, or null if the appointment has none.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignup>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Revision counter increased by updates; not an input precondition or a per-occurrence ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy alias for appointment.calculated.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentOccurrenceListCalculated {
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
/// Stable iCalendar UID for this occurrence.
#[serde(rename = "iCalUid", deserialize_with = "crate::lenient::string")]
pub i_cal_uid: String,
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentSignup {
#[serde(rename = "signupDaysArchiveGroupNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_days_archive_group_no: Option<i64>,
#[serde(rename = "signupDaysForwardNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_days_forward_no: Option<i64>,
#[serde(rename = "signupGroupTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_group_type_id: Option<i64>,
#[serde(rename = "signupTemplateGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_template_group_id: Option<i64>,
/// Use 'signupDaysForwardNo' instead. Misspelled legacy field.
#[serde(rename = "singupDaysForwardNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'signupDaysForwardNo' instead."]
pub singup_days_forward_no: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configure groups used to collect registrations for individual appointment occurrences. These are separate ChurchTools groups, not meeting invitations or service-planning events.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentSignupCreate {
/// How many days after the appointment registration groups are archived.
#[serde(rename = "signupDaysArchiveGroupNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_days_archive_group_no: Option<i64>,
/// How many days ahead registration groups are created.
#[serde(rename = "signupDaysForwardNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_days_forward_no: Option<i64>,
/// Group type used for the registration groups.
#[serde(rename = "signupGroupTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_group_type_id: Option<i64>,
/// Group used as a template for registration groups.
#[serde(rename = "signupTemplateGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub signup_template_group_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// New appointment data plus the scope removed from the original series. The response identifies the newly created appointment; the original retains the unaffected dates.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentSplitUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Location entered with an appointment.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentAddressCreate>,
/// Resource reservations matched by resourceId.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<AppointmentBookingCreate>>,
/// Description of the appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Only new service-planning events to create. Existing linked events are updated separately when the appointment changes; events no longer matching the series may be deleted.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<AppointmentEventCreate>>,
/// Send an information email to the person on whose behalf the appointment is managed, or its original creator. The workflow skips inactive recipients, the acting user and changes without notable differences.
#[serde(rename = "informOwner", default, skip_serializing_if = "Option::is_none")]
pub inform_owner: Option<bool>,
/// Set `false` for a regular appointment. Use `true` only when the appointment is intended to be visible exclusively to signed-in users.
#[serde(rename = "isInternal")]
pub is_internal: bool,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub link: Option<Option<String>>,
/// Invitees for the appointment or series. The field name is lowercase.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meetingrequests: Option<Vec<MeetingRequestCreate>>,
/// Person ID on whose behalf the appointment is created. This person is also used as inviter for meeting requests.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Configure groups used to collect registrations for individual appointment occurrences. These are separate ChurchTools groups, not meeting invitations or service-planning events.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignupCreate>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Appointment tags to add, as IDs, names or objects containing id.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<serde_json::Value>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// IDs of existing appointment bookings to delete. These are booking IDs, not resource IDs. In a split request, the selected scope is removed from these bookings and not recreated for the new appointment.
#[serde(rename = "bookingsToDelete", default, skip_serializing_if = "Option::is_none")]
pub bookings_to_delete: Option<Vec<i64>>,
/// Local date identifying the original occurrence or start of the split segment.
#[serde(rename = "splitDate")]
pub split_date: chrono::NaiveDate,
/// true cuts the original series off on the day before splitDate; false adds an exception for splitDate only. Supply the complete recurrence of the new part in either case.
#[serde(rename = "splitUntilEnd")]
pub split_until_end: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Saved appointment defaults plus the template ID and metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplate {
/// Location entered with an appointment template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentTemplateAddressCreate>,
/// Whether the template proposes an all-day appointment.
#[serde(rename = "allDay", default, skip_serializing_if = "Option::is_none")]
pub all_day: Option<bool>,
/// Stored resource-booking defaults in the legacy template format.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<AppointmentBooking>>,
/// Calendar for which the template provides defaults.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Days after the appointment for archiving registration groups.
#[serde(rename = "daysArchiveGroupNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub days_archive_group_no: Option<i64>,
/// Days ahead for creating registration groups.
#[serde(rename = "daysForwardNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub days_forward_no: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Difference between end and start in seconds. With allDay=true, 0 represents one all-day date because the appointment end date is inclusive.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// Stored service-planning event template selections. Applying them is part of appointment creation, not saving this template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<AppointmentEvent>>,
/// Group type for registration groups created for appointment occurrences.
#[serde(rename = "grouptypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grouptype_id: Option<i64>,
#[serde(rename = "isInternal", default, skip_serializing_if = "Option::is_none")]
pub is_internal: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
/// Seconds from the chosen appointment start to the series end used when applying this template.
#[serde(rename = "repeatDuration", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_duration: Option<i64>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// Monthly-by-weekday ordinal, using the template field name repeatOptionId. The resulting appointment uses repeatOption.
#[serde(rename = "repeatOptionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option_id: Option<i64>,
/// Local start time used when applying the template, conventionally HH:mm.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub start_time: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
/// Existing appointment-tag IDs saved in the template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<i64>>,
/// Group used as a template for registration groups.
#[serde(rename = "templateGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub template_group_id: Option<i64>,
/// Title proposed for appointments created from this template.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Use `calendarId` instead.
#[serde(rename = "categoryId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `calendarId` instead."]
pub category_id: Option<i64>,
/// Template ID; not an appointment ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image: Option<AppointmentTemplateImage>,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Location entered with an appointment template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplateAddressCreate {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// A country's ISO-code
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
/// Coordinate stored as text in appointment templates.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
/// Coordinate stored as text in appointment templates.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
/// Legacy alias for name.
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub meeting_at: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Save reusable appointment defaults without creating appointments or their linked resources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplateCreate {
/// Location entered with an appointment template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentTemplateAddressCreate>,
/// Whether the template proposes an all-day appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "allDay", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub all_day: Option<Option<bool>>,
/// Stored resource-booking defaults in the legacy template format.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Option<Vec<AppointmentBooking>>>,
/// Calendar for which the template provides defaults.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Days after the appointment for archiving registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "daysArchiveGroupNo", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub days_archive_group_no: Option<Option<i64>>,
/// Days ahead for creating registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "daysForwardNo", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub days_forward_no: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Difference between end and start in seconds. With allDay=true, 0 represents one all-day date because the appointment end date is inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
/// Stored service-planning event template selections. Applying them is part of appointment creation, not saving this template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub events: Option<Option<Vec<AppointmentEvent>>>,
/// Group type for registration groups created for appointment occurrences.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "grouptypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub grouptype_id: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "isInternal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub is_internal: Option<Option<bool>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub link: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Seconds from the chosen appointment start to the series end used when applying this template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatDuration", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_duration: Option<Option<i64>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// Monthly-by-weekday ordinal, using the template field name repeatOptionId. The resulting appointment uses repeatOption.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOptionId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option_id: Option<Option<i64>>,
/// Local start time used when applying the template, conventionally HH:mm.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::string")]
pub start_time: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Existing appointment-tag IDs saved in the template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Option<Vec<i64>>>,
/// Group used as a template for registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "templateGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub template_group_id: Option<Option<i64>>,
/// Title proposed for appointments created from this template.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Image file associated with an appointment template, managed separately from template create/update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplateImage {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::string")]
pub file_url: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replace the saved appointment-template defaults.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplateUpdate {
/// Location entered with an appointment template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentTemplateAddressCreate>,
/// Whether the template proposes an all-day appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "allDay", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub all_day: Option<Option<bool>>,
/// Stored resource-booking defaults in the legacy template format.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Option<Vec<AppointmentBooking>>>,
/// Calendar for which the template provides defaults.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Days after the appointment for archiving registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "daysArchiveGroupNo", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub days_archive_group_no: Option<Option<i64>>,
/// Days ahead for creating registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "daysForwardNo", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub days_forward_no: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Difference between end and start in seconds. With allDay=true, 0 represents one all-day date because the appointment end date is inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
/// Stored service-planning event template selections. Applying them is part of appointment creation, not saving this template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub events: Option<Option<Vec<AppointmentEvent>>>,
/// Group type for registration groups created for appointment occurrences.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "grouptypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub grouptype_id: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "isInternal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub is_internal: Option<Option<bool>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub link: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Seconds from the chosen appointment start to the series end used when applying this template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatDuration", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_duration: Option<Option<i64>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// Monthly-by-weekday ordinal, using the template field name repeatOptionId. The resulting appointment uses repeatOption.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOptionId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option_id: Option<Option<i64>>,
/// Local start time used when applying the template, conventionally HH:mm.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::string")]
pub start_time: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Existing appointment-tag IDs saved in the template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Option<Vec<i64>>>,
/// Group used as a template for registration groups.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "templateGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub template_group_id: Option<Option<i64>>,
/// Title proposed for appointments created from this template.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Appointment template returned immediately after a write.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentTemplateWritten {
/// Location entered with an appointment template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentTemplateAddressCreate>,
/// Whether the template proposes an all-day appointment.
#[serde(rename = "allDay", default, skip_serializing_if = "Option::is_none")]
pub all_day: Option<bool>,
/// Stored resource-booking defaults in the legacy template format.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<AppointmentBooking>>,
/// Calendar for which the template provides defaults.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// Days after the appointment for archiving registration groups.
#[serde(rename = "daysArchiveGroupNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub days_archive_group_no: Option<i64>,
/// Days ahead for creating registration groups.
#[serde(rename = "daysForwardNo", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub days_forward_no: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Difference between end and start in seconds. With allDay=true, 0 represents one all-day date because the appointment end date is inclusive.
#[serde(deserialize_with = "crate::lenient::number")]
pub duration: i64,
/// Stored service-planning event template selections. Applying them is part of appointment creation, not saving this template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<AppointmentEvent>>,
/// Group type for registration groups created for appointment occurrences.
#[serde(rename = "grouptypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grouptype_id: Option<i64>,
#[serde(rename = "isInternal", default, skip_serializing_if = "Option::is_none")]
pub is_internal: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
/// Seconds from the chosen appointment start to the series end used when applying this template.
#[serde(rename = "repeatDuration", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_duration: Option<i64>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// Monthly-by-weekday ordinal, using the template field name repeatOptionId. The resulting appointment uses repeatOption.
#[serde(rename = "repeatOptionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option_id: Option<i64>,
/// Local start time used when applying the template, conventionally HH:mm.
#[serde(rename = "startTime", deserialize_with = "crate::lenient::string")]
pub start_time: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
/// Existing appointment-tag IDs saved in the template.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<i64>>,
/// Group used as a template for registration groups.
#[serde(rename = "templateGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub template_group_id: Option<i64>,
/// Title proposed for appointments created from this template.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Use `calendarId` instead.
#[serde(rename = "categoryId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `calendarId` instead."]
pub category_id: Option<i64>,
/// Template ID; not an appointment ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image: Option<AppointmentTemplateImage>,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Full update of an appointment or series. Existing linked bookings and events follow the new schedule. The events list contains only new events; meetingrequests has separate replacement semantics.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct AppointmentUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Location entered with an appointment.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<AppointmentAddressCreate>,
/// Resource reservations matched by resourceId.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bookings: Option<Vec<AppointmentBookingCreate>>,
/// Description of the appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Only new service-planning events to create. Existing linked events are updated separately when the appointment changes; events no longer matching the series may be deleted.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<AppointmentEventCreate>>,
/// Send an information email to the person on whose behalf the appointment is managed, or its original creator. The workflow skips inactive recipients, the acting user and changes without notable differences.
#[serde(rename = "informOwner", default, skip_serializing_if = "Option::is_none")]
pub inform_owner: Option<bool>,
/// Set `false` for a regular appointment. Use `true` only when the appointment is intended to be visible exclusively to signed-in users.
#[serde(rename = "isInternal")]
pub is_internal: bool,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub link: Option<Option<String>>,
/// Invitees for the appointment or series. The field name is lowercase.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meetingrequests: Option<Vec<MeetingRequestCreate>>,
/// Person ID on whose behalf the appointment is created. This person is also used as inviter for meeting requests.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Configure groups used to collect registrations for individual appointment occurrences. These are separate ChurchTools groups, not meeting invitations or service-planning events.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignupCreate>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Appointment tags to add, as IDs, names or objects containing id.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<serde_json::Value>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// IDs of existing appointment bookings to delete. These are booking IDs, not resource IDs. In a split request, the selected scope is removed from these bookings and not recreated for the new appointment.
#[serde(rename = "bookingsToDelete", default, skip_serializing_if = "Option::is_none")]
pub bookings_to_delete: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One musical version of a song. Event agenda song items refer to an arrangement ID, allowing different keys, instruments or sources for the same song.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Arrangement {
/// Free-text time signature, such as `4/4` or `6/8`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub beat: Option<String>,
/// Notes about performing this arrangement.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Expected duration in seconds.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// Musical key using the API spelling.
/// Allowed values: `A`, `A#`, `A#m`, `Ab`, `Abm`, `Am`, `B`, `B#`, `B#m`, `Bb`, `Bbm`, `Bm`, `C`, `C#`, `C#m`, `Cb`, `Cbm`, `Cm`, `D`, `D#`, `D#m`, `Db`, `Dbm`, `Dm`, `E`, `E#`, `E#m`, `Eb`, `Ebm`, `Em`, ….
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key: Option<String>,
/// Name distinguishing this version from other arrangements.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// ID of a song source, such as a hymnal or songbook, from GET /song/sources.
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub source_id: Option<i64>,
/// Location within the selected source, such as a song number or page. Only used with sourceId.
#[serde(rename = "sourceReference", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_reference: Option<String>,
/// Tempo in beats per minute.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tempo: Option<i64>,
#[serde(rename = "@deprecated")]
pub deprecated: ArrangementDeprecated,
/// Compatibility alias for tempo, serialized as a string or `null`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub bpm: Option<String>,
/// List of files uploaded to that arrangement
pub files: Vec<FileOrLink>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether this arrangement is marked as a default for its song.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Use 'key' instead
/// Allowed values: `A`, `A#`, `A#m`, `Ab`, `Abm`, `Am`, `B`, `B#`, `B#m`, `Bb`, `Bbm`, `Bm`, `C`, `C#`, `C#m`, `Cb`, `Cbm`, `Cm`, `D`, `D#`, `D#m`, `Db`, `Dbm`, `Dm`, `E`, `E#`, `E#m`, `Eb`, `Ebm`, `Em`, ….
#[serde(rename = "keyOfArrangement", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'key' instead"]
pub key_of_arrangement: Option<String>,
/// List of links "uploaded" to that arrangement
pub links: Vec<FileOrLink>,
pub meta: MetaDataEntityId,
/// Use 'description' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'description' instead"]
pub note: Option<String>,
/// Source associated with this arrangement, or `null` when none is assigned.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub source: Option<SongSource>,
/// Source abbreviation if set, otherwise its name, or `null` when no source is assigned.
#[serde(rename = "sourceName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub source_name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A new musical version of a song, optionally assigning existing files.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArrangementCreate {
/// Free-text time signature, such as `4/4` or `6/8`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub beat: Option<Option<String>>,
/// Notes about performing this arrangement.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Expected duration in seconds.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<Option<i64>>,
/// Musical key using the API spelling.
/// Allowed values: `A`, `A#`, `A#m`, `Ab`, `Abm`, `Am`, `B`, `B#`, `B#m`, `Bb`, `Bbm`, `Bm`, `C`, `C#`, `C#m`, `Cb`, `Cbm`, `Cm`, `D`, `D#`, `D#m`, `Db`, `Dbm`, `Dm`, `E`, `E#`, `E#m`, `Eb`, `Ebm`, `Em`, ….
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub key: Option<Option<String>>,
/// Name distinguishing this version from other arrangements.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// ID of a song source, such as a hymnal or songbook, from GET /song/sources.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub source_id: Option<Option<i64>>,
/// Location within the selected source, such as a song number or page. Only used with sourceId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sourceReference", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub source_reference: Option<Option<String>>,
/// Tempo in beats per minute.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tempo: Option<Option<i64>>,
/// IDs of existing files to assign to the arrangement.
#[serde(rename = "fileIds", default, skip_serializing_if = "Option::is_none")]
pub file_ids: Option<Vec<i64>>,
/// `true` makes this the song's only default arrangement. The first arrangement of a song becomes the default regardless of this value.
#[serde(rename = "isDefault", default, skip_serializing_if = "Option::is_none")]
pub is_default: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArrangementDeprecated {
/// Allowed values: `tempo`.
#[serde(deserialize_with = "crate::lenient::string")]
pub bpm: String,
/// Allowed values: `key`.
#[serde(rename = "keyOfArrangement", deserialize_with = "crate::lenient::string")]
pub key_of_arrangement: String,
/// Allowed values: `description`.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Allowed values: `source.name`.
#[serde(rename = "sourceName", deserialize_with = "crate::lenient::string")]
pub source_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Result of synchronous audio transposition. These fields are returned directly at the top level, without a data or meta wrapper.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArrangementFileTranspose {
/// Display filename with the signed semitone count inserted before the original extension. For example, down2 changes Rehearsal.mp3 to Rehearsal-2.mp3.
#[serde(deserialize_with = "crate::lenient::string")]
pub bezeichnung: String,
/// Storage filename of the new file, currently a content hash. Use bezeichnung for the human-readable name.
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
/// ID of the newly created file.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Modification timestamp of the new file.
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
/// True when conversion and saving the new file succeeded. Failures use an error response.
pub success: bool,
/// Relative download URL of the new file, resolved against the ChurchTools installation URL.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a transposed audio copy from an existing file. No file upload is included in this request.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArrangementFileTransposeCreate {
/// Pitch shift in semitones: up1 through up6 raise the pitch by one to six semitones, down1 through down6 lower it. For example, up2 moves C to D. Zero and shifts beyond six semitones are not accepted.
/// Allowed values: `down1`, `down2`, `down3`, `down4`, `down5`, `down6`, `up1`, `up2`, `up3`, `up4`, `up5`, `up6`.
#[serde(rename = "transpose-interval", deserialize_with = "crate::lenient::string")]
pub transpose_interval: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Musical details of one song version. Files, links and the default flag are managed separately.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArrangementUpdate {
/// Free-text time signature, such as `4/4` or `6/8`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub beat: Option<Option<String>>,
/// Notes about performing this arrangement.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Expected duration in seconds.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<Option<i64>>,
/// Musical key using the API spelling.
/// Allowed values: `A`, `A#`, `A#m`, `Ab`, `Abm`, `Am`, `B`, `B#`, `B#m`, `Bb`, `Bbm`, `Bm`, `C`, `C#`, `C#m`, `Cb`, `Cbm`, `Cm`, `D`, `D#`, `D#m`, `Db`, `Dbm`, `Dm`, `E`, `E#`, `E#m`, `Eb`, `Ebm`, `Em`, ….
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub key: Option<Option<String>>,
/// Name distinguishing this version from other arrangements.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// ID of a song source, such as a hymnal or songbook, from GET /song/sources.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub source_id: Option<Option<i64>>,
/// Location within the selected source, such as a song number or page. Only used with sourceId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sourceReference", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub source_reference: Option<Option<String>>,
/// Tempo in beats per minute.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tempo: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Association {
#[serde(deserialize_with = "crate::lenient::string")]
pub abbreviation: String,
/// ISO 3166-1 alpha-2 country code of the association.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Balance-sheet selection. The API parses both dates but does not reject reversed or out-of-period ranges.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BalanceReportCreate {
/// Account-type IDs. Omission, null or \[\] selects all types. Existing IDs must be JSON integers; numeric strings do not match. Unknown IDs are ignored.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "accountTypes", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub account_types: Option<Option<Vec<i64>>>,
/// Accounting period owning the accounts. Requires finance edit masterdata or explicit view/edit permission for this period.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// PDF creates a file and returns its URL with HTTP 201. CSV/XLSX return the file directly with HTTP 200. Accept: text/html overrides this selection.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub format: Option<String>,
/// Include account-group grouping/columns in the report.
#[serde(rename = "showAccountGroups", default, skip_serializing_if = "Option::is_none")]
pub show_account_groups: Option<bool>,
/// Include zero-value accounts according to the selected report’s balance/activity calculation.
#[serde(rename = "showEmptyAccounts", default, skip_serializing_if = "Option::is_none")]
pub show_empty_accounts: Option<bool>,
/// Last document date to include.
#[serde(rename = "endDate")]
pub end_date: chrono::NaiveDate,
/// First document date to include.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Supporting document (Beleg) attached to a finance booking or booking suggestion. This represents the uploaded evidence, not an invoice or payment request.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Bill {
/// Accounting period shared by the linked booking or suggestion.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// File attached to a bill. This embedded representation has no file ID; use its fileUrl to download the document.
pub file: BillFile,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Linked split transaction, covering its component transactions. Null when no such link is stored.
#[serde(rename = "splitTransactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub split_transaction_id: Option<i64>,
/// Date the supporting document was submitted, independently of the booking date.
#[serde(rename = "submittedDate")]
pub submitted_date: chrono::NaiveDate,
/// Person who submitted the document. Must exist and be visible to the caller.
#[serde(rename = "submittedPid", deserialize_with = "crate::lenient::number")]
pub submitted_pid: i64,
/// Linked ordinary transaction. Null when no such link is stored.
#[serde(rename = "transactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub transaction_id: Option<i64>,
/// Linked booking suggestion from an account statement. Null when no such link is stored.
#[serde(rename = "transactionSuggestionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub transaction_suggestion_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillCreateWithSplit {
/// Accounting period shared by the linked booking or suggestion.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Existing uploaded file. A file in the unknown domain is reassigned to the bill; a file in another domain is copied before assignment.
#[serde(rename = "fileId", deserialize_with = "crate::lenient::number")]
pub file_id: i64,
/// Optional new display name for the attached file. Omission or null retains its name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<Option<String>>,
#[serde(rename = "splitTransactionId", deserialize_with = "crate::lenient::number")]
pub split_transaction_id: i64,
/// Date the supporting document was submitted, independently of the booking date.
#[serde(rename = "submittedDate")]
pub submitted_date: chrono::NaiveDate,
/// Person who submitted the document. Must exist and be visible to the caller.
#[serde(rename = "submittedPid", deserialize_with = "crate::lenient::number")]
pub submitted_pid: i64,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "transactionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub transaction_id: serde_json::Value,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "transactionSuggestionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub transaction_suggestion_id: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillCreateWithSuggestion {
/// Accounting period shared by the linked booking or suggestion.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Existing uploaded file. A file in the unknown domain is reassigned to the bill; a file in another domain is copied before assignment.
#[serde(rename = "fileId", deserialize_with = "crate::lenient::number")]
pub file_id: i64,
/// Optional new display name for the attached file. Omission or null retains its name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<Option<String>>,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "splitTransactionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub split_transaction_id: serde_json::Value,
/// Date the supporting document was submitted, independently of the booking date.
#[serde(rename = "submittedDate")]
pub submitted_date: chrono::NaiveDate,
/// Person who submitted the document. Must exist and be visible to the caller.
#[serde(rename = "submittedPid", deserialize_with = "crate::lenient::number")]
pub submitted_pid: i64,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "transactionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub transaction_id: serde_json::Value,
#[serde(rename = "transactionSuggestionId", deserialize_with = "crate::lenient::number")]
pub transaction_suggestion_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillCreateWithTransaction {
/// Accounting period shared by the linked booking or suggestion.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Existing uploaded file. A file in the unknown domain is reassigned to the bill; a file in another domain is copied before assignment.
#[serde(rename = "fileId", deserialize_with = "crate::lenient::number")]
pub file_id: i64,
/// Optional new display name for the attached file. Omission or null retains its name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<Option<String>>,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "splitTransactionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub split_transaction_id: serde_json::Value,
/// Date the supporting document was submitted, independently of the booking date.
#[serde(rename = "submittedDate")]
pub submitted_date: chrono::NaiveDate,
/// Person who submitted the document. Must exist and be visible to the caller.
#[serde(rename = "submittedPid", deserialize_with = "crate::lenient::number")]
pub submitted_pid: i64,
#[serde(rename = "transactionId", deserialize_with = "crate::lenient::number")]
pub transaction_id: i64,
/// Must be omitted or null when another booking link is selected.
#[serde(rename = "transactionSuggestionId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub transaction_suggestion_id: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// File attached to a bill. This embedded representation has no file ID; use its fileUrl to download the document.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillFile {
/// Bill ID stored as a file-domain string.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// Allowed values: `bill`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::string")]
pub file_url: String,
/// Stored filename, or null when unavailable.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<String>,
/// Image preview URL when available; otherwise null.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// File modification metadata. Creation metadata is not serialized.
pub meta: BillFileMetaData,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// File modification metadata. Creation metadata is not serialized.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillFileMetaData {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson")]
pub modified_person: MetaDataPersonId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates submission details and optionally changes the booking link. Omitted or null link IDs retain the current link. Supply at most one new link: when multiple IDs are supplied, the service gives splitTransactionId precedence over transactionId over transactionSuggestionId. Setting only a suggestion currently does not clear existing transaction links. The accounting period and attached file cannot be replaced here.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BillUpdate {
/// Optional new display name for the attached file. Omission or null retains its name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<Option<String>>,
/// Linked split transaction, covering its component transactions.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "splitTransactionId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub split_transaction_id: Option<Option<i64>>,
/// Date the supporting document was submitted, independently of the booking date.
#[serde(rename = "submittedDate")]
pub submitted_date: chrono::NaiveDate,
/// Person who submitted the document. Must exist and be visible to the caller.
#[serde(rename = "submittedPid", deserialize_with = "crate::lenient::number")]
pub submitted_pid: i64,
/// Linked ordinary transaction.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "transactionId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub transaction_id: Option<Option<i64>>,
/// Linked booking suggestion from an account statement.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "transactionSuggestionId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub transaction_suggestion_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BlogItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub author: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub content: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub date: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored additional booking date. Its legacy metadata contains the modifier ID directly.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingAdditional {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
#[serde(rename = "isRepeated")]
pub is_repeated: bool,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: BookingAdditionalMeta,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingAdditionalMeta {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPid", deserialize_with = "crate::lenient::number")]
pub modified_pid: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For an appointment-linked booking, only status and description can be changed here. Change the resource and schedule through the linked appointment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingAppointmentUpdate {
/// Booking notes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored resource booking, which may represent a recurring series. A booking reserves one resource. `appointment` links it to a calendar appointment; `null` identifies an independent booking. Use calculated occurrence dates when displaying a series in a date range.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingBase {
pub additionals: Vec<BookingAdditional>,
#[serde(rename = "allDay")]
pub all_day: bool,
/// When the current approval or rejection was recorded; null while unanswered.
#[serde(rename = "answeredDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub answered_date: Option<chrono::DateTime<chrono::Utc>>,
/// Person who recorded the answer, including the system user for automatic approval; null while unanswered.
#[serde(rename = "answeredPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub answered_pid: Option<i64>,
/// Linked calendar appointment, or null for an independent booking.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub appointment: Option<SimpleAppointment>,
/// Use `appointment` instead.
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `appointment` instead."]
pub appointment_id: Option<i64>,
/// Use `title` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `title` instead."]
pub caption: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<BookingException>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Included with `include[]=involvedPersonsDomainObjects`. The person for whom the booking was made and the person who answered can be null.
#[serde(rename = "involvedPersonsDomainObjects", default, skip_serializing_if = "Option::is_none")]
pub involved_persons_domain_objects: Option<BookingCalculatedWithIncludesBaseInvolvedPersonsDomainObjects>,
/// True when the reader may see availability but booking title, subtitle and description are hidden. This can result from missing access to the linked calendar or public-user anonymization settings.
#[serde(rename = "isAnonymized")]
pub is_anonymized: bool,
/// Use `subtitle` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `subtitle` instead."]
pub location: Option<String>,
pub meta: MetaDataEntityId,
/// Use `description` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `description` instead."]
pub note: Option<String>,
/// Person for whom the booking is made.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub quantity: i64,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Use `resourceId` instead.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `resourceId` instead."]
pub resource: Option<BookingCalculatedWithIncludesBaseResource>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Whether the booking is marked for display in the calendar. This does not create or link a calendar appointment.
#[serde(rename = "showInCal")]
pub show_in_cal: bool,
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Version counter increased by booking updates and status changes.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One occurrence: base describes the stored series, calculated contains the dates of this occurrence.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculated {
/// Stored resource booking, which may represent a recurring series. A booking reserves one resource. `appointment` links it to a calendar appointment; `null` identifies an independent booking. Use calculated occurrence dates when displaying a series in a date range.
pub base: BookingBase,
pub calculated: BookingCalculatedCalculated,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedCalculated {
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludes {
/// Use booking.base.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use booking."]
pub base: Option<BookingCalculatedWithIncludesBase>,
/// One occurrence: base describes the stored series, calculated contains the dates of this occurrence.
pub booking: BookingCalculated,
/// Use booking.calculated.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use booking."]
pub calculated: Option<BookingCalculatedWithIncludesCalculated>,
/// Included with `include[]=conflicts`. Conflicts are collected for the booking ID across the requested range, so multiple occurrences of the same series can carry the same list.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub conflicts: Option<Vec<BookingConflict>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Use booking.base.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludesBase {
pub additionals: Vec<BookingAdditional>,
#[serde(rename = "allDay")]
pub all_day: bool,
/// When the current approval or rejection was recorded; null while unanswered.
#[serde(rename = "answeredDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub answered_date: Option<chrono::DateTime<chrono::Utc>>,
/// Person who recorded the answer, including the system user for automatic approval; null while unanswered.
#[serde(rename = "answeredPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub answered_pid: Option<i64>,
/// Linked calendar appointment, or null for an independent booking.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub appointment: Option<SimpleAppointment>,
/// Use `appointment` instead.
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `appointment` instead."]
pub appointment_id: Option<i64>,
/// Use `title` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `title` instead."]
pub caption: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<BookingException>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Included with `include[]=involvedPersonsDomainObjects`. The person for whom the booking was made and the person who answered can be null.
#[serde(rename = "involvedPersonsDomainObjects", default, skip_serializing_if = "Option::is_none")]
pub involved_persons_domain_objects: Option<BookingCalculatedWithIncludesBaseInvolvedPersonsDomainObjects>,
/// True when the reader may see availability but booking title, subtitle and description are hidden. This can result from missing access to the linked calendar or public-user anonymization settings.
#[serde(rename = "isAnonymized")]
pub is_anonymized: bool,
/// Use `subtitle` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `subtitle` instead."]
pub location: Option<String>,
pub meta: MetaDataEntityId,
/// Use `description` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `description` instead."]
pub note: Option<String>,
/// Person for whom the booking is made.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub quantity: i64,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Use `resourceId` instead.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `resourceId` instead."]
pub resource: Option<BookingCalculatedWithIncludesBaseResource>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Whether the booking is marked for display in the calendar. This does not create or link a calendar appointment.
#[serde(rename = "showInCal")]
pub show_in_cal: bool,
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Version counter increased by booking updates and status changes.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Included with `include[]=involvedPersonsDomainObjects`. The person for whom the booking was made and the person who answered can be null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludesBaseInvolvedPersonsDomainObjects {
#[serde(rename = "answeredBy", default, skip_serializing_if = "Option::is_none")]
pub answered_by: Option<DomainObjectPerson>,
/// Person as Domain Object
#[serde(rename = "createdBy")]
pub created_by: DomainObjectPerson,
/// Person as Domain Object
#[serde(rename = "modifiedBy")]
pub modified_by: DomainObjectPerson,
#[serde(rename = "onBehalfOf", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of: Option<DomainObjectPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Use `resourceId` instead.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludesBaseResource {
/// Persons responsible for this resource. Resource administrators can view and administer its bookings; changing resource settings still requires permission to edit resource master data.
#[serde(rename = "adminIds")]
pub admin_ids: Vec<i64>,
/// Additional information about the resource, such as capacity or available equipment.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Location text used in the resource’s iCalendar export.
#[serde(rename = "iCalLocation", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub i_cal_location: Option<String>,
/// Automatically approves pending bookings when there are no conflicts. For virtual resources, automatic approval bypasses the conflict check. This does not grant permission to edit resource settings.
#[serde(rename = "isAutoAccept")]
pub is_auto_accept: bool,
/// Whether this is a virtual resource. Virtual bookings have a separate creation permission and bypass conflicts when checking automatic approval.
#[serde(rename = "isVirtual")]
pub is_virtual: bool,
/// Internal location of the resource.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub location: Option<String>,
/// Name of the individual resource, for example a room or vehicle.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Number of units available for simultaneous bookings.
#[serde(deserialize_with = "crate::lenient::number")]
pub quantity: i64,
/// Access token used by the legacy public iCalendar export. Changing or clearing it invalidates subscriptions using the previous token.
#[serde(rename = "randomString", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub random_string: Option<String>,
/// Resource type used to group this resource, such as rooms or vehicles. Resource types are available from `/resourcetypes`.
#[serde(rename = "resourceTypeId", deserialize_with = "crate::lenient::number")]
pub resource_type_id: i64,
/// Sort value for displaying resources.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Use `needsAppointment` instead.
#[serde(rename = "doesRequireCalEntry", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `needsAppointment` instead."]
pub does_require_cal_entry: Option<bool>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Included with `include[]=involvedPersonsDomainObjects`. Contains person references for resolvable `adminIds`; missing persons are omitted.
#[serde(rename = "involvedPersonsDomainObjects", default, skip_serializing_if = "Option::is_none")]
pub involved_persons_domain_objects: Option<BookingCalculatedWithIncludesBaseResourceInvolvedPersonsDomainObjects>,
pub meta: MetaDataEntityId,
/// Resource name translated for the current language, falling back to name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Whether bookings must be linked to a calendar appointment. Legacy resources can return null.
#[serde(rename = "needsAppointment", default, skip_serializing_if = "Option::is_none")]
pub needs_appointment: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Included with `include[]=involvedPersonsDomainObjects`. Contains person references for resolvable `adminIds`; missing persons are omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludesBaseResourceInvolvedPersonsDomainObjects {
pub admins: Vec<DomainObjectPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Use booking.calculated.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCalculatedWithIncludesCalculated {
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An overlapping occurrence of another pending or approved booking for the same resource. Adjacent timed bookings do not conflict. Dates retain their timezone offset.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingConflict {
#[serde(rename = "bookingId", deserialize_with = "crate::lenient::number")]
pub booking_id: i64,
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
/// True when title is replaced by the translated unknown-appointment label.
#[serde(rename = "isAnonymized")]
pub is_anonymized: bool,
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Preview conflicts for a proposed booking without saving it.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingConflictRequestBody {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Number of resource units reserved by each occurrence.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement schedule to preview against the stored booking’s resource. The current booking is excluded from conflicts. No data is saved and resourceId is not used.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingConflictUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Number of resource units reserved by each occurrence.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create an independent resource booking. A resource requiring an appointment must instead be booked through the appointment APIs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingCreate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Number of resource units reserved by each occurrence.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Booking notes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Person for whom the booking is made.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Whether the booking is marked for display in the calendar. This does not create or link a calendar appointment.
#[serde(rename = "showInCal")]
pub show_in_cal: bool,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Optional booking subtitle.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Booking title shown in resource planning.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored date excluded from a booking series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingException {
/// A simple date in ISO format, e.g. '2022-10-19'
pub date: chrono::NaiveDate,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement booking and the scope to remove from the original series. The returned booking has a new ID.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingSplitCreate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Number of resource units reserved by each occurrence.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Booking notes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Person for whom the booking is made.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Whether the booking is marked for display in the calendar. This does not create or link a calendar appointment.
#[serde(rename = "showInCal")]
pub show_in_cal: bool,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Optional booking subtitle.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Booking title shown in resource planning.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Local start date of the occurrence to remove or the first date to cut from the series.
#[serde(rename = "splitDate")]
pub split_date: chrono::NaiveDate,
/// False excludes splitDate only. True truncates the original series before splitDate and removes its additional dates and exceptions on or after that day.
#[serde(rename = "splitUntilEnd")]
pub split_until_end: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Complete replacement input for a booking without a linked appointment. Include every recurrence entry to retain.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingStandaloneUpdate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Number of resource units reserved by each occurrence.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Booking notes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Person for whom the booking is made.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<Option<i64>>,
/// Resource to reserve, such as a room, vehicle or piece of equipment.
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Whether the booking is marked for display in the calendar. This does not create or link a calendar appointment.
#[serde(rename = "showInCal")]
pub show_in_cal: bool,
/// Booking status: 1 = pending approval, 2 = approved, 3 = rejected. Rejected bookings are excluded from conflict checks.
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Optional booking subtitle.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Booking title shown in resource planning.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingWithIncludes {
/// With `include[]=conflicts`, contains conflicts across the complete series. Otherwise serialized as \[\]. Person includes are attached to booking itself.
#[serde(rename = "additionalInfos", default, skip_serializing_if = "serde_json::Value::is_null")]
pub additional_infos: serde_json::Value,
/// Stored resource booking, which may represent a recurring series. A booking reserves one resource. `appointment` links it to a calendar appointment; `null` identifies an independent booking. Use calculated occurrence dates when displaying a series in a date range.
pub booking: BookingBase,
/// Occurrences indexed by their local start date (YYYY-MM-DD). Values are UTC timestamps, including for all-day bookings. An empty result is serialized as \[\].
#[serde(rename = "calculatedDates", default, skip_serializing_if = "serde_json::Value::is_null")]
pub calculated_dates: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingWithIncludesAdditionalInfosVariant1 {
pub conflicts: Vec<BookingConflict>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BookingWithIncludesCalculatedDatesVariant1Value {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `event`/`declineEvent`: Cancels or deletes service-planning events. Selected IDs are event IDs, not appointment IDs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkEventDeclineUpdate {
/// Delete the event when true; otherwise invalidate it. Deletion delegates to the event service.
#[serde(rename = "deleteCalEntry")]
pub delete_cal_entry: bool,
/// Notify assigned persons after processing.
#[serde(rename = "informDeleteEvent")]
pub inform_delete_event: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `event`/`addPersonToService`: Assigns a person or free-text name to a service position in each event. Exactly one of `personId` or `personName` must be specified.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkEventServiceAssignmentCreate {
/// never requires a reusable slot; newIfNeeded creates one if needed; alwaysNew adds a slot unless the same assignee already has a valid assignment.
/// Allowed values: `alwaysNew`, `never`, `newIfNeeded`.
#[serde(deserialize_with = "crate::lenient::string")]
pub option: String,
/// Registered person ID.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_id: Option<i64>,
/// Free-text assignee.
#[serde(rename = "personName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub person_name: Option<String>,
/// Service-definition ID.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For `create-follow-up`. Supply exactly one of `dueDate` or `duration`; `duration` must contain a supported day, month, or year count. `actionContext.groupId` is the originating group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkFollowUpActionCreate {
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// Allowed values: `immediately`, `when-completed`.
#[serde(rename = "continuationType", deserialize_with = "crate::lenient::string")]
pub continuation_type: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Exactly one of `dueDate` or `duration` must be specified.
#[serde(rename = "dueDate", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<chrono::NaiveDate>,
/// Exactly one of `dueDate` or `duration` must be specified. Within `duration`, at least one of `numDays`, `numMonths`, or `numYears` must be specified.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub duration: Option<BulkFollowUpActionCreateDuration>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_id: Option<Option<i64>>,
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupMemberStatus", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_member_status: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupOfGroupTypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_of_group_type_id: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successRoleId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_role_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Exactly one of `dueDate` or `duration` must be specified. Within `duration`, at least one of `numDays`, `numMonths`, or `numYears` must be specified.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkFollowUpActionCreateDuration {
#[serde(rename = "numDays", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub num_days: Option<i64>,
#[serde(rename = "numMonths", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub num_months: Option<i64>,
#[serde(rename = "numYears", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub num_years: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`addParentGroup`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupAddParentGroupUpdate {
/// Parent group ID to add.
#[serde(rename = "parentGroupId", deserialize_with = "crate::lenient::number")]
pub parent_group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setAgeGroups`: Changes selected age groups.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupAgeGroupsUpdate {
#[serde(rename = "ageGroupIds")]
pub age_group_ids: Vec<i64>,
/// Replace the selection, add choices, or remove choices.
/// Allowed values: `add`, `del`, `overwrite`.
#[serde(rename = "writeOption", deserialize_with = "crate::lenient::string")]
pub write_option: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`delTag`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupDelTagUpdate {
/// Existing group-tag ID to remove.
#[serde(rename = "tagId", deserialize_with = "crate::lenient::number")]
pub tag_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setMeetingTime`: Changes the free-text meeting time.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupMeetingTimeUpdate {
/// Free-text meeting time, not a structured timestamp.
#[serde(rename = "meetingTime", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub meeting_time: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setCampus`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetCampusUpdate {
/// Campus ID.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setGroupCategory`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetGroupCategoryUpdate {
/// Group-category ID.
#[serde(rename = "groupCategoryId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_category_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setInformLeader`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetInformLeaderUpdate {
/// Enable leader notifications.
#[serde(rename = "informLeader")]
pub inform_leader: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setMaxMembers`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetMaxMembersUpdate {
/// Maximum number of members.
#[serde(rename = "maxMembers", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_members: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setShowInMemberStatistic`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetShowInMemberStatisticUpdate {
/// Include the group in membership statistics.
#[serde(rename = "inStatistic")]
pub in_statistic: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setSignUpOpen`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetSignUpOpenUpdate {
/// Open or close signup now by updating the group’s signup dates; this is not a persistent independent boolean.
#[serde(rename = "isOpenForMembers")]
pub is_open_for_members: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setTargetGroup`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetTargetGroupUpdate {
/// Target-group masterdata ID.
#[serde(rename = "targetGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub target_group_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setWeeklyMeeting`: Applies the setting to each selected group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupSetWeeklyMeetingUpdate {
/// Enable weekly meeting generation.
#[serde(rename = "createWeeklyGroupMeetings")]
pub create_weekly_group_meetings: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setStatus`: Changes group status; identical status leaves the group and side-effect settings unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupStatusUpdate {
/// Deactivate the chat when finishing the group.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub deactivate_chat_on_status_finished: Option<bool>,
/// Deactivate routines when finishing; execution additionally checks routine-administration permission.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub deactivate_routines_on_status_finished: Option<bool>,
/// Group-status ID.
#[serde(rename = "groupStatusId", deserialize_with = "crate::lenient::number")]
pub group_status_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setVisibility`: Changes group visibility.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupVisibilityUpdate {
/// Passes the visibility-change option for the current user’s posts to the group update.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub skip_my_posts_reducing_visibility: Option<bool>,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `group`/`setWeekday`: Changes the meeting weekday.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkGroupWeekdayUpdate {
/// Weekday numbered 0–6.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub weekday: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Permission-preview result. Targets without permission are omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkInfos {
/// Allowed IDs in original order, with duplicates retained and native bulk IDs cast to integers.
#[serde(rename = "allowedDomainObjectIdentifiers")]
pub allowed_domain_object_identifiers: Vec<serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Request body for permission previews and queued bulk operations. The `domainType` and `jobKey` URL parameters determine the required `jobData` schema; use the exact mapping below. Send `{}` for operations without additional data. Target identifiers retain their request order and duplicates. Built-in bulk jobs cast target identifiers to integers; action-based operations expect integer identifiers.
///
/// Built-in bulk jobs:
///
/// | domainType | jobKey | jobData schema |
/// | --- | --- | --- |
/// | group | addParentGroup | BulkGroupAddParentGroupUpdate |
/// | group | addTag | BulkTagCreate |
/// | group | delete | BulkEmptyData |
/// | group | delTag | BulkGroupDelTagUpdate |
/// | group | setAgeGroups | BulkGroupAgeGroupsUpdate |
/// | group | setCampus | BulkGroupSetCampusUpdate |
/// | group | setGroupCategory | BulkGroupSetGroupCategoryUpdate |
/// | group | setInformLeader | BulkGroupSetInformLeaderUpdate |
/// | group | setMaxMembers | BulkGroupSetMaxMembersUpdate |
/// | group | setMeetingTime | BulkGroupMeetingTimeUpdate |
/// | group | setShowInMemberStatistic | BulkGroupSetShowInMemberStatisticUpdate |
/// | group | setSignUpOpen | BulkGroupSetSignUpOpenUpdate |
/// | group | setStatus | BulkGroupStatusUpdate |
/// | group | setTargetGroup | BulkGroupSetTargetGroupUpdate |
/// | group | setVisibility | BulkGroupVisibilityUpdate |
/// | group | setWeekday | BulkGroupWeekdayUpdate |
/// | group | setWeeklyMeeting | BulkGroupSetWeeklyMeetingUpdate |
/// | person | addPersonAuth | BulkPersonAddPersonAuthUpdate |
/// | person | addDepartment | BulkPersonAddDepartmentUpdate |
/// | person | addPersonTag | BulkTagCreate |
/// | person | addToGroup | BulkPersonMembershipCreate |
/// | person | archivePerson | BulkEmptyData |
/// | person | changeCampus | BulkPersonChangeCampusUpdate |
/// | person | changeFamilyStatus | BulkPersonChangeFamilyStatusUpdate |
/// | person | changeGroupRoleAndStatus | BulkPersonMembershipUpdate |
/// | person | changeNationality | BulkPersonChangeNationalityUpdate |
/// | person | changeSex | BulkPersonChangeSexUpdate |
/// | person | changeStatus | BulkPersonChangeStatusUpdate |
/// | person | deleteDepartment | BulkPersonDeleteDepartmentUpdate |
/// | person | deleteFromGroup | BulkPersonDeleteFromGroupUpdate |
/// | person | deletePerson | BulkEmptyData |
/// | person | delPersonTag | BulkPersonDelPersonTagUpdate |
/// | person | forceTwoFactor | BulkEmptyData |
/// | person | invitePerson | BulkEmptyData |
/// | person | changeGroupMemberField | BulkPersonMembershipFieldUpdate |
/// | person | deactivateForceTwoFactor | BulkEmptyData |
/// | person | undoArchivePerson | BulkEmptyData |
/// | event | addPersonToService | BulkEventServiceAssignmentCreate |
/// | event | declineEvent | BulkEventDeclineUpdate |
///
/// Actions (discoverable through `POST /actions`):
///
/// | domainType | jobKey | jobData schema |
/// | --- | --- | --- |
/// | group_membership | add-member-to-group | BulkMembershipActionCreate |
/// | group_membership | archive-member | BulkEmptyData |
/// | group_membership | change-member-status-active-requested | BulkEmptyData |
/// | group_membership | change-member-status-active-to_delete | BulkEmptyData |
/// | group_membership | change-member-status-requested-active | BulkEmptyData |
/// | group_membership | change-member-status-requested-to_delete | BulkEmptyData |
/// | group_membership | change-member-status-requested-waiting | BulkEmptyData |
/// | group_membership | change-member-status-to_delete-active | BulkEmptyData |
/// | group_membership | change-member-status-to_delete-requested | BulkEmptyData |
/// | group_membership | change-member-status-waiting-active | BulkEmptyData |
/// | group_membership | change-member-status-waiting-requested | BulkEmptyData |
/// | group_membership | change-member-status-waiting-to_delete | BulkEmptyData |
/// | group_membership | create-follow-up | BulkFollowUpActionCreate |
/// | group_membership | edit-group-membership | BulkMembershipActionUpdate |
/// | group_membership | edit-member | BulkPersonActionUpdate |
/// | group_membership | edit-tags-for-member | BulkPersonTagsActionUpdate |
/// | group_membership | invite-member | BulkEmptyData |
/// | group_membership | remove-member | BulkEmptyData |
/// | group_membership | send-member-email | BulkMemberEmailActionCreate |
/// | person | add-person-to-group | BulkMembershipActionCreate |
/// | person | edit-person | BulkPersonActionUpdate |
/// | person | invite-person | BulkEmptyData |
/// | person | archive-person | BulkEmptyData |
/// | person | edit-tags-for-person | BulkPersonTagsActionUpdate |
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkJobCreate {
/// Context for action-based operations. Membership actions commonly require `groupId`.
#[serde(rename = "actionContext", default, skip_serializing_if = "Option::is_none")]
pub action_context: Option<BulkJobCreateActionContext>,
/// Targets to check or queue, in request order. Empty arrays are accepted. Prefer integer IDs for the registered jobs/actions.
#[serde(rename = "domainObjectIdentifiers")]
pub domain_object_identifiers: Vec<serde_json::Value>,
/// Payload selected by the domain/key table.
#[serde(rename = "jobData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub job_data: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Context for action-based operations. Membership actions commonly require `groupId`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkJobCreateActionContext {
/// Group of the selected memberships for context-dependent membership actions.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Queue acknowledgment, not execution results. No allowed targets still produces a GUID/group and zero queued jobs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkJobQueued {
/// Queue group formed from the resolved domain, job key and GUID.
#[serde(rename = "jobGroup", deserialize_with = "crate::lenient::string")]
pub job_group: String,
/// Identifier shared by all chunks and their job logs.
#[serde(rename = "jobGuid", deserialize_with = "crate::lenient::string")]
pub job_guid: String,
/// Number of queued chunks, not number of affected objects. Normally up to 50 IDs per chunk; group/delete uses up to 5.
#[serde(rename = "numberOfQueuedJobs", deserialize_with = "crate::lenient::number")]
pub number_of_queued_jobs: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Payload for `send-member-email`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkMemberEmailActionCreate {
/// Include a sign-out URL when available.
#[serde(rename = "addSignOutUrl", default, skip_serializing_if = "Option::is_none")]
pub add_sign_out_url: Option<bool>,
#[serde(rename = "attachmentIds", default, skip_serializing_if = "Option::is_none")]
pub attachment_ids: Option<Vec<i64>>,
/// Email body.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub body: Option<String>,
/// Optional sender person ID.
#[serde(rename = "senderId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sender_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Optional global template ID.
#[serde(rename = "templateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub template_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For add-person-to-group and add-member-to-group. groupId selects the destination; custom field keys are destination-field reference names. Existing membership leaves the person unchanged. The member variant resolves the person from the selected membership IDs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkMembershipActionCreate {
/// Membership comment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Member-field values keyed by reference name.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub fields: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Target group ID; must be a JSON integer before action validation starts.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Notify leaders; execution defaults to true.
#[serde(rename = "informLeader", default, skip_serializing_if = "Option::is_none")]
pub inform_leader: Option<bool>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "memberEndDate", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "memberStartDate", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<chrono::NaiveDate>,
/// Target group-type role ID.
#[serde(rename = "roleId", deserialize_with = "crate::lenient::number")]
pub role_id: i64,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Waiting-list position; -1 requests the next available position.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For edit-group-membership. actionContext.groupId must identify the actual group of every selected membership. Custom fields are keyed by reference name, not numeric field ID.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkMembershipActionUpdate {
/// Membership comment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Member-field values keyed by reference name.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub fields: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Notify leaders; execution defaults to true.
#[serde(rename = "informLeader", default, skip_serializing_if = "Option::is_none")]
pub inform_leader: Option<bool>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "memberEndDate", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "memberStartDate", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<chrono::NaiveDate>,
/// Replacement group-type role ID.
#[serde(rename = "roleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub role_id: Option<i64>,
/// Waiting-list position; -1 requests the next available position.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/addDepartment: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonAddDepartmentUpdate {
/// Department ID to add. Note the key department, unlike departmentId used for removal.
#[serde(deserialize_with = "crate::lenient::number")]
pub department: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/addPersonAuth: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonAddPersonAuthUpdate {
/// Authorization ID to assign.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/changeCampus: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonChangeCampusUpdate {
/// Campus ID.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::number")]
pub campus_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`changeFamilyStatus`: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonChangeFamilyStatusUpdate {
/// Family-status masterdata ID.
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`changeNationality`: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonChangeNationalityUpdate {
/// Nationality masterdata ID.
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`changeSex`: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonChangeSexUpdate {
/// Sex masterdata ID.
#[serde(rename = "sexId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/changeStatus: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonChangeStatusUpdate {
/// Person-status ID.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/delPersonTag: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonDelPersonTagUpdate {
/// Person-tag ID to remove.
#[serde(rename = "tagId", deserialize_with = "crate::lenient::number")]
pub tag_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/deleteDepartment: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonDeleteDepartmentUpdate {
/// Department ID to remove. The last remaining department is retained.
#[serde(rename = "departmentId", deserialize_with = "crate::lenient::number")]
pub department_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// person/deleteFromGroup: Applies this operation to each selected person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonDeleteFromGroupUpdate {
/// Group ID from which to remove the selected persons.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`addToGroup`: Adds persons to the selected group; existing memberships are unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonMembershipCreate {
/// Target group ID.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Role ID belonging to the target group type.
#[serde(rename = "roleId", deserialize_with = "crate::lenient::number")]
pub role_id: i64,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`changeGroupMemberField`: Changes a group-member custom field. Selected identifiers are person IDs, not membership IDs. The value is validated against the actual field at execution time. For multiselect, use an array; other fields use the scalar or first nonempty array element.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonMembershipFieldUpdate {
/// Group-member field ID belonging to the group.
#[serde(rename = "customFieldId", deserialize_with = "crate::lenient::number")]
pub custom_field_id: i64,
/// Group ID.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Value matching the field’s configured type and options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// For multiselect fields, replace, add, or remove values.
/// Allowed values: `add`, `del`, `overwrite`.
#[serde(rename = "writeOption", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub write_option: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// `person`/`changeGroupRoleAndStatus`: Changes only memberships matching `oldStatus` and, when set, `oldRoleId`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonMembershipUpdate {
/// Group ID.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Optional replacement role.
#[serde(rename = "newRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_role_id: Option<i64>,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "newStatus", deserialize_with = "crate::lenient::string")]
pub new_status: String,
/// Optional old-role filter.
#[serde(rename = "oldRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub old_role_id: Option<i64>,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "oldStatus", deserialize_with = "crate::lenient::string")]
pub old_status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For `edit-tags-for-person` and `edit-tags-for-member`. Supply either tag IDs or tag names.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkPersonTagsActionUpdate {
#[serde(rename = "tagIds", default, skip_serializing_if = "Option::is_none")]
pub tag_ids: Option<Vec<i64>>,
#[serde(rename = "tagNames", default, skip_serializing_if = "Option::is_none")]
pub tag_names: Option<Vec<String>>,
/// Allowed values: `add`, `remove`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// For `group`/`addTag` and `person`/`addPersonTag`. Supply an existing tag ID or a name for a new tag.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkTagCreate {
/// Existing tag ID.
#[serde(rename = "tagId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tag_id: Option<i64>,
/// New tag name.
#[serde(rename = "tagName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub tag_name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A mail-merge rendering job. Generates one PDF per selected recipient (or address group) and makes those PDFs available together in a ZIP archive. It does not send email or postal mail. The legacy response uses mixed snake_case and camelCase fields.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Bulkletter {
/// HTML content of the bulkletter, may contain placeholders.
#[serde(deserialize_with = "crate::lenient::string")]
pub content: String,
/// Legacy database timestamp in Y-m-d H:i:s format, without timezone; nullable in storage.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub created: Option<String>,
/// ID of the person that created the bulkletter (returned as string).
#[serde(deserialize_with = "crate::lenient::string")]
pub created_pid: String,
/// Generated ZIP archive file ID, or 0 before a file has been stored.
#[serde(rename = "fileId", deserialize_with = "crate::lenient::number")]
pub file_id: i64,
/// Optional group the bulkletter is associated with. `0` if no group is set.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the HTML template used to render the bulkletter.
#[serde(rename = "htmlTemplateId", deserialize_with = "crate::lenient::number")]
pub html_template_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Rendering lifecycle: TODO, IN_PROGRESS, DONE or ERROR. Completion and storing the archive are separate steps; check fileId/url as well as status.
/// Allowed values: `DONE`, `ERROR`, `IN_PROGRESS`, `TODO`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Legacy database timestamp in Y-m-d H:i:s format, without timezone; nullable in storage.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub updated: Option<String>,
/// Relative download URL of the ZIP archive containing individual PDFs. May be empty or null before the archive is available; resolve relative to the CT base URL.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a mail-merge job using an HTML template and selected person IDs. Requires edit bulkletter permission and visibility of the template. Successful creation only schedules rendering.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkletterCreate {
/// HTML inserted into the template’s {{content}} slot. Supports person/group placeholders. Non-empty; the literal string 0 is rejected.
#[serde(deserialize_with = "crate::lenient::string")]
pub content: String,
/// Group persons by identical street, address addition, postal code, city and country. Only persons with street, postal code and city are grouped. The first person returned for each address represents it; this is not a family-relationship or household-head calculation.
#[serde(rename = "groupByHousehold")]
pub group_by_household: bool,
/// Optional group used as placeholder context, not as a restriction on personIds.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<Option<i64>>,
/// ID of the HTML template used to render the bulkletter.
#[serde(rename = "htmlTemplateId", deserialize_with = "crate::lenient::number")]
pub html_template_id: i64,
/// Job name. Non-empty; the literal string 0 is rejected by the current validator.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Person IDs to render. Duplicate IDs are resolved through the person lookup; unknown IDs do not create recipient rows.
#[serde(rename = "personIds")]
pub person_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Acknowledges the newly scheduled job. Read its Location URL for status and the eventual ZIP download.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkletterCreated {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy address fields for a scheduled recipient. Values are read from the current person record, not a saved address snapshot.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct BulkletterReceiver {
/// Person ID (returned as string).
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// Last name of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// City of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ort: Option<String>,
/// Postal code of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub plz: Option<String>,
/// Street address of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub strasse: Option<String>,
/// First name of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub vorname: Option<String>,
/// Additional address line of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zusatz: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calendar containing appointments and their series. Calendar settings, appointment editing and calendar administration are separate concerns. The type selects the applicable administration category; effective visibility depends on permissions. This object is also embedded in appointment responses.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Calendar {
/// Campus associated with this calendar, or null for no campus. A campus represents a ChurchTools location/site, not a calendar permission group.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Display color, normally a CSS hex color such as #336699.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub color: Option<String>,
/// Event type ID used by the Evangelische Termine integration, or null. This is an external event classification, not a ChurchTools calendar type.
#[serde(rename = "evTermineEventTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ev_termine_event_type_id: Option<i64>,
/// Configured service-planning event template ID for this calendar, or null. This differs from an appointment template.
#[serde(rename = "eventTemplateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub event_template_id: Option<i64>,
/// External iCalendar feed to import. webcal:// and ical:// are normalized to https://; addresses without a scheme receive https://.
#[serde(rename = "iCalSourceUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub i_cal_source_url: Option<String>,
/// Calendar display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. The calendar list is sorted by this value in ascending order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the Evangelische Termine integration should synchronize this calendar. This is separate from importing an iCalendar feed.
#[serde(rename = "syncToEvTermine")]
pub sync_to_ev_termine: bool,
/// Calendar category used by ChurchTools: church for a church calendar, group for a group calendar, personal for a personal calendar. The category determines which administration permissions apply; it does not by itself grant public access or link the calendar to a particular group or person. Access is controlled separately. The type is chosen on creation and cannot be changed by PUT.
/// Allowed values: `church`, `group`, `personal`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Legacy response metadata mapping isPublic and isPrivate to type.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Calendar ID used in /calendars/{calendarId} and appointment URLs.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Legacy category flag: true for personal calendars. Use type instead.
#[serde(rename = "isPrivate", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead."]
pub is_private: Option<bool>,
/// Legacy category flag: true for church calendars. Use type; this flag does not replace access-permission checks.
#[serde(rename = "isPublic", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type; this flag does not replace access-permission checks."]
pub is_public: Option<bool>,
pub meta: MetaDataEntityId,
/// Localized display name, falling back to the stored name for ordinary calendar names.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Generated token used by calendar subscription/export links. This is not a complete URL and is not the external import source address.
#[serde(rename = "randomUrl", deserialize_with = "crate::lenient::string")]
pub random_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create a calendar with its category and settings. The creator receives permission to edit its appointments. Calendar creation does not itself create appointments, except when an iCalSourceUrl initiates a feed import.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CalendarCreate {
/// Campus associated with this calendar, or null for no campus. A campus represents a ChurchTools location/site, not a calendar permission group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Display color, normally a CSS hex color such as #336699.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// Event type ID used by the Evangelische Termine integration, or null. This is an external event classification, not a ChurchTools calendar type.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "evTermineEventTypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub ev_termine_event_type_id: Option<Option<i64>>,
/// Configured service-planning event template ID for this calendar, or null. This differs from an appointment template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eventTemplateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub event_template_id: Option<Option<i64>>,
/// External iCalendar feed to import. webcal:// and ical:// are normalized to https://; addresses without a scheme receive https://.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "iCalSourceUrl", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub i_cal_source_url: Option<Option<String>>,
/// Calendar display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. The calendar list is sorted by this value in ascending order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the Evangelische Termine integration should synchronize this calendar. This is separate from importing an iCalendar feed.
#[serde(rename = "syncToEvTermine", default, skip_serializing_if = "Option::is_none")]
pub sync_to_ev_termine: Option<bool>,
/// Calendar category used by ChurchTools: church for a church calendar, group for a group calendar, personal for a personal calendar. The category determines which administration permissions apply; it does not by itself grant public access or link the calendar to a particular group or person. Access is controlled separately. The type is chosen on creation and cannot be changed by PUT.
/// Allowed values: `church`, `group`, `personal`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Editable calendar settings. The calendar type cannot be changed here. A supplied iCalSourceUrl triggers an external calendar import.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CalendarUpdate {
/// Campus associated with this calendar, or null for no campus. A campus represents a ChurchTools location/site, not a calendar permission group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Display color, normally a CSS hex color such as #336699.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// Event type ID used by the Evangelische Termine integration, or null. This is an external event classification, not a ChurchTools calendar type.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "evTermineEventTypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub ev_termine_event_type_id: Option<Option<i64>>,
/// Configured service-planning event template ID for this calendar, or null. This differs from an appointment template.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eventTemplateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub event_template_id: Option<Option<i64>>,
/// External iCalendar feed to import. webcal:// and ical:// are normalized to https://; addresses without a scheme receive https://.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "iCalSourceUrl", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub i_cal_source_url: Option<Option<String>>,
/// Calendar display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. The calendar list is sorted by this value in ascending order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the Evangelische Termine integration should synchronize this calendar. This is separate from importing an iCalendar feed.
#[serde(rename = "syncToEvTermine", default, skip_serializing_if = "Option::is_none")]
pub sync_to_ev_termine: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A campus represents one location or congregation within a ChurchTools installation. Persons, groups, calendars and other resources can reference its numeric ID. This is the compact campus master-data representation; the detailed campus profile is a separate API representation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Campus {
/// Address associated with the campus profile, or null when none is assigned. Campus create/update requests do not set this field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<CampusAddress>,
/// Persistent profile GUID generated by ChurchTools. Use the numeric id for campusId references.
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
/// Numeric campus ID used by campusId fields in other API resources.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Stored campus name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Optional short profile name. Distinct from shorty and not editable through the campus create/update endpoints.
#[serde(rename = "shortName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
/// Campus abbreviation, or null for records without one. New campuses created through this API require an abbreviation.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Display-order value. GET /campuses does not guarantee this order; sort by this field in the client when needed.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored address associated with a campus profile.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CampusAddress {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// A country's ISO-code
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
/// The identifier of the domain object. This field is set automatically from the path parameter and should not be included in the request body.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// The domain type of the address. This field is set automatically from the path parameter and should not be included in the request body.
/// Allowed values: `appointment`, `campus`, `church`, `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "@deprecated")]
pub deprecated: StoredAddressDeprecated,
/// Use `latitude` instead
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub geo_lat: Option<String>,
/// Use `longitude` instead
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub geo_lng: Option<String>,
/// Use `latitude` instead
#[serde(rename = "latitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub latitude_loose: Option<String>,
/// Use `longitude` instead
#[serde(rename = "longitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub longitude_loose: Option<String>,
/// Allowed values: `default`, `parent`, `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(rename = "markerColor", default, skip_serializing_if = "serde_json::Value::is_null")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_color: serde_json::Value,
/// Use `icon` instead
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `icon` instead"]
pub marker_icon: Option<String>,
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_url: Option<String>,
/// Use `name` instead
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `name` instead"]
pub meeting_at: Option<String>,
/// Use `zip` instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `zip` instead"]
pub postalcode: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a campus (a location or congregation within the same ChurchTools installation). Name and abbreviation are required. Other profile details are managed separately.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CampusCreate {
/// Campus name. Whitespace is trimmed; at least one character must remain.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Abbreviation used in compact displays. Whitespace is trimmed. This endpoint requires an explicit value; it does not generate one from the name.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display-order value for clients that sort campuses. Negative values are accepted. Omitted defaults to zero.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial campus update despite the PUT method. Every field is optional. Omitted or null values retain their existing values; an empty object leaves the campus unchanged. The ID comes from the URL.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CampusUpdate {
/// New name. Omitted or null retains the current value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// New abbreviation. Omitted or null retains the current value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// New display-order value. Omitted or null retains the current value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A cash discount defines a percentage for early-payment discounts and the ledger account to which the discount is posted. Its accounting period is determined by that account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CashDiscount {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Trimmed description. Supply a nonblank value because the stored model requires a string.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Percentage points: 2 means 2%. Stored values are floating-point numbers, although this API currently accepts only integer input.
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: f64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A cash discount defines a percentage for early-payment discounts and the ledger account to which the discount is posted. Its accounting period is determined by that account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CashDiscountCreate {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Trimmed description. Supply a nonblank value because the stored model requires a string.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Whole percentage points: 2 means 2%. This endpoint currently accepts only integers and does not validate a percentage range.
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for this cash discount.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CashDiscountUpdate {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Trimmed description. Supply a nonblank value because the stored model requires a string.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Whole percentage points: 2 means 2%. This endpoint currently accepts only integers and does not validate a percentage range.
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group or event chat room synchronized with Matrix.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Chat {
/// Person ID recorded as the room creator. `0` represents a system user.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub creator: Option<i64>,
/// ID of the group (`ctg`) or service-planning event (`cte`) associated with the room.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Stable ChurchTools chat identifier, not a Matrix room ID.
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
/// `ctg` identifies a group and `cte` identifies a service-planning event.
/// Allowed values: `cte`, `ctg`.
#[serde(deserialize_with = "crate::lenient::string")]
pub prefix: String,
/// Display name of the room.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub roomname: Option<String>,
/// Room lifecycle status. `STARTING` awaits confirmation from the central chat service.
/// Allowed values: `NOT_STARTED`, `STARTED`, `STARTING`, `STOPPED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ChatCreate {
/// ID of the group (`ctg`) or service-planning event (`cte`) associated with the room.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Stable ChurchTools chat identifier, not a Matrix room ID.
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
/// `ctg` identifies a group and `cte` identifies a service-planning event.
/// Allowed values: `cte`, `ctg`.
#[serde(deserialize_with = "crate::lenient::string")]
pub prefix: String,
/// Display name of the room.
#[serde(deserialize_with = "crate::lenient::string")]
pub roomname: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields used to update chat metadata or change its lifecycle status. When `status` is set, the request performs a lifecycle transition.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ChatUpdate {
/// Person ID recorded as the room creator.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub creator: Option<i64>,
/// ID of the group (`ctg`) or service-planning event (`cte`) associated with the room.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<i64>,
/// Synchronization token for central chat service callbacks.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nonce: Option<String>,
/// `ctg` identifies a group and `cte` identifies a service-planning event.
/// Allowed values: `cte`, `ctg`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub prefix: Option<String>,
/// Display name of the room.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub roomname: Option<String>,
/// Requested lifecycle status.
/// Allowed values: `STARTED`, `STOPPED`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub status: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Attendance confirmation for an existing person. The embedded meeting contains refreshed attendance statistics.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Checkin {
pub group: DomainObjectGroup,
/// One dated occurrence of a group meeting, used to record attendance, guest counts and feedback. It is separate from the group itself and its memberships. No independent end time is stored. Cancellation and completion are separate flags; completion locks check-in changes.
#[serde(rename = "groupMeeting")]
pub group_meeting: GroupMeeting,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Number of participants currently checked in at this meeting.
#[serde(rename = "totalCheckedIn", deserialize_with = "crate::lenient::number")]
pub total_checked_in: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Records attendance for one existing person at one group meeting. Supply exactly one non-null date or groupMeetingId; the other may be omitted or null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinCreate {
/// Exact start timestamp of a meeting in this group. An existing meeting at that timestamp is reused; otherwise a meeting is created.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// ID of an existing meeting belonging to the path group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupMeetingId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_meeting_id: Option<Option<i64>>,
/// optional printer ID, if a name tag should be printed out
#[serde(rename = "printerId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub printer_id: Option<i64>,
/// Optional ticket token for this person and group. The ticket is marked used before attendance is recorded; later failures can leave it used.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Membership to create before a separate attendance check-in. The group’s default role and normal active membership status are used; the origin is check-in. No meeting attendance or label printing is performed here.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinMembershipCreate {
/// Group-member custom field values keyed by field ID. Definitions and allowed options belong to the selected group. Omitted fields use membership defaults. POST and PUT currently differ in validation, so clients should submit correctly typed values for the field definition.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub fields: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Target group ID. Supply an integer even though the enclosing validator does not validate this nested key explicitly.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Allows admission even when the group is full; no additional override permission is checked here.
#[serde(rename = "ignoreGroupSize", default, skip_serializing_if = "Option::is_none")]
pub ignore_group_size: Option<bool>,
/// Person fields to update after membership creation, keyed by API field name. Only names configured as person fields for this group are applied; other names are ignored. Send an empty object when no changes are needed.
#[serde(rename = "personFields", deserialize_with = "crate::lenient::map")]
pub person_fields: std::collections::BTreeMap<String, serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy person-model response used only by check-in admission. It differs from the regular, permission-filtered Person API resource: coordinates are strings, emails currently serialize as an object, and security-level properties are absent. Additional implementation properties may be present; clients should consume only the fields needed for admission and use the regular person endpoint for subsequent reads.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinPerson {
#[serde(rename = "departmentIds")]
pub department_ids: Vec<i64>,
/// The internal email collection currently serializes as an object rather than the normal Person email array.
#[serde(deserialize_with = "crate::lenient::map")]
pub emails: std::collections::BTreeMap<String, serde_json::Value>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Stored coordinate as a string; can be empty.
#[serde(deserialize_with = "crate::lenient::string")]
pub latitude: String,
/// Stored coordinate as a string; can be empty.
#[serde(deserialize_with = "crate::lenient::string")]
pub longitude: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a new person, adds a check-in creation note, optionally tags the person and creates a group membership.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinPersonCreate {
/// Membership to create before a separate attendance check-in. The group’s default role and normal active membership status are used; the origin is check-in. No meeting attendance or label printing is performed here.
pub group: CheckinMembershipCreate,
/// Person fields for creation during check-in admission. Uses the normal new-person field validation, including installation-specific masterdata and custom fields. Unlike ordinary creation, this flow forces duplicate creation and ignores visibility. Optional fields depend on configured field security and new-person settings.
pub person: CheckinPersonDataCreate,
/// Optional person-tag ID. Omitted/null behaves as 0 and normally adds no tag. Nonexistent IDs are silently ignored; use a tag belonging to the person domain.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "tagId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tag_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person fields for creation during check-in admission. Uses the normal new-person field validation, including installation-specific masterdata and custom fields. Unlike ordinary creation, this flow forces duplicate creation and ignores visibility. Optional fields depend on configured field security and new-person settings.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinPersonDataCreate {
#[serde(rename = "addressAddition", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_addition: Option<String>,
#[serde(rename = "baptisedBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub baptised_by: Option<String>,
#[serde(rename = "birthName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birth_name: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birthplace: Option<String>,
/// ID of a campus returned by `GET /person/masterdata`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::number")]
pub campus_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(rename = "cmsUserId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cms_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBaptism", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_baptism: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBelonging", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_belonging: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfDeath", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfEntry", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_entry: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfResign", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_resign: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Department IDs returned by `GET /person/masterdata`. At least one department must be set.
#[serde(rename = "departmentIds")]
pub department_ids: Vec<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Save many eMail addresses for person. If `emails` is present in request `email` is ignored.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub emails: Option<Vec<PersonEmail>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub fax: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "firstContact", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_contact: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Required field; surrounding whitespace is removed, blank text becomes null.
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
/// Optional unique person GUID. Generated when omitted.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job: Option<String>,
/// Required nonblank surname, trimmed before use.
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mobile: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
#[serde(rename = "optigemId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub optigem_id: Option<String>,
#[serde(rename = "phonePrivate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_private: Option<String>,
#[serde(rename = "phoneWork", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_work: Option<String>,
#[serde(rename = "placeOfBaptism", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub place_of_baptism: Option<String>,
/// Legacy representation of the privacy agreement. Use the three flat `privacyPolicyAgreement*` fields instead. When this object is used, all three values must be provided if privacy agreement fields are mandatory.
#[serde(rename = "privacyPolicyAgreement", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use the three flat `privacyPolicyAgreement*` fields instead."]
pub privacy_policy_agreement: Option<CheckinPersonDataCreatePrivacyPolicyAgreement>,
/// Date of the privacy policy agreement. Required together with agreement type and person when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementDate", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_date: Option<chrono::NaiveDate>,
/// ID of the configured agreement type describing how the agreement was obtained. This is independent from who gave the agreement. Required together with agreement date and person when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_type_id: Option<i64>,
/// ID of the configured agreement source describing who gave the agreement. This is independent from how the agreement was obtained. Required together with agreement date and type when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementWhoId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_who_id: Option<i64>,
#[serde(rename = "referredBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_by: Option<String>,
#[serde(rename = "referredTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_to: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sexId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<Option<i64>>,
/// ID of a person status returned by `GET /person/masterdata`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "weddingDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub wedding_date: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy representation of the privacy agreement. Use the three flat `privacyPolicyAgreement*` fields instead. When this object is used, all three values must be provided if privacy agreement fields are mandatory.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinPersonDataCreatePrivacyPolicyAgreement {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date: Option<Option<chrono::NaiveDate>>,
/// How the agreement was obtained: 1 group registration, 2 self-confirmation, 3 outside ChurchTools, 4 check-in.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "typeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub type_id: Option<Option<i64>>,
/// Who gave the agreement: 1 the person themself, 2 a parent, 10000 the person responsible for a group signup.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "whoId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub who_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Admits an existing person to a group and updates the group’s configured person fields. This is not a general person update or an attendance check-in.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CheckinPersonUpdate {
/// Membership to create before a separate attendance check-in. The group’s default role and normal active membership status are used; the origin is check-in. No meeting attendance or label printing is performed here.
pub group: CheckinMembershipCreate,
/// Existing person to admit to the group. A current membership causes a conflict instead of being updated.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Optional person-tag ID. Omitted/null behaves as 0 and normally adds no tag. Nonexistent IDs are silently ignored; use a tag belonging to the person domain.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "tagId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tag_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A finance client is the organizational entity whose books are kept separately, for example a congregation or a charitable organization. Each client owns accounting periods, and those periods own its accounts and cost centers. It is unrelated to an OAuth application client.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Client {
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// Stored DATEV identifier as a string or null.
#[serde(rename = "datevClientNumber", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datev_client_number: Option<String>,
/// Stored DATEV identifier as a string or null.
#[serde(rename = "datevConsultantNumber", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datev_consultant_number: Option<String>,
/// Optional valid email address. Use null or omit to clear it; an empty string is not accepted.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Employer name used for electronically supported employer audits (euBP). Omitted or null clears it.
#[serde(rename = "eubpBusinessName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_name: Option<String>,
/// German employer business number for euBP: eight digits with a valid checksum. The first three digits must not be 000 or 100–110. Omitted or null clears it; empty string is rejected.
#[serde(rename = "eubpBusinessNumber", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_number: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Trimmed client name, unique across finance clients.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
#[serde(rename = "postalCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub postal_code: Option<String>,
/// Ascending display order. Required for creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
/// Treasurer person as a domain object, or null when none is assigned.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub treasurer: Option<DomainObjectPerson>,
/// Optional person ID of the treasurer. Omitted or null clears the assignment.
#[serde(rename = "treasurerId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub treasurer_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A finance client is the organizational entity whose books are kept separately, for example a congregation or a charitable organization. Each client owns accounting periods, and those periods own its accounts and cost centers. It is unrelated to an OAuth application client.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ClientCreate {
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// Optional numeric DATEV client identifier. Numeric strings or numbers are accepted and stored as strings. Empty string is also accepted; omission or null clears it.
#[serde(rename = "datevClientNumber", default, skip_serializing_if = "serde_json::Value::is_null")]
pub datev_client_number: serde_json::Value,
/// Optional numeric DATEV consultant identifier. Numeric strings or numbers are accepted and stored as strings. Empty string is also accepted; omission or null clears it.
#[serde(rename = "datevConsultantNumber", default, skip_serializing_if = "serde_json::Value::is_null")]
pub datev_consultant_number: serde_json::Value,
/// Optional valid email address. Use null or omit to clear it; an empty string is not accepted.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub email: Option<Option<String>>,
/// Employer name used for electronically supported employer audits (euBP). Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eubpBusinessName", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_name: Option<Option<String>>,
/// German employer business number for euBP: eight digits with a valid checksum. The first three digits must not be 000 or 100–110. Omitted or null clears it; empty string is rejected.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eubpBusinessNumber", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_number: Option<Option<String>>,
/// Trimmed client name, unique across finance clients.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<Option<String>>,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "postalCode", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub postal_code: Option<Option<String>>,
/// Ascending display order. Required for creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// Optional person ID of the treasurer. Omitted or null clears the assignment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "treasurerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub treasurer_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement finance-client data. name and sortKey are required; omitted optional fields are cleared, including contact, DATEV and euBP fields.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ClientUpdate {
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// Optional numeric DATEV client identifier. Numeric strings or numbers are accepted and stored as strings. Empty string is also accepted; omission or null clears it.
#[serde(rename = "datevClientNumber", default, skip_serializing_if = "serde_json::Value::is_null")]
pub datev_client_number: serde_json::Value,
/// Optional numeric DATEV consultant identifier. Numeric strings or numbers are accepted and stored as strings. Empty string is also accepted; omission or null clears it.
#[serde(rename = "datevConsultantNumber", default, skip_serializing_if = "serde_json::Value::is_null")]
pub datev_consultant_number: serde_json::Value,
/// Optional valid email address. Use null or omit to clear it; an empty string is not accepted.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub email: Option<Option<String>>,
/// Employer name used for electronically supported employer audits (euBP). Omitted or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eubpBusinessName", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_name: Option<Option<String>>,
/// German employer business number for euBP: eight digits with a valid checksum. The first three digits must not be 000 or 100–110. Omitted or null clears it; empty string is rejected.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "eubpBusinessNumber", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub eubp_business_number: Option<Option<String>>,
/// Trimmed client name, unique across finance clients.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<Option<String>>,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "postalCode", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub postal_code: Option<Option<String>>,
/// Ascending display order. Required for creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Optional contact information. Omitted or null clears it, including on update. These values are not trimmed by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// Optional person ID of the treasurer. Omitted or null clears the assignment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "treasurerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub treasurer_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Value for Tailwind color
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Color {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `100`, `200`, `300`, `400`, `50`, `500`, `600`, `700`, `800`, `900`.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub shade: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CombinedDonationReceipts {
/// Separate attachment PDF in twofiles mode. Omitted in onefile mode when receipts exist; null when no matching receipts exist.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub attachments: Option<String>,
/// Combined cover-letter PDF, or the complete combined PDF in onefile mode. Null if no matching receipts exist.
#[serde(rename = "coverLetters", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cover_letters: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Visibility category for person comments and person-linked notes. This is a master-data label referenced by commentViewerId, not a ChurchTools group or a list of people. Access is assigned through the view comments permission for this ID.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CommentViewer {
/// Category ID used as commentViewerId and as a selection of churchdb view comments.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Stored category name or translation key.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Name translated for the current language, falling back to the stored name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Display sort key. Lists are sorted by sortKey, then stored name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create a visibility category for person comments/notes. Creating the category does not grant anyone permission to read its content.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CommentViewerCreate {
/// Trimmed display name or translation key, 1–50 characters. No uniqueness constraint is applied.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Nonnegative display sort key; defaults to 0.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates a visibility category. The category ID comes from the URL. name is required; sortKey is optional and preserves its value when omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CommentViewerUpdate {
/// Trimmed display name or translation key, 1–50 characters. No uniqueness constraint is applied.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional nonnegative sort key. Omission preserves the existing value. Explicit null passes the validator but fails the integer setter; use omission to retain the value.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Config {
#[serde(rename = "_current_config_file", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub current_config_file: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub accept_datasecurity: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub access_control_allow_credentials: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub access_control_allow_origins: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<String>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_message: Option<String>,
#[serde(rename = "aiAssistantAvailable", default, skip_serializing_if = "Option::is_none")]
pub ai_assistant_available: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_available_generation_count: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_available_generation_tests: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_count: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_total_generation_count: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub allowaiassistant: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowcheckin: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedcals: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedclients: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedcwbusers: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedresources: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedservices: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedstations: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedsyncconnections: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedsyncjobs: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedtextgenerations: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub alloweduser: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowfinance: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowldap: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowoptigemsync: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowsync: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub app_security_request: Option<bool>,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub auth_cache_time: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub authorized_persons: Option<String>,
/// Allowed values: `ChurchTools`, `VereinTools`.
#[serde(deserialize_with = "crate::lenient::string")]
pub brand: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub build: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_access_token: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ccli_auto_reporting_enabled: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ccli_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_last_token_refresh: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_refresh_token: Option<String>,
#[serde(rename = "chatServer", deserialize_with = "crate::lenient::string")]
pub chat_server: String,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub chrome_active: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub chrome_binary: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcal_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_css: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_firstdayinweek: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_maincalname: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_group_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_person_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_delete_event_chat_after_x_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_group_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_before_x_days: Option<i64>,
/// A stringified array of calendar ids
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_for_calendars: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_sync_user_id: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_child: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_parent: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_standard: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_tags: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_active: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_archivedeletehistory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_access_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_client_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_client_secret: Option<String>,
/// Allowed values: `false`, `true`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_connected: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_refresh_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_scopes: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_token_expiry: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_emailseparator: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lat: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lng: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_apikey: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apisecret: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_sendgroupmails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_smscmtelecom_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_smspromote_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchdb_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchfinance_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchreport_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchreport_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchreport_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchreport_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_anonymize_for_public_user: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchresource_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchresource_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_send_emails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_agendashowenumeration: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_entries_last_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_invite_persons: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_openservice_rememberdays: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_reminderhours: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_songwithcategoryasdir: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchsync_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchsync_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchsync_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchwiki_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_sortcode: Option<i64>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub cron_daily: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub cron_hour_8: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cron_last_execution: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cronjob_dbdump: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cronjob_delay: Option<i64>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub currently_mail_sending: Option<String>,
#[serde(rename = "datasecurityPrivacyDeclarationWikiLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_declaration_wiki_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub datasecurity_banner_enabled: Option<bool>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_hint: Option<String>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text: Option<String>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text_for_children: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_user: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub deactivate_default_login: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_phone_area_code: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub deprecation_usage_mail_last_execution: Option<String>,
/// Allowed values: `churchtools`, `own`.
#[serde(rename = "emailServer", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub encryptionkey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub env: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_api_key: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_vid: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_appointment_search: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_automation: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_custommodule: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_darkmode: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_dynamic_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_eubp: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_event_fact_widget: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_finance_donators_datatable: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_flags_ui: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_group: Option<String>,
/// Deprecated compatibility flag that is always true.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub feature_markdown_group: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_mobile_groups: Option<String>,
/// Deprecated compatibility flag that is always true.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub feature_newsfeed_comment_reactions: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_old_group_module: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_org_chart_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_permission_new: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_person_probe_filter: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_posts: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_resources_app: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_sessionless_login: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_sync: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_usechurchquery: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_meta_cron_last_file_size_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_meta_cron_last_image_metadata_id: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finance_active: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_inmenu: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_sortcode: Option<String>,
#[serde(rename = "finderUrl", deserialize_with = "crate::lenient::string")]
pub finder_url: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_sync_job: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_transaction: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "hideBetaStates", default, skip_serializing_if = "Option::is_none")]
pub hide_beta_states: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hide_all_hints: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hostingservice: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub https_only: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ical_invitation_hmac_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_extension: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external_link: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_internal: Option<String>,
#[serde(rename = "imprintWikiLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub imprint_wiki_link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub installation_verification_code: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub invite_email_text: Option<String>,
/// Whether the current user is configured as an authorized person.
#[serde(rename = "isCurrentUserAuthorizedPerson")]
pub is_current_user_authorized_person: bool,
#[serde(rename = "isPostsActive")]
pub is_posts_active: bool,
#[serde(rename = "isSamlActive", default, skip_serializing_if = "Option::is_none")]
pub is_saml_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_blog_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_onboarding_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_pr_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_rss_widget_active: Option<bool>,
/// The language code is a two-letter code that represents the language. For example, "en" for English, "de" for German, and "fr" for French.
/// Allowed values: `cn`, `de`, `en`, `es`, `fa`, `fi`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `sv`, `tw`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub language: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_cron: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_cron_finished: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_db_dump: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_import_clear: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_translation_update: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ldap_otp_enabled: Option<bool>,
#[serde(rename = "licenseSettings", default, skip_serializing_if = "Option::is_none")]
pub license_settings: Option<GetConfigResponseLicenseSettings>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub log_debug: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub login_message: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mail_enabled: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_sending_in_background: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_sending_starttime: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_host: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_port: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_smtpsecure: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_username: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub matomo_uri: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_uploadfile_size_kb: Option<i64>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_birthday_full: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_email: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_fax: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_group_couples: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_picture: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_salutation: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefongeschaeftlich: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefonhandy: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefonprivat: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub onboarding_start: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub openai_api_key: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub openstreetmaps_enabled: Option<bool>,
/// Allowed values: `Auftrag`, `Bedenkzeit`, `Entscheidung`, `Finder`, `FinderCombo`, `Mitarbeiter`, `Testphase`, `Unbekannt`, `Vorlage/Schulung/Test`, `WebsiteCombo`, `zu löschen`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orderstatus: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub orderstatus_since_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub package: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_edit_time_limited: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_enabled: Option<bool>,
/// Allowed values: `all`, `featured_groups`, `my_groups`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_filter: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_weekdays: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_featured_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub post_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_wizard_completed: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_wizard_groups: Option<String>,
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub prevent_change_security_settings: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub prevent_export: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub prevent_manual_finance_account_creation: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory_api: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_internal: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_relationships: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub profile: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub public_channel_registry: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub public_channel_registry_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_host: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_port: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_user: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redis_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rss_widget_link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_authorized_persons: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_chat_sync: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_consolidation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_guid_sync: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_job_queueing: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_newsletter: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_notification: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub send_data_security_mails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub session_handler: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
#[serde(rename = "showAIAssistant", default, skip_serializing_if = "Option::is_none")]
pub show_ai_assistant: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub show_remember_me: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_language: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_licensekey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_logo: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub site_offline: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_region: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_startpage: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_url: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "support-user-active-since", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub support_user_active_since: Option<chrono::DateTime<chrono::Utc>>,
/// Whether this installation is configured as a test system.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub test: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub timezone: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url_metadata_url: Option<String>,
/// Allowed values: `failed`, `in_progress`, `not_verified`, `verified`.
#[serde(rename = "verificationStatus", deserialize_with = "crate::lenient::string")]
pub verification_status: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
#[serde(rename = "webchatLink", deserialize_with = "crate::lenient::string")]
pub webchat_link: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_order_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_sync_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_testphase_date: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub website_trial_user_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome_subtext: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub wget_path: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Shared label for person email addresses. Renaming a label changes its display wherever that label is used.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ContactLabel {
/// Whether this label is preferred for new email addresses. Setting `true` unsets an existing default label.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Unique contact-label name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display-order value.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Contact-label ID referenced by a person’s email address.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Translated Name of Label
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Label used to distinguish a person’s email addresses, for example private and work. Names must be unique.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ContactLabelCreate {
/// Whether this label is preferred for new email addresses. Setting `true` unsets an existing default label.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Unique contact-label name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display-order value.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for an existing contact label.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ContactLabelUpdate {
/// Whether this label is preferred for new email addresses. Setting `true` unsets an existing default label.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Unique contact-label name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display-order value.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A cost center assigns income and expenses to a purpose, project or group within one accounting period. Budgets and balances use integer minor currency units (for example cents). Linking a group also enables access through group-internal finance permissions. Includes the linked group, or null when there is none.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenter {
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Budget is in cent.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<i64>,
/// Budget plus cash-account income minus cash-account expenses, in minor currency units. Null without a budget or before calculation.
#[serde(rename = "budgetBalance", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_balance: Option<i64>,
/// Remaining budget of the matching cost center in the previous period, in minor currency units. Null when unavailable or not calculated; an unmatched center can have 0.
#[serde(rename = "budgetBalanceLastPeriod", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_balance_last_period: Option<i64>,
/// Budget of the cost center with the same number in the previous period of this client, in minor currency units. Null when unavailable or not calculated.
#[serde(rename = "budgetLastPeriod", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_last_period: Option<i64>,
/// Cash-account expenses minus cash-account income, in minor currency units. Can be negative. Null if not calculated, for example immediately after creation.
#[serde(rename = "budgetSpent", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_spent: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Linked group as a domain object, or null. The response does not include a separate groupId.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<DomainObjectGroup>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Cost centers to create. Each item may select its own accounting period and group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenterBulkCreate {
#[serde(rename = "costCenters")]
pub cost_centers: Vec<CostCenterCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A cost center assigns income and expenses to a purpose, project or group within one accounting period. Budgets and balances use integer minor currency units (for example cents). Linking a group also enables access through group-internal finance permissions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenterCreate {
/// Existing, open accounting period owning this cost center.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Optional trimmed note. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<Option<String>>,
/// Optional budget in minor currency units, for example 3200 for EUR 32.00. Omitted or null removes the budget.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<Option<i64>>,
/// Optional linked group. Omitted or null removes the link, including on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<Option<i64>>,
/// Trimmed name, unique within the accounting period. Supply a nonblank name when creating.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Trimmed identifier, unique within the accounting period. Leading zeros are preserved; letters are accepted, although list ordering compares the integer value.
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Optional account-report options. A missing body selects the entire accounting period as a PDF.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenterStatementReportCreate {
/// Last document date to include. Omission or null defaults to the corresponding accounting-period boundary. The final endDate must be on or after startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "endDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<Option<chrono::NaiveDate>>,
/// PDF creates a file and returns its URL with HTTP 201. CSV/XLSX return the file directly with HTTP 200. Accept: text/html overrides this selection.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub format: Option<String>,
/// First document date to include. Omission or null defaults to the corresponding accounting-period boundary. The final endDate must be on or after startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "startDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<Option<chrono::NaiveDate>>,
/// Include transactions classified as internal rebookings in the cost-center report.
#[serde(rename = "includeRebookings", default, skip_serializing_if = "Option::is_none")]
pub include_rebookings: Option<bool>,
/// Legacy alias for format.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub r#type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A cost center assigns income and expenses to a purpose, project or group within one accounting period. Budgets and balances use integer minor currency units (for example cents). Linking a group also enables access through group-internal finance permissions. Serialized entity without the expanded group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenterStored {
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Budget is in cent.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<i64>,
/// Budget plus cash-account income minus cash-account expenses, in minor currency units. Null without a budget or before calculation.
#[serde(rename = "budgetBalance", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_balance: Option<i64>,
/// Remaining budget of the matching cost center in the previous period, in minor currency units. Null when unavailable or not calculated; an unmatched center can have 0.
#[serde(rename = "budgetBalanceLastPeriod", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_balance_last_period: Option<i64>,
/// Budget of the cost center with the same number in the previous period of this client, in minor currency units. Null when unavailable or not calculated.
#[serde(rename = "budgetLastPeriod", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_last_period: Option<i64>,
/// Cash-account expenses minus cash-account income, in minor currency units. Can be negative. Null if not calculated, for example immediately after creation.
#[serde(rename = "budgetSpent", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget_spent: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for a cost center. number and accountingPeriodId are required; omitted name, annotation, budget and groupId are cleared. The target accounting period must be open. Both name and number must remain unique in that period.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CostCenterUpdate {
/// Existing, open accounting period owning this cost center.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Optional trimmed note. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<Option<String>>,
/// Optional budget in minor currency units, for example 3200 for EUR 32.00. Omitted or null removes the budget.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<Option<i64>>,
/// Optional linked group. Omitted or null removes the link, including on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<Option<i64>>,
/// Trimmed name. Unlike creation, updating accepts omitted, null or blank names and stores null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Trimmed identifier, unique within the accounting period. Leading zeros are preserved; letters are accepted, although list ordering compares the integer value.
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Metadata for a stored file or URL attachment. `domainType` and `domainId` identify the owning attachment context.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CtFile {
/// Domain-specific extra data. Empty for most files (serialized as an empty array), but some domains add a key-value object (e.g. statement uploads return `{ "statementId": 1 }`).
#[serde(rename = "additionalInfos", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub additional_infos: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Whether the image was generated by artificial intelligence.
#[serde(rename = "aiGenerated")]
pub ai_generated: bool,
/// Image credit or attribution.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Attribution link.
#[serde(rename = "annotationLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation_link: Option<String>,
/// File or image description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Attachment-context identifier; its meaning depends on `domainType`.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
/// Stored attachment category. Internal categories may not be accepted by the domain-based file routes.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Absolute download URL or external link URL.
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::string")]
pub file_url: String,
/// Storage filename/hash for a binary file, or the target URL for a link. name is the user-facing display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
/// Image dimensions calculated from the file.
#[serde(rename = "imageMetadata", default, skip_serializing_if = "Option::is_none")]
pub image_metadata: Option<CtFileImageMetadata>,
#[serde(rename = "imageOption", default, skip_serializing_if = "Option::is_none")]
pub image_option: Option<CtFileImageOption>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub meta: FileMetaData,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Legacy relative download URL, or an absolute external URL for a link.
#[serde(rename = "relativeUrl", deserialize_with = "crate::lenient::string")]
pub relative_url: String,
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// Whether domain lists show the file only to users who may edit its owning object.
#[serde(rename = "showOnlyWhenEditable")]
pub show_only_when_editable: bool,
/// The file size in byte
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
/// file for a stored file, link for a filename beginning with http.
/// Allowed values: `file`, `link`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Persisted file record ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Image dimensions calculated from the file.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CtFileImageMetadata {
#[serde(rename = "aspectRatio", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub aspect_ratio: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub height: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub width: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CtFileImageOption {
pub crop: CtFileImageOptionCrop,
pub focus: CtFileImageOptionFocus,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CtFileImageOptionCrop {
#[serde(deserialize_with = "crate::lenient::number")]
pub bottom: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub left: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub right: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub top: f64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CtFileImageOptionFocus {
#[serde(deserialize_with = "crate::lenient::number")]
pub x: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub y: f64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Database-field definition. key is the API property name used when reading or writing a person/group value; column is its underlying database column. fieldCategory and fieldType describe ownership and value behavior. Installation-created fields have createdByChurch=true; built-in fields expose fewer editable settings.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbField {
/// Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
#[serde(rename = "deleteOnArchive")]
pub delete_on_archive: bool,
/// Whether the field is enabled for normal use.
#[serde(rename = "isActive")]
pub is_active: bool,
/// Whether routines may use this field.
#[serde(rename = "isAvailableInRoutines")]
pub is_available_in_routines: bool,
/// Whether the field is available on new-person forms; primarily relevant to person categories.
#[serde(rename = "isNewPersonField")]
pub is_new_person_field: bool,
/// Configured field length.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// Legacy display-layout setting, retained for compatibility.
#[serde(rename = "lineEnding", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub line_ending: Option<String>,
/// Stored display name or translation key. nameTranslated is its localized display text.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Security-level ID governing access to this field, resolved from installation masterdata.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Abbreviated label.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Display-order value within its category.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the field may be used as a placeholder.
#[serde(rename = "useAsPlaceholder")]
pub use_as_placeholder: bool,
/// Compatibility mappings emitted by the backend.
#[serde(rename = "@deprecated")]
pub deprecated: DbFieldDeprecated,
/// Underlying database column; prefer key for API requests.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub column: Option<String>,
/// True for a custom field created by this ChurchTools installation.
#[serde(rename = "createdByChurch")]
pub created_by_church: bool,
/// Stored field category and its underlying entity table. Use internCode when creating a field.
#[serde(rename = "fieldCategory")]
pub field_category: DbFieldCategory,
/// Database-field type definition. internCode selects the input/validation behavior; the numeric ID is referenced by field definitions. The name can be a translation key.
#[serde(rename = "fieldType")]
pub field_type: DbFieldType,
/// Stored flag controlling frontend visibility; current updates reset it to false.
#[serde(rename = "hideInFrontend")]
pub hide_in_frontend: bool,
/// Field-definition ID used in /dbfields paths.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the field is marked as basic information; current updates reset it to false.
#[serde(rename = "isBasicInfo")]
pub is_basic_info: bool,
/// Whether the field is marked as non-configurable; current updates reset it to false.
#[serde(rename = "isNotConfigurable")]
pub is_not_configurable: bool,
/// Whether stored field values may be null. Custom checkbox fields are non-nullable.
#[serde(rename = "isNullable")]
pub is_nullable: bool,
/// API property name. Built-in columns are mapped to API names; custom fields normally retain their generated column name.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Localized display name for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Deprecated alias of isNotConfigurable.
#[serde(rename = "notConfigurable", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub not_configurable: Option<bool>,
/// Deprecated alias of isNullable.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub nullable: Option<bool>,
/// Optional choices, included by an unfiltered list with include\[\]=options. The row shape depends on the field. Campus and group-visibility fields use specialized representations in this expansion.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<DbFieldOption>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored field category and its underlying entity table. Use internCode when creating a field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldCategory {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Field category: f_address (person address/contact), f_church (person church information), f_category (person categories), f_group (group data), f_dep (departments), f_growpath (person growth-path data), or f_datasecurity (person privacy information). These are category codes, not entity IDs.
/// Allowed values: `f_address`, `f_category`, `f_church`, `f_datasecurity`, `f_dep`, `f_group`, `f_growpath`.
#[serde(rename = "internCode", deserialize_with = "crate::lenient::string")]
pub intern_code: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub table: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a custom database column and field definition, plus an option table for selection types. Checkbox fields require `deleteOnArchive=false`. Column names are generated from the label and may receive a numeric suffix.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldCreate {
/// Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
#[serde(rename = "deleteOnArchive")]
pub delete_on_archive: bool,
/// Whether the field is enabled for normal use.
#[serde(rename = "isActive")]
pub is_active: bool,
/// Whether routines may use this field.
#[serde(rename = "isAvailableInRoutines", default, skip_serializing_if = "Option::is_none")]
pub is_available_in_routines: Option<bool>,
/// Whether the field is available on new-person forms; primarily relevant to person categories.
#[serde(rename = "isNewPersonField")]
pub is_new_person_field: bool,
/// Configured maximum length for text and textarea fields.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// Legacy display-layout setting retained for compatibility.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "lineEnding", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub line_ending: Option<Option<String>>,
/// Stored display name or translation key. nameTranslated is its localized display text.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Security-level ID governing access to this field, resolved from installation masterdata.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Abbreviated display label.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// Display-order value within its category.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the field may be used as a placeholder.
#[serde(rename = "useAsPlaceholder")]
pub use_as_placeholder: bool,
/// Field category: f_address (person address/contact), f_church (person church information), f_category (person categories), f_group (group data), f_dep (departments), f_growpath (person growth-path data), or f_datasecurity (person privacy information). These are category codes, not entity IDs.
/// Allowed values: `f_address`, `f_category`, `f_church`, `f_datasecurity`, `f_dep`, `f_group`, `f_growpath`.
#[serde(rename = "fieldCategoryInternCode", deserialize_with = "crate::lenient::string")]
pub field_category_intern_code: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility mappings emitted by the backend.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldDeprecated {
/// Allowed values: `isNotConfigurable`.
#[serde(rename = "notConfigurable", deserialize_with = "crate::lenient::string")]
pub not_configurable: String,
/// Allowed values: `isNullable`.
#[serde(deserialize_with = "crate::lenient::string")]
pub nullable: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Option row. Keys and value types depend on the selected masterdata table. Integer SQL columns are returned as JSON integers (including null values coerced to 0); other columns retain their database-returned value. name and sortKey are common aliases, not universal fields.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldOption {
/// Option identifier; group-visibility expansions use string IDs.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub id: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One writable option-table column. Names are API keys; `bezeichnung`, `sortkey`, `kuerzel` and `securitylevel_id` are mapped to `name`, `sortKey`, `shorty` and `securityLevel`. Audit columns are omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldOptionColumn {
/// Generated by the database; omit this column from create/update payloads.
#[serde(rename = "isAutoIncrement")]
pub is_auto_increment: bool,
/// Whether the underlying database column permits SQL NULL.
#[serde(rename = "isNullable")]
pub is_nullable: bool,
/// Parsed SQL width. For `int(11)`, 11 is a display width rather than a numerical bound.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// API property name to use in option payloads.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Localized label for the API property name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// SQL type reported by table introspection, such as int, varchar or tinyint. This is not FieldTypeCode and has no fixed API enum.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Option row for the selected field’s underlying masterdata table. Read `/dbfields/{fieldId}/options/metadata` first: provide every column whose `isAutoIncrement` is `false`, using its API name. There is no universal set of writable keys across all fields. For custom selection tables, `name` and `sortKey` are both required.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldOptionCreate {
/// Common option label. Custom selection-table labels contain 1–30 characters.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Display order, required for custom selection tables and any metadata exposing a non-auto-increment `sortKey` column.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Full option-row update based on the selected field’s metadata. All non-auto-increment columns are required, even if only one value changes. The option ID comes from the path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldOptionUpdate {
/// Common option label. Custom selection-table labels contain 1–30 characters.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Display order, required for custom selection tables and any metadata exposing a non-auto-increment `sortKey` column.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Database-field type definition. internCode selects the input/validation behavior; the numeric ID is referenced by field definitions. The name can be a translation key.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldType {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Input/storage type. select and radioselect use one option, multiselect uses multiple options. text and textarea require a configured length when created. api identifies an application-specific field type.
/// Allowed values: `api`, `checkbox`, `date`, `datetime`, `multiselect`, `number`, `radioselect`, `select`, `text`, `textarea`.
#[serde(rename = "internCode", deserialize_with = "crate::lenient::string")]
pub intern_code: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display-order value.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates an existing field. Only installation-created fields can change their name, active state, line ending and configured length. Type, nullability and column/key cannot be changed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DbFieldUpdate {
/// Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
#[serde(rename = "deleteOnArchive")]
pub delete_on_archive: bool,
/// Whether the field is enabled for normal use.
#[serde(rename = "isActive", default, skip_serializing_if = "Option::is_none")]
pub is_active: Option<bool>,
/// Whether routines may use this field.
#[serde(rename = "isAvailableInRoutines", default, skip_serializing_if = "Option::is_none")]
pub is_available_in_routines: Option<bool>,
/// Whether the field is available on new-person forms; primarily relevant to person categories.
#[serde(rename = "isNewPersonField")]
pub is_new_person_field: bool,
/// Configured maximum length for text and textarea fields.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// Legacy display-layout setting retained for compatibility.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "lineEnding", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub line_ending: Option<Option<String>>,
/// Stored display name or translation key. nameTranslated is its localized display text.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Security-level ID governing access to this field, resolved from installation masterdata.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Abbreviated display label.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// Display-order value within its category.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the field may be used as a placeholder.
#[serde(rename = "useAsPlaceholder")]
pub use_as_placeholder: bool,
/// Installation-created person fields can move between `f_address`, `f_church`, `f_category` and `f_datasecurity`. Built-in fields and fields in other categories can only keep their existing category.
/// Allowed values: `f_address`, `f_category`, `f_church`, `f_datasecurity`, `f_dep`, `f_group`, `f_growpath`.
#[serde(rename = "fieldCategoryInternCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub field_category_intern_code: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DeleteGroupsGroupIdMeetingsMeetingIdMembersMemberIdBody {
/// Attendance state after revoking the check-in.
/// Allowed values: `absent`, `unsure`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub status: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DeleteSimulateData {
#[serde(deserialize_with = "crate::lenient::string")]
pub redirect: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Denomination of a church
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Denomination {
/// Technical enum case name used by ChurchTools.
/// Allowed values: `CATHOLIC`, `ECUMENICAL`, `FREE_EVANGELICAL`, `NONE`, `ORTHODOX`, `PROTESTANT`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Translation key of the denomination.
/// Allowed values: `denomination.catholic`, `denomination.ecumenical`, `denomination.free.evangelical`, `denomination.none`, `denomination.orthodox`, `denomination.protestant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Localized denomination name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person-related department used to organize the directory and its access rules. It is distinct from campuses, groups and service groups.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Department {
#[serde(rename = "@deprecated")]
pub deprecated: DepartmentDeprecated,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Use `shorty` instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `shorty` instead"]
pub short: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DepartmentDeprecated {
/// Allowed values: `shorty`.
#[serde(deserialize_with = "crate::lenient::string")]
pub short: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility metadata describing legacy date fields.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Deprecated {
#[serde(rename = "dateFrom", deserialize_with = "crate::lenient::string")]
pub date_from: String,
#[serde(rename = "dateTo", deserialize_with = "crate::lenient::string")]
pub date_to: String,
#[serde(rename = "endDate", deserialize_with = "crate::lenient::string")]
pub end_date: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One app-device registration belonging to a person. deviceId identifies the registration; pushId is the delivery token. Reading devices does not extend their lifetime.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Device {
/// Compatibility mapping for legacy fields; id actually contains pushId.
#[serde(rename = "@deprecated")]
pub deprecated: DeviceDeprecated,
/// Used App Version
#[serde(rename = "appVersion", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub app_version: Option<String>,
/// Use `meta.createdDate` instead
#[serde(rename = "createdAt", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `meta."]
pub created_at: Option<chrono::DateTime<chrono::Utc>>,
/// Client-generated registration identifier, scoped to the person. Not necessarily a UUID and not the legacy id field.
#[serde(rename = "deviceId", deserialize_with = "crate::lenient::string")]
pub device_id: String,
/// Registration expiry, refreshed by PUT to three months from now, or one day during simulation. Reads and push selection do not themselves enforce this timestamp.
#[serde(rename = "expirationDate", serialize_with = "crate::datetime::serialize_utc")]
pub expiration_date: chrono::DateTime<chrono::Utc>,
/// Legacy value equal to pushId, despite the compatibility marker naming deviceId as its replacement.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub id: Option<String>,
pub meta: MetaDataEntityId,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Push-provider token, or null. Do not use it as the registration identifier.
#[serde(rename = "pushId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub push_id: Option<String>,
/// Use `expirationDate` instead
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `expirationDate` instead"]
pub ttl: Option<chrono::DateTime<chrono::Utc>>,
/// Push platform: APN for Apple Push Notification service; FCM for Firebase Cloud Messaging.
/// Allowed values: `APN`, `FCM`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Use `meta.modifiedDate` instead
#[serde(rename = "updatedAt", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `meta."]
pub updated_at: Option<chrono::DateTime<chrono::Utc>>,
/// Legacy alias of appVersion.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub version: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility mapping for legacy fields; id actually contains pushId.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DeviceDeprecated {
#[serde(rename = "createdAt", deserialize_with = "crate::lenient::string")]
pub created_at: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub ttl: String,
#[serde(rename = "updatedAt", deserialize_with = "crate::lenient::string")]
pub updated_at: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub version: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates or refreshes a device registration. personId and deviceId come from the URL. Omitted values do not uniformly preserve the previous registration.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DeviceUpdate {
/// App version accepted by the version validator, such as 1.2.3. Omission or null clears the stored version.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "appVersion", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub app_version: Option<Option<String>>,
/// Trimmed push token. Omission replaces the token with deviceId; null clears it; an empty or whitespace-only string preserves the previous token (null on a new device).
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "pushId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub push_id: Option<Option<String>>,
/// Push platform: APN for Apple Push Notification service; FCM for Firebase Cloud Messaging.
/// Allowed values: `APN`, `FCM`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Legacy alias of appVersion; use appVersion. The canonical field takes precedence if both are present.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub version: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Action as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectAction {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectActionDomainAttributes,
/// Allowed values: `action`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub frontend_url: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectActionDomainAttributes {
#[serde(rename = "createDomainType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub create_domain_type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Appointment as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectAppointment {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `appointment`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `calendar`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One dated occurrence of an appointment series, identified by appointment ID and occurrence date.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectAppointmentOccurrence {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectAppointmentOccurrenceDomainAttributes,
/// Allowed values: `appointment_occurrence`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `calendar-day`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectAppointmentOccurrenceDomainAttributes {
/// Occurrence date used in the compound identifier.
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calendar as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectCalendar {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectCalendarDomainAttributes,
/// Allowed values: `calendar`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `calendar`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectCalendarDomainAttributes {
#[serde(rename = "campusName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub campus_name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Event as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectEvent {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectEventDomainAttributes,
/// Allowed values: `event`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `calendar-day`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectEventDomainAttributes {
/// Start of this service-planning event.
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// External person as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectExternalPerson {
#[serde(rename = "apiUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub api_url: serde_json::Value,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectExternalPersonDomainAttributes,
#[serde(rename = "domainIdentifier", default, skip_serializing_if = "serde_json::Value::is_null")]
pub domain_identifier: serde_json::Value,
/// Allowed values: `externalPerson`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub frontend_url: serde_json::Value,
/// Allowed values: `user`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
#[serde(rename = "imageUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub image_url: serde_json::Value,
pub infos: Vec<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectExternalPersonDomainAttributes {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectFile {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `file`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `file`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectFurtherLink {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `further_link`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub frontend_url: serde_json::Value,
/// Allowed values: `link`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGroup {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectGroupDomainAttributes,
/// Allowed values: `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `users`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGroupDomainAttributes {
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<f64>,
#[serde(rename = "groupStatusId", deserialize_with = "crate::lenient::number")]
pub group_status_id: f64,
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: f64,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A person’s membership in a group. Its `domainIdentifier` is the membership row ID; `domainAttributes` contains the group, person, and role IDs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGroupMembership {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectGroupMembershipDomainAttributes,
/// Allowed values: `group_membership`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `user`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGroupMembershipDomainAttributes {
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfDeath", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<chrono::NaiveDate>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Globally Unique Identifier
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(rename = "isArchived")]
pub is_archived: bool,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
#[serde(rename = "roleId", deserialize_with = "crate::lenient::number")]
pub role_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Public directory entry for an enabled group homepage. domainIdentifier is the numeric homepage record ID as a string, while apiUrl/frontendUrl contain its random URL hash. childGroupIds are hierarchy descendants, not necessarily the groups actually displayed by the page.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGrouphomepage {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectGrouphomepageDomainAttributes,
/// Allowed values: `grouphomepage`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub frontend_url: Option<String>,
/// Allowed values: `globe`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectGrouphomepageDomainAttributes {
/// All reachable active, non-hidden descendants, across every hierarchy depth. This may include internal groups, repeated IDs along multiple hierarchy paths, and groups omitted by the public-page feature filter.
#[serde(rename = "childGroupIds")]
pub child_group_ids: Vec<i64>,
/// ID of the group that owns this homepage; that group itself is not part of the descendant list.
#[serde(rename = "parentGroupId", deserialize_with = "crate::lenient::number")]
pub parent_group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectLogo {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `logo`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub frontend_url: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// OSM Address as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectOsmAddress {
#[serde(rename = "apiUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub api_url: serde_json::Value,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `osm-address`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", default, skip_serializing_if = "serde_json::Value::is_null")]
pub frontend_url: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Pairs domain types and identifiers by array index. The arrays must have equal lengths. Empty arrays are allowed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectPayload {
/// For `person`, `group`, `song`, `event`, `group_membership`, and `appointment`, use a numeric database ID encoded as a string. `group_membership` uses the membership row ID, and `wiki_page` uses the page GUID. For `appointment_occurrence`, use `-`, for example `23-2026-09-14`.
pub domain_identifiers: Vec<String>,
/// Object types corresponding to the identifiers at the same indexes.
/// Allowed values: `appointment`, `appointment_occurrence`, `event`, `group`, `group_membership`, `person`, `song`, `wiki_page`.
pub domain_types: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person as Domain Object
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectPerson {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectPersonDomainAttributes,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// user for an ordinary person; user-shield for a censored person placeholder.
/// Allowed values: `user`, `user-shield`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectPersonDomainAttributes {
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfDeath", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<chrono::NaiveDate>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
/// Globally Unique Identifier
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(rename = "isArchived")]
pub is_archived: bool,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectPost {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `post`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `newspaper`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact display reference returned for responseFormat=domainObject. domainIdentifier is the role ID as a string, title is the stored role name, and infos contains the translated group-type name. apiUrl, imageUrl, color and initials are null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectRole {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Empty object; roles do not expose additional domain attributes.
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `role`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Absolute link to this role in the group-type settings.
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Icon identifying a leader or participant role.
/// Allowed values: `id-badge`, `user`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectSong {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes", deserialize_with = "crate::lenient::map")]
pub domain_attributes: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `song`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `music`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectWikiPage {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectWikiPageDomainAttributes,
/// Allowed values: `wiki_page`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `file`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DomainObjectWikiPageDomainAttributes {
#[serde(rename = "wikiCategoryId", deserialize_with = "crate::lenient::number")]
pub wiki_category_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Download URLs for an individual donation receipt: cover letter and attachment. This representation has no receipt ID, sum or metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonationReceipt {
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Download URL of the attachment PDF, possibly a temporary watermarked copy.
#[serde(deserialize_with = "crate::lenient::string")]
pub attachment: String,
/// Download URL of the cover letter PDF, possibly a temporary watermarked copy.
#[serde(rename = "coverLetter", deserialize_with = "crate::lenient::string")]
pub cover_letter: String,
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::number")]
pub donator_id: i64,
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse_id: Option<i64>,
/// Stored or newly generated receipt type. Requested watermarking does not change the stored type in this response.
/// Allowed values: `DRAFT`, `DUPLICATE`, `ORIGINAL`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonationReceiptCreate {
/// Accounting period for the requested donor or pair.
#[serde(deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// DRAFT creates temporary PDFs, ORIGINAL creates persistent files, and DUPLICATE marks a copy. On reads this parameter chooses watermarking, not which stored record is selected.
/// Allowed values: `DRAFT`, `DUPLICATE`, `ORIGINAL`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Background generation job information. With total=0 both jobGroup and statusUrl are null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonationReceiptJobResult {
#[serde(rename = "jobGroup", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job_group: Option<String>,
/// URL for polling generation progress, or null when no jobs were created.
#[serde(rename = "statusUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub status_url: Option<String>,
/// Number of donor households queued for receipt generation.
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonationReceiptsCreate {
#[serde(deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Identifier of an existing attachment template.
#[serde(deserialize_with = "crate::lenient::string")]
pub donation_receipt_attachment_template_id: String,
/// Identifier of an existing cover-letter template.
#[serde(deserialize_with = "crate::lenient::string")]
pub donation_receipt_letter_template_id: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Donation summary for one person or one donor/spouse pair in an accounting period. A single person and that person’s couple form separate aggregates. Canceled transactions and cancellation entries are excluded.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Donator {
/// Serialized migration hint for the deprecated field.
#[serde(rename = "@deprecated")]
pub deprecated: DonatorDeprecated,
/// Total number of donations in the specified accounting period.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Creation timestamp of the selected stored receipt, or null if no receipt exists.
#[serde(rename = "donationReceiptCreatedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub donation_receipt_created_date: Option<chrono::DateTime<chrono::Utc>>,
/// Indicator if all necessary data for a donation receipt is available.
#[serde(rename = "hasAllDonatorData")]
pub has_all_donator_data: bool,
/// Indicator if a donation receipt is available.
#[serde(rename = "hasDonationReceipt")]
pub has_donation_receipt: bool,
/// Presence of first name, last name, street, postcode and city for the single donor or, for a pair, the person with the smaller ID. These are presence flags, not validated addresses.
#[serde(rename = "hasDonatorData")]
pub has_donator_data: DonatorHasDonatorData,
/// True if the stored receipt predates the tracked last modification or has a different net sum. False when no receipt exists.
#[serde(rename = "isDonationReceiptOutdated")]
pub is_donation_receipt_outdated: bool,
/// Amount for the selected latest donation in minor currency units; a payback fallback is negative. Equal document dates have no transaction-ID tie-breaker.
#[serde(rename = "lastDonationAmount", deserialize_with = "crate::lenient::number")]
pub last_donation_amount: i64,
/// Latest donation document date, falling back to the latest payback date if no donation exists.
#[serde(rename = "lastDonationDate", serialize_with = "crate::datetime::serialize_utc")]
pub last_donation_date: chrono::DateTime<chrono::Utc>,
/// Deprecated alias of lastModifiedDate.
#[serde(rename = "lastModified", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub last_modified: Option<chrono::DateTime<chrono::Utc>>,
/// Latest modification timestamp considered for the household’s donation records and cancellation tracking.
#[serde(rename = "lastModifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub last_modified_date: chrono::DateTime<chrono::Utc>,
/// Total number of donation paybacks in the specified accounting period.
#[serde(rename = "paybackCount", deserialize_with = "crate::lenient::number")]
pub payback_count: i64,
/// Resolved persons for the donor or donor/spouse pair. Pair grouping normalizes the person IDs regardless of their order in the original transaction.
pub persons: Vec<DomainObjectPerson>,
/// Net donation amount after paybacks, in minor currency units. May be zero or negative.
#[serde(deserialize_with = "crate::lenient::number")]
pub sum: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Serialized migration hint for the deprecated field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonatorDeprecated {
/// Allowed values: `lastModifiedDate`.
#[serde(rename = "lastModified", deserialize_with = "crate::lenient::string")]
pub last_modified: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Presence of first name, last name, street, postcode and city for the single donor or, for a pair, the person with the smaller ID. These are presence flags, not validated addresses.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DonatorHasDonatorData {
pub city: bool,
#[serde(rename = "firstName")]
pub first_name: bool,
#[serde(rename = "lastName")]
pub last_name: bool,
pub street: bool,
pub zip: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Action definition for a source membership state. An empty object requests no action.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcess {
/// Leaving out a value or setting it to null is handled identically: When creating a membership the default value is used, when updating a membership the value is left unchanged. Target groupMemberStatus none requests deletion of an existing membership. For queryResultOnly, use an actual membership state to create a membership.
#[serde(rename = "handleMembership", default, skip_serializing_if = "Option::is_none")]
pub handle_membership: Option<DynamicGroupProcessHandleMembership>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Leaving out a value or setting it to null is handled identically: When creating a membership the default value is used, when updating a membership the value is left unchanged. Target groupMemberStatus none requests deletion of an existing membership. For queryResultOnly, use an actual membership state to create a membership.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessHandleMembership {
/// Omit or use null for context-dependent fallback (default on creation, unchanged on update). {unchanged: true} preserves a value; {default: true} requests the process default. Use a scalar or {value: ...} for an explicit value. An empty object passes request schema validation but fails when the rules execute. Explicit null cannot reliably clear every membership field in the current processor.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub comment: serde_json::Value,
/// Membership-field values keyed by numeric field ID or reference name. The request schema only accepts lowercase letters, digits and hyphens as keys; field existence and value semantics are resolved during refresh.
#[serde(rename = "groupMemberFields", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub group_member_fields: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Allowed values: `active`, `none`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", default, skip_serializing_if = "serde_json::Value::is_null")]
pub group_member_status: serde_json::Value,
/// Group-type role ID, or a value-control object. It must be valid for this group when executed; the request schema does not resolve it.
#[serde(rename = "groupTypeRoleId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub group_type_role_id: serde_json::Value,
/// Omit or use null for context-dependent fallback (default on creation, unchanged on update). {unchanged: true} preserves a value; {default: true} requests the process default. Use a scalar or {value: ...} for an explicit value. An empty object passes request schema validation but fails when the rules execute. Explicit null cannot reliably clear every membership field in the current processor.
#[serde(rename = "memberEndDate", default, skip_serializing_if = "serde_json::Value::is_null")]
pub member_end_date: serde_json::Value,
/// Omit or use null for context-dependent fallback (default on creation, unchanged on update). {unchanged: true} preserves a value; {default: true} requests the process default. Use a scalar or {value: ...} for an explicit value. An empty object passes request schema validation but fails when the rules execute. Explicit null cannot reliably clear every membership field in the current processor.
#[serde(rename = "memberStartDate", default, skip_serializing_if = "serde_json::Value::is_null")]
pub member_start_date: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessHandleMembershipCommentVariant5 {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub value: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessHandleMembershipGroupMemberStatusVariant5 {
/// Allowed values: `active`, `none`, `requested`, `to_delete`, `waiting`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub value: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessHandleMembershipGroupTypeRoleIdVariant5 {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub value: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessHandleMembershipMemberStartDateVariant5 {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub value: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Defines how a person is placed in the dynamic group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessSets {
/// People who are both current members and part of this rule’s result.
#[serde(rename = "groupAndQueryResult")]
pub group_and_query_result: DynamicGroupProcessSetsGroupAndQueryResult,
/// People who already belong to the group but are absent from this rule’s result.
#[serde(rename = "groupOnly")]
pub group_only: DynamicGroupProcessSetsGroupOnly,
/// People in the query result who are not current members; only the none source-state key is valid.
#[serde(rename = "queryResultOnly")]
pub query_result_only: DynamicGroupProcessSetsQueryResultOnly,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// People who are both current members and part of this rule’s result.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessSetsGroupAndQueryResult {
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub active: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub none: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub requested: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub to_delete: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub waiting: Option<DynamicGroupProcess>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// People who already belong to the group but are absent from this rule’s result.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessSetsGroupOnly {
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub active: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub none: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub requested: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub to_delete: Option<DynamicGroupProcess>,
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub waiting: Option<DynamicGroupProcess>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// People in the query result who are not current members; only the none source-state key is valid.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupProcessSetsQueryResultOnly {
/// Action definition for a source membership state. An empty object requests no action.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub none: Option<DynamicGroupProcess>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// ChurchQuery definition evaluated by the dynamic-group engine. params.responseFields must include the field named by personIdFieldName.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupQuery {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Allowed values: `ChurchQuery`.
#[serde(deserialize_with = "crate::lenient::string")]
pub method: String,
pub params: DynamicGroupQueryParams,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupQueryParams {
#[serde(rename = "computedFields", default, skip_serializing_if = "Option::is_none")]
pub computed_fields: Option<Vec<DynamicGroupQueryParamsComputedFieldsItem>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// JSON expression evaluated as the query filter.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub filter: serde_json::Value,
#[serde(rename = "groupBy", default, skip_serializing_if = "Option::is_none")]
pub group_by: Option<Vec<String>>,
#[serde(rename = "orderBy", default, skip_serializing_if = "Option::is_none")]
pub order_by: Option<Vec<String>>,
#[serde(rename = "outfileNamePart", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub outfile_name_part: Option<String>,
#[serde(rename = "primaryEntityAlias", deserialize_with = "crate::lenient::string")]
pub primary_entity_alias: String,
#[serde(rename = "responseFields")]
pub response_fields: Vec<String>,
/// Only if the query is used in a unit test
#[serde(default, skip_serializing_if = "Option::is_none")]
pub test: Option<DynamicGroupQueryParamsTest>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupQueryParamsComputedFieldsItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Only if the query is used in a unit test
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupQueryParamsTest {
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Failure entry returned by refresh-all. It has no structured groupId; the human-readable error includes group context.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupRefreshError {
/// Legacy failure marker; not the number of changes rolled back.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Localized error message with group context and underlying exception message.
#[serde(deserialize_with = "crate::lenient::string")]
pub error: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Statistics for one synchronous group refresh. At most 500 actual membership changes are applied per execution; repeat refreshes may be needed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupRefreshResult {
/// Memberships created in this run.
#[serde(deserialize_with = "crate::lenient::number")]
pub created: i64,
/// Memberships removed in this run.
#[serde(deserialize_with = "crate::lenient::number")]
pub deleted: i64,
/// Group whose rules were evaluated.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Estimated additional runs based on the remaining-action counter; not an automatically queued job count.
#[serde(rename = "runsNeeded", deserialize_with = "crate::lenient::number")]
pub runs_needed: i64,
/// Reported remaining actions at the change limit. This can overcount when earlier actions did not require a write.
#[serde(deserialize_with = "crate::lenient::number")]
pub unprocessed: i64,
/// Existing memberships changed in this run.
#[serde(deserialize_with = "crate::lenient::number")]
pub updated: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One automatic-membership rule. Queries and processing modes are evaluated against the membership snapshot at the start of a refresh. Rules are ordered by increasing importance; any requested deletion takes precedence over updates, regardless of importance.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupRule {
/// Human-readable explanation of what this rule does.
#[serde(deserialize_with = "crate::lenient::string")]
pub description: String,
/// Determines the order of the rule sets. The higher the number, the later the rule set is processed. As it may override previous results, a higher number implies higher priority.
#[serde(deserialize_with = "crate::lenient::number")]
pub importance: i64,
/// The name of the field that contains the person id. This is used to identify the person to be placed in the dynamic group.
#[serde(rename = "personIdFieldName", deserialize_with = "crate::lenient::string")]
pub person_id_field_name: String,
/// Defines how a person is placed in the dynamic group.
pub process: DynamicGroupProcessSets,
/// ChurchQuery definition evaluated by the dynamic-group engine. params.responseFields must include the field named by personIdFieldName.
pub query: DynamicGroupQuery,
/// Short rule identifier used in diagnostics.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces all stored rules. It does not activate the group or run a refresh. An empty array clears the stored rule set and reads back as null, while preserving the refresh status.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupRuleSetUpdate {
#[serde(rename = "dynamicGroupRuleSet")]
pub dynamic_group_rule_set: Vec<DynamicGroupRule>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Set the refresh mode independently of the stored rule set. This does not evaluate or execute rules.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupStatusUpdate {
/// Controls automatic membership refresh: active participates in scheduled and manual refreshes; manual allows explicit refresh only; inactive blocks both; none disables dynamic-group behavior without deleting stored rules or existing memberships.
/// Allowed values: `active`, `inactive`, `manual`, `none`.
#[serde(rename = "dynamicGroupStatus", deserialize_with = "crate::lenient::string")]
pub dynamic_group_status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupValueDefault {
pub default: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DynamicGroupValueUnchanged {
pub unchanged: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Placeholder lookups made while rendering one visible person’s content. Conditional branches affect which placeholders are evaluated.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EmailPlaceholderStatistics {
/// Unique evaluated placeholder names in first-lookup order, excluding internal .all/.person names.
pub order: Vec<String>,
/// Recipient represented by this entry.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Map of evaluated placeholder names to availability codes. An empty map can serialize as \[\]. Internal names ending in .all or .person are omitted.
/// Allowed values: `0`, `1`, `2`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub stats: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Read-only request for per-person placeholder availability. Only persons visible to the current user are considered.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EmailPlaceholderStatisticsCreate {
/// HTML/text fragments concatenated in order without inserting whitespace. Empty array produces an empty body before optional template wrapping.
pub content: Vec<String>,
/// Optional HTML template. All literal {{body}} tokens are replaced with the concatenated content before placeholders are resolved. If the template has no HTML file, content is used directly.
#[serde(rename = "emailTemplateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub email_template_id: Option<i64>,
/// Optional visible group providing group and membership placeholders. Template access can also be granted through permission to view this group’s automatic emails.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<i64>,
/// Accepted legacy parameter. Currently validated but not used in rendering, authorization or statistics.
#[serde(rename = "automaticEmailId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub automatic_email_id: Option<i64>,
/// IDs of the persons for which statistics are calculated
#[serde(rename = "personIds")]
pub person_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Flat rendering result; no data wrapper. The subject property is present only when the request included subject.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EmailPreview {
/// Rendered email preview HTML
#[serde(deserialize_with = "crate::lenient::string")]
pub html: String,
/// Rendered subject, only present when a subject was provided
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subject: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Render one visible person’s email content for preview. This does not create a draft or send an email.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EmailPreviewCreate {
/// HTML/text fragments concatenated in order without inserting whitespace. Empty array produces an empty body before optional template wrapping.
pub content: Vec<String>,
/// Optional HTML template. All literal {{body}} tokens are replaced with the concatenated content before placeholders are resolved. If the template has no HTML file, content is used directly.
#[serde(rename = "emailTemplateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub email_template_id: Option<i64>,
/// Optional visible group providing group and membership placeholders. Template access can also be granted through permission to view this group’s automatic emails.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<i64>,
/// ID of the person used to render person placeholders
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Optional email subject to render with placeholders
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subject: Option<String>,
/// Optional acting-user context used by placeholder decorators; omit to use the current context. This is distinct from the recipient personId. Context handling currently differs between placeholder types.
#[serde(rename = "userId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub user_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// euBP service health information
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpHealthInfo {
/// Configured service environment, normally test, production or mock. The configuration is returned verbatim.
#[serde(deserialize_with = "crate::lenient::string")]
pub environment: String,
/// Whether the eXTra service is available
#[serde(rename = "extraServiceAvailable")]
pub extra_service_available: bool,
/// Configured eXTra integration-service URL.
#[serde(rename = "extraServiceUrl", deserialize_with = "crate::lenient::string")]
pub extra_service_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpPeriodAccountsUpdate {
/// Complete additional-account selection for this submission-period row. Duplicates are deduplicated; unknown IDs are ignored. \[\] removes additional selections.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Submission of finance data for an electronically supported audit (euBP), transmitted through the eXTra service to Deutsche Rentenversicherung (DRV). One submission groups a main finance client and optionally related clients across calendar years. Period rows link these years to CT accounting periods; they are not accounting periods themselves.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmission {
/// ID of the finance client
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// Client request ID from eXTra service
#[serde(rename = "clientRequestId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub client_request_id: Option<String>,
/// Company name snapshot used for transmission
#[serde(rename = "companyName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub company_name: Option<String>,
/// Company number snapshot used for transmission
#[serde(rename = "companyNumber", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub company_number: Option<String>,
/// Delivery deadline for the audit data Serialized as an ISO timestamp including timezone, even though creation accepts a calendar date. Serialized as an ISO timestamp including timezone, even though creation accepts a calendar date.
#[serde(rename = "deliveryDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub delivery_date: Option<chrono::DateTime<chrono::Utc>>,
/// URL to download the generated export ZIP file
#[serde(rename = "downloadUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub download_url: Option<String>,
/// Status code from DRV
#[serde(rename = "drvStatusCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub drv_status_code: Option<String>,
/// Status message from DRV
#[serde(rename = "drvStatusMessage", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub drv_status_message: Option<String>,
/// Most recent eXTra transport/status code.
#[serde(rename = "extraStatusCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub extra_status_code: Option<String>,
/// Most recent eXTra status message.
#[serde(rename = "extraStatusMessage", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub extra_status_message: Option<String>,
/// ID of the generated export file in cc_file
#[serde(rename = "fileId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub file_id: Option<i64>,
/// Submission ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// One row per affected client and requested year, including rows without a matching accounting period.
pub periods: Vec<EubpSubmissionPeriod>,
/// Reference date for the audit (Stichtag der Prüfung) Serialized as an ISO timestamp including timezone, even though creation accepts a calendar date. Serialized as an ISO timestamp including timezone, even though creation accepts a calendar date.
#[serde(rename = "referenceDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub reference_date: Option<chrono::DateTime<chrono::Utc>>,
/// Timestamp when submission was sent
#[serde(rename = "sentDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sent_date: Option<chrono::DateTime<chrono::Utc>>,
/// Server message ID from eXTra service
#[serde(rename = "serverMessageId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub server_message_id: Option<String>,
/// Local workflow state. Accounts are editable in draft, rejected and response. pending means queued/in progress, not accepted by DRV.
/// Allowed values: `accepted`, `cancelled`, `draft`, `finished`, `pending`, `rejected`, `response`, `sent`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Title of the submission
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Reason for transmission (1=audit, 2=software change, 3=provider change)
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "transmissionReason", deserialize_with = "crate::lenient::number")]
pub transmission_reason: i64,
/// Start year of the delivery period
#[serde(rename = "yearFrom", deserialize_with = "crate::lenient::number")]
pub year_from: i64,
/// End year of the delivery period
#[serde(rename = "yearTo", deserialize_with = "crate::lenient::number")]
pub year_to: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An additional account linked to a submission period
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionAccount {
/// ID of the account
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Name of the account
#[serde(rename = "accountName", deserialize_with = "crate::lenient::string")]
pub account_name: String,
/// Account number
#[serde(rename = "accountNumber", deserialize_with = "crate::lenient::string")]
pub account_number: String,
/// Submission account ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// ID of the parent submission period
#[serde(rename = "submissionPeriodId", deserialize_with = "crate::lenient::number")]
pub submission_period_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionAccountsUpdate {
/// Complete selection by exact keys from the unified account list. \[\] clears optional selections; mandatory/transmitted accounts remain effectively selected.
#[serde(rename = "accountKeys")]
pub account_keys: Vec<String>,
/// Restrict the update to one affected client; omitted/null applies to all clients. A non-participating client results in no changes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "clientId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub client_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a draft audit submission. The main client needs a treasurer and a business number. An overlapping submission involving any selected client is rejected unless its status is cancelled or rejected. yearFrom must not exceed yearTo.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionCreate {
/// Year-to-account-ID mapping for the main client only. Currently non-empty ID lists are rejected by a misplaced Unique validator; use the separate account-selection endpoints after creating the draft.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "additionalAccountsPerYear", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub additional_accounts_per_year: Option<Option<std::collections::BTreeMap<String, Vec<i64>>>>,
/// IDs of finance clients that belong to the audited company and should get their own submission periods. The main clientId is always added automatically. Clients without an accounting period overlapping the requested years are omitted. Included clients must exist and have either no business number or the same number as the main client.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "affectedClientIds", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub affected_client_ids: Option<Option<Vec<i64>>>,
/// ID of the finance client
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// Delivery deadline for the audit data Only retained for transmissionReason=1; cleared for software/provider changes. Only retained for transmissionReason=1; cleared for software/provider changes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "deliveryDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub delivery_date: Option<Option<chrono::NaiveDate>>,
/// Reference date for the audit (Stichtag der Prüfung) Only retained for transmissionReason=1; cleared for software/provider changes. Only retained for transmissionReason=1; cleared for software/provider changes.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "referenceDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub reference_date: Option<Option<chrono::NaiveDate>>,
/// Title of the submission
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub title: Option<Option<String>>,
/// Reason for transmission (1=audit, 2=software change, 3=provider change)
/// Allowed values: `1`, `2`, `3`.
#[serde(rename = "transmissionReason", deserialize_with = "crate::lenient::number")]
pub transmission_reason: i64,
/// Start year of the delivery period
#[serde(rename = "yearFrom", deserialize_with = "crate::lenient::number")]
pub year_from: i64,
/// End year of the delivery period
#[serde(rename = "yearTo", deserialize_with = "crate::lenient::number")]
pub year_to: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A period (year) within an euBP submission
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionPeriod {
/// ID of the linked accounting period
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub accounting_period_id: Option<i64>,
/// Additional accounts for this period
#[serde(rename = "additionalAccounts")]
pub additional_accounts: Vec<EubpSubmissionAccount>,
/// ID of the finance client this period belongs to
#[serde(rename = "clientId", deserialize_with = "crate::lenient::number")]
pub client_id: i64,
/// File number assigned during export
#[serde(rename = "fileNumber", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_number: Option<String>,
/// True when an accounting period is linked; this does not imply that any transactions exist.
#[serde(rename = "hasData")]
pub has_data: bool,
/// Submission-period row ID; distinct from accountingPeriodId.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Marks the final client/year row of the submission, including when that row has no accounting data.
#[serde(rename = "isLast")]
pub is_last: bool,
/// ID of the parent submission
#[serde(rename = "submissionId", deserialize_with = "crate::lenient::number")]
pub submission_id: i64,
/// Account IDs that were transmitted during submission (mandatory + additional accounts)
#[serde(rename = "transmittedAccountIds", default, skip_serializing_if = "Option::is_none")]
pub transmitted_account_ids: Option<Vec<i64>>,
/// Year of this period
#[serde(deserialize_with = "crate::lenient::number")]
pub year: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Structural client/year preview and missing-period warnings. This is not a validation of the complete generated transmission file.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionPreview {
/// Preview data per period
pub periods: Vec<EubpSubmissionPreviewPeriodsItem>,
/// Validation warnings
pub warnings: Vec<EubpSubmissionPreviewWarningsItem>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionPreviewPeriodsItem {
#[serde(rename = "dateRange")]
pub date_range: EubpSubmissionPreviewPeriodsItemDateRange,
/// Whether an accounting period is linked. Without one, dateRange covers the complete calendar year.
#[serde(rename = "hasData")]
pub has_data: bool,
#[serde(rename = "isLast")]
pub is_last: bool,
#[serde(deserialize_with = "crate::lenient::number")]
pub year: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionPreviewPeriodsItemDateRange {
pub from: chrono::NaiveDate,
pub to: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpSubmissionPreviewWarningsItem {
/// Localized warning text.
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
/// Allowed values: `info`.
#[serde(deserialize_with = "crate::lenient::string")]
pub severity: String,
/// Allowed values: `missing_accounting_period`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Years without a linked accounting period. A year can occur more than once for different clients.
pub years: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Accounts merged across selected client/year rows by exact number|name. Only accounts with bookings are listed; fields that differ by year/client are combined.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EubpUnifiedAccount {
/// Account-group name of the first encountered merged account; other years/clients can have different groups.
#[serde(rename = "accountGroupName", deserialize_with = "crate::lenient::string")]
pub account_group_name: String,
/// Whether this is a donation account True when true for at least one merged account. True when true for at least one merged account.
#[serde(rename = "isDonationAccount")]
pub is_donation_account: bool,
/// Opaque selection key composed of account number, a vertical bar and account name. Reuse the returned key exactly.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Whether this account is mandatory for euBP True when true for at least one merged account. True when true for at least one merged account.
pub mandatory: bool,
/// Account name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Account number
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// True if at least one merged account is mandatory, already transmitted or additionally selected.
pub selected: bool,
/// Whether this account was already transmitted True when true for at least one merged account. True when true for at least one merged account.
pub transmitted: bool,
/// Years in which this account has bookings
pub years: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Event classification returned by the configured Evangelische Termine server. Keys and labels are supplied by that server and are not a fixed ChurchTools enum.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EvangelischeTermineEventType {
/// External event-type identifier to use in integration settings.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Display label supplied by Evangelische Termine.
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Connection settings to test against Evangelische Termine. Testing these values does not save settings or enable synchronization.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EvangelischeTermineSettingsValidateCreate {
/// SOAP API key for the organizer. The literal value ***** reuses the API key already stored in ChurchTools. The supplied URL and organizer ID are still used for this check.
#[serde(rename = "apiKey", deserialize_with = "crate::lenient::string")]
pub api_key: String,
/// Base URL of the Evangelische Termine installation, without /soap or /soap?WSDL. Leading/trailing whitespace and a trailing slash are normalized; a hostname without a scheme uses HTTPS. The client validates the target URL before connecting.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// External organizer identifier (Veranstalter-ID). Send it as a string, even when it contains only digits.
#[serde(deserialize_with = "crate::lenient::string")]
pub vid: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An occurrence in service planning linked to a calendar appointment. id identifies the planning event, appointmentId the underlying appointment (possibly a recurring series). This enriched read representation differs from the response to PUT /events/{eventId}.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Event {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
#[serde(rename = "adminIds")]
pub admin_ids: Vec<i64>,
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::number")]
pub appointment_id: i64,
/// Calendar as Domain Object
pub calendar: DomainObjectCalendar,
/// Room lifecycle status. `STARTING` awaits confirmation from the central chat service.
/// Allowed values: `NOT_STARTED`, `STARTED`, `STARTING`, `STOPPED`.
#[serde(rename = "chatStatus", deserialize_with = "crate::lenient::string")]
pub chat_status: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// End derived by adding the underlying appointment duration to this event occurrence’s start.
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "eventAdminIds", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub event_admin_ids: Option<Vec<i64>>,
#[serde(rename = "eventFiles")]
pub event_files: Vec<DomainObjectFile>,
/// Assignments included by include=eventServices (legacy spelling). Always included by single-event and person-event reads.
#[serde(rename = "eventServices", default, skip_serializing_if = "Option::is_none")]
pub event_services_2: Option<Vec<ServiceRequest>>,
/// Assignments included by include=event_services. The property spelling follows the requested include.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub event_services: Option<Vec<ServiceRequest>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Deprecated alias for description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<String>,
/// Computed UI permissions. startChat does not include all installation-level chat prerequisites; the chat action performs its own authorization checks.
pub permissions: EventPermissions,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Change chat activation for an event, optionally sending invitation emails.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventChatUpdate {
/// `true` starts or reactivates the event chat; `false` stops an existing chat.
pub enabled: bool,
/// Send invitations to eligible event participants who cannot chat yet. This is independent of enabled: `true` can also send invitations when stopping the chat. Repeated requests can send invitations again.
#[serde(rename = "triggerChatInviteMail", default, skip_serializing_if = "Option::is_none")]
pub trigger_chat_invite_mail: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update the event description, administrators and cancellation state. Event dates, the calendar appointment and service assignments are managed through their respective endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventDetailsUpdate {
/// Replace the administrator list. A change to the set of IDs additionally requires the "edit masterdata" permission for the service planning domain.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<i64>>,
/// Event description.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Legacy input alias for `adminIds`.
#[serde(rename = "eventAdminIds", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub event_admin_ids: Option<Vec<i64>>,
/// Whether the service-planning event is cancelled.
#[serde(rename = "isCanceled", default, skip_serializing_if = "Option::is_none")]
pub is_canceled: Option<bool>,
/// Deprecated alias for `description`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Result of updating event details. This differs from the enriched event read response: it contains the stored appointment, description, administrators and cancellation flag, without services, event startDate or meta.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventDetailsUpdateResult {
/// Stored administrator IDs.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<serde_json::Value>>,
/// Stored calendar appointment, including its recurrence definition. This is not an occurrence-specific appointment projection.
pub appointment: EventDetailsUpdateResultAppointment,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Event GUID, or `null` for a legacy record without one.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
/// Deprecated alias for `description`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored calendar appointment, including its recurrence definition. This is not an occurrence-specific appointment projection.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventDetailsUpdateResultAppointment {
pub additionals: Vec<AppointmentAdditionals>,
/// Use 'additionals' instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'additionals' instead"]
pub additions: Option<Vec<AppointmentAdditionals>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// True when the appointment is all-day. The serialized endDate is inclusive.
#[serde(rename = "allDay")]
pub all_day: bool,
/// Calendar containing the appointment.
pub calendar: AppointmentBaseCalendar,
/// Use 'title' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'title' instead"]
pub caption: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<AppointmentExeptions>,
/// ID of the stored appointment or series.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub image: Option<Image>,
/// Use 'description' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'description' instead"]
pub information: Option<String>,
#[serde(rename = "isInternal")]
pub is_internal: bool,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
pub meta: MetaDataEntityId,
/// Use 'subtitle' instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'subtitle' instead"]
pub note: Option<String>,
/// Person on whose behalf the appointment was entered, or null.
#[serde(rename = "onBehalfOfPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub on_behalf_of_pid: Option<i64>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Registration-group configuration, or null if the appointment has none.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub signup: Option<AppointmentSignup>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Revision counter increased by updates; not an input precondition or a per-occurrence ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A fact definition describes a metric or selection (for example attendance or service type). An event fact stores one value for that definition on a service-planning event. `eventId` identifies the event, not its calendar appointment; `factId` identifies the reusable definition from /facts. Values are returned as numbers for numeric facts and strings for select facts. Definitions and events are referenced by ID, not embedded.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventFact {
/// Legacy response marker identifying the metadata replacements.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
/// Service-planning event ID. This is not the calendar appointment ID.
#[serde(rename = "eventId", deserialize_with = "crate::lenient::number")]
pub event_id: i64,
/// ID of the fact definition from /facts; the same `factId` can have different values on different events.
#[serde(rename = "factId", deserialize_with = "crate::lenient::number")]
pub fact_id: i64,
pub meta: MetaDataEntityId,
/// Last modification timestamp.
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of the person who last modified the value.
#[serde(rename = "modifiedPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_pid: Option<i64>,
/// Numeric facts are serialized as JSON numbers, select facts as their stored option text. A legacy empty stored value is returned as `null`; new values cannot be `null`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calendar selection and optional event-start date range for a facts export. For a complete calendar month, use its first day as from and the first day of the next month as to.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventFactExportCreate {
/// Calendars containing the appointments linked to the service-planning events. Only events visible to the current user are exported.
pub calendar_ids: Vec<i64>,
/// Inclusive lower bound for the event start date in the installation’s timezone.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub from: Option<chrono::NaiveDate>,
/// Exclusive upper bound for the event start date in the installation’s timezone. Must be later than from when both are supplied.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub to: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces the value of an event fact, or creates it if none is stored yet. The same validation applies to creation and replacement.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventFactUpdate {
/// For numeric facts, prefer a JSON number. For select facts, send the configured option text from /facts/{id}.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Message and selected recipients for an event email. This creates a send operation, not a stored event or agenda.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventMailCreate {
/// HTML email body. ChurchTools appends buttons for all supplied events and any requested, available agenda and file links.
#[serde(deserialize_with = "crate::lenient::string")]
pub body: String,
/// Events used to resolve participating recipients and message links. Every supplied event must exist. Events are not required to share an agenda.
#[serde(rename = "eventIds")]
pub event_ids: Vec<i64>,
/// Selected person IDs. Only selected participants in visible service groups of the loaded events, or selected people the sender may otherwise view, receive the message. The response reports other IDs as rejected. Participants are not added automatically.
pub recipients: Vec<i64>,
/// Also include the currently logged-in person as a recipient, even if their ID is absent from recipients.
#[serde(rename = "sendCopyToMe", default, skip_serializing_if = "Option::is_none")]
pub send_copy_to_me: Option<bool>,
/// Email subject.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Append links for supplied events that have an agenda and for whose calendar the sender has "view agenda" permission.
#[serde(rename = "appendAgendaButton")]
pub append_agenda_button: bool,
/// File IDs to list as links in the message body. Only files associated with one of the supplied events are used. These are links, not binary email attachments.
pub files: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective scope of an event email queue operation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventMailSendResult {
/// Supplied event IDs for which an agenda button was included. An empty array means no requested agenda button could be included.
#[serde(rename = "agendaEventIds")]
pub agenda_event_ids: Vec<i64>,
/// Requested file IDs included as links in the message.
#[serde(rename = "includedFileIds")]
pub included_file_ids: Vec<i64>,
/// Requested person IDs rejected by visibility rules.
#[serde(rename = "rejectedRecipientIds")]
pub rejected_recipient_ids: Vec<i64>,
/// Person IDs whose messages were accepted by the mail queue, including the sender when `sendCopyToMe` added them. Queue acceptance does not confirm delivery.
#[serde(rename = "sentRecipientIds")]
pub sent_recipient_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reference records used by the Event module. IDs in assignments, event facts and song arrangements refer to these configurable records. Their names and IDs are installation-specific, not enums.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventMasterData {
/// Configured reasons for absences, such as holidays or illness. Referenced by absence records.
#[serde(rename = "absenceReasons")]
pub absence_reasons: Vec<AbsenceReason>,
/// Definitions of event facts, such as attendance or collection totals. These are field definitions, not the values recorded for an event.
pub facts: Vec<serde_json::Value>,
/// Service groups organize related roles, such as music or technical teams. A service refers to its group through `serviceGroupId`.
#[serde(rename = "serviceGroups")]
pub service_groups: Vec<ServiceGroup>,
/// Service-role definitions, such as worship leader or sound operator. A role is distinct from a person's assignment to that role at an event.
pub services: Vec<Service>,
/// Categories used to organize songs. Song records refer to these categories.
#[serde(rename = "songCategories")]
pub song_categories: Vec<SongCategory>,
/// Sources used by song arrangements, such as hymnals or song collections.
#[serde(rename = "songSources")]
pub song_sources: Vec<SongSource>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Computed UI permissions. startChat does not include all installation-level chat prerequisites; the chat action performs its own authorization checks.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventPermissions {
#[serde(rename = "startChat")]
pub start_chat: bool,
#[serde(rename = "useChat")]
pub use_chat: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Enriched event with the eventServices include always present, possibly as an empty list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventReadWithServices {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
#[serde(rename = "adminIds")]
pub admin_ids: Vec<i64>,
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::number")]
pub appointment_id: i64,
/// Calendar as Domain Object
pub calendar: DomainObjectCalendar,
/// Room lifecycle status. `STARTING` awaits confirmation from the central chat service.
/// Allowed values: `NOT_STARTED`, `STARTED`, `STARTING`, `STOPPED`.
#[serde(rename = "chatStatus", deserialize_with = "crate::lenient::string")]
pub chat_status: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// End derived by adding the underlying appointment duration to this event occurrence’s start.
#[serde(rename = "endDate", serialize_with = "crate::datetime::serialize_utc")]
pub end_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "eventAdminIds", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub event_admin_ids: Option<Vec<i64>>,
#[serde(rename = "eventFiles")]
pub event_files: Vec<DomainObjectFile>,
/// Assignments included by include=eventServices (legacy spelling). Always included by single-event and person-event reads.
#[serde(rename = "eventServices", default, skip_serializing_if = "Option::is_none")]
pub event_services_2: Option<Vec<ServiceRequest>>,
/// Assignments included by include=event_services. The property spelling follows the requested include.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub event_services: Option<Vec<ServiceRequest>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Deprecated alias for description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<String>,
/// Computed UI permissions. startChat does not include all installation-level chat prerequisites; the chat action performs its own authorization checks.
pub permissions: EventPermissions,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventService {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<std::collections::BTreeMap<String, String>>,
/// Use `isAccepted` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `isAccepted` instead"]
pub agreed: Option<bool>,
#[serde(rename = "allowChat", default, skip_serializing_if = "Option::is_none")]
pub allow_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Use `index` instead
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `index` instead"]
pub counter: Option<i64>,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub event: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub index: Option<i64>,
#[serde(rename = "isAccepted", default, skip_serializing_if = "Option::is_none")]
pub is_accepted: Option<bool>,
#[serde(rename = "isValid", default, skip_serializing_if = "Option::is_none")]
pub is_valid: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub permissions: Option<EventServicePermissions>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Deprecated alias for `meta.modifiedDate`.
#[serde(rename = "requestedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requested_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "requesterPerson", default, skip_serializing_if = "Option::is_none")]
pub requester_person: Option<DomainObjectPerson>,
#[serde(rename = "requesterPersonId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requester_person_id: Option<i64>,
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub service_id: Option<i64>,
#[serde(rename = "serviceName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub service_name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventServiceCountUpdate {
/// Desired total number of active slots for this service, including occupied slots. Use 0 to remove all slots, which succeeds only when all are unassigned.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// ID of the reusable service role from /services.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventServiceEventVariant2 {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventServicePermissions {
#[serde(rename = "enterSelfIfFree", default, skip_serializing_if = "Option::is_none")]
pub enter_self_if_free: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Change the number of service slots in one event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventServicesUpdate {
/// Desired counts for the listed services only. An empty array makes no changes. Supply each `serviceId` once: entries are processed against the initial slot snapshot, so repeated IDs do not represent successive updates.
pub services: Vec<EventServiceCountUpdate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// This is separate from a calendar appointment template. When creating an event for an appointment with eventTemplateId, the current event-creation service copies description, `adminIds`, service slot counts and facts. The appointment and supplied startDate determine the new event’s appointment and time; the remaining scheduling fields are template metadata for clients.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventTemplate {
/// Database storage can return numeric IDs as strings. `null` means no stored administrator list.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<serde_json::Value>>,
/// Default calendar ID; `null` when no default is stored.
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub calendar_id: Option<i64>,
/// Empty text is converted to `null` when the event is created from this template.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Default duration in seconds, not minutes.
#[serde(rename = "durationInSeconds", deserialize_with = "crate::lenient::number")]
pub duration_in_seconds: i64,
/// Proposed event name; `null` when no default is stored.
#[serde(rename = "eventName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub event_name: Option<String>,
/// Default recorded values keyed by fact definition ID from /facts.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub facts: serde_json::Value,
/// Default local start hour; `null` when no default is stored.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub hour: Option<i64>,
/// ID to use as eventTemplateId when creating an event for a calendar appointment.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Default local start minute; `null` when no default is stored.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub minute: Option<i64>,
/// Deprecated alias for description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<String>,
/// Service roles and their requested slot counts; an empty list is allowed.
pub services: Vec<EventTemplateService>,
/// Template display order. This endpoint sorts by `sortKey` ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Name of the reusable template, distinct from the proposed event name.
#[serde(rename = "templateName", deserialize_with = "crate::lenient::string")]
pub template_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct EventTemplateService {
/// Number of unassigned slots to create for this service role when applying the template.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// ID of the reusable service role from /services.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Sanitized provider configuration returned to settings administrators. OAuth/OIDC client secrets and SAML SP private keys are not included.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLogin {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub config: serde_json::Value,
/// Whether the login flow may create a ChurchTools person when no local identity mapping exists. The matching mode controls whether this happens automatically or requires an explicit choice.
#[serde(rename = "createNewPerson")]
pub create_new_person: bool,
/// Whether the external provider offers a registration flow; support depends on the protocol handler.
#[serde(rename = "hasRegistration")]
pub has_registration: bool,
/// Whether this provider is listed among available SSO login choices. Hiding it is not the same as deleting its configuration or mappings.
#[serde(rename = "isVisible")]
pub is_visible: bool,
/// Determines how an authenticated external identity without an existing person mapping is handled. Auto-match mode uses automatic name-and-email matching and optional person creation. Verified mode asks the user to either prove ownership of a local account or, when `createNewPerson` is enabled, explicitly create a person. Pre-provisioned mode rejects identities without a mapping.
/// Allowed values: `auto_match`, `preprovisioned_only`, `verified_user_linking`.
#[serde(rename = "matchingMode", deserialize_with = "crate::lenient::string")]
pub matching_mode: String,
/// Display name shown for this provider.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Default campus ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonCampusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_campus_id: Option<i64>,
/// Default department ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonDepartmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_department_id: Option<i64>,
/// Default person status ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonStatusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_status_id: Option<i64>,
/// Marks the preferred external login. At most one provider may have this flag; choosing a second primary provider is rejected rather than automatically demoting the first.
#[serde(rename = "primaryLogin")]
pub primary_login: bool,
/// Secondary text on the login choice.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
/// Configured login protocol.
/// Allowed values: `oauth`, `oidc`, `saml`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Whether existing person data is updated from provider data after successful matching.
#[serde(rename = "updateDataOnLogin")]
pub update_data_on_login: bool,
/// Provider configuration ID used in management and protocol URLs.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Resolved provider logo URL, or null if unavailable.
#[serde(rename = "logoUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub logo_url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Browser-session-bound authorization request. Retain the session cookie, open url in that browser session and let the provider redirect to the callback.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginAuthorizationStart {
/// Pending authorization expiry as Unix epoch seconds; normally 600 seconds after creation.
#[serde(rename = "expiresAt", deserialize_with = "crate::lenient::number")]
pub expires_at: i64,
/// Opaque, single-use authorization state. Do not reuse it or substitute another browser session.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Provider authorization URL including state, nonce and the PKCE challenge.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates an external login provider. SAML configuration requires the SAML settings feature flag.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginCreate {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub config: serde_json::Value,
/// Whether the login flow may create a ChurchTools person when no local identity mapping exists. The matching mode controls whether this happens automatically or requires an explicit choice.
#[serde(rename = "createNewPerson")]
pub create_new_person: bool,
/// Whether the external provider offers a registration flow; support depends on the protocol handler.
#[serde(rename = "hasRegistration")]
pub has_registration: bool,
#[serde(rename = "isVisible", default, skip_serializing_if = "Option::is_none")]
pub is_visible: Option<bool>,
/// Determines how an authenticated external identity without an existing person mapping is handled. Auto-match mode uses automatic name-and-email matching and optional person creation. Verified mode asks the user to either prove ownership of a local account or, when `createNewPerson` is enabled, explicitly create a person. Pre-provisioned mode rejects identities without a mapping.
/// Allowed values: `auto_match`, `preprovisioned_only`, `verified_user_linking`.
#[serde(rename = "matchingMode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub matching_mode: Option<String>,
/// Display name shown for this provider.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Default campus ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonCampusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_campus_id: Option<i64>,
/// Default department ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonDepartmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_department_id: Option<i64>,
/// Default person status ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonStatusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_status_id: Option<i64>,
#[serde(rename = "primaryLogin", default, skip_serializing_if = "Option::is_none")]
pub primary_login: Option<bool>,
/// Secondary text on the login choice.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Configured login protocol.
/// Allowed values: `oauth`, `oidc`, `saml`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Whether existing person data is updated from provider data after successful matching.
#[serde(rename = "updateDataOnLogin")]
pub update_data_on_login: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Credentials used to prove ownership of a local account for a pending external identity. The token must originate from the preceding external login in the same browser session.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginLinkCreate {
/// Opaque, session-bound linking token from the account-linking redirect. Expires 600 seconds after creation.
#[serde(rename = "linkToken", deserialize_with = "crate::lenient::string")]
pub link_token: String,
/// Password for that account; does not replace the second-factor step.
#[serde(deserialize_with = "crate::lenient::string")]
pub password: String,
/// Username or email address verified by the configured ChurchTools credential authentication, including legacy LDAP when configured.
#[serde(deserialize_with = "crate::lenient::string")]
pub username: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginLinkResult {
/// Absolute ChurchTools URL to navigate to. It can request two-factor verification; HTTP 200 alone does not mean login is complete.
#[serde(deserialize_with = "crate::lenient::string")]
pub location: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// OAuth provider configuration.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginOAuthConfig {
#[serde(rename = "accessTokenUrl", deserialize_with = "crate::lenient::string")]
pub access_token_url: String,
#[serde(rename = "authorizeUrl", deserialize_with = "crate::lenient::string")]
pub authorize_url: String,
/// Version 2 uses the stable /oauthclients/login/callback URL. Existing providers without this value retain their provider-specific callback URL. New OAuth providers default to version 2.
/// Allowed values: `2`.
#[serde(rename = "callbackUrlVersion", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub callback_url_version: Option<i64>,
#[serde(rename = "clientId", deserialize_with = "crate::lenient::string")]
pub client_id: String,
/// OAuth client secret.
#[serde(rename = "clientSecret", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub scope: Option<String>,
#[serde(rename = "urlResourceOwnerDetails", deserialize_with = "crate::lenient::string")]
pub url_resource_owner_details: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// OpenID Connect provider configuration.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginOidcConfig {
/// Optional allowlist for the `ct_connection` claim. When configured, an ID token without an allowed connection is rejected.
#[serde(rename = "allowedConnections", default, skip_serializing_if = "Option::is_none")]
pub allowed_connections: Option<Vec<String>>,
/// Retained for stored-data and API compatibility. Callback routing no longer depends on this value.
/// Allowed values: `2`.
#[serde(rename = "callbackUrlVersion", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub callback_url_version: Option<i64>,
#[serde(rename = "clientId", deserialize_with = "crate::lenient::string")]
pub client_id: String,
/// OpenID Connect client secret.
#[serde(rename = "clientSecret", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
/// Optional installation identifier that must be present in the `ct_entitlements` claim.
#[serde(rename = "installationId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub installation_id: Option<String>,
/// Exact HTTPS issuer used for discovery and token validation. User info, query strings and fragments are rejected; a path and explicit port are allowed.
#[serde(deserialize_with = "crate::lenient::string")]
pub issuer: String,
/// Optional minimum `acr`. Numeric values are ordered numerically; non-numeric values require an exact match.
#[serde(rename = "minAcr", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub min_acr: Option<String>,
/// Space-separated scopes. Missing, null or empty values use `openid profile email`. The `openid` scope is always included. Claim policies do not automatically add scopes.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub scope: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An OIDC authorization test could not be started or completed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginOidcTestError {
/// Sorted unique claim names from the validated ID token on success. Claim values and tokens are never returned.
#[serde(rename = "claimNames", default, skip_serializing_if = "Option::is_none")]
pub claim_names: Option<Vec<String>>,
/// Sanitized, actionable failure category without provider response details.
/// Allowed values: `acr_insufficient`, `client_id_mismatch`, `configuration_error`, `connection_not_allowed`, `discovery_issuer_mismatch`, `discovery_private_network`, `discovery_unavailable`, `entitlement_missing`, `id_token_invalid`, `issuer_invalid`, `nonce_invalid`, `provider_error`, `signature_invalid`, `signing_algorithm_unsupported`, `signing_key_unavailable`, `subject_missing`, `token_exchange_failed`, `token_time_invalid`, `validation_failed`.
#[serde(rename = "errorCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub error_code: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Session-bound OIDC test status. pending means the provider callback is outstanding; success means token and claim-policy validation succeeded; error contains a sanitized category; expired also covers unknown states or another administrator/session.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginOidcTestResult {
/// Sorted unique claim names from the validated ID token on success. Claim values and tokens are never returned.
#[serde(rename = "claimNames", default, skip_serializing_if = "Option::is_none")]
pub claim_names: Option<Vec<String>>,
/// Sanitized, actionable failure category without provider response details.
/// Allowed values: `acr_insufficient`, `client_id_mismatch`, `configuration_error`, `connection_not_allowed`, `discovery_issuer_mismatch`, `discovery_private_network`, `discovery_unavailable`, `entitlement_missing`, `id_token_invalid`, `issuer_invalid`, `nonce_invalid`, `provider_error`, `signature_invalid`, `signing_algorithm_unsupported`, `signing_key_unavailable`, `subject_missing`, `token_exchange_failed`, `token_time_invalid`, `validation_failed`.
#[serde(rename = "errorCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub error_code: Option<String>,
/// Allowed values: `error`, `expired`, `pending`, `success`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// OIDC test authorization. The callback records diagnostics instead of creating a person, linking an identity or completing a ChurchTools login.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginOidcTestStart {
/// Pending authorization expiry as Unix epoch seconds; normally 600 seconds after creation.
#[serde(rename = "expiresAt", deserialize_with = "crate::lenient::number")]
pub expires_at: i64,
/// Opaque, single-use authorization state. Do not reuse it or substitute another browser session.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Provider authorization URL including state, nonce and the PKCE challenge.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Request to create a ChurchTools person from the identity already verified by the external provider and stored in this browser session. No person attributes are accepted from the client.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginPersonCreate {
/// Opaque, session-bound linking token from the account-linking redirect. Expires 600 seconds after creation.
#[serde(rename = "linkToken", deserialize_with = "crate::lenient::string")]
pub link_token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Public summary of one external identity-provider link for a person. Provider configuration, secrets and the external identity identifier are not included.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginPersonMapping {
/// ID of the linked external-login provider; used to unlink this mapping.
#[serde(rename = "externalLoginId", deserialize_with = "crate::lenient::number")]
pub external_login_id: i64,
/// Configured provider display name.
#[serde(rename = "externalLoginName", deserialize_with = "crate::lenient::string")]
pub external_login_name: String,
/// Authentication protocol used by the provider.
/// Allowed values: `ldap`, `oauth`, `oidc`, `saml`.
#[serde(rename = "externalLoginType", deserialize_with = "crate::lenient::string")]
pub external_login_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlCertificateMetadata {
#[serde(rename = "fingerprintSha256", deserialize_with = "crate::lenient::string")]
pub fingerprint_sha256: String,
/// Allowed values: `expired`, `expiring`, `not-yet-valid`, `valid`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Allowed values: `signing`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#use: String,
#[serde(rename = "validFrom", serialize_with = "crate::datetime::serialize_utc")]
pub valid_from: chrono::DateTime<chrono::Utc>,
#[serde(rename = "validTo", serialize_with = "crate::datetime::serialize_utc")]
pub valid_to: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// SAML identity-provider settings. SP keys and certificates are managed by ChurchTools.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlConfig {
/// Retained for stored-data and API compatibility. Callback routing no longer depends on this value.
/// Allowed values: `2`.
#[serde(rename = "callbackUrlVersion", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub callback_url_version: Option<i64>,
#[serde(rename = "emailAttribute", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email_attribute: Option<String>,
#[serde(rename = "firstNameAttribute", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name_attribute: Option<String>,
#[serde(rename = "idAttribute", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub id_attribute: Option<String>,
/// Legacy signing certificate fingerprint. Ignored when multiple signing certificates are configured.
#[serde(rename = "idpCertFingerprint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_cert_fingerprint: Option<String>,
#[serde(rename = "idpCertificateMetadata", default, skip_serializing_if = "Option::is_none")]
pub idp_certificate_metadata: Option<Vec<ExternalLoginSamlCertificateMetadata>>,
/// SAML IdP entity identifier. Required when the provider will be visible.
#[serde(rename = "idpEntityId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_entity_id: Option<String>,
#[serde(rename = "idpSingleLogoutService", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_single_logout_service: Option<String>,
/// Allowed values: `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect`.
#[serde(rename = "idpSingleLogoutServiceBinding", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_single_logout_service_binding: Option<String>,
/// IdP SSO URL. Required when the provider will be visible.
#[serde(rename = "idpSingleSignOnService", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_single_sign_on_service: Option<String>,
/// Allowed values: `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect`.
#[serde(rename = "idpSingleSignOnServiceBinding", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_single_sign_on_service_binding: Option<String>,
/// Legacy field for a single IdP signing certificate in PEM format.
#[serde(rename = "idpX509cert", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub idp_x509cert: Option<String>,
#[serde(rename = "idpX509certMulti", default, skip_serializing_if = "Option::is_none")]
pub idp_x509cert_multi: Option<ExternalLoginSamlConfigIdpX509certMulti>,
#[serde(rename = "lastNameAttribute", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name_attribute: Option<String>,
/// Identifies providers imported from the legacy SAML configuration.
#[serde(rename = "migratedLegacySamlProvider", default, skip_serializing_if = "Option::is_none")]
pub migrated_legacy_saml_provider: Option<bool>,
#[serde(rename = "signRequests", default, skip_serializing_if = "Option::is_none")]
pub sign_requests: Option<bool>,
/// Signature algorithm URI. The API validates URL syntax but not a closed algorithm catalog.
#[serde(rename = "signatureAlgorithm", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub signature_algorithm: Option<String>,
/// Required signatures on inbound SAML authentication responses. `response` requires the outer SAML Response, `assertion` requires its Assertion, and `both` requires both. SP metadata exposes the Assertion requirement as `WantAssertionsSigned`; SAML metadata has no standard attribute for requiring the outer Response signature.
/// Allowed values: `assertion`, `both`, `response`.
#[serde(rename = "signatureRequirement", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub signature_requirement: Option<String>,
#[serde(rename = "siteName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
#[serde(rename = "spX509cert", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sp_x509cert: Option<String>,
#[serde(rename = "usernameAttribute", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub username_attribute: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlConfigIdpX509certMulti {
/// One or more IdP signing certificates in PEM format. Multiple certificates support signing key rollover; encryption certificates are not configured here.
pub signing: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlTestMapping {
/// Configured attribute name, or the SAML default for this ChurchTools field.
#[serde(rename = "claimName", deserialize_with = "crate::lenient::string")]
pub claim_name: String,
/// ChurchTools identity field whose provider attribute mapping is inspected.
/// Allowed values: `email`, `firstName`, `id`, `lastName`, `username`.
#[serde(deserialize_with = "crate::lenient::string")]
pub field: String,
/// Whether the attribute name exists in the response. Empty attribute values still count as present.
pub present: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// SAML protocol-test diagnostics. success means an authenticated SAML response was received; it does not imply that local person matching or required attribute values are valid. error carries no detailed error category. pending and expired contain only status.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlTestResult {
/// Sorted unique SAML attribute names on success; attribute values and the SAML assertion are not returned.
#[serde(rename = "claimNames", default, skip_serializing_if = "Option::is_none")]
pub claim_names: Option<Vec<String>>,
/// Five configured/default mappings in order: id, email, username, firstName, lastName. Presence checks only the attribute name, not whether its value is nonempty or usable.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mappings: Option<Vec<ExternalLoginSamlTestMapping>>,
/// Allowed values: `error`, `expired`, `pending`, `success`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A SAML test bound to the current browser session, administrator and provider. Keep the session cookie when opening url and polling state.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginSamlTestStart {
/// Unix timestamp in seconds, 600 seconds after creation; applies to pending and completed results.
#[serde(rename = "expiresAt", deserialize_with = "crate::lenient::number")]
pub expires_at: i64,
/// Opaque RelayState used to correlate the callback and poll this test.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Identity-provider SSO URL containing the SAML request and RelayState. Open it in the same browser session.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates provider settings. The protocol in `type` must match the existing provider.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalLoginUpdate {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub config: serde_json::Value,
/// Whether the login flow may create a ChurchTools person when no local identity mapping exists. The matching mode controls whether this happens automatically or requires an explicit choice.
#[serde(rename = "createNewPerson")]
pub create_new_person: bool,
/// Whether the external provider offers a registration flow; support depends on the protocol handler.
#[serde(rename = "hasRegistration")]
pub has_registration: bool,
/// Whether this provider is listed among available SSO login choices. Hiding it is not the same as deleting its configuration or mappings.
#[serde(rename = "isVisible", default, skip_serializing_if = "Option::is_none")]
pub is_visible: Option<bool>,
/// Determines how an authenticated external identity without an existing person mapping is handled. Auto-match mode uses automatic name-and-email matching and optional person creation. Verified mode asks the user to either prove ownership of a local account or, when `createNewPerson` is enabled, explicitly create a person. Pre-provisioned mode rejects identities without a mapping.
/// Allowed values: `auto_match`, `preprovisioned_only`, `verified_user_linking`.
#[serde(rename = "matchingMode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub matching_mode: Option<String>,
/// Display name shown for this provider.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Default campus ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonCampusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_campus_id: Option<i64>,
/// Default department ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonDepartmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_department_id: Option<i64>,
/// Default person status ID for newly created people. A numeric ID is required when createNewPerson is true; explicit null is required otherwise.
#[serde(rename = "newPersonStatusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub new_person_status_id: Option<i64>,
/// Marks the preferred external login. At most one provider may have this flag; choosing a second primary provider is rejected rather than automatically demoting the first.
#[serde(rename = "primaryLogin", default, skip_serializing_if = "Option::is_none")]
pub primary_login: Option<bool>,
/// Secondary text on the login choice.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<Option<String>>,
/// Configured login protocol.
/// Allowed values: `oauth`, `oidc`, `saml`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Whether existing person data is updated from provider data after successful matching.
#[serde(rename = "updateDataOnLogin")]
pub update_data_on_login: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configured external connection with masked access credentials.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalSystem {
/// Adapter-specific HTTP header values used to access the external system.
#[serde(rename = "accessHeaderValues", default, skip_serializing_if = "serde_json::Value::is_null")]
pub access_header_values: serde_json::Value,
/// Name of a registered adapter from `/sync/adapters`. Custom adapter names are supported.
#[serde(deserialize_with = "crate::lenient::string")]
pub adapter: String,
/// Display name of the external connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// External system ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Number of configured sync jobs.
#[serde(rename = "jobConfigsCount", deserialize_with = "crate::lenient::number")]
pub job_configs_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Connection to a specific external system through a registered adapter.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalSystemCreate {
/// Adapter-specific HTTP header values used to access the external system.
#[serde(rename = "accessHeaderValues", default, skip_serializing_if = "serde_json::Value::is_null")]
pub access_header_values: serde_json::Value,
/// Name of a registered adapter from `/sync/adapters`. Custom adapter names are supported.
#[serde(deserialize_with = "crate::lenient::string")]
pub adapter: String,
/// Display name of the external connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates the external connection. Supplied header keys are merged into existing headers.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ExternalSystemUpdate {
/// Adapter-specific HTTP header values used to access the external system.
#[serde(rename = "accessHeaderValues", default, skip_serializing_if = "serde_json::Value::is_null")]
pub access_header_values: serde_json::Value,
/// Name of a registered adapter from `/sync/adapters`. Custom adapter names are supported.
#[serde(deserialize_with = "crate::lenient::string")]
pub adapter: String,
/// Display name of the external connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Existing external system ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored numeric metric definition. `unit` can be `null` in existing data.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FactNumber {
/// Deprecated response field that points clients from fieldType to type.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
/// Legacy alias for type.
/// Allowed values: `number`, `select`.
#[serde(rename = "fieldType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub field_type: Option<String>,
/// ID of the fact master data entry.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Stored label of the metric or selection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Label translated for the current language, falling back to name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Sort key for ordering facts.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Allowed values: `number`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Unit for numeric values.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub unit: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Definition of a numeric metric, such as attendance. Recorded event values are returned as JSON numbers.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FactNumberCreate {
/// Label of the metric or selection, trimmed before storage.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Unit displayed with numeric values.
#[serde(deserialize_with = "crate::lenient::string")]
pub unit: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored selection definition. options contains the literal labels accepted when writing event values; legacy definitions can have an empty list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FactSelect {
/// Deprecated response field that points clients from fieldType to type.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
/// Legacy alias for type.
/// Allowed values: `number`, `select`.
#[serde(rename = "fieldType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub field_type: Option<String>,
/// ID of the fact master data entry.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Stored label of the metric or selection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Label translated for the current language, falling back to name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Sort key for ordering facts.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Allowed values for select facts.
pub options: Vec<String>,
/// Allowed values: `select`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Definition of a selection field, such as service type. Supply the complete list of non-empty option labels; event values use the label itself, not an option ID.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FactSelectCreate {
/// Label of the metric or selection, trimmed before storage.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Complete list of allowed option labels. Supply at least one option.
pub options: Vec<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FeatureUsage {
/// Value to decrement the metric by
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub delta: Option<f64>,
/// Feature, tour or event name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Allowed values: `event`, `feature`, `tour`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Field mapping for an external connection and domain. `GET` can return an unsaved mapping when none exists.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FieldMapping {
/// ChurchTools domain types accepted by entity and field mapping validation. Adapter support can be a smaller subset.
/// Allowed values: `account`, `account_class`, `account_group`, `account_type`, `accounting_period`, `agenda`, `agenda_item`, `appointment`, `appointment_image`, `appointment_occurrence`, `appointment_template_image`, `attachments`, `avatar`, `booking`, `bulkletter_template`, `client`, `cost_center`, `custom_module`, `donation_attachment_template`, `donation_cover_letter_template`, `eubp_attachment`, `eubp_submission`, `event`, `eventchat`, `familyavatar`, `file`, `finance_template`, `follow_up`, `further_link`, `group`, ….
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
pub entries: SyncFieldMappingEntries,
/// Configured external connection with masked access credentials.
#[serde(rename = "externalSystem")]
pub external_system: ExternalSystem,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored directional field mapping. No separate entry ID is returned.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FieldMappingEntry {
/// Source field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub from: String,
/// Adapter-specific source-field qualifier.
#[serde(rename = "fromFilter", deserialize_with = "crate::lenient::string")]
pub from_filter: String,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub others: serde_json::Value,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Target field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub to: String,
/// Adapter-specific target-field qualifier.
#[serde(rename = "toFilter", deserialize_with = "crate::lenient::string")]
pub to_filter: String,
#[serde(rename = "valueMapping", default, skip_serializing_if = "serde_json::Value::is_null")]
pub value_mapping: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Display-metadata update for every attachment of a domain object.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileDomainUpdate {
/// Display name assigned to every matching file.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Sort key assigned to every matching file.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stores a URL as an attachment without downloading its target. The selected category’s file-save hooks still run.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileLinkCreate {
/// Display name. The URL is used when no name is supplied.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Attachment security level.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<Option<i64>>,
/// Absolute URL to store.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileMetaData {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "createdPerson", default, skip_serializing_if = "serde_json::Value::is_null")]
pub created_person: serde_json::Value,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "serde_json::Value::is_null")]
pub modified_person: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// File or Link for a specific domain type. E.g. uploaded music file for songs or avatar of a person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileOrLink {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// ChurchTools Domain Type. Where does this file belong to?
#[serde(rename = "domainType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_type: Option<String>,
/// Link to external website or link to file in ChurchTools
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_url: Option<String>,
/// Filename of uploaded file or name of the link
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
/// Name of that file, when it's been uploaded
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates one file and optionally copies it to another attachment context.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileUpdate {
/// Display name assigned to every matching file.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Sort key assigned to every matching file.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Target attachment context to which the file is copied.
#[serde(rename = "copyTo", default, skip_serializing_if = "Option::is_none")]
pub copy_to: Option<FileUpdateCopyTo>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Target attachment context to which the file is copied.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileUpdateCopyTo {
/// Target identifier.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
/// Target attachment category.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Metadata returned after upload. The `attachments` category does not create a database file record and returns `id: null`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FileUploadResult {
/// Domain-specific extra data. Empty for most files (serialized as an empty array), but some domains add a key-value object (e.g. statement uploads return `{ "statementId": 1 }`).
#[serde(rename = "additionalInfos", deserialize_with = "crate::lenient::map")]
pub additional_infos: std::collections::BTreeMap<String, serde_json::Value>,
/// Whether the image was generated by artificial intelligence.
#[serde(rename = "aiGenerated")]
pub ai_generated: bool,
/// Image credit or attribution.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Attribution link.
#[serde(rename = "annotationLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation_link: Option<String>,
/// File or image description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Attachment-context identifier; its meaning depends on `domainType`.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
/// Stored attachment category. Internal categories may not be accepted by the domain-based file routes.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Absolute download URL or external link URL.
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::string")]
pub file_url: String,
/// Storage filename/hash for a binary file, or the target URL for a link. name is the user-facing display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
/// Image dimensions calculated from the file.
#[serde(rename = "imageMetadata", default, skip_serializing_if = "Option::is_none")]
pub image_metadata: Option<CtFileImageMetadata>,
#[serde(rename = "imageOption", default, skip_serializing_if = "Option::is_none")]
pub image_option: Option<CtFileImageOption>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub meta: FileMetaData,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Legacy relative download URL, or an absolute external URL for a link.
#[serde(rename = "relativeUrl", deserialize_with = "crate::lenient::string")]
pub relative_url: String,
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// Whether domain lists show the file only to users who may edit its owning object.
#[serde(rename = "showOnlyWhenEditable")]
pub show_only_when_editable: bool,
/// The file size in byte
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
/// file for a stored file, link for a filename beginning with http.
/// Allowed values: `file`, `link`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Persisted file ID, or null for the special attachments category.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Finance definitions needed for one accounting period. Clients and periods include all entries visible to the caller; account types, classes, groups and tax types are installation-wide. Accounts, cost centers, tax rates, cash discounts and transaction purposes relate to the selected period.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceMasterData {
#[serde(rename = "accountClasses")]
pub account_classes: Vec<AccountClass>,
#[serde(rename = "accountGroups")]
pub account_groups: Vec<AccountGroup>,
#[serde(rename = "accountTypes")]
pub account_types: Vec<AccountType>,
#[serde(rename = "accountingPeriods")]
pub accounting_periods: Vec<AccountingPeriod>,
/// Entries for the selected period filtered by the caller’s finance permissions.
pub accounts: Vec<Account>,
/// Entries linked to accounts of the selected period; this collection has no per-account visibility filter.
#[serde(rename = "cashDiscounts")]
pub cash_discounts: Vec<CashDiscount>,
pub clients: Vec<Client>,
/// Entries for the selected period filtered by the caller’s finance permissions.
#[serde(rename = "costCenters")]
pub cost_centers: Vec<CostCenter>,
/// Entries linked to accounts of the selected period; this collection has no per-account visibility filter.
#[serde(rename = "taxRates")]
pub tax_rates: Vec<TaxRate>,
#[serde(rename = "taxTypes")]
pub tax_types: Vec<TaxType>,
/// Entries for the selected period filtered by the caller’s finance permissions.
#[serde(rename = "transactionPurposes")]
pub transaction_purposes: Vec<TransactionPurpose>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored finance-template JSON file, with counts of the definitions it contains. These files describe a chart of accounts for reuse in another accounting period.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplate {
pub counts: FinanceTemplateCounts,
/// File-domain identifier, if assigned.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_identifier: Option<String>,
/// Allowed values: `finance_template`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "relativeUrl", deserialize_with = "crate::lenient::string")]
pub relative_url: String,
/// Stored file security level, if assigned.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// File size in bytes, or null when unavailable.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable account definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateAccount {
/// Parent account-group name.
#[serde(rename = "accountGroup", deserialize_with = "crate::lenient::string")]
pub account_group: String,
/// Budget in minor currency units.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<i64>,
#[serde(rename = "isDonationAccount")]
pub is_donation_account: bool,
#[serde(rename = "isMandatoryEubp")]
pub is_mandatory_eubp: bool,
#[serde(rename = "isOpeningBalanceAccount")]
pub is_opening_balance_account: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Tax-type name and percentage separated by a slash, or null.
#[serde(rename = "taxRate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub tax_rate: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable account class definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateAccountClass {
/// Parent account-type name instead of an installation-specific ID.
#[serde(rename = "accountType", deserialize_with = "crate::lenient::string")]
pub account_type: String,
#[serde(rename = "includeProfitLoss")]
pub include_profit_loss: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable account group definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateAccountGroup {
/// Parent account-class name.
#[serde(rename = "accountClass", deserialize_with = "crate::lenient::string")]
pub account_class: String,
#[serde(rename = "isCashAssetAccount")]
pub is_cash_asset_account: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable account type definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateAccountType {
/// Allowed values: `assets`, `liabilities`.
#[serde(rename = "balanceType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub balance_type: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable cash discount definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateCashDiscount {
/// Receiving account name.
#[serde(deserialize_with = "crate::lenient::string")]
pub account: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: f64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable cost center definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateCostCenter {
/// Budget in minor currency units.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub budget: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateCounts {
#[serde(rename = "accountClasses", deserialize_with = "crate::lenient::number")]
pub account_classes: i64,
#[serde(rename = "accountGroups", deserialize_with = "crate::lenient::number")]
pub account_groups: i64,
#[serde(rename = "accountTypes", deserialize_with = "crate::lenient::number")]
pub account_types: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub accounts: i64,
#[serde(rename = "costCenters", deserialize_with = "crate::lenient::number")]
pub cost_centers: i64,
#[serde(rename = "taxRates", deserialize_with = "crate::lenient::number")]
pub tax_rates: i64,
#[serde(rename = "taxTypes", deserialize_with = "crate::lenient::number")]
pub tax_types: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable chart-of-accounts definitions. Relationships use names or account numbers instead of database IDs. No transactions, client objects or accounting-period objects are included. This export is not a full-fidelity backup.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateExport {
#[serde(rename = "accountClasses")]
pub account_classes: Vec<FinanceTemplateAccountClass>,
#[serde(rename = "accountGroups")]
pub account_groups: Vec<FinanceTemplateAccountGroup>,
#[serde(rename = "accountTypes")]
pub account_types: Vec<FinanceTemplateAccountType>,
pub accounts: Vec<FinanceTemplateAccount>,
#[serde(rename = "cashDiscounts")]
pub cash_discounts: Vec<FinanceTemplateCashDiscount>,
#[serde(rename = "costCenters")]
pub cost_centers: Vec<FinanceTemplateCostCenter>,
#[serde(rename = "taxRates")]
pub tax_rates: Vec<FinanceTemplateTaxRate>,
#[serde(rename = "taxTypes")]
pub tax_types: Vec<FinanceTemplateTaxType>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable tax rate definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateTaxRate {
/// Receiving account name.
#[serde(deserialize_with = "crate::lenient::string")]
pub account: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub rate: Option<f64>,
#[serde(rename = "taxType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub tax_type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Portable tax type definition in an exported finance template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceTemplateTaxType {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FinanceYearValueComparison {
#[serde(rename = "lastYear", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub last_year: Option<i64>,
#[serde(rename = "thisYear", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub this_year: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A planned follow-up for a person, optionally associated with a group membership. dueDate is the original plan; effectiveDueDate is the currently scheduled date. doneDate marks both completed and dismissed follow-ups, which are distinguished in history rather than a separate response status. FollowUp is the older master-data type; this resource is FollowUp2 for compatibility.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUp2 {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Trimmed description; missing, null or blank becomes null.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Original planned date. May be absent/null; direct creation/update allows past dates. Omission on update clears it.
#[serde(rename = "dueDate", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "effectiveDueDate", default, skip_serializing_if = "Option::is_none")]
pub effective_due_date: Option<chrono::NaiveDate>,
/// Configured icon, or handshake when none is configured.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Person responsible for the follow-up, or null when it is handled by eligible group staff.
#[serde(rename = "ownerId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub owner_id: Option<i64>,
/// Optional fixed destination group for completion. Completion still requires the client to submit its selected successGroupId; it is not added automatically.
#[serde(rename = "successGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub success_group_id: Option<i64>,
/// Membership status assigned in the selected success group; null uses the default active status.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "successGroupMemberStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub success_group_member_status: Option<String>,
/// Optional group-type restriction for selecting a destination group on completion.
#[serde(rename = "successGroupOfGroupTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub success_group_of_group_type_id: Option<i64>,
/// Role assigned in the selected success group; null uses the membership service default.
#[serde(rename = "successRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub success_role_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "doneDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub done_date: Option<chrono::DateTime<chrono::Utc>>,
/// Group context for a membership follow-up; null for a personal follow-up.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Group-membership row ID, distinct from personId; null for personal follow-ups.
#[serde(rename = "membershipId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub membership_id: Option<i64>,
pub meta: MetaDataEntityId,
/// Allowed values: `bulk-job`, `default`, `migration`, `routine`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Person the follow-up concerns.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Completion action payload. A configured fixed group is not selected automatically; `0` also completes without a membership action.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpCompletionCreate {
/// Selected destination group. Must match a configured fixed group and/or group-type restriction. Completion can create or overwrite this person’s membership using the configured role/status defaults.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for a follow-up concerning a person, optionally within an existing group membership. The person is the subject; ownerId is the person responsible for handling it. Date fields are calendar dates, not timestamps. Only title must be nonempty; omitted/blank description is normalized to null. duration is not read by these direct CRUD endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpCreate {
/// Optional color. Missing/null uses the yellow display fallback.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// Trimmed description; missing, null or blank becomes null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Original planned date. May be absent/null; direct creation/update allows past dates. Omission on update clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<Option<chrono::NaiveDate>>,
/// Current working due date. Defaults to dueDate when omitted/null; postponement changes this independently of the original dueDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "effectiveDueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub effective_due_date: Option<Option<chrono::NaiveDate>>,
/// Optional icon name. Missing/null/blank is stored as null; responses display the handshake fallback.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<Option<String>>,
/// Responsible person ID. Personal creation defaults to the current user; group-member creation can remain unassigned. Omitted/null on update preserves the current owner.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "ownerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub owner_id: Option<Option<i64>>,
/// Optional fixed destination group for completion. Completion still requires the client to submit its selected successGroupId; it is not added automatically.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_id: Option<Option<i64>>,
/// Membership status assigned in the selected success group; null uses the default active status.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupMemberStatus", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_member_status: Option<Option<String>>,
/// Optional group-type restriction for selecting a destination group on completion.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupOfGroupTypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_of_group_type_id: Option<Option<i64>>,
/// Role assigned in the selected success group; null uses the membership service default.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successRoleId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_role_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpNoteCreate {
/// Note text.
#[serde(deserialize_with = "crate::lenient::string")]
pub comment: String,
/// Visibility category applied only to an additional person link when `also_apply_to_person=true`. Ignored for the follow-up link itself.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "commentViewerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment_viewer_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpPostponeCreate {
/// New effective date, strictly after today in server date handling. The original `dueDate` is retained.
#[serde(rename = "dueDate")]
pub due_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpResetCreate {
/// A future date overrides `effectiveDueDate`; otherwise it is restored from the original `dueDate`, which may be past or null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<Option<chrono::NaiveDate>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Mutable fields of a follow-up backed by a shared specification. The specification owns `title`, `description`, `icon`, `color` and success settings, so those fields cannot be changed through the follow-up endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpSharedUpdate {
/// Original planned date. Omission or null clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<Option<chrono::NaiveDate>>,
/// Current working due date. Defaults to dueDate when omitted/null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "effectiveDueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub effective_due_date: Option<Option<chrono::NaiveDate>>,
/// Responsible person ID. Omitted/null preserves the current owner.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "ownerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub owner_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Counts within the current user’s follow-up scope, excluding archived subject persons. Pending categories use the effective due date after postponements and the server’s current date. Completed and dismissed items both count as done. All counters are present, including zero.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpStatistics {
/// Number of completed or dismissed follow-ups (doneDate is set).
#[serde(rename = "countDone", deserialize_with = "crate::lenient::number")]
pub count_done: i64,
/// Number of pending follow-ups due after today
#[serde(rename = "countDueAfterToday", deserialize_with = "crate::lenient::number")]
pub count_due_after_today: i64,
/// Number of pending follow-ups due before today (aka 'overdue')
#[serde(rename = "countDueBeforeToday", deserialize_with = "crate::lenient::number")]
pub count_due_before_today: i64,
/// Number of pending follow-ups due today
#[serde(rename = "countDueToday", deserialize_with = "crate::lenient::number")]
pub count_due_today: i64,
/// Number of pending follow-ups without due date
#[serde(rename = "countDueUnspecified", deserialize_with = "crate::lenient::number")]
pub count_due_unspecified: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update of a follow-up backed by an unshared specification. Updating a shared specification uses `FollowUpSharedUpdate` instead. The owner cannot be unassigned through this endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FollowUpUpdate {
/// Optional color. Missing/null uses the yellow display fallback.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// Trimmed description; missing, null or blank becomes null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Original planned date. May be absent/null; direct creation/update allows past dates. Omission on update clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub due_date: Option<Option<chrono::NaiveDate>>,
/// Current working due date. Defaults to dueDate when omitted/null; postponement changes this independently of the original dueDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "effectiveDueDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub effective_due_date: Option<Option<chrono::NaiveDate>>,
/// Optional icon name. Missing/null/blank is stored as null; responses display the handshake fallback.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<Option<String>>,
/// Responsible person ID. Personal creation defaults to the current user; group-member creation can remain unassigned. Omitted/null on update preserves the current owner.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "ownerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub owner_id: Option<Option<i64>>,
/// Optional fixed destination group for completion. Completion still requires the client to submit its selected successGroupId; it is not added automatically.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_id: Option<Option<i64>>,
/// Membership status assigned in the selected success group; null uses the default active status.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupMemberStatus", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_member_status: Option<Option<String>>,
/// Optional group-type restriction for selecting a destination group on completion.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successGroupOfGroupTypeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_group_of_group_type_id: Option<Option<i64>>,
/// Role assigned in the selected success group; null uses the membership service default.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "successRoleId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub success_role_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FurtherLink {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: f64,
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct FurtherLinkCreate {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: f64,
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetCaptchaResponse {
pub parameters: GetCaptchaResponseParameters,
#[serde(deserialize_with = "crate::lenient::string")]
pub signature: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetCaptchaResponseParameters {
#[serde(deserialize_with = "crate::lenient::string")]
pub algorithm: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub cost: i64,
#[serde(rename = "expiresAt", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub expires_at: Option<i64>,
#[serde(rename = "keyLength", deserialize_with = "crate::lenient::number")]
pub key_length: i64,
#[serde(rename = "keyPrefix", deserialize_with = "crate::lenient::string")]
pub key_prefix: String,
#[serde(rename = "keySignature", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key_signature: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub nonce: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub salt: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetConfigResponse {
#[serde(rename = "_current_config_file", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub current_config_file: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub accept_datasecurity: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub access_control_allow_credentials: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub access_control_allow_origins: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<String>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_message: Option<String>,
#[serde(rename = "aiAssistantAvailable", default, skip_serializing_if = "Option::is_none")]
pub ai_assistant_available: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_available_generation_count: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_available_generation_tests: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_count: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_total_generation_count: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub allowaiassistant: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowcheckin: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedcals: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedclients: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedcwbusers: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedresources: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedservices: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedstations: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedsyncconnections: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedsyncjobs: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowedtextgenerations: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub alloweduser: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowfinance: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowldap: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowoptigemsync: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub allowsync: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub app_security_request: Option<bool>,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub auth_cache_time: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub authorized_persons: Option<String>,
/// Allowed values: `ChurchTools`, `VereinTools`.
#[serde(deserialize_with = "crate::lenient::string")]
pub brand: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub build: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_access_token: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ccli_auto_reporting_enabled: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ccli_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_last_token_refresh: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli_refresh_token: Option<String>,
#[serde(rename = "chatServer", deserialize_with = "crate::lenient::string")]
pub chat_server: String,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub chrome_active: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub chrome_binary: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcal_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_css: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_firstdayinweek: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_maincalname: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_group_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_person_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_delete_event_chat_after_x_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_group_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_before_x_days: Option<i64>,
/// A stringified array of calendar ids
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_for_calendars: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_sync_user_id: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_child: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_parent: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_standard: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_tags: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_active: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcustommodule_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_archivedeletehistory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_access_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_client_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_client_secret: Option<String>,
/// Allowed values: `false`, `true`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_connected: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_refresh_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_scopes: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_token_expiry: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_emailseparator: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lat: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lng: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_apikey: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apisecret: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_sendgroupmails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_smscmtelecom_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_smspromote_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchdb_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchfinance_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchreport_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchreport_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchreport_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchreport_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_anonymize_for_public_user: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchresource_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchresource_name_default: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_send_emails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_agendashowenumeration: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_entries_last_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_invite_persons: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_openservice_rememberdays: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_reminderhours: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_songwithcategoryasdir: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchsync_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchsync_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchsync_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchwiki_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_sortcode: Option<i64>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub cron_daily: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub cron_hour_8: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cron_last_execution: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cronjob_dbdump: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cronjob_delay: Option<i64>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub currently_mail_sending: Option<String>,
#[serde(rename = "datasecurityPrivacyDeclarationWikiLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_declaration_wiki_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub datasecurity_banner_enabled: Option<bool>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_hint: Option<String>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text: Option<String>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text_for_children: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub db_user: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub deactivate_default_login: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_phone_area_code: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub deprecation_usage_mail_last_execution: Option<String>,
/// Allowed values: `churchtools`, `own`.
#[serde(rename = "emailServer", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub encryptionkey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub env: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_api_key: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_vid: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_appointment_search: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_automation: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_custommodule: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_darkmode: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_dynamic_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_eubp: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_event_fact_widget: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_finance_donators_datatable: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_flags_ui: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_group: Option<String>,
/// Deprecated compatibility flag that is always true.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub feature_markdown_group: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_mobile_groups: Option<String>,
/// Deprecated compatibility flag that is always true.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub feature_newsfeed_comment_reactions: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_old_group_module: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_org_chart_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_permission_new: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_person_probe_filter: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_posts: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_resources_app: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_sessionless_login: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_sync: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub feature_usechurchquery: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_meta_cron_last_file_size_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_meta_cron_last_image_metadata_id: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finance_active: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_inmenu: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_name_default: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finance_sortcode: Option<String>,
#[serde(rename = "finderUrl", deserialize_with = "crate::lenient::string")]
pub finder_url: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_sync_job: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_transaction: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "hideBetaStates", default, skip_serializing_if = "Option::is_none")]
pub hide_beta_states: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub hide_all_hints: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hostingservice: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub https_only: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ical_invitation_hmac_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_extension: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external_link: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_internal: Option<String>,
#[serde(rename = "imprintWikiLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub imprint_wiki_link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub installation_verification_code: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub invite_email_text: Option<String>,
/// Whether the current user is configured as an authorized person.
#[serde(rename = "isCurrentUserAuthorizedPerson")]
pub is_current_user_authorized_person: bool,
#[serde(rename = "isPostsActive")]
pub is_posts_active: bool,
#[serde(rename = "isSamlActive", default, skip_serializing_if = "Option::is_none")]
pub is_saml_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_blog_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_onboarding_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_pr_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_rss_widget_active: Option<bool>,
/// The language code is a two-letter code that represents the language. For example, "en" for English, "de" for German, and "fr" for French.
/// Allowed values: `cn`, `de`, `en`, `es`, `fa`, `fi`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `sv`, `tw`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub language: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_cron: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_cron_finished: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_db_dump: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_import_clear: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_translation_update: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ldap_otp_enabled: Option<bool>,
#[serde(rename = "licenseSettings", default, skip_serializing_if = "Option::is_none")]
pub license_settings: Option<GetConfigResponseLicenseSettings>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub log_debug: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub login_message: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mail_enabled: Option<bool>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_sending_in_background: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_sending_starttime: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_host: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_port: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_smtpsecure: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_username: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub matomo_uri: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_uploadfile_size_kb: Option<i64>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_birthday_full: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_email: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_fax: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_group_couples: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_picture: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_salutation: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefongeschaeftlich: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefonhandy: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub memberlist_telefonprivat: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub onboarding_start: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub openai_api_key: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub openstreetmaps_enabled: Option<bool>,
/// Allowed values: `Auftrag`, `Bedenkzeit`, `Entscheidung`, `Finder`, `FinderCombo`, `Mitarbeiter`, `Testphase`, `Unbekannt`, `Vorlage/Schulung/Test`, `WebsiteCombo`, `zu löschen`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orderstatus: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub orderstatus_since_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub package: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_edit_time_limited: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_enabled: Option<bool>,
/// Allowed values: `all`, `featured_groups`, `my_groups`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_filter: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_weekdays: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_featured_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub post_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_wizard_completed: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_wizard_groups: Option<String>,
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub prevent_change_security_settings: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub prevent_export: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub prevent_manual_finance_account_creation: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory_api: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_internal: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_relationships: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub profile: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub public_channel_registry: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub public_channel_registry_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_host: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_port: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rabbitmq_config_user: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redis_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rss_widget_link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_authorized_persons: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_chat_sync: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_consolidation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_guid_sync: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_job_queueing: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_newsletter: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub safe_mode_enable_notification: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub send_data_security_mails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub session_handler: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
#[serde(rename = "showAIAssistant", default, skip_serializing_if = "Option::is_none")]
pub show_ai_assistant: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub show_remember_me: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_language: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_licensekey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_logo: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub site_offline: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_region: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_startpage: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_url: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "support-user-active-since", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub support_user_active_since: Option<chrono::DateTime<chrono::Utc>>,
pub test: bool,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub timezone: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url_metadata_url: Option<String>,
/// Allowed values: `failed`, `in_progress`, `not_verified`, `verified`.
#[serde(rename = "verificationStatus", deserialize_with = "crate::lenient::string")]
pub verification_status: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
#[serde(rename = "webchatLink", deserialize_with = "crate::lenient::string")]
pub webchat_link: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_order_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_sync_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_testphase_date: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub website_trial_user_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome_subtext: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub wget_path: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetConfigResponseLicenseSettings {
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hide_licensetab: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetGroupMemberstatusResponseItem {
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// Translated name of the member status.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetGroupsGroupIdMemberfieldsDataItemVariant1 {
/// A global person field configured for this group’s membership/signup UI. id identifies the configuration row; dbField.id identifies the underlying person field used in the /memberfields/person/{fieldId} path.
pub field: GroupMemberFieldPerson,
/// Allowed values: `person`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetGroupsGroupIdMemberfieldsDataItemVariant2 {
/// A group-specific membership field definition. Values belong to a person’s membership in this group, rather than to the person globally.
pub field: GroupMemberFieldGroup,
/// Allowed values: `group`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetGroupsIdQrcodecheckinPersonIdPdfData {
/// Absolute URL of the generated PDF; contains the ticket credential in its filename.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetInfoResponse {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// Database Build Version
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub build: Option<String>,
#[serde(rename = "shortName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
#[serde(rename = "siteName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
/// ChurchTools Version
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub version: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetLogsStatisticsLoginDataItem {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastLogin", serialize_with = "crate::datetime::serialize_utc")]
pub last_login: chrono::DateTime<chrono::Utc>,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Count of how many times a user has loged in.
#[serde(rename = "totalLogins", deserialize_with = "crate::lenient::number")]
pub total_logins: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponse {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub admin: Option<GetMenuResponseAdmin>,
#[serde(rename = "currentStation", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub current_station: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub family: Option<Vec<GetMenuResponseFamilyItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub help: Option<GetMenuResponseHelp>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub logo: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub modules: Option<Vec<GetMenuResponseModulesItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub personal: Option<GetMenuResponsePersonal>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub simulate: Option<bool>,
#[serde(rename = "siteName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub stations: Option<Vec<GetMenuResponseStationsItem>>,
#[serde(rename = "stationsCount", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub stations_count: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub user: Option<GetMenuResponseUser>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseAdmin {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<GetMenuResponseAdminActionsItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub primary: Option<Vec<GetMenuResponseAdminPrimaryItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub secondary: Option<Vec<GetMenuResponseAdminPrimaryItem>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseAdminActionsItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub href: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseAdminPrimaryItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub href: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseFamilyItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub href: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseHelp {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<GetMenuResponseHelpActionsItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub primary: Option<Vec<GetMenuResponseHelpPrimaryItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub secondary: Option<Vec<GetMenuResponseHelpSecondaryItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tertiary: Option<Vec<GetMenuResponseHelpSecondaryItem>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseHelpActionsItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseHelpPrimaryItem {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub external: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub href: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub key: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseHelpSecondaryItem {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub external: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub href: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseModulesItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub href: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponsePersonal {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<GetMenuResponseAdminPrimaryItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub primary: Option<Vec<GetMenuResponseAdminPrimaryItem>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub secondary: Option<Vec<GetMenuResponseAdminPrimaryItem>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseStationsItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub association_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub bezeichnung: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub created_pid: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub denomination: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub is_published: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub kuerzel: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub modified_pid: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub profile_type: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sign_up_group_id: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub slug: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub social_media: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sortkey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub tags: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub team_title: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visitors: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetMenuResponseUser {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub firstname: Option<String>,
#[serde(rename = "hasAdminRights", default, skip_serializing_if = "Option::is_none")]
pub has_admin_rights: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image: Option<String>,
#[serde(rename = "imageId", default, skip_serializing_if = "serde_json::Value::is_null")]
pub image_id: serde_json::Value,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub lastname: Option<String>,
#[serde(rename = "loggedIn", default, skip_serializing_if = "Option::is_none")]
pub logged_in: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPermissionsDefinitionsData {
pub modules: Vec<PermissionDefinitionModule>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPermissionsGlobalPersonSummaryData {
pub permissions: Vec<PermissionPersonSummaryEntry>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPermissionsOriginsGlobalPersonsPersonIdData {
pub permissions: Vec<PermissionWithOrigins>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPermissionsOriginsInternalPersonsPersonIdData {
pub groups: Vec<GetPermissionsOriginsInternalPersonsPersonIdDataGroupsItem>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPermissionsOriginsInternalPersonsPersonIdDataGroupsItem {
/// ID of the target group the permissions apply to
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
pub permissions: Vec<PermissionWithOrigins>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPersonsBirthdaysDataItem {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<String>,
/// Calculated age. (see note to that endpoint)
#[serde(deserialize_with = "crate::lenient::number")]
pub age: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(default, skip_serializing_if = "Option::is_none")]
pub anniversary: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "anniversaryInitialDate", default, skip_serializing_if = "Option::is_none")]
pub anniversary_initial_date: Option<chrono::NaiveDate>,
/// Actually birthday
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub date: Option<String>,
/// Person as Domain Object
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
/// Type of Date
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPersonsDuplicatesDataItem {
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub relationship_type_id: Option<i64>,
pub relationships: Vec<PersonDuplicate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPersonsIdLoginstringResponse {
/// Secret one-time credential; consume through a login link.
#[serde(rename = "loginString", deserialize_with = "crate::lenient::string")]
pub login_string: String,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetPersonsRelationshipsDataItem {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<std::collections::BTreeMap<String, String>>,
#[serde(rename = "degreeOfRelationship", default, skip_serializing_if = "serde_json::Value::is_null")]
#[deprecated = "deprecated in the ChurchTools API"]
pub degree_of_relationship: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "personAId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_a_id: Option<i64>,
#[serde(rename = "personBId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_b_id: Option<i64>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
#[serde(rename = "relationshipName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub relationship_name: Option<String>,
#[serde(rename = "relationshipType", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub relationship_type: Option<std::collections::BTreeMap<String, serde_json::Value>>,
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub relationship_type_id: Option<i64>,
#[serde(rename = "relativeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub relative_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetSearchDataItem {
/// Allowed values: `action`, `domainObject`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetSyncExternalsystemsIdFieldmappingsDomaintypeNosuggestionsDataVariant1 {
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub es: Option<std::collections::BTreeMap<String, bool>>,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub master: Option<std::collections::BTreeMap<String, bool>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GetWidgetsBlogData {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<BlogItem>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
#[serde(rename = "totalCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub total_count: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Current user’s global permission values, keyed by active module and registered permission key. Missing grants are false for flags and \[\] for selections. Maximum-level permissions return a single-element array containing the maximum (99999 for unrestricted); multiple-selection permissions expand unrestricted grants into current IDs, losing the distinction from explicit grants to all current values. Compatibility aliases can be null when their source module is absent.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissions {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcal: Option<GlobalPermissionsChurchcal>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcheckin: Option<GlobalPermissionsChurchcheckin>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcore: Option<GlobalPermissionsChurchcore>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb: Option<GlobalPermissionsChurchdb>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup: Option<GlobalPermissionsChurchgroup>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchreport: Option<GlobalPermissionsChurchreport>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource: Option<GlobalPermissionsChurchresource>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice: Option<GlobalPermissionsChurchservice>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync: Option<GlobalPermissionsChurchsync>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchwiki: Option<GlobalPermissionsChurchwiki>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finance: Option<GlobalPermissionsFinance>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post: Option<GlobalPermissionsPost>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchcal {
#[serde(rename = "admin appointment tags", default, skip_serializing_if = "Option::is_none")]
pub admin_appointment_tags: Option<bool>,
#[serde(rename = "admin church category")]
pub admin_church_category: bool,
#[serde(rename = "admin group category")]
pub admin_group_category: bool,
#[serde(rename = "admin personal category")]
pub admin_personal_category: bool,
#[serde(rename = "assistance mode")]
pub assistance_mode: bool,
#[serde(rename = "create group category")]
pub create_group_category: bool,
#[serde(rename = "create personal category")]
pub create_personal_category: bool,
#[serde(rename = "edit calendar entry template")]
pub edit_calendar_entry_template: Vec<i64>,
#[serde(rename = "edit category")]
pub edit_category: Vec<i64>,
pub view: bool,
#[serde(rename = "view category")]
pub view_category: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchcheckin {
#[serde(rename = "create person")]
pub create_person: bool,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
pub view: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchcore {
#[serde(rename = "administer church html templates")]
pub administer_church_html_templates: bool,
#[serde(rename = "administer custom modules", default, skip_serializing_if = "Option::is_none")]
pub administer_custom_modules: Option<bool>,
#[serde(rename = "administer persons")]
pub administer_persons: bool,
#[serde(rename = "administer settings")]
pub administer_settings: bool,
#[serde(rename = "edit languages")]
pub edit_languages: Vec<i64>,
#[serde(rename = "edit public profiles")]
pub edit_public_profiles: bool,
#[serde(rename = "edit translations masterdata")]
pub edit_translations_masterdata: bool,
#[serde(rename = "edit website releases")]
pub edit_website_releases: bool,
#[serde(rename = "edit website staff")]
pub edit_website_staff: bool,
#[serde(rename = "invite persons")]
pub invite_persons: bool,
#[serde(rename = "login to external system")]
pub login_to_external_system: Vec<i64>,
#[serde(rename = "simulate persons")]
pub simulate_persons: bool,
#[serde(rename = "use church html templates")]
pub use_church_html_templates: Vec<i64>,
#[serde(rename = "use churchquery", default, skip_serializing_if = "Option::is_none")]
pub use_churchquery: Option<bool>,
#[serde(rename = "view links", default, skip_serializing_if = "Option::is_none")]
pub view_links: Option<Vec<i64>>,
#[serde(rename = "view logfile")]
pub view_logfile: bool,
#[serde(rename = "view website")]
pub view_website: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchdb {
#[serde(rename = "administer global filters")]
pub administer_global_filters: bool,
/// Compatibility alias of churchgroup administer groups. Null when the corresponding module/permission is absent.
#[serde(rename = "administer groups", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub administer_groups: Option<bool>,
#[serde(rename = "complex filter")]
pub complex_filter: bool,
/// Compatibility alias of churchgroup create groups of grouptype. Null when the corresponding module/permission is absent.
#[serde(rename = "create groups of grouptype", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub create_groups_of_grouptype: Option<Vec<i64>>,
#[serde(rename = "create person")]
pub create_person: bool,
#[serde(rename = "create print labels")]
pub create_print_labels: bool,
/// Compatibility alias of churchgroup delete group. Null when the corresponding module/permission is absent.
#[serde(rename = "delete group", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub delete_group: Option<Vec<i64>>,
/// Compatibility alias of churchgroup delete groups of grouptype. Null when the corresponding module/permission is absent.
#[serde(rename = "delete groups of grouptype", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub delete_groups_of_grouptype: Option<Vec<i64>>,
#[serde(rename = "delete persons")]
pub delete_persons: bool,
#[serde(rename = "edit bulkletter")]
pub edit_bulkletter: bool,
/// Compatibility alias of churchgroup edit group. Null when the corresponding module/permission is absent.
#[serde(rename = "edit group", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_group: Option<Vec<i64>>,
#[serde(rename = "edit group memberships")]
pub edit_group_memberships: bool,
/// Compatibility alias of churchgroup edit group memberships of group. Null when the corresponding module/permission is absent.
#[serde(rename = "edit group memberships of group", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_group_memberships_of_group: Option<Vec<i64>>,
/// Compatibility alias of churchgroup edit group memberships of grouptype. Null when the corresponding module/permission is absent.
#[serde(rename = "edit group memberships of grouptype", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_group_memberships_of_grouptype: Option<Vec<i64>>,
/// Compatibility alias of churchgroup edit groups of grouptype. Null when the corresponding module/permission is absent.
#[serde(rename = "edit groups of grouptype", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_groups_of_grouptype: Option<Vec<i64>>,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
#[serde(rename = "edit person visibility")]
pub edit_person_visibility: bool,
#[serde(rename = "edit relations")]
pub edit_relations: bool,
/// Omitted when export prevention is configured; otherwise a grant flag.
#[serde(rename = "export data", default, skip_serializing_if = "Option::is_none")]
pub export_data: Option<bool>,
#[serde(rename = "push/pull archive")]
pub push_pull_archive: bool,
#[serde(rename = "security level edit own data")]
pub security_level_edit_own_data: Vec<i64>,
/// Compatibility alias of churchgroup security level group. Null when the corresponding module/permission is absent.
#[serde(rename = "security level group", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub security_level_group: Option<Vec<i64>>,
#[serde(rename = "security level person")]
pub security_level_person: Vec<i64>,
#[serde(rename = "security level view own data")]
pub security_level_view_own_data: Vec<i64>,
#[serde(rename = "send sms")]
pub send_sms: bool,
pub view: bool,
#[serde(rename = "view alldata")]
pub view_alldata: Vec<i64>,
#[serde(rename = "view archive")]
pub view_archive: bool,
#[serde(rename = "view birthdaylist", default, skip_serializing_if = "Option::is_none")]
pub view_birthdaylist: Option<bool>,
#[serde(rename = "view comments")]
pub view_comments: Vec<i64>,
/// Compatibility alias of churchgroup view group. Null when the corresponding module/permission is absent.
#[serde(rename = "view group", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub view_group: Option<Vec<i64>>,
/// Compatibility alias of churchgroup view groups of grouptype. Null when the corresponding module/permission is absent.
#[serde(rename = "view groups of grouptype", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub view_groups_of_grouptype: Option<Vec<i64>>,
#[serde(rename = "view hidden persons")]
pub view_hidden_persons: bool,
#[serde(rename = "view history", default, skip_serializing_if = "Option::is_none")]
pub view_history: Option<bool>,
#[serde(rename = "view memberliste")]
pub view_memberliste: bool,
#[serde(rename = "view person history")]
pub view_person_history: bool,
#[serde(rename = "view person tags")]
pub view_person_tags: bool,
/// Campus IDs whose persons are globally visible through this permission.
#[serde(rename = "view persons from campus")]
pub view_persons_from_campus: Vec<i64>,
#[serde(rename = "view station")]
pub view_station: Vec<i64>,
#[serde(rename = "view statistics")]
pub view_statistics: bool,
#[serde(rename = "view tags", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub view_tags: Option<bool>,
#[serde(rename = "write access")]
pub write_access: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchgroup {
#[serde(rename = "administer global views")]
pub administer_global_views: bool,
#[serde(rename = "administer groups")]
pub administer_groups: bool,
#[serde(rename = "create groups of grouptype")]
pub create_groups_of_grouptype: Vec<i64>,
#[serde(rename = "delete group")]
pub delete_group: Vec<i64>,
#[serde(rename = "delete groups of grouptype")]
pub delete_groups_of_grouptype: Vec<i64>,
#[serde(rename = "edit group")]
pub edit_group: Vec<i64>,
#[serde(rename = "edit group memberships of group")]
pub edit_group_memberships_of_group: Vec<i64>,
#[serde(rename = "edit group memberships of grouptype")]
pub edit_group_memberships_of_grouptype: Vec<i64>,
#[serde(rename = "edit groups of grouptype")]
pub edit_groups_of_grouptype: Vec<i64>,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
#[serde(rename = "security level group")]
pub security_level_group: Vec<i64>,
pub view: bool,
#[serde(rename = "view group")]
pub view_group: Vec<i64>,
#[serde(rename = "view group history")]
pub view_group_history: bool,
#[serde(rename = "view group tags")]
pub view_group_tags: bool,
#[serde(rename = "view groups of grouptype")]
pub view_groups_of_grouptype: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchreport {
pub view: bool,
#[serde(rename = "view query")]
pub view_query: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchresource {
#[serde(rename = "administer bookings")]
pub administer_bookings: Vec<i64>,
#[serde(rename = "assistance mode")]
pub assistance_mode: bool,
#[serde(rename = "create bookings")]
pub create_bookings: Vec<i64>,
#[serde(rename = "create virtual bookings")]
pub create_virtual_bookings: bool,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
pub view: bool,
#[serde(rename = "view resource")]
pub view_resource: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchservice {
#[serde(rename = "edit agenda")]
pub edit_agenda: Vec<i64>,
#[serde(rename = "edit agenda templates")]
pub edit_agenda_templates: Vec<i64>,
#[serde(rename = "edit events")]
pub edit_events: Vec<i64>,
#[serde(rename = "edit fact")]
pub edit_fact: Vec<i64>,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
#[serde(rename = "edit servicegroup")]
pub edit_servicegroup: Vec<i64>,
#[serde(rename = "edit songcategory")]
pub edit_songcategory: Vec<i64>,
#[serde(rename = "edit template")]
pub edit_template: bool,
#[serde(rename = "export facts")]
pub export_facts: bool,
#[serde(rename = "manage absent")]
pub manage_absent: bool,
#[serde(rename = "use ccli")]
pub use_ccli: bool,
pub view: bool,
#[serde(rename = "view agenda")]
pub view_agenda: Vec<i64>,
#[serde(rename = "view events")]
pub view_events: Vec<i64>,
#[serde(rename = "view fact")]
pub view_fact: Vec<i64>,
#[serde(rename = "view history")]
pub view_history: bool,
#[serde(rename = "view servicegroup")]
pub view_servicegroup: Vec<i64>,
#[serde(rename = "view song statistics")]
pub view_song_statistics: bool,
#[serde(rename = "view songcategory")]
pub view_songcategory: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchsync {
pub view: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsChurchwiki {
#[serde(rename = "edit category")]
pub edit_category: Vec<i64>,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
pub view: bool,
#[serde(rename = "view category")]
pub view_category: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsFinance {
#[serde(rename = "edit accounting period")]
pub edit_accounting_period: Vec<i64>,
#[serde(rename = "edit masterdata")]
pub edit_masterdata: bool,
pub view: bool,
#[serde(rename = "view accounting period")]
pub view_accounting_period: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GlobalPermissionsPost {
#[serde(rename = "moderate posts")]
pub moderate_posts: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// The group model structures all information in different objects: `information`, `settings`, `followUp`, and `roles`. Custom group fields are added to the root level of this model.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Group {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<std::collections::BTreeMap<String, String>>,
#[serde(rename = "averageMemberAge", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub average_member_age: Option<f64>,
#[serde(rename = "followUp", default, skip_serializing_if = "Option::is_none")]
pub follow_up: Option<GroupFollowUp>,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(rename = "hasPermissions", default, skip_serializing_if = "Option::is_none")]
pub has_permissions: Option<bool>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub information: GroupInformation,
#[serde(rename = "memberStatistics", default, skip_serializing_if = "Option::is_none")]
pub member_statistics: Option<GroupMemberStatistics>,
pub meta: MetaDataEntityId,
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_date: Option<String>,
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_person: Option<GroupModifiedPerson>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
pub permissions: GroupPermissions,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub places: Option<Vec<Address>>,
#[serde(rename = "publicPostsStatistic", default, skip_serializing_if = "Option::is_none")]
pub public_posts_statistic: Option<GroupPublicPostsStatistic>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub roles: Option<Vec<GroupRole>>,
/// You can see group fields up to this security level.
#[serde(rename = "securityLevelForGroup", deserialize_with = "crate::lenient::number")]
pub security_level_for_group: i64,
pub settings: GroupSettings,
#[serde(rename = "signupConditions", default, skip_serializing_if = "Option::is_none")]
pub signup_conditions: Option<GroupSignupConditions>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Address attached to a group, used as a meeting place. All body fields are optional and default to null. Ownership is taken from the path. This operation stores coordinates supplied by the client; it does not look them up from the postal address.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupAddressCreate {
/// Address addition. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<Option<String>>,
/// Address city. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// Optional ChurchTools color. The special values default and parent select the default or owning group color. Omitted or null clears the value.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Country code, at most two characters. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub country: Option<Option<String>>,
/// Address district. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub district: Option<Option<String>>,
/// Address icon. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<Option<String>>,
/// Coordinate as a number or decimal string. Omitted or null clears it; geographic range limits are not validated.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub latitude: serde_json::Value,
/// Coordinate as a number or decimal string. Omitted or null clears it; geographic range limits are not validated.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub longitude: serde_json::Value,
/// Address name. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Address street. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// Address zip. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement address details. Omitted fields are cleared, so send all values to retain. No body id is required; addressId comes from the URL.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupAddressUpdate {
/// Address addition. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<Option<String>>,
/// Address city. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// Optional ChurchTools color. The special values default and parent select the default or owning group color. Omitted or null clears the value.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Country code, at most two characters. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub country: Option<Option<String>>,
/// Address district. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub district: Option<Option<String>>,
/// Address icon. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<Option<String>>,
/// Coordinate as a number or decimal string. Omitted or null clears it; geographic range limits are not validated.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub latitude: serde_json::Value,
/// Coordinate as a number or decimal string. Omitted or null clears it; geographic range limits are not validated.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub longitude: serde_json::Value,
/// Address name. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Address street. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// Address zip. Whitespace is trimmed; omitted, null or blank clears the value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A thematic classification for groups, such as worship services or community activities. A group can reference a category through information.groupCategoryId. Categories are separate from group types, which define shared settings and membership roles.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupCategory {
/// ChurchTools color token used to display the category, such as blue.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Optional explanation of the category. Omitted, null or blank input is stored as null, including on update.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// ID of this master-data record in this ChurchTools installation. Use it when assigning this classification to a group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Creation and modification timestamps and person IDs for this category.
pub meta: GroupCategoryMeta,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupCategoryCreate {
/// ChurchTools color token used to display the category, such as blue.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Optional explanation of the category. Omitted, null or blank input is stored as null, including on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creation and modification timestamps and person IDs for this category.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupCategoryMeta {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "createdPerson")]
pub created_person: MetaDataPersonId,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson")]
pub modified_person: MetaDataPersonId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Options for copying a group. newName must be supplied in the JSON body or query; query values take precedence. The copy flags default to false.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupDuplicateCreate {
/// Copy memberships, including statuses, roles, comments and member field values. Archived persons are excluded; group capacity is ignored and leaders are not informed.
#[serde(rename = "copyMembers", default, skip_serializing_if = "Option::is_none")]
pub copy_members: Option<bool>,
/// Copy group-role permissions and permission inheritance settings. Locked permissions are omitted unless the current user is an authorized person.
#[serde(rename = "copyPermissions", default, skip_serializing_if = "Option::is_none")]
pub copy_permissions: Option<bool>,
/// Copy membership routines and prepare their potential runs for the new group.
#[serde(rename = "copyRoutines", default, skip_serializing_if = "Option::is_none")]
pub copy_routines: Option<bool>,
/// Name of the copy, trimmed before validation. Required in either the query or JSON body. The validator accepts up to 255 characters, but the stored group name column is limited to 100.
#[serde(rename = "newName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub new_name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Selection for a group spreadsheet export. An empty selection produces no group rows.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupExportCreate {
/// Group IDs to export. Unknown or invisible IDs are silently omitted; duplicates do not produce duplicate rows. Rows are sorted by group name, not by this array.
pub ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupFollowUp {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reminder: Option<bool>,
#[serde(rename = "typeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub type_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// The hierarchy of one group
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupHierarchy {
pub children: Vec<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<DomainObjectGroup>,
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
pub parents: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Public group homepage settings, filter definitions, and all public groups displayed on the page.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupHomepage {
/// Maps deprecated response field names to their replacements.
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Stored custom description for the group homepage header.
#[serde(rename = "customDescription", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub custom_description: Option<String>,
/// Stored custom title for the group homepage header.
#[serde(rename = "customTitle", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub custom_title: Option<String>,
/// Type how groups are listed on the page.
/// Allowed values: `list`, `minitile`, `tile`.
#[serde(rename = "defaultView", deserialize_with = "crate::lenient::string")]
pub default_view: String,
/// Stored hierarchy depth. A request depth override changes loaded groups without changing this returned setting.
#[serde(deserialize_with = "crate::lenient::number")]
pub depth: i64,
/// Description of the group that owns the group homepage.
#[serde(deserialize_with = "crate::lenient::string")]
pub description: String,
/// Header rendering choice: none hides the description, group uses description, custom uses customDescription. The API retains both stored texts regardless of this choice.
/// Allowed values: `custom`, `group`, `none`.
#[serde(rename = "descriptionMode", deserialize_with = "crate::lenient::string")]
pub description_mode: String,
/// Deprecated alias of filters.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub filter: Option<Vec<GroupHomepageFilter>>,
/// Specifies all filters that can be applied for this group homepage.
pub filters: Vec<GroupHomepageFilter>,
/// Eligible descendant groups after hierarchy loading and the current session’s public-group feature check. Parent group itself is excluded; clients may construct nesting from children IDs.
pub groups: Vec<PublicGroup>,
/// Group Homepage ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// If true, nested groups are collapsed by default.
#[serde(rename = "isCollapsed")]
pub is_collapsed: bool,
/// Whether the group homepage is enabled. Clients should not display the group homepage if it is not enabled.
#[serde(rename = "isEnabled")]
pub is_enabled: bool,
pub meta: MetaDataEntityId,
/// Name of the group homepage's parent group.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Group field to sort groups by.
/// Allowed values: `dateOfFoundation`, `name`.
#[serde(rename = "orderBy", deserialize_with = "crate::lenient::string")]
pub order_by: String,
/// Direction if groups are sorted ascending or descending.
/// Allowed values: `ASC`, `DESC`.
#[serde(rename = "orderDirection", deserialize_with = "crate::lenient::string")]
pub order_direction: String,
/// ID of the parent group of all groups that should be displayed in the group homepage
#[serde(rename = "parentGroup", deserialize_with = "crate::lenient::number")]
pub parent_group: i64,
/// The group homepage identifier (same as provided as hash request parameter).
#[serde(rename = "randomUrl", deserialize_with = "crate::lenient::string")]
pub random_url: String,
/// Deprecated alias of showFilters.
#[serde(rename = "showFilter", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub show_filter: Option<bool>,
/// If true, selected filters are displayed.
#[serde(rename = "showFilters")]
pub show_filters: bool,
/// If true, the group homepage is set to display group images.
#[serde(rename = "showGroupImages")]
pub show_group_images: bool,
/// Deprecated alias of showLeaders.
#[serde(rename = "showLeader", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub show_leader: Option<bool>,
/// If true, the group homepage is set to display the leaders of each group.
#[serde(rename = "showLeaders")]
pub show_leaders: bool,
/// Effective map-display setting: true only when both the homepage setting and the installation openstreetmaps_enabled flag are true. Meeting-place data remains in groups when false.
#[serde(rename = "showMap")]
pub show_map: bool,
/// Use 'orderBy' instead.
/// Allowed values: `dateOfFoundation`, `name`.
#[serde(rename = "sortBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use 'orderBy' instead."]
pub sort_by: Option<String>,
/// Header rendering choice: none hides the heading, group uses name, custom uses customTitle. The API returns the individual fields rather than a resolved display title.
/// Allowed values: `custom`, `group`, `none`.
#[serde(rename = "titleMode", deserialize_with = "crate::lenient::string")]
pub title_mode: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Filter definition for the homepage UI. All five types are returned, including hidden filters; options contain complete master-data catalogs rather than only options used by displayed groups.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupHomepageFilter {
/// If true, this filter is enabled on the group homepage.
pub show: bool,
/// Catalog used by this filter.
/// Allowed values: `agegroups`, `campus`, `groupcategory`, `targetgroups`, `weekday`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Available options for this filter type.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Display setting for one of the five supported homepage filters. Only entries with show=true are stored.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupHomepageFilterCreate {
/// If true, this filter is enabled on the group homepage.
pub show: bool,
/// Catalog used by this filter.
/// Allowed values: `agegroups`, `campus`, `groupcategory`, `targetgroups`, `weekday`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Upsert settings. Omitted header modes/custom text are preserved, but omitted layout/order/collapse/depth fields reset to their defaults and omitted filters disables all filters.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupHomepageUpdate {
/// Custom description. Trimmed; null or blank clears the value. Omission preserves the current value on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "customDescription", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub custom_description: Option<Option<String>>,
/// Custom heading. Trimmed; null or blank clears the value. Omission preserves the current value on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "customTitle", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub custom_title: Option<Option<String>>,
/// Initial group display layout.
/// Allowed values: `list`, `minitile`, `tile`.
#[serde(rename = "defaultView", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_view: Option<String>,
/// Maximum child hierarchy depth; 1 includes direct children. The public endpoint can override this value.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub depth: Option<i64>,
/// Header content source. Omission uses group for a new page and preserves the current setting on update.
/// Allowed values: `custom`, `group`, `none`.
#[serde(rename = "descriptionMode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description_mode: Option<String>,
/// Replaces the enabled filters in the supplied order. Omission or an empty array disables all five filters. options from read responses are ignored.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filters: Option<Vec<GroupHomepageFilterCreate>>,
/// Whether the group list starts collapsed.
#[serde(rename = "isCollapsed", default, skip_serializing_if = "Option::is_none")]
pub is_collapsed: Option<bool>,
/// Whether the public hash URL may be opened.
#[serde(rename = "isEnabled")]
pub is_enabled: bool,
/// Group field used to sort the page.
/// Allowed values: `dateOfFoundation`, `name`.
#[serde(rename = "orderBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub order_by: Option<String>,
/// Ascending or descending sort order.
/// Allowed values: `ASC`, `DESC`.
#[serde(rename = "orderDirection", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub order_direction: Option<String>,
/// Display the filter controls. Individual filter visibility is configured with filters.
#[serde(rename = "showFilters")]
pub show_filters: bool,
/// Include group images in public group details.
#[serde(rename = "showGroupImages")]
pub show_group_images: bool,
/// Include leaders in public group details.
#[serde(rename = "showLeaders")]
pub show_leaders: bool,
/// Enable the map when the global OpenStreetMap setting also permits it.
#[serde(rename = "showMap")]
pub show_map: bool,
/// Header content source. Omission uses group for a new page and preserves the current setting on update.
/// Allowed values: `custom`, `group`, `none`.
#[serde(rename = "titleMode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title_mode: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupInformation {
#[serde(rename = "ageGroupIds")]
pub age_group_ids: Vec<i64>,
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Room lifecycle status. `STARTING` awaits confirmation from the central chat service.
/// Allowed values: `NOT_STARTED`, `STARTED`, `STARTING`, `STOPPED`.
#[serde(rename = "chatStatus", deserialize_with = "crate::lenient::string")]
pub chat_status: String,
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(rename = "dateOfFoundation", default, skip_serializing_if = "Option::is_none")]
pub date_of_foundation: Option<chrono::NaiveDate>,
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::NaiveDate>,
#[serde(rename = "groupCategoryId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_category_id: Option<i64>,
#[serde(rename = "groupHomepageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_url: Option<String>,
#[serde(rename = "groupStatusId", deserialize_with = "crate::lenient::number")]
pub group_status_id: i64,
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
#[serde(rename = "imageAiGenerated", default, skip_serializing_if = "Option::is_none")]
pub image_ai_generated: Option<bool>,
#[serde(rename = "imageAnnotation", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_annotation: Option<String>,
#[serde(rename = "imageAnnotationLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_annotation_link: Option<String>,
#[serde(rename = "imageDescription", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_description: Option<String>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Allowed maximal members
#[serde(rename = "maxMembers", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub max_members: Option<i64>,
#[serde(rename = "meetingTime", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub meeting_time: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
#[serde(rename = "signUpOverrideRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sign_up_override_role_id: Option<i64>,
#[serde(rename = "targetGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub target_group_id: Option<i64>,
/// The number of the weekday. Starting with 0 = Sunday, 1 = Monday, ...
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub weekday: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One dated occurrence of a group meeting, used to record attendance, guest counts and feedback. It is separate from the group itself and its memberships. No independent end time is stored. Cancellation and completion are separate flags; completion locks check-in changes.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMeeting {
/// Compatibility metadata describing legacy date fields.
#[serde(rename = "@deprecated", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<Deprecated>,
/// Optional map from person IDs to attendance states, returned with include=attendances. Visibility and group-history permissions affect which people are included.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub attendances: Option<std::collections::BTreeMap<String, String>>,
/// Meeting notes; null when no text is stored.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Deprecated compatibility value equal to startDate.
#[serde(rename = "dateFrom", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub date_from: Option<chrono::DateTime<chrono::Utc>>,
/// Deprecated compatibility value equal to startDate.
#[serde(rename = "dateTo", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub date_to: Option<chrono::DateTime<chrono::Utc>>,
/// Legacy compatibility value equal to startDate; this is not an actual end time.
#[serde(rename = "endDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub end_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of the group this meeting belongs to.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Whether attendance editing has started. Check-in and bulk attendance changes set this flag; resetting attendance clears it. This does not mean the meeting is completed.
#[serde(rename = "hasEditingStarted")]
pub has_editing_started: bool,
/// ID of this meeting; distinct from the group ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the meeting was canceled. Canceling retains the meeting record.
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
/// Whether attendance and feedback have been marked as completed. Attendance changes through check-in endpoints are rejected while this is true.
#[serde(rename = "isCompleted")]
pub is_completed: bool,
pub meta: MetaDataEntityId,
/// Additional guest headcount entered for the meeting, or null when unspecified. This does not create person or attendance records.
#[serde(rename = "numGuests", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub num_guests: Option<i64>,
/// Recorded feedback fields and answers for this meeting. The group selects a feedback template through settings.groupMeeting.templateId.
#[serde(rename = "pollResult", default, skip_serializing_if = "Option::is_none")]
pub poll_result: Option<Vec<MeetingTemplateField>>,
/// Start of the group meeting
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Counts by attendance status. These are calculated for the meeting and are separate from numGuests.
pub statistics: GroupMeetingStatistics,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group meeting as returned by the member history endpoint. Attendance statistics are not calculated here.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMeetingForMember {
/// Compatibility metadata describing legacy date fields.
#[serde(rename = "@deprecated")]
pub deprecated: Deprecated,
/// Meeting notes; null when no text is stored.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Deprecated compatibility value equal to startDate.
#[serde(rename = "dateFrom", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub date_from: Option<chrono::DateTime<chrono::Utc>>,
/// Deprecated compatibility value equal to startDate.
#[serde(rename = "dateTo", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub date_to: Option<chrono::DateTime<chrono::Utc>>,
/// Legacy compatibility value equal to startDate; this is not an actual end time.
#[serde(rename = "endDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub end_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of the group this meeting belongs to.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Whether attendance editing has started. Check-in and bulk attendance changes set this flag; resetting attendance clears it. This does not mean the meeting is completed.
#[serde(rename = "hasEditingStarted")]
pub has_editing_started: bool,
/// ID of this meeting; distinct from the group ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the meeting was canceled. Canceling retains the meeting record.
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
/// Whether attendance and feedback have been marked as completed. Attendance changes through check-in endpoints are rejected while this is true.
#[serde(rename = "isCompleted")]
pub is_completed: bool,
pub meta: MetaDataEntityId,
/// Additional guest headcount entered for the meeting, or null when unspecified. This does not create person or attendance records.
#[serde(rename = "numGuests", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub num_guests: Option<i64>,
/// Recorded feedback fields and answers for this meeting. The group selects a feedback template through settings.groupMeeting.templateId.
#[serde(rename = "pollResult", default, skip_serializing_if = "Option::is_none")]
pub poll_result: Option<Vec<MeetingTemplateField>>,
/// Start of the group meeting
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Always an empty array on this endpoint; attendance counts are not loaded.
pub statistics: Vec<serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One person in the meeting attendance view. The person ID and attendance remain available even when a current visible active membership cannot be included.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMeetingMember {
/// True exactly when status is present.
#[serde(rename = "isCheckedIn")]
pub is_checked_in: bool,
/// Current visible active membership, or null if none is available. A null value can represent a former member or a person whose membership details are not visible.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub member: Option<GroupMember>,
/// Person ID. Use this value as memberId when changing this person's meeting attendance.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Attendance at one meeting, independent of membership status: present means recorded as attending; absent means recorded as not attending; unsure means attendance has not been decided. not-in-group is also used when no attendance record exists for that person and meeting, so it does not prove that the person is currently outside the group.
/// Allowed values: `absent`, `not-in-group`, `present`, `unsure`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Counts by attendance status. These are calculated for the meeting and are separate from numGuests.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMeetingStatistics {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub absent: Option<i64>,
#[serde(rename = "not-in-group", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub not_in_group: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub present: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub unsure: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A person’s membership in one group. The membership has its own record ID, a role defined by the group type, and an independent membership status. Use person.domainIdentifier as personId in membership endpoint URLs; id identifies the membership record. Field visibility depends on the current user’s permissions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMember {
/// Legacy response-field mapping emitted by the membership transformer.
#[serde(rename = "@deprecated")]
pub deprecated: GroupMemberDeprecated,
/// Comment about this membership. Only included when the current user can view basic group member fields.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Visible additional fields stored on this membership. Each entry identifies the group member field and its value. This is an array in responses; write requests use an object keyed by field ID.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Vec<GroupMemberFieldsItem>>,
/// Group to which this membership belongs.
pub group: GroupMemberGroup,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::string")]
pub group_member_status: String,
/// ID of the role definition for the group type, matching Role.id from GET /roles. This identifies the member’s role (for example, participant or leader); GroupRole.id identifies a group-specific role configuration.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// ID of the membership record linking the person and group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Membership end date, or null if none is set. Only included when the current user can view basic group member fields.
#[serde(rename = "memberEndDate", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<chrono::NaiveDate>,
/// Date on which the membership began (YYYY-MM-DD), or null if no start date is set.
#[serde(rename = "memberStartDate", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<chrono::NaiveDate>,
/// Newsletter subscription information, included when the member list is requested with include=newsletter.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub newsletter: Option<GroupMemberNewsletter>,
/// Person who belongs to the group. domainIdentifier is the person ID as a string.
pub person: GroupMemberPerson,
/// Requested additional person fields, keyed by field name. Values are subject to person-field permissions. Returned as an empty array when no fields were requested. These values belong to the person, whereas fields contains values belonging to this membership.
#[serde(rename = "personFields", default, skip_serializing_if = "serde_json::Value::is_null")]
pub person_fields: serde_json::Value,
/// use person.domainIdentifier (type: string) instead.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Person ID recorded as having registered this member, or null if none is recorded.
#[serde(rename = "registeredBy", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub registered_by: Option<i64>,
/// Timestamp of the most recent role change.
#[serde(rename = "roleChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub role_changed_date: chrono::DateTime<chrono::Utc>,
/// Timestamp of the most recent membership status change.
#[serde(rename = "statusChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub status_changed_date: chrono::DateTime<chrono::Utc>,
/// Person tags, included when the member list is requested with include=tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Position on the group’s waiting list, or null when no position is assigned.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group-wide capacity counters, independent of the caller’s individual member visibility. These counters have different role/status scopes and are not a partition of one common total.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberCounts {
/// Non-archived memberships in non-hidden roles of this group type, excluding to_delete; includes requested/waiting memberships.
#[serde(rename = "allPlaces", deserialize_with = "crate::lenient::number")]
pub all_places: i64,
/// maxMembers minus takenPlaces, clamped to zero. Null means no maximum is configured; requested/waiting places are not subtracted.
#[serde(rename = "freePlaces", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub free_places: Option<i64>,
/// Non-archived requested/waiting memberships in seat-counting roles of this group type. Includes entries already assigned a waiting-list position.
#[serde(rename = "requestedPlaces", deserialize_with = "crate::lenient::number")]
pub requested_places: i64,
/// Active, non-archived memberships in active, non-hidden group roles configured to count toward seats.
#[serde(rename = "takenPlaces", deserialize_with = "crate::lenient::number")]
pub taken_places: i64,
/// Subset of requestedPlaces with a non-null waiting-list position, or zero if the group’s waiting list is disabled.
#[serde(rename = "waitinglistPlaces", deserialize_with = "crate::lenient::number")]
pub waitinglist_places: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy response-field mapping emitted by the membership transformer.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberDeprecated {
#[serde(rename = "personId", deserialize_with = "crate::lenient::string")]
pub person_id: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One requested export column. Its header and format are derived from the referenced field; extra display metadata in the request is ignored.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberExportColumn {
/// Column reference. Use person., groupMemberField., relation. or group_type.. Fixed membership columns are member.comment, member.groupMemberStatus, member.groupTypeRoleName, member.memberStartDate, member.memberEndDate, member.registeredBy, member.registeredBy_fullName and member.waitingListPosition. Special columns are special.age, special.Anrede1, special.Anrede2, special.id, special.__combined_name and special.growPath. Some person fields expand to multiple columns. Unknown keys are not reliably rejected.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Version 10 column selection. Columns are emitted in pinned order followed by unpinned order; person.id is prepended to pinned when absent from both lists. Pinned columns are frozen in XLSX; CSV only preserves their ordering. An empty pair of lists still exports person.id.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberExportConfig {
/// Leading columns, frozen horizontally in XLSX.
pub pinned: Vec<GroupMemberExportColumn>,
/// Columns following the pinned columns.
pub unpinned: Vec<GroupMemberExportColumn>,
/// Current configuration version. Use the integer 10.
/// Allowed values: `10`.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Optional custom column selection. Omit config, send null or an empty object to use the default export.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberExportCreate {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub config: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Built-in full export preset. Replaces any supplied column lists and version.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberExportTemplate {
/// Select every discoverable person, relationship, group-type, special and accessible membership field.
/// Allowed values: `allin`.
#[serde(deserialize_with = "crate::lenient::string")]
pub template: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A group-specific membership field definition. Values belong to a person’s membership in this group, rather than to the person globally.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroup {
/// Compatibility mapping returned by the serializer.
#[serde(rename = "@deprecated")]
pub deprecated: GroupMemberFieldGroupDeprecated,
/// Normalized default: string for scalar field types, an array of option-ID strings for multiselect, or null when unset. Checkbox defaults are strings 0/1, numeric defaults are strings, and date/datetime defaults are formatted date strings.
#[serde(rename = "defaultValue", default, skip_serializing_if = "serde_json::Value::is_null")]
pub default_value: serde_json::Value,
/// Use `name` instead.
#[serde(rename = "fieldName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `name` instead."]
pub field_name: Option<String>,
/// Input/storage type. select and radioselect use one option, multiselect uses multiple options. text and textarea require a configured length when created. api identifies an application-specific field type.
/// Allowed values: `api`, `checkbox`, `date`, `datetime`, `multiselect`, `number`, `radioselect`, `select`, `text`, `textarea`.
#[serde(rename = "fieldTypeCode", deserialize_with = "crate::lenient::string")]
pub field_type_code: String,
/// Numeric id of the field type.
#[serde(rename = "fieldTypeId", deserialize_with = "crate::lenient::number")]
pub field_type_id: i64,
/// ID of the group this member field belongs to.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the group member field.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Maximum stored value length for member field data.
#[serde(rename = "maxLength", deserialize_with = "crate::lenient::number")]
pub max_length: i64,
/// Internal field name shown to administrators.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional field name shown in the signup form.
#[serde(rename = "nameInSignupForm", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name_in_signup_form: Option<String>,
/// Internal field description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Optional field description shown in the signup form.
#[serde(rename = "noteInSignupForm", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note_in_signup_form: Option<String>,
/// Backend-assigned options for select-like fields.
pub options: Vec<GroupMemberFieldGroupOption>,
/// Stable machine-readable key for this field.
#[serde(rename = "referenceName", deserialize_with = "crate::lenient::string")]
pub reference_name: String,
/// Whether this field is mandatory in the signup form.
#[serde(rename = "requiredInRegistrationForm")]
pub required_in_registration_form: bool,
/// Security level required to see and edit this field.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Sort order among group member fields.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether this field is shown in the signup form.
#[serde(rename = "useInRegistrationForm")]
pub use_in_registration_form: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a field on memberships of the path group. Its type is fixed after creation. The reference name is generated when omitted; defaults and choices are normalized to the field type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupCreate {
/// Default value, validated according to fieldTypeCode. Checkbox accepts booleans and supported boolean strings; number accepts numbers or numeric strings. Date/datetime require date/Zulu date-time strings. Text and textarea accept up to 4000 characters; api accepts up to 255. Select/radioselect accept an option name or ID; multiselect accepts an array, comma-separated string or JSON-encoded array of option names/IDs. Responses normalize scalar values to strings and multiselect values to arrays of option-ID strings. Null clears the default.
#[serde(rename = "defaultValue", default, skip_serializing_if = "serde_json::Value::is_null")]
pub default_value: serde_json::Value,
/// One of the ten supported field types. Unlike global database fields, text/textarea member fields do not require a length parameter and have a fixed maximum value size of 4000.
/// Allowed values: `api`, `checkbox`, `date`, `datetime`, `multiselect`, `number`, `radioselect`, `select`, `text`, `textarea`.
#[serde(rename = "fieldTypeCode", deserialize_with = "crate::lenient::string")]
pub field_type_code: String,
/// Internal field name shown to administrators.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional field name shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nameInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name_in_signup_form: Option<Option<String>>,
/// Internal field description.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Optional field description shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "noteInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note_in_signup_form: Option<Option<String>>,
/// Choices for select, radioselect or multiselect, in display order. Only name is needed; submitted IDs are discarded and new IDs are allocated. Duplicate new names are deduplicated. Omitted/null/empty creates no choices; options for other field types are not retained.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub options: Option<Option<Vec<GroupMemberFieldGroupOptionCreate>>>,
/// Optional stable machine-readable key. If omitted, it is generated from the field name.
#[serde(rename = "referenceName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub reference_name: Option<String>,
/// Whether this field is mandatory in the signup form.
#[serde(rename = "requiredInRegistrationForm")]
pub required_in_registration_form: bool,
/// Security level required to see and edit this field.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Sort order among group member fields. Defaults to 0.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Whether this field is shown in the signup form.
#[serde(rename = "useInRegistrationForm")]
pub use_in_registration_form: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility mapping returned by the serializer.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupDeprecated {
#[serde(rename = "fieldName", deserialize_with = "crate::lenient::string")]
pub field_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupOption {
/// Backend-assigned option ID serialized as a string. Update requests accept its numeric value.
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// Display value of the option.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A newly created choice. Use an object containing name; compact string entries are rejected by the current controller. Submitted compatibility IDs are discarded on create.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupOptionCreate {
/// Option display value, trimmed before storage.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Choice in a replacement option list. Include the existing numeric ID to retain a choice; omit it or use null to create a new choice.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupOptionPatch {
/// Existing option ID belonging to this field, or null for a new option.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub id: Option<Option<i64>>,
/// Display label, trimmed before storage.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial membership field update. Omitted fields are preserved. options, when supplied, replaces the full list and can modify stored member selections. Field type cannot be changed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupPatch {
/// Default value, validated according to fieldTypeCode. Checkbox accepts booleans and supported boolean strings; number accepts numbers or numeric strings. Date/datetime require date/Zulu date-time strings. Text and textarea accept up to 4000 characters; api accepts up to 255. Select/radioselect accept an option name or ID; multiselect accepts an array, comma-separated string or JSON-encoded array of option names/IDs. Responses normalize scalar values to strings and multiselect values to arrays of option-ID strings. Null clears the default.
#[serde(rename = "defaultValue", default, skip_serializing_if = "serde_json::Value::is_null")]
pub default_value: serde_json::Value,
/// Internal field name shown to administrators.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Optional field name shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nameInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name_in_signup_form: Option<Option<String>>,
/// Internal field description.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Optional field description shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "noteInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note_in_signup_form: Option<Option<String>>,
/// Full replacement list. Retain numeric IDs of existing choices; omitted choices are deleted and removed from member values. \[\] removes all choices. Current backend behavior for null rebuilds existing labels with new IDs, which also clears selections using the previous IDs; preserve the list by omitting options instead.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub options: Option<Option<Vec<GroupMemberFieldGroupOptionPatch>>>,
/// Machine-readable key, unique within this group. Changing it changes the key used by reference-name clients; existing numeric field IDs remain unchanged.
#[serde(rename = "referenceName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub reference_name: Option<String>,
/// Whether this field is mandatory in the signup form.
#[serde(rename = "requiredInRegistrationForm", default, skip_serializing_if = "Option::is_none")]
pub required_in_registration_form: Option<bool>,
/// Security level required to see and edit this field.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level: Option<i64>,
/// Sort order among group member fields. Defaults to 0.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Whether this field is shown in the signup form.
#[serde(rename = "useInRegistrationForm", default, skip_serializing_if = "Option::is_none")]
pub use_in_registration_form: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Full update of a membership field. Requires name, referenceName, securityLevel and both registration flags. Omitted notes, signup labels and defaultValue are cleared; sortKey resets to zero. Supply options with existing IDs to preserve selections.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldGroupUpdate {
/// Default value, validated according to fieldTypeCode. Checkbox accepts booleans and supported boolean strings; number accepts numbers or numeric strings. Date/datetime require date/Zulu date-time strings. Text and textarea accept up to 4000 characters; api accepts up to 255. Select/radioselect accept an option name or ID; multiselect accepts an array, comma-separated string or JSON-encoded array of option names/IDs. Responses normalize scalar values to strings and multiselect values to arrays of option-ID strings. Null clears the default.
#[serde(rename = "defaultValue", default, skip_serializing_if = "serde_json::Value::is_null")]
pub default_value: serde_json::Value,
/// Internal field name shown to administrators.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Optional field name shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nameInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name_in_signup_form: Option<Option<String>>,
/// Internal field description.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Optional field description shown in the signup form. Null or text identical to the internal name/note is stored as null, allowing the internal text to be used.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "noteInSignupForm", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note_in_signup_form: Option<Option<String>>,
/// Full replacement list; include IDs of choices to retain. \[\] removes all choices and their selections. Omission or null currently rebuilds the existing labels with new IDs and can clear previous selections. Always send existing IDs when preserving choices in PUT.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub options: Option<Option<Vec<GroupMemberFieldGroupOptionPatch>>>,
/// Machine-readable key, unique within this group. Changing it changes the key used by reference-name clients; existing numeric field IDs remain unchanged.
#[serde(rename = "referenceName", deserialize_with = "crate::lenient::string")]
pub reference_name: String,
/// Whether this field is mandatory in the signup form.
#[serde(rename = "requiredInRegistrationForm")]
pub required_in_registration_form: bool,
/// Security level required to see and edit this field.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Sort order; omission resets it to zero.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Whether this field is shown in the signup form.
#[serde(rename = "useInRegistrationForm")]
pub use_in_registration_form: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A global person field configured for this group’s membership/signup UI. id identifies the configuration row; dbField.id identifies the underlying person field used in the /memberfields/person/{fieldId} path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldPerson {
/// Whether the person field is required in this group’s signup form.
#[serde(rename = "requiredInRegistrationForm")]
pub required_in_registration_form: bool,
/// Display order among this group’s person and membership fields. Required on both create and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Underlying global field definition. Its id, rather than this resource’s id, identifies the person-field link in the API path.
#[serde(rename = "dbField")]
pub db_field: GroupMemberFieldPersonDbField,
/// Group using the person field.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the group/person-field configuration row.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Underlying global field definition. Its id, rather than this resource’s id, identifies the person-field link in the API path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldPersonDbField {
/// Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
#[serde(rename = "deleteOnArchive")]
pub delete_on_archive: bool,
/// Whether the field is enabled for normal use.
#[serde(rename = "isActive")]
pub is_active: bool,
/// Whether routines may use this field.
#[serde(rename = "isAvailableInRoutines")]
pub is_available_in_routines: bool,
/// Whether the field is available on new-person forms; primarily relevant to person categories.
#[serde(rename = "isNewPersonField")]
pub is_new_person_field: bool,
/// Configured field length.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// Legacy display-layout setting, retained for compatibility.
#[serde(rename = "lineEnding", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub line_ending: Option<String>,
/// Stored display name or translation key. nameTranslated is its localized display text.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Security-level ID governing access to this field, resolved from installation masterdata.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Abbreviated label.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Display-order value within its category.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the field may be used as a placeholder.
#[serde(rename = "useAsPlaceholder")]
pub use_as_placeholder: bool,
/// Compatibility mappings emitted by the backend.
#[serde(rename = "@deprecated")]
pub deprecated: DbFieldDeprecated,
/// Underlying database column; prefer key for API requests.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub column: Option<String>,
/// True for a custom field created by this ChurchTools installation.
#[serde(rename = "createdByChurch")]
pub created_by_church: bool,
/// Stored field category and its underlying entity table. Use internCode when creating a field.
#[serde(rename = "fieldCategory")]
pub field_category: DbFieldCategory,
/// Database-field type definition. internCode selects the input/validation behavior; the numeric ID is referenced by field definitions. The name can be a translation key.
#[serde(rename = "fieldType")]
pub field_type: DbFieldType,
/// Stored flag controlling frontend visibility; current updates reset it to false.
#[serde(rename = "hideInFrontend")]
pub hide_in_frontend: bool,
/// Field-definition ID used in /dbfields paths.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the field is marked as basic information; current updates reset it to false.
#[serde(rename = "isBasicInfo")]
pub is_basic_info: bool,
/// Whether the field is marked as non-configurable; current updates reset it to false.
#[serde(rename = "isNotConfigurable")]
pub is_not_configurable: bool,
/// Whether stored field values may be null. Custom checkbox fields are non-nullable.
#[serde(rename = "isNullable")]
pub is_nullable: bool,
/// API property name. Built-in columns are mapped to API names; custom fields normally retain their generated column name.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Localized display name for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Deprecated alias of isNotConfigurable.
#[serde(rename = "notConfigurable", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub not_configurable: Option<bool>,
/// Deprecated alias of isNullable.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub nullable: Option<bool>,
/// Optional choices, included by an unfiltered list with include\[\]=options. The row shape depends on the field. Campus and group-visibility fields use specialized representations in this expansion.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<DbFieldOption>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Upsert settings for the person-field link. Both settings are required and replace their current values.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldPersonUpdate {
/// Whether the person field is required in this group’s signup form.
#[serde(rename = "requiredInRegistrationForm")]
pub required_in_registration_form: bool,
/// Display order among this group’s person and membership fields. Required on both create and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberFieldsItem {
/// ID of the group member field definition.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Display name of the field.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Field display order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Value formatted according to the field type. Checkbox values are strings "1" or "0"; select and radioselect values are option IDs as strings or null; multiselect values are arrays of option ID strings. Date and datetime fields use YYYY-MM-DD and UTC timestamps, respectively.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group to which this membership belongs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberGroup {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectGroupDomainAttributes,
/// Allowed values: `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `users`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy membership history with snapshots immediately after and before an event. This endpoint is separate from the general history API. current/previous are both objects even for creation/removal; null fields represent absent membership state.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberHistoryEntry {
/// State after this change.
pub current: GroupMemberHistoryEntryCurrent,
/// Group whose membership changed.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// History entry ID. Use the last returned ID as offset_id to fetch older entries.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Person ID, not the membership row ID.
#[serde(rename = "memberId", deserialize_with = "crate::lenient::number")]
pub member_id: i64,
pub meta: MetaDataCreatedId,
/// Recorded source of the change; older entries can have no source.
/// Allowed values: `automatic`, `bulk-job`, `check-in`, `cron`, `default`, `duplicate-group`, `follow-up`, `group-creation`, `person-deletion`, `routine`, `self-registration`, `sign-up`, `waitinglist`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub origin: Option<String>,
/// State from the linked previous history entry, independently of filters and pagination. All fields are null when no previous snapshot exists.
pub previous: GroupMemberHistoryEntryPrevious,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// State after this change.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberHistoryEntryCurrent {
/// Membership comment at this point; empty strings and the string 0 serialize as null.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::NaiveDate>,
/// Historical field values by display name. Values and labels reflect the saved snapshot; legacy malformed numeric keys may serialize as an array. Null means no stored field snapshot.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub fields: serde_json::Value,
/// Group-type role ID at this point, or null when there is no membership.
#[serde(rename = "memberRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub member_role_id: Option<i64>,
/// Membership workflow state at this point, or null after removal/before creation.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "membershipStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub membership_status: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// State from the linked previous history entry, independently of filters and pagination. All fields are null when no previous snapshot exists.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberHistoryEntryPrevious {
/// Membership comment at this point; empty strings and the string 0 serialize as null.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::NaiveDate>,
/// Historical field values by display name. Values and labels reflect the saved snapshot; legacy malformed numeric keys may serialize as an array. Null means no stored field snapshot.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub fields: serde_json::Value,
/// Group-type role ID at this point, or null when there is no membership.
#[serde(rename = "memberRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub member_role_id: Option<i64>,
/// Membership workflow state at this point, or null after removal/before creation.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "membershipStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub membership_status: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One group meeting paired with the requested person’s recorded attendance, if any.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberMeeting {
/// Group meeting as returned by the member history endpoint. Attendance statistics are not calculated here.
#[serde(rename = "groupMeeting")]
pub group_meeting: GroupMeetingForMember,
/// Stored attendance status, or null when no attendance record exists. Null does not indicate whether the person is a current group member.
/// Allowed values: `absent`, `not-in-group`, `present`, `unsure`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub status: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Newsletter subscription information, included when the member list is requested with include=newsletter.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberNewsletter {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::map")]
pub newsletter: std::collections::BTreeMap<String, GroupMemberNewsletterPersonStatus>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberNewsletterPersonStatus {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "doiDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub doi_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "isSynced")]
pub is_synced: bool,
#[serde(rename = "isUnsubscribed")]
pub is_unsubscribed: bool,
#[serde(rename = "syncError", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sync_error: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person who belongs to the group. domainIdentifier is the person ID as a string.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberPerson {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectPersonDomainAttributes,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// user for an ordinary person; user-shield for a censored person placeholder.
/// Allowed values: `user`, `user-shield`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberShort {
/// Whether this row represents a deleted historical membership
pub deleted: bool,
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_member_status: Option<String>,
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastChange", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_change: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Statistics for one authorized requested field. Group membership fields precede person fields; request order is preserved within each set.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberStatistic {
/// Person date fields return earliest/latest records. Other fields return frequency buckets, normally sorted by descending count.
pub data: Vec<serde_json::Value>,
/// Identifies the namespace of key.
/// Allowed values: `groupMemberField`, `personField`.
#[serde(rename = "fieldType", deserialize_with = "crate::lenient::string")]
pub field_type: String,
/// Input/storage type. select and radioselect use one option, multiselect uses multiple options. text and textarea require a configured length when created. api identifies an application-specific field type.
/// Allowed values: `api`, `checkbox`, `date`, `datetime`, `multiselect`, `number`, `radioselect`, `select`, `text`, `textarea`.
#[serde(rename = "fieldTypeCode", deserialize_with = "crate::lenient::string")]
pub field_type_code: String,
/// Integer membership-field ID for groupMemberField; database field key for personField.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub key: serde_json::Value,
/// Missing values. Membership-field defaults may supply absent values; treatment differs between select-like and other field types.
#[serde(deserialize_with = "crate::lenient::number")]
pub missing: i64,
/// For membership fields and person date fields: matching non-archived memberships. For other person fields: count with non-empty values, excluding missing.
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Frequency of a stored value or option label. Multiselect memberships can contribute to several buckets.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberStatisticBucket {
/// Number of occurrences of this value.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Stored value; select-like membership fields resolve option IDs to labels.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Earliest or latest non-null value of a person date field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberStatisticDateExtreme {
/// Person as Domain Object
#[serde(rename = "domainObject")]
pub domain_object: DomainObjectPerson,
/// Person ID for this extreme; ties are not ordered by person ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Translated earliest/latest label in the request language.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Date field value converted to a UTC timestamp.
#[serde(serialize_with = "crate::datetime::serialize_utc")]
pub value: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMemberStatistics {
#[serde(deserialize_with = "crate::lenient::number")]
pub active: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub leaders: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub participants: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub requested: f64,
/// Members in counted roles with a status selected in settings.statusesCountedTowardsSeats.
#[serde(rename = "seatsTaken", deserialize_with = "crate::lenient::number")]
pub seats_taken: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub to_delete: f64,
#[serde(deserialize_with = "crate::lenient::number")]
pub waiting: f64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Binds a routine to one group, group-type role and membership status. Matching memberships use this binding to select their automation; the nested routine contains configuration, not execution history.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMembershipRoutine {
/// Group using this routine.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::string")]
pub group_member_status: String,
/// Group-type role ID for which this binding applies.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// ID of this role/status binding, distinct from routine.id.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Automation definition, including enabled and disabled steps as a nested tree. Domain context bindings and per-membership execution progress are separate resources.
pub routine: Routine,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create-if-missing binding request. On an existing binding the current backend ignores routineId and returns the original routine. For a new binding routineId is required to avoid a server error.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupMembershipRoutineUpdate {
/// ID of an existing routine with no steps. Needed when creating a binding; ignored if a binding already exists for this path.
#[serde(rename = "routineId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub routine_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupModifiedPerson {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupPermissions {
/// Current user can start chat.
#[serde(rename = "startChat")]
pub start_chat: bool,
/// Current user can use the chat.
#[serde(rename = "useChat")]
pub use_chat: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Counts currently published, unexpired, non-banned posts by their configured group visibility. Both counters are always present.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupPostStatistics {
/// Posts restricted to group members.
#[serde(deserialize_with = "crate::lenient::number")]
pub group_intern: i64,
/// Posts visible to people who can see the group.
#[serde(deserialize_with = "crate::lenient::number")]
pub group_visible: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupPublicPostsStatistic {
#[serde(deserialize_with = "crate::lenient::number")]
pub count: f64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastPostDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_post_date: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored check-in ticket for one person and group. A ticket is distinct from membership and attendance: reading it does not create a membership or check the person in. Ticket lifecycle timestamps may remain null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupQRCodeCheckin {
/// ChurchTools group ID.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Ticket domain for these routes.
/// Allowed values: `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Most recent PDF-link generation recorded as downloaded; this does not prove the PDF was retrieved.
#[serde(rename = "downloadedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub downloaded_date: Option<chrono::DateTime<chrono::Utc>>,
/// Optional ticket expiry. Group check-in tickets are currently created without an expiry.
#[serde(rename = "expiryDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub expiry_date: Option<chrono::DateTime<chrono::Utc>>,
/// Whether an email job is currently queued; this does not confirm delivery.
#[serde(rename = "isQueued")]
pub is_queued: bool,
/// Person for whom the ticket was issued.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Most recent recorded email-send time; null until marked sent.
#[serde(rename = "sentDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sent_date: Option<chrono::DateTime<chrono::Utc>>,
/// Opaque ticket credential encoded with the person/group IDs in the QR code.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Most recent recorded ticket use; this field alone does not prove attendance was successfully saved.
#[serde(rename = "usedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub used_date: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A shared group-type role combined with its settings for one concrete group. id identifies this group's role settings; groupTypeRoleId identifies the shared definition. growPathId is also group-specific. The inherited name, type and default/hidden flags describe the shared definition.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupRole {
/// ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// Growth-path association for this role in this group, or null when none is set. This is the group-specific value, not the value of the shared role definition.
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
/// Whether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
#[serde(rename = "isHidden")]
pub is_hidden: bool,
/// Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
#[serde(rename = "isLeader", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead; this field is not used to create or update a role."]
pub is_leader: Option<bool>,
/// Stored name of the role. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Abbreviated label for the role, used in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order among roles. Lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Functional classification of the role. Multiple roles with different names can share the same classification.
/// Allowed values: `leader`, `participant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// ID of the role settings record for this group. Use this ID in PATCH /groups/{groupId}/roles/{roleId}.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Whether members in this role are allowed to read the group chat.
#[serde(rename = "canReadChat")]
pub can_read_chat: bool,
/// Whether members in this role are allowed to write in the group chat.
#[serde(rename = "canWriteChat")]
pub can_write_chat: bool,
/// Whether memberships in this role count towards the group's participant capacity.
#[serde(rename = "countsTowardsSeats")]
pub counts_towards_seats: bool,
/// Whether members in this role are required to use two-factor authentication.
#[serde(rename = "forceTwoFactorAuth")]
pub force_two_factor_auth: bool,
/// ID of the shared role definition from GET /group/roles. This differs from id, which identifies the settings for this group.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// IDs of HTML templates available for membership documents in this role; null when no template list is stored.
#[serde(rename = "htmlTemplateIds", default, skip_serializing_if = "Option::is_none")]
pub html_template_ids: Option<Vec<i64>>,
/// Whether this role is enabled for use in this group. This is a role setting, separate from an individual person's membership status.
#[serde(rename = "isActive")]
pub is_active: bool,
/// Whether members in this role receive a QR code for group check-in.
#[serde(rename = "receiveQRCode")]
pub receive_qr_code: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Change only the supplied settings for a role in one group; omitted fields retain their current values.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupRoleUpdate {
/// Allow members in this role to read the group chat.
#[serde(rename = "canReadChat", default, skip_serializing_if = "Option::is_none")]
pub can_read_chat: Option<bool>,
/// Allow members in this role to write in the group chat.
#[serde(rename = "canWriteChat", default, skip_serializing_if = "Option::is_none")]
pub can_write_chat: Option<bool>,
/// Count memberships in this role towards the group's participant capacity.
#[serde(rename = "countsTowardsSeats", default, skip_serializing_if = "Option::is_none")]
pub counts_towards_seats: Option<bool>,
/// Require members in this role to use two-factor authentication.
#[serde(rename = "forceTwoFactorAuth", default, skip_serializing_if = "Option::is_none")]
pub force_two_factor_auth: Option<bool>,
/// Set the growth-path association for this role in this group. Send null to clear it; omit the field to keep the current value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<Option<i64>>,
/// Replace the list of HTML templates available for membership documents in this role. Send an empty array to clear the list; null is not accepted. Newly added templates must support group membership documents.
#[serde(rename = "htmlTemplateIds", default, skip_serializing_if = "Option::is_none")]
pub html_template_ids: Option<Vec<i64>>,
/// Enable or disable this role in the group. The default role cannot be deactivated. This does not set the membership status of individual people.
#[serde(rename = "isActive", default, skip_serializing_if = "Option::is_none")]
pub is_active: Option<bool>,
/// Enable check-in QR codes for members in this role.
#[serde(rename = "receiveQRCode", default, skip_serializing_if = "Option::is_none")]
pub receive_qr_code: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSettings {
/// Own children are listed as option during group sign up.
#[serde(rename = "allowChildRegistration")]
pub allow_child_registration: bool,
/// It is allowed to sign up other people uring group sign up.
#[serde(rename = "allowOtherRegistration")]
pub allow_other_registration: bool,
/// People with same eMail address are listed as option during group sign up.
#[serde(rename = "allowSameEmailRegistration")]
pub allow_same_email_registration: bool,
/// Spouse is listed as option during group sign up.
#[serde(rename = "allowSpouseRegistration")]
pub allow_spouse_registration: bool,
/// Waiting list is in-/active for this group.
#[serde(rename = "allowWaitinglist")]
pub allow_waitinglist: bool,
/// If set (together with appointmentStartDate), the group is a signup group for the specified appointment
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub appointment_id: Option<i64>,
/// If set (together with appointmentId), the group is a signup group for the specified appointment
#[serde(rename = "appointmentStartDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub appointment_start_date: Option<chrono::DateTime<chrono::Utc>>,
/// Indicator if applications are accepted automatically.
#[serde(rename = "autoAccept")]
pub auto_accept: bool,
/// In combination with waiting list: People automatically move up in waiting list.
#[serde(rename = "automaticMoveUp")]
pub automatic_move_up: bool,
/// Indicator whether the chat history should be visible for new chat group members.
#[serde(rename = "chatHistoryVisible")]
pub chat_history_visible: bool,
/// Default value for whether posts can be commented on.
#[serde(rename = "defaultPostCommentsActive")]
pub default_post_comments_active: bool,
/// Default value for post notification scope.
/// Allowed values: `group_intern`, `group_visible`.
#[serde(rename = "defaultPostNotificationScope", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_post_notification_scope: Option<String>,
/// Default placeholder text for entering post content.
#[serde(rename = "defaultPostPlaceholderText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_post_placeholder_text: Option<String>,
/// Allowed values: `group_intern`, `group_visible`.
#[serde(rename = "defaultPostVisibility", deserialize_with = "crate::lenient::string")]
pub default_post_visibility: String,
/// Rule set for dynamic group update.
#[serde(rename = "dynamicGroupRuleSet", default, skip_serializing_if = "Option::is_none")]
pub dynamic_group_rule_set: Option<Vec<DynamicGroupRule>>,
/// Controls automatic membership refresh: active participates in scheduled and manual refreshes; manual allows explicit refresh only; inactive blocks both; none disables dynamic-group behavior without deleting stored rules or existing memberships. Null in group resources means no explicit status is stored.
/// Allowed values: `active`, `inactive`, `manual`, `none`.
#[serde(rename = "dynamicGroupStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub dynamic_group_status: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "dynamicGroupUpdateFinished", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub dynamic_group_update_finished: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "dynamicGroupUpdateStarted", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub dynamic_group_update_started: Option<chrono::DateTime<chrono::Utc>>,
/// Controls email verification for anonymous group signups.
/// Allowed values: `all`, `existing`, `none`.
#[serde(rename = "emailVerificationMode", deserialize_with = "crate::lenient::string")]
pub email_verification_mode: String,
/// Indicator if posts of this groups are featured to subscribe
#[serde(rename = "externalPostSubscriptionsEnabled")]
pub external_post_subscriptions_enabled: bool,
#[serde(rename = "groupMeeting")]
pub group_meeting: GroupSettingsGroupMeeting,
#[serde(rename = "inStatistic")]
pub in_statistic: bool,
/// Inform leader via e-mail about changes.
#[serde(rename = "informLeader")]
pub inform_leader: bool,
#[serde(rename = "isHidden")]
pub is_hidden: bool,
/// Indicator if people can sign up for group membership.
#[serde(rename = "isOpenForMembers")]
pub is_open_for_members: bool,
#[serde(rename = "isPublic")]
pub is_public: bool,
/// The maximum number of group members in counted roles and statuses.
#[serde(rename = "maxMembers", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_members: Option<i64>,
/// Campus, status, and department for newly created persons.
#[serde(rename = "newMember")]
pub new_member: GroupSettingsNewMember,
#[serde(rename = "postsEnabled")]
pub posts_enabled: bool,
/// QR Codes are sent to participants, which can be used during check-in
#[serde(rename = "qrCodeCheckin")]
pub qr_code_checkin: bool,
/// QR Codes are not automatically sent via email
#[serde(rename = "qrCodeCheckinAutomaticEmail")]
pub qr_code_checkin_automatic_email: bool,
/// Send default sign up email to new members.
#[serde(rename = "sendDefaultSignUpMail")]
pub send_default_sign_up_mail: bool,
#[serde(rename = "showStreet")]
pub show_street: bool,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "signUpClosingDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sign_up_closing_date: Option<chrono::DateTime<chrono::Utc>>,
/// Email is required for all participants during group sign up (spouse, children, others).
#[serde(rename = "signUpEmailRequiredForAll", default, skip_serializing_if = "Option::is_none")]
pub sign_up_email_required_for_all: Option<bool>,
/// Headline for group sign up.
#[serde(rename = "signUpHeadline", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sign_up_headline: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "signUpNotificationSentDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sign_up_notification_sent_date: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "signUpOpeningDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sign_up_opening_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "signUpOverrideRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sign_up_override_role_id: Option<i64>,
/// Membership statuses that occupy seats when their role counts towards seats. Defaults to active only. An empty array means no membership occupies a seat.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "statusesCountedTowardsSeats")]
pub statuses_counted_towards_seats: Vec<String>,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
/// Maximum number of persons on waiting list.
#[serde(rename = "waitinglistMaxPersons", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_max_persons: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSettingsGroupMeeting {
/// Automatically create group meetings.
#[serde(rename = "autoCreate")]
pub auto_create: bool,
/// Template for group meetings.
#[serde(rename = "templateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub template_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Campus, status, and department for newly created persons.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSettingsNewMember {
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(rename = "departmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub department_id: Option<i64>,
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Specifies conditions required to sign up in this group. Not all conditions apply to any user, e.g. some of the conditions only apply to users that are not logged in.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSignUpConditions {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
#[serde(rename = "atLeastOneLeaderCanCreateNewPerson")]
pub at_least_one_leader_can_create_new_person: bool,
/// If false, none of the group's leaders have an email address set. Only persons already signed in can sign up.
#[serde(rename = "canContactLeader")]
pub can_contact_leader: bool,
#[serde(rename = "canSignUp")]
pub can_sign_up: bool,
#[serde(rename = "canSignUpAsNewPerson")]
pub can_sign_up_as_new_person: bool,
#[serde(rename = "defaultRoleSetInGroup", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub default_role_set_in_group: Option<bool>,
/// If false, the group's end date has passed and nobody can sign up.
#[serde(rename = "endDateNotPassed")]
pub end_date_not_passed: bool,
#[serde(rename = "groupAllowsWaitinglist")]
pub group_allows_waitinglist: bool,
/// If false, no leader is set for the group and nobody can sign up.
#[serde(rename = "groupHasLeader")]
pub group_has_leader: bool,
#[serde(rename = "groupHasSpaceForRequests")]
pub group_has_space_for_requests: bool,
#[serde(rename = "groupHasSpaceOnWaitinglist")]
pub group_has_space_on_waitinglist: bool,
/// If false, the group is not in active state and nobody can sign up.
#[serde(rename = "groupIsActive")]
pub group_is_active: bool,
/// If false, the group's max number of members is reached and nobody can sign up.
#[serde(rename = "groupIsNotFull")]
pub group_is_not_full: bool,
/// If false, the group is set to hidden and nobody can sign up.
#[serde(rename = "groupIsNotHidden")]
pub group_is_not_hidden: bool,
/// If false, the group is not set to be open for members and nobody can sign up.
#[serde(rename = "groupIsOpenForMembers")]
pub group_is_open_for_members: bool,
/// If false, the group is not public and only users already signed in are allowed to sign up.
#[serde(rename = "groupIsPublic")]
pub group_is_public: bool,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(rename = "groupVisibility", deserialize_with = "crate::lenient::string")]
pub group_visibility: String,
/// If false, the default department for new users is not set. When persons without an account attempt to sign up, no new user accounts will be created but the group leader will be requested by mail.
#[serde(rename = "newPersonDepartmentIsSet")]
pub new_person_department_is_set: bool,
/// If false, the default station for new users is not set. When persons without an account attempt to sign up, no new user accounts will be created but the group leader will be requested by mail.
#[serde(rename = "newPersonStationIsSet")]
pub new_person_station_is_set: bool,
/// If false, the default status for new users is not set. When persons without an account attempt to sign up, no new user accounts will be created but the group leader will be requested by mail.
#[serde(rename = "newPersonStatusIsSet")]
pub new_person_status_is_set: bool,
/// If false, the sign-up role is not set for the group and nobody can sign up when that role is required.
#[serde(rename = "signUpRoleSetInGroup")]
pub sign_up_role_set_in_group: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Options for sending or previewing the group sign-up notification. The body is optional.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSignUpNotificationRequest {
/// Preview recipient selection without sending or marking the group as notified. Can also be supplied as a query parameter; use only one location.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub dry_run: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Recipient selection count for a group sign-up push notification. This endpoint returns the object directly, without a data wrapper.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSignUpNotificationResult {
/// Number of selected recipient rows, also in dry runs. A person with multiple registered push devices can be counted multiple times. This is not a count of unique persons or confirmed deliveries.
#[serde(rename = "sentToCount", deserialize_with = "crate::lenient::number")]
pub sent_to_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupSignupConditions {
#[serde(rename = "canContactLeader")]
pub can_contact_leader: bool,
#[serde(rename = "canSignUp")]
pub can_sign_up: bool,
#[serde(rename = "canSignUpAsNewPerson")]
pub can_sign_up_as_new_person: bool,
#[serde(rename = "defaultRoleSetInGroup")]
pub default_role_set_in_group: bool,
#[serde(rename = "endDateNotPassed")]
pub end_date_not_passed: bool,
#[serde(rename = "groupAllowsWaitinglist")]
pub group_allows_waitinglist: bool,
#[serde(rename = "groupHasLeader")]
pub group_has_leader: bool,
#[serde(rename = "groupHasSpaceForRequests")]
pub group_has_space_for_requests: bool,
#[serde(rename = "groupHasSpaceOnWaitinglist")]
pub group_has_space_on_waitinglist: bool,
#[serde(rename = "groupIsActive")]
pub group_is_active: bool,
#[serde(rename = "groupIsNotFull")]
pub group_is_not_full: bool,
#[serde(rename = "groupIsNotHidden")]
pub group_is_not_hidden: bool,
#[serde(rename = "groupIsOpenForMembers")]
pub group_is_open_for_members: bool,
#[serde(rename = "groupIsPublic")]
pub group_is_public: bool,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(rename = "groupVisibility", deserialize_with = "crate::lenient::string")]
pub group_visibility: String,
#[serde(rename = "newPersonDepartmentIsSet")]
pub new_person_department_is_set: bool,
#[serde(rename = "newPersonStationIsSet")]
pub new_person_station_is_set: bool,
#[serde(rename = "newPersonStatusIsSet")]
pub new_person_status_is_set: bool,
#[serde(rename = "signUpRoleSetInGroup")]
pub sign_up_role_set_in_group: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Per-role/status counts restricted to visible members, alongside capacity counters for the full group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupStatistics {
/// Histogram keyed by group-type-role ID and membership status, for example 8:active. Only visible persons/members contribute. Empty histogram serializes as \[\].
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub members: serde_json::Value,
/// Group-wide capacity counters, independent of the caller’s individual member visibility. These counters have different role/status scopes and are not a partition of one common total.
pub unfiltered: GroupMemberCounts,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupStatisticsMembersVariant1Value {
/// Number of visible memberships in this role/status.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Repeats the map key: role definition ID followed by workflow status.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupStatus {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Allowed values: `active`, `archived`, `finished`, `pending`.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A configurable type shared by groups, such as small groups or ministry teams. It defines common settings and the set of membership roles available to those groups. A group references its type through `information.groupTypeId`; a membership role describes a person's function within a group, such as leader or participant.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupType {
/// Whether eligible groups of this type are offered for membership selection when creating a person in the ChurchTools UI. This does not automatically add the person to a group or grant membership permissions.
#[serde(rename = "availableForNewPerson")]
pub available_for_new_person: bool,
/// ChurchTools color token used to display this group type; not a hexadecimal color code.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Optional explanatory text for this group type. Returned as null when no description is stored.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Whether groups of this type are expected to retain a leader. The ChurchTools UI uses this setting when removing leaders or deactivating leader roles.
#[serde(rename = "isLeaderNecessary")]
pub is_leader_necessary: bool,
/// Stored singular name of the group type. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored plural name of the group type. Use namePluralTranslated from the response for a localized display name.
#[serde(rename = "namePlural", deserialize_with = "crate::lenient::string")]
pub name_plural: String,
/// Number of child-group levels to which permissions configured for this group type are inherited. 0 disables inheritance to child groups; 1 includes direct children. This setting does not itself grant permissions.
#[serde(rename = "permissionDepth", deserialize_with = "crate::lenient::number")]
pub permission_depth: i64,
/// Whether posts are enabled for groups of this type. Access to individual groups and posts still depends on permissions.
#[serde(rename = "postsEnabled")]
pub posts_enabled: bool,
/// Short label used to identify this group type in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order of the group type. Lower values come first; this endpoint sorts equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// ID of the group type in this ChurchTools installation. Use this ID when referencing the type from a group or role.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Creation and last modification timestamps and person IDs for this group type.
pub meta: GroupTypeMeta,
/// Plural display name translated into the current language, if a translation exists.
#[serde(rename = "namePluralTranslated", deserialize_with = "crate::lenient::string")]
pub name_plural_translated: String,
/// Singular display name translated into the current language, if a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Changes the group type and migrates type-specific role references. Keys and values are group-type role IDs, not group-role row IDs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupTypeChangeUpdate {
/// ID of the target group type.
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// Map each old group-type role ID (JSON key) to its target role ID in the new type. Include every role used by memberships, settings and routines. Many-to-one mapping keeps the first mapped role settings and removes obsolete ones; it is rejected with 400 when affected membership routines cannot be merged. Missing mappings are not reliably rejected before migration.
#[serde(rename = "roleMapping", deserialize_with = "crate::lenient::map")]
pub role_mapping: std::collections::BTreeMap<String, i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupTypeCreate {
/// Whether eligible groups of this type are offered for membership selection when creating a person in the ChurchTools UI. This does not automatically add the person to a group or grant membership permissions.
#[serde(rename = "availableForNewPerson")]
pub available_for_new_person: bool,
/// ChurchTools color token used to display this group type; not a hexadecimal color code.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Optional explanatory text for this group type. Returned as null when no description is stored.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Whether groups of this type are expected to retain a leader. The ChurchTools UI uses this setting when removing leaders or deactivating leader roles.
#[serde(rename = "isLeaderNecessary")]
pub is_leader_necessary: bool,
/// Stored singular name of the group type. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored plural name of the group type. Use namePluralTranslated from the response for a localized display name.
#[serde(rename = "namePlural", deserialize_with = "crate::lenient::string")]
pub name_plural: String,
/// Number of child-group levels to which permissions configured for this group type are inherited. 0 disables inheritance to child groups; 1 includes direct children. This setting does not itself grant permissions.
#[serde(rename = "permissionDepth", deserialize_with = "crate::lenient::number")]
pub permission_depth: i64,
/// Whether posts are enabled for groups of this type. Access to individual groups and posts still depends on permissions.
#[serde(rename = "postsEnabled")]
pub posts_enabled: bool,
/// Short label used to identify this group type in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order of the group type. Lower values come first; this endpoint sorts equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creation and last modification timestamps and person IDs for this group type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupTypeMeta {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "createdPerson")]
pub created_person: MetaDataPersonId,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson")]
pub modified_person: MetaDataPersonId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One wiki category made available through the current user’s role in this group, with a limited list of latest page versions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupWikiCategoryPagesItem {
/// Category metadata with edit/delete permissions for the current user.
pub category: GroupWikiCategoryPagesItemCategory,
/// Latest page versions ordered by most recent modification then title; contains no text or previews.
pub pages: Vec<SimpleWikiPage>,
/// Total eligible latest-version pages in this category, before the per-category limit.
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Category metadata with edit/delete permissions for the current user.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupWikiCategoryPagesItemCategory {
/// Campus association, or null when no campus is assigned.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Whether files in this wiki category can be read without category-view permission. This flag does not make the wiki pages themselves public.
#[serde(rename = "fileAccessWithoutPermission")]
pub file_access_without_permission: bool,
/// Whether the category should appear in navigation menus; it is still returned by the category catalog when false.
#[serde(rename = "inMenu")]
pub in_menu: bool,
/// Category name; unlike page titles it is not trimmed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order; negative values are accepted.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Wiki category ID used in category/page endpoint URLs.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Display name translated for the current request language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Page-operation hints based on category edit rights. Populated by the category list; normally empty in create/update and embedded page categories.
pub permissions: GroupWikiCategoryPagesItemCategoryPermissions,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Page-operation hints based on category edit rights. Populated by the category list; normally empty in create/update and embedded page categories.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupWikiCategoryPagesItemCategoryPermissions {
#[serde(rename = "canDelete", default, skip_serializing_if = "Option::is_none")]
pub can_delete: Option<bool>,
#[serde(rename = "canEdit", default, skip_serializing_if = "Option::is_none")]
pub can_edit: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupedGroups {
/// Allowed values: `ageGroup`, `campus`, `groupCategory`, `groupStatus`, `groupType`, `isOpenForMembers`, `targetGroup`, `visibility`.
#[serde(rename = "groupedBy", deserialize_with = "crate::lenient::string")]
pub grouped_by: String,
#[serde(rename = "groupedGroups", deserialize_with = "crate::lenient::map")]
pub grouped_groups: std::collections::BTreeMap<String, GroupedGroupsGroupedGroupsValue>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GroupedGroupsGroupedGroupsValue {
#[serde(deserialize_with = "crate::lenient::number")]
pub all: i64,
#[serde(rename = "groupPreviews")]
pub group_previews: Vec<DomainObjectGroup>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A growth-path stage used to classify a person’s progress through group participation. Group-type roles and concrete group roles reference its ID. Person calculation selects the matching stage with the highest sortKey; this catalog is not a per-person activity history.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GrowPath {
/// Stored display color key. Create/update accept CTColor values; existing rows serialize the stored string.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
/// Stage ID referenced by roles and the calculated person growPathId.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Stored stage name or translation key.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display name translated for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Display order and priority for person-stage calculation. The highest matching sort key wins; equal keys have no explicit tie-breaker.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create a stage used by role-based person growth-path calculation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GrowPathCreate {
/// Color key accepted by the growth-path validator.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Trimmed stage name or translation key, 1–100 characters. Duplicate names are allowed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Nonnegative display order and calculation priority; defaults to 0. Larger values take precedence when a person qualifies for several stages.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement stage fields. ID comes from the URL. name and color are required; omitting sortKey resets it to 0, unlike the comment-viewer update endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct GrowPathUpdate {
/// Color key accepted by the growth-path validator.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Trimmed stage name or translation key, 1–100 characters. Duplicate names are allowed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Nonnegative display order and calculation priority; defaults to 0. Larger values take precedence when a person qualifies for several stages.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HistoryBeforeAfterValue {
#[serde(rename = "afterValue", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub after_value: Option<String>,
#[serde(rename = "afterValueTranslated", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub after_value_translated: Option<String>,
#[serde(rename = "beforeValue", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub before_value: Option<String>,
#[serde(rename = "beforeValueTranslated", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub before_value_translated: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(rename = "keyTranslated", deserialize_with = "crate::lenient::string")]
pub key_translated: String,
/// Type and serialization format of the historical value
/// Allowed values: `boolean`, `date`, `date-list`, `datetime`, `number`, `text`, `text-list`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HistoryEntry {
#[serde(deserialize_with = "crate::lenient::string")]
pub action: String,
#[serde(rename = "beforeAfterValues")]
pub before_after_values: Vec<HistoryBeforeAfterValue>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub links: Vec<HistoryLink>,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub origin: Option<String>,
#[serde(rename = "translatedTitle", deserialize_with = "crate::lenient::string")]
pub translated_title: String,
#[serde(rename = "translationArgs", deserialize_with = "crate::lenient::map")]
pub translation_args: std::collections::BTreeMap<String, String>,
#[serde(rename = "translationKey", deserialize_with = "crate::lenient::string")]
pub translation_key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HistoryLink {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub role: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored template metadata. HTML and MJML content are separate file references; retrieve the corresponding content endpoints for source text. Image assets are stored separately.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HtmlTemplate {
/// Template purpose: email for group-member emails, bulkletter for mail-merged letters, groupmember-document for membership documents, and donation-receipt-letter/attachment for donation receipt output.
/// Allowed values: `bulkletter`, `donation-receipt-attachment`, `donation-receipt-letter`, `email`, `groupmember-document`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether the template is shared for its domain. Shared availability still depends on template/domain permissions; ownership is retained even for global templates.
#[serde(rename = "isGlobal")]
pub is_global: bool,
/// Display name of the HTML template.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// ID of the stored HTML content file, or `null` if no HTML content is stored.
#[serde(rename = "htmlFileId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub html_file_id: Option<i64>,
/// ID of the HTML template.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// ID of the stored MJML content file, or `null` if no MJML content is stored.
#[serde(rename = "mjmlFileId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub mjml_file_id: Option<i64>,
/// Creator/owner of the template, including global templates; null is possible for imported or legacy ownerless records.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub owner: Option<DomainObjectPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Editor asset descriptor for one stored image upload; does not include a file ID or general file metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HtmlTemplateAssetUpload {
/// Original uploaded file name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Absolute image URL with crop=original, suitable for embedding in the template.
#[serde(deserialize_with = "crate::lenient::string")]
pub src: String,
/// Uploaded asset type used by the editor.
/// Allowed values: `image`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates template metadata owned by the current user, with independently optional HTML and MJML source files. The API stores both sources as supplied; it does not compile MJML into HTML. Membership-document and donation-receipt purposes require isGlobal=true.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HtmlTemplateCreate {
/// Template purpose: email for group-member emails, bulkletter for mail-merged letters, groupmember-document for membership documents, and donation-receipt-letter/attachment for donation receipt output.
/// Allowed values: `bulkletter`, `donation-receipt-attachment`, `donation-receipt-letter`, `email`, `groupmember-document`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether the template is shared for its domain. Shared availability still depends on template/domain permissions; ownership is retained even for global templates.
#[serde(rename = "isGlobal", default, skip_serializing_if = "Option::is_none")]
pub is_global: Option<bool>,
/// Display name of the HTML template.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Copy image asset files from this template ID after creating the new template. Does not copy HTML/MJML or rewrite embedded URLs; omit/null to copy none.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "copyAssetsFromId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub copy_assets_from_id: Option<Option<i64>>,
/// HTML source; omitted/null stores no HTML file. The nonempty string 0 is also treated as absent by the current service.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub html: Option<Option<String>>,
/// MJML editor source; omitted/null stores no MJML file. This input is not compiled or validated as MJML by this endpoint.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub mjml: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Identifier and display name of an HTML document template. This does not include template content or a generated document.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HtmlTemplateInfo {
/// Template ID used when requesting the generated membership document.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial metadata/content update. Omission or null preserves existing values; null does not delete content. HTML/MJML are independent sources and are not rendered/compiled here.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HtmlTemplateUpdate {
/// Replace HTML source when nonempty and truthy; null/omission and the string 0 preserve existing content. Empty string fails validation.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub html: Option<Option<String>>,
/// Attach a file in the html_template domain, either already belonging to this template or an unbound upload (domainId=-1) created by the current user. Evaluated after html/mjml updates; deletes other content files and clears mjmlFileId. Null/0/omission preserves the current reference.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "htmlFileId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub html_file_id: Option<Option<i64>>,
/// Change shared availability; null/omission preserves it. Membership-document and donation-receipt templates must stay global.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "isGlobal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub is_global: Option<Option<bool>>,
/// Replace MJML source independently; null/omission and the string 0 preserve it. Empty string fails validation.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub mjml: Option<Option<String>>,
/// New trimmed display name; null/omission preserves it. The current service also ignores the otherwise valid name 0.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Image {
#[serde(rename = "additionalInfos")]
pub additional_infos: Vec<String>,
#[serde(rename = "domainId", deserialize_with = "crate::lenient::string")]
pub domain_id: String,
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "fileUrl", deserialize_with = "crate::lenient::string")]
pub file_url: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "imageOption")]
pub image_option: ImageImageOption,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::string")]
pub image_url: String,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "relativeUrl", deserialize_with = "crate::lenient::string")]
pub relative_url: String,
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
#[serde(rename = "showOnlyWhenEditable")]
pub show_only_when_editable: bool,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ImageImageOption {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub crop: Option<ImageImageOptionCrop>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub focus: Option<ImageImageOptionFocus>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ImageImageOptionCrop {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub bottom: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub left: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub right: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub top: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ImageImageOptionFocus {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub x: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub y: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Image metadata returned after an update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ImageMetadataUpdateResult {
/// Whether the image was generated with AI.
#[serde(rename = "aiGenerated")]
pub ai_generated: bool,
/// Image credit or attribution.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
/// Attribution link.
#[serde(rename = "annotationLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation_link: Option<String>,
/// Image description.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Identifier of the object owning the image.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_identifier: Option<String>,
/// File domain selecting the owning resource and update policy.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Storage filename; different from the public URL hash.
#[serde(deserialize_with = "crate::lenient::string")]
pub filename: String,
/// Stored file ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Original display filename, including extension.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// File security level.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// File size in bytes.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
/// Absolute public image URL.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Image metadata update used by both image update routes.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ImageUpdate {
/// Whether the image was generated with AI.
#[serde(rename = "aiGenerated", default, skip_serializing_if = "Option::is_none")]
pub ai_generated: Option<bool>,
/// Image credit or attribution.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<Option<String>>,
/// Attribution link.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "annotationLink", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub annotation_link: Option<Option<String>>,
/// Alternative text describing the image for screen readers.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Legacy alias for `options`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub image_options: Option<Option<String>>,
/// JSON-encoded image options. `crop` contains the `top`, `right`, `bottom` and `left` margins relative to the original dimensions. `focus` contains `x` and `y` coordinates relative to the original top-left corner.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub options: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Internal permissions derived from the current user's groups linked to service roles. Global rights and other policy grants, such as event administration, are not included. This is not a complete authorization result for an API action.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalEventPermissions {
/// Event-level rights from connected groups with valid service assignments in this event. `+edit agenda` additionally requires an assignment to the current person in the relevant group. Empty when none were found.
#[serde(rename = "internalPerms", default, skip_serializing_if = "serde_json::Value::is_null")]
pub internal_perms: serde_json::Value,
/// Service-group IDs mapped to granted rights. These rights are collected across all connected service roles, independently of whether a role is assigned in this event. Empty results are serialized as \[\].
#[serde(rename = "serviceGroups", default, skip_serializing_if = "serde_json::Value::is_null")]
pub service_groups: serde_json::Value,
/// Service-role IDs mapped to granted rights. Keys are master-data service IDs, not assignment IDs. These rights are collected independently of assignments in the requested event. Empty results are serialized as \[\].
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub services: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Sparse map of granted internal group permissions. Only present keys are granted by this calculation; values are always `true`. Absence does not evaluate grants from other authorization sources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalEventRights {
#[serde(rename = "+attach file", default, skip_serializing_if = "Option::is_none")]
pub attach_file: Option<bool>,
#[serde(rename = "+edit agenda", default, skip_serializing_if = "Option::is_none")]
pub edit_agenda: Option<bool>,
#[serde(rename = "+edit event", default, skip_serializing_if = "Option::is_none")]
pub edit_event: Option<bool>,
#[serde(rename = "+edit info", default, skip_serializing_if = "Option::is_none")]
pub edit_info: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Sparse map of granted internal group permissions. Only present keys are granted by this calculation; values are always `true`. Absence does not evaluate grants from other authorization sources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalEventServiceGroupRights {
#[serde(rename = "+view absence", default, skip_serializing_if = "Option::is_none")]
pub view_absence: Option<bool>,
#[serde(rename = "+view service", default, skip_serializing_if = "Option::is_none")]
pub view_service: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Sparse map of granted internal group permissions. Only present keys are granted by this calculation; values are always `true`. Absence does not evaluate grants from other authorization sources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalEventServiceRights {
#[serde(rename = "+admin service", default, skip_serializing_if = "Option::is_none")]
pub admin_service: Option<bool>,
#[serde(rename = "+edit service", default, skip_serializing_if = "Option::is_none")]
pub edit_service: Option<bool>,
#[serde(rename = "+entry all", default, skip_serializing_if = "Option::is_none")]
pub entry_all: Option<bool>,
#[serde(rename = "+entry free", default, skip_serializing_if = "Option::is_none")]
pub entry_free: Option<bool>,
#[serde(rename = "+see history", default, skip_serializing_if = "Option::is_none")]
pub see_history: Option<bool>,
#[serde(rename = "+see reason", default, skip_serializing_if = "Option::is_none")]
pub see_reason: Option<bool>,
#[serde(rename = "+see workload", default, skip_serializing_if = "Option::is_none")]
pub see_workload: Option<bool>,
#[serde(rename = "+start event chat", default, skip_serializing_if = "Option::is_none")]
pub start_event_chat: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Current user’s group-internal values for a target group, grouped by active module. Grants come from direct role assignments and inherited superior-group assignments. Flags default to false, maximum levels to 0, and selectable permissions can be 0 when absent or integer arrays when granted. Maximum unrestricted access uses 99999. Global grants and object policies are not included.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalGroupPermissions {
/// Group-internal permission values from the churchdb module.
pub churchdb: InternalGroupPermissionsChurchdb,
/// Group-internal permission values from the churchservice module.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice: Option<InternalGroupPermissionsChurchservice>,
/// Group-internal permission values from the finance module.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finance: Option<InternalGroupPermissionsFinance>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group-internal permission values from the churchdb module.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalGroupPermissionsChurchdb {
#[serde(rename = "+add person", default, skip_serializing_if = "Option::is_none")]
pub add_person: Option<bool>,
#[serde(rename = "+admin automatic emails", default, skip_serializing_if = "Option::is_none")]
pub admin_automatic_emails: Option<bool>,
#[serde(rename = "+admin followup", default, skip_serializing_if = "Option::is_none")]
pub admin_followup: Option<bool>,
#[serde(rename = "+admin group chat", default, skip_serializing_if = "Option::is_none")]
pub admin_group_chat: Option<bool>,
/// Use "+admin group member fields" instead.
#[serde(rename = "+admin group fields", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use \"+admin group member fields\" instead."]
pub admin_group_fields: Option<bool>,
#[serde(rename = "+admin group member fields", default, skip_serializing_if = "Option::is_none")]
pub admin_group_member_fields: Option<bool>,
#[serde(rename = "+admin meetings", default, skip_serializing_if = "Option::is_none")]
pub admin_meetings: Option<bool>,
#[serde(rename = "+admin posts", default, skip_serializing_if = "Option::is_none")]
pub admin_posts: Option<bool>,
#[serde(rename = "+admin routines", default, skip_serializing_if = "Option::is_none")]
pub admin_routines: Option<bool>,
#[serde(rename = "+create group", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_group: serde_json::Value,
#[serde(rename = "+create notes", default, skip_serializing_if = "Option::is_none")]
pub create_notes: Option<bool>,
#[serde(rename = "+create post group intern", default, skip_serializing_if = "Option::is_none")]
pub create_post_group_intern: Option<bool>,
#[serde(rename = "+create post group visible", default, skip_serializing_if = "Option::is_none")]
pub create_post_group_visible: Option<bool>,
/// Legacy derived flag, returned by the single-group endpoint as the conjunction of +create post group intern and +create post group visible. Not added by the all-groups endpoint.
#[serde(rename = "+create posts", default, skip_serializing_if = "Option::is_none")]
pub create_posts: Option<bool>,
#[serde(rename = "+do followup", default, skip_serializing_if = "Option::is_none")]
pub do_followup: Option<bool>,
#[serde(rename = "+do group meeting", default, skip_serializing_if = "Option::is_none")]
pub do_group_meeting: Option<bool>,
#[serde(rename = "+edit basic group memberships", default, skip_serializing_if = "Option::is_none")]
pub edit_basic_group_memberships: Option<bool>,
#[serde(rename = "+edit group basic settings", default, skip_serializing_if = "Option::is_none")]
pub edit_group_basic_settings: Option<bool>,
/// Use "edit group member fields" instead.
#[serde(rename = "+edit group fields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use \"edit group member fields\" instead."]
pub edit_group_fields: Option<i64>,
#[serde(rename = "+edit group hierarchy", default, skip_serializing_if = "Option::is_none")]
pub edit_group_hierarchy: Option<bool>,
#[serde(rename = "+edit group infos", default, skip_serializing_if = "Option::is_none")]
pub edit_group_infos: Option<bool>,
#[serde(rename = "+edit group member fields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub edit_group_member_fields: Option<i64>,
/// Compatibility flag derived from +edit basic group memberships OR +edit group member fields.
#[serde(rename = "+edit group memberships", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_group_memberships: Option<bool>,
#[serde(rename = "+edit groupmemberstatus", default, skip_serializing_if = "Option::is_none")]
pub edit_groupmemberstatus: Option<bool>,
#[serde(rename = "+edit own group member fields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub edit_own_group_member_fields: Option<i64>,
/// Use "+edit own group member fields" instead.
#[serde(rename = "+edit own groupmemberfields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use \"+edit own group member fields\" instead."]
pub edit_own_groupmemberfields: Option<i64>,
#[serde(rename = "+edit person fields of group members", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub edit_person_fields_of_group_members: Option<i64>,
/// Use "+edit person fields of group members" instead.
#[serde(rename = "+edit persons", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use \"+edit person fields of group members\" instead."]
pub edit_persons: Option<bool>,
#[serde(rename = "+exit group", default, skip_serializing_if = "Option::is_none")]
pub exit_group: Option<bool>,
#[serde(rename = "+export group members", default, skip_serializing_if = "Option::is_none")]
pub export_group_members: Option<bool>,
#[serde(rename = "+get emails", default, skip_serializing_if = "Option::is_none")]
pub get_emails: Option<bool>,
#[serde(rename = "+invite person", default, skip_serializing_if = "Option::is_none")]
pub invite_person: Option<bool>,
#[serde(rename = "+mail group members", default, skip_serializing_if = "Option::is_none")]
pub mail_group_members: Option<bool>,
#[serde(rename = "+remove from group", default, skip_serializing_if = "Option::is_none")]
pub remove_from_group: Option<bool>,
#[serde(rename = "+see group", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub see_group: Option<i64>,
#[serde(rename = "+see group member fields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub see_group_member_fields: Option<i64>,
#[serde(rename = "+see group tags", default, skip_serializing_if = "Option::is_none")]
pub see_group_tags: Option<bool>,
/// Use "+see group member fields" instead.
#[serde(rename = "+see groupmemberfields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use \"+see group member fields\" instead."]
pub see_groupmemberfields: Option<i64>,
#[serde(rename = "+see hidden group", default, skip_serializing_if = "Option::is_none")]
pub see_hidden_group: Option<bool>,
#[serde(rename = "+see own group member fields", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub see_own_group_member_fields: Option<i64>,
#[serde(rename = "+see persons", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub see_persons: Option<i64>,
#[serde(rename = "+see tags", default, skip_serializing_if = "Option::is_none")]
pub see_tags: Option<bool>,
#[serde(rename = "+view history", default, skip_serializing_if = "Option::is_none")]
pub view_history: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group-internal permission values from the churchservice module.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalGroupPermissionsChurchservice {
#[serde(rename = "+admin service", default, skip_serializing_if = "Option::is_none")]
pub admin_service: Option<bool>,
#[serde(rename = "+attach file", default, skip_serializing_if = "Option::is_none")]
pub attach_file: Option<bool>,
#[serde(rename = "+edit agenda", default, skip_serializing_if = "Option::is_none")]
pub edit_agenda: Option<bool>,
#[serde(rename = "+edit event", default, skip_serializing_if = "Option::is_none")]
pub edit_event: Option<bool>,
#[serde(rename = "+edit info", default, skip_serializing_if = "Option::is_none")]
pub edit_info: Option<bool>,
#[serde(rename = "+edit service", default, skip_serializing_if = "Option::is_none")]
pub edit_service: Option<bool>,
#[serde(rename = "+entry all", default, skip_serializing_if = "Option::is_none")]
pub entry_all: Option<bool>,
#[serde(rename = "+entry free", default, skip_serializing_if = "Option::is_none")]
pub entry_free: Option<bool>,
#[serde(rename = "+see history", default, skip_serializing_if = "Option::is_none")]
pub see_history: Option<bool>,
#[serde(rename = "+see reason", default, skip_serializing_if = "Option::is_none")]
pub see_reason: Option<bool>,
#[serde(rename = "+see workload", default, skip_serializing_if = "Option::is_none")]
pub see_workload: Option<bool>,
#[serde(rename = "+start event chat", default, skip_serializing_if = "Option::is_none")]
pub start_event_chat: Option<bool>,
#[serde(rename = "+view absence", default, skip_serializing_if = "Option::is_none")]
pub view_absence: Option<bool>,
#[serde(rename = "+view service", default, skip_serializing_if = "Option::is_none")]
pub view_service: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Group-internal permission values from the finance module.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalGroupPermissionsFinance {
#[serde(rename = "+allow posting", default, skip_serializing_if = "Option::is_none")]
pub allow_posting: Option<bool>,
#[serde(rename = "+see cost center budgets", default, skip_serializing_if = "Option::is_none")]
pub see_cost_center_budgets: Option<bool>,
#[serde(rename = "+see cost centers", default, skip_serializing_if = "Option::is_none")]
pub see_cost_centers: Option<bool>,
#[serde(rename = "+see donators in cost centers", default, skip_serializing_if = "Option::is_none")]
pub see_donators_in_cost_centers: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Current user’s internal permission values toward a target person. Combines grants over the target person’s non-archived groups, including pending/waiting/to-delete memberships in the target group selection. This is not the target person’s own permissions or a full authorization decision.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalPersonPermissions {
pub churchdb: InternalPersonPermissionsChurchdb,
/// Only present when the service module and its person-related definitions are active.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice: Option<InternalPersonPermissionsChurchservice>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalPersonPermissionsChurchdb {
#[serde(rename = "+do followup", default, skip_serializing_if = "Option::is_none")]
pub do_followup: Option<bool>,
#[serde(rename = "+edit person fields of group members", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub edit_person_fields_of_group_members: Option<i64>,
/// Compatibility flag derived from +edit person fields of group members > 0.
#[serde(rename = "+edit persons", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub edit_persons: Option<bool>,
#[serde(rename = "+invite person", default, skip_serializing_if = "Option::is_none")]
pub invite_person: Option<bool>,
#[serde(rename = "+see persons", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub see_persons: Option<i64>,
#[serde(rename = "+see tags", default, skip_serializing_if = "Option::is_none")]
pub see_tags: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Only present when the service module and its person-related definitions are active.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct InternalPersonPermissionsChurchservice {
#[serde(rename = "+see workload", default, skip_serializing_if = "Option::is_none")]
pub see_workload: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Persisted background-job summary. The identifier is a string generated when scheduling, not an integer database ID. Execution arguments and log entries are not included.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Job {
/// Scheduling timestamp.
#[serde(rename = "createdDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of the associated business object.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<i64>,
/// Kind of business object associated with the job.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_type: Option<String>,
/// Opaque identifier returned when the job was scheduled.
#[serde(deserialize_with = "crate::lenient::string")]
pub identifier: String,
/// Whether the job was scheduled as a dry run.
#[serde(rename = "isDryRun")]
pub is_dry_run: bool,
/// Last status-update timestamp.
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
/// Registered worker job name; an extensible key, not localized display text.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored background-job status. The status-update endpoint accepts all values; the list filter accepts only `IN_PROGRESS`, `DONE`, and `ERROR`.
/// Allowed values: `CANCELED`, `DONE`, `ERROR`, `IN_PROGRESS`, `QUEUED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored sync job configuration. master means ChurchTools; ES means the configured external system.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobConfigurationReturn {
/// Whether the periodic scheduler can start this job.
#[serde(rename = "autoScheduleEnabled")]
pub auto_schedule_enabled: bool,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorES", deserialize_with = "crate::lenient::string")]
pub create_behavior_es: String,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorMaster", deserialize_with = "crate::lenient::string")]
pub create_behavior_master: String,
/// Adapter-specific defaults for newly created records on this side.
#[serde(rename = "createDefaultsES", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_es: serde_json::Value,
/// Adapter-specific defaults for newly created records on this side.
#[serde(rename = "createDefaultsMaster", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_master: serde_json::Value,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorES", deserialize_with = "crate::lenient::string")]
pub delete_behavior_es: String,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorMaster", deserialize_with = "crate::lenient::string")]
pub delete_behavior_master: String,
/// Domain supported by the adapter, such as person. Job configuration accepts adapter-specific domain names.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether matching records are linked: never, use an existing record, or merge when linking.
/// Allowed values: `alwaysMerge`, `alwaysUse`, `never`.
#[serde(rename = "linkBehavior", deserialize_with = "crate::lenient::string")]
pub link_behavior: String,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "linkData", deserialize_with = "crate::lenient::string")]
pub link_data: String,
/// Job display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "updateBehavior", deserialize_with = "crate::lenient::string")]
pub update_behavior: String,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "updateData", deserialize_with = "crate::lenient::string")]
pub update_data: String,
/// Configured external connection with masked access credentials.
#[serde(rename = "externalSystem")]
pub external_system: ExternalSystem,
/// Job configuration ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobGroupStatus {
pub jobs: JobGroupStatusJobs,
/// Name of Job Group. `__single__` is For Jobs Which don't Belong to a Group
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Total Jobs in Queue of This Job Group
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobGroupStatusJobs {
/// Number of Buried Jobs
#[serde(deserialize_with = "crate::lenient::number")]
pub buried: i64,
/// Number of Deleted Jobs (but still in Queue listed)
#[serde(deserialize_with = "crate::lenient::number")]
pub deleted: i64,
/// Number of Pending Jobs
#[serde(deserialize_with = "crate::lenient::number")]
pub pending: i64,
/// Number of Running Jobs
#[serde(deserialize_with = "crate::lenient::number")]
pub running: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Message appended to the application log for an existing background job.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobLogCreate {
/// Log message.
#[serde(rename = "logMessage", deserialize_with = "crate::lenient::string")]
pub log_message: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One diagnostic entry produced by a background or bulk job. elementId and elementName identify the job element, whose domain depends on the job.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobLogEntry {
/// Identifier of the processed element.
#[serde(rename = "elementId", deserialize_with = "crate::lenient::number")]
pub element_id: i64,
/// Display name recorded for the processed element.
#[serde(rename = "elementName", deserialize_with = "crate::lenient::string")]
pub element_name: String,
/// Source filename recorded with the diagnostic.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file: Option<String>,
/// Source line recorded with the diagnostic.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub line: Option<i64>,
/// Diagnostic text produced by the job; may be localized.
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Assigns a stored job status and emits the status-change event. It does not enqueue, interrupt or restart a worker.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct JobStatusUpdate {
/// Marks the status change as manual.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub manual: Option<bool>,
/// Stored background-job status. The status-update endpoint accepts all values; the list filter accepts only `IN_PROGRESS`, `DONE`, and `ERROR`.
/// Allowed values: `CANCELED`, `DONE`, `ERROR`, `IN_PROGRESS`, `QUEUED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates an address-label PDF for the selected visible persons. Uses stored person fields and relationship data at generation time.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LabelCreate {
/// Combine selected visible spouses linked by relationship type 2 into one label. Their addresses need not match. Birthday sorting always disables this option.
#[serde(rename = "combineSpouses", default, skip_serializing_if = "Option::is_none")]
pub combine_spouses: Option<bool>,
/// Selected person IDs. Prefer an array of integers; legacy comma-separated strings and a single integer are also accepted. Duplicate IDs do not duplicate labels. Empty selection yields no persons; nonexistent or invisible persons are omitted.
#[serde(rename = "personIds", default, skip_serializing_if = "serde_json::Value::is_null")]
pub person_ids: serde_json::Value,
/// name sorts by surname/given name; postal by country/postal code/street/name; birthday by month/day/year/name. Birthday sorting forces separate labels. Unrecognized values currently retain initial name order.
/// Allowed values: `birthday`, `name`, `postal`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sortpolicy: Option<String>,
/// A4 sheet layout: Avery3475 has 24 labels (70×36 mm), Herma4425 has 10 (105×57 mm), Herma4677 has 21 (63.5×38.1 mm).
/// Allowed values: `AveryLabels3475`, `HermaLabels4425`, `HermaLabels4677`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LabelTotals {
/// Counts regardless of missing address fields; PDF generation uses this population.
#[serde(rename = "ignoreAddress")]
pub ignore_address: LabelTotalsIgnoreAddress,
/// Counts requiring nonempty street, postal code and city after optional spouse grouping. Completeness uses stored fields, not the requesting user’s field-level visibility.
#[serde(rename = "onlyCompleteAddress")]
pub only_complete_address: LabelTotalsOnlyCompleteAddress,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Counts regardless of missing address fields; PDF generation uses this population.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LabelTotalsIgnoreAddress {
/// Count after combining selected visible spouses. It is the resulting label count, not the number of couples.
#[serde(rename = "combinedLabels", deserialize_with = "crate::lenient::number")]
pub combined_labels: i64,
/// Count with one label per visible selected person.
#[serde(rename = "totalLabels", deserialize_with = "crate::lenient::number")]
pub total_labels: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Counts requiring nonempty street, postal code and city after optional spouse grouping. Completeness uses stored fields, not the requesting user’s field-level visibility.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LabelTotalsOnlyCompleteAddress {
/// Count after combining selected visible spouses. It is the resulting label count, not the number of couples.
#[serde(rename = "combinedLabels", deserialize_with = "crate::lenient::number")]
pub combined_labels: i64,
/// Count with one label per visible selected person.
#[serde(rename = "totalLabels", deserialize_with = "crate::lenient::number")]
pub total_labels: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Read-only count request for address labels.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LabelTotalsRequest {
/// Selected person IDs. Prefer an array of integers; legacy comma-separated strings and a single integer are also accepted. Duplicate IDs do not duplicate labels. Empty selection yields no persons; nonexistent or invisible persons are omitted.
#[serde(rename = "personIds", default, skip_serializing_if = "serde_json::Value::is_null")]
pub person_ids: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Language {
/// The language code is a two-letter code that represents the language. For example, "en" for English, "de" for German, and "fr" for French.
/// Allowed values: `cn`, `de`, `en`, `es`, `fa`, `fi`, `fr`, `it`, `nl`, `pl`, `pt`, `ru`, `sv`, `tw`.
#[serde(deserialize_with = "crate::lenient::string")]
pub code: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isActive")]
pub is_active: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Deprecated raw cc_file database row with an added download URL. Numeric/boolean columns are strings, date columns use SQL datetime strings, JSON columns remain JSON text. SELECT * can expose further database columns as the schema evolves; use CtFile through /files/{id}/meta for a stable normalized contract.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LegacyFileMetadata {
/// Raw database boolean flag (0 or 1 as string).
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::string")]
pub ai_generated_yn: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub annotation_link: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub bezeichnung: String,
/// Raw SQL datetime string without a timezone suffix; not the normalized ZuluDate representation.
#[serde(deserialize_with = "crate::lenient::string")]
pub created_date: String,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub created_pid: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub domain_id: String,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id_int: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Raw SQL datetime string without a timezone suffix; not the normalized ZuluDate representation.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub expiration_date: Option<String>,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub file_size_bytes: Option<String>,
/// Raw storage filename/hash or URL.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub filename: Option<String>,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// JSON text stored in the database, not an expanded JSON object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_metadata: Option<String>,
/// JSON text stored in the database, not an expanded JSON object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_options: Option<String>,
/// Raw SQL datetime string without a timezone suffix; not the normalized ZuluDate representation.
#[serde(deserialize_with = "crate::lenient::string")]
pub modified_date: String,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub modified_pid: String,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub securitylevel_id: Option<String>,
/// Raw database boolean flag (0 or 1 as string).
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::string")]
pub showonlywheneditable_yn: String,
/// Raw database numeric value returned as a string by the legacy connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub sortkey: String,
/// Legacy download query built from filename without the file ID. For URL attachments this is still a download query, not the original external URL.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LinkingOpenGraph {
/// Allowed values: `http-error`, `success`, `timeout-short`.
#[serde(rename = "fetchStatus", deserialize_with = "crate::lenient::string")]
pub fetch_status: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub data: Option<LinkingOpenGraphData>,
/// Allowed values: `opengraph`.
#[serde(rename = "linkingType", deserialize_with = "crate::lenient::string")]
pub linking_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LinkingOpenGraphData {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub article: Option<OpenGraphArticle>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub audios: Option<Vec<OpenGraphAudio>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub book: Option<OpenGraphBook>,
/// A brief description of the OpenGraph content.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// The determiner for the noun in the content.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub determiner: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub images: Option<Vec<OpenGraphImage>>,
/// The locale of the OpenGraph object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub locale: Option<String>,
/// Alternate locales available.
#[serde(rename = "localesAlternate", default, skip_serializing_if = "Option::is_none")]
pub locales_alternate: Option<Vec<String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub music: Option<OpenGraphMusic>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub profile: Option<OpenGraphProfile>,
/// The site name of the OpenGraph object.
#[serde(rename = "siteName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
/// The title of the OpenGraph object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// The type of OpenGraph object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// The URL of the OpenGraph object.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub videos: Option<Vec<OpenGraphVideo>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A global restriction on changing one permission selection, across assignment domains. It does not revoke existing grants. Authorized persons can still modify locked assignments.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LockedPermission {
/// Numeric permission definition ID; locks may include group-internal (+) permissions as well as global permissions.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Concrete data selection, -1 to lock all selections, or null for a boolean permission. The repository always returns this field.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Permission selection to lock or unlock. dataId may be omitted for boolean permissions; selectable permissions require a non-null integer.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LockedPermissionChange {
/// Numeric permission definition ID; locks may include group-internal (+) permissions as well as global permissions.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Omit or use null for a boolean permission. For a selectable permission provide a concrete ID or -1 for all selections. Selection existence/range is currently not validated; do not send the internal storage sentinel -2147483648.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LockedPermissionState {
/// Whether the current person belongs to the installation’s authorized contact-person list. This is distinct from permission-administration rights.
#[serde(rename = "isCurrentUserAuthorizedPerson")]
pub is_current_user_authorized_person: bool,
/// All stored locks ordered by authId and dataId, including any locks for inactive or obsolete definitions.
pub permissions: Vec<LockedPermission>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Atomic additions/removals, not replacement of the full lock list. Both lists are required; empty lists are valid.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LockedPermissionUpdate {
/// Locks to add. Duplicates are collapsed and existing rows are retained.
pub add: Vec<LockedPermissionChange>,
/// Exact locks to remove. Missing rows are ignored. Removing -1 does not remove separate concrete-value locks.
pub remove: Vec<LockedPermissionChange>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// ChurchTools writes log messages for many events and changes. This can be an update for a person or the deletion of an event. You can use the log to debug your system and follow error messages. This is a versitile tool.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Log {
/// Timestamp of log
#[serde(serialize_with = "crate::datetime::serialize_utc")]
pub date: chrono::DateTime<chrono::Utc>,
/// Analog to the domain type, the ID is the explicit resource.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// The domain type tells us, where in ChurchTools the action was performed.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// The log level indicates the importance. 1 = Warning, 2 = Notice, 3 = Info.
#[serde(deserialize_with = "crate::lenient::number")]
pub level: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
/// If the person ID is `-1`, that means, no person but the system itself has logged that message.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// The name of the person, who caused the log message. This is stored in the log, because the person could be deleted later. So we have the name in the log, even if the person is deleted.
#[serde(rename = "personName", deserialize_with = "crate::lenient::string")]
pub person_name: String,
#[serde(rename = "simulatePerson", default, skip_serializing_if = "Option::is_none")]
pub simulate_person: Option<DomainObjectPerson>,
/// If a person is simulated by an administrator, we log the personId as well. This makes it possible to see if a person did the action or an admin, who simulated that person.
#[serde(rename = "simulatePersonId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub simulate_person_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Password credentials. The same username may be a ChurchTools login name or an email address. LDAP is tried first when configured, followed by local authentication.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LoginCreate {
/// Account password; preserve spaces exactly.
#[serde(deserialize_with = "crate::lenient::string")]
pub password: String,
/// Login name or email address.
#[serde(deserialize_with = "crate::lenient::string")]
pub username: String,
/// Request persistent browser login.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "rememberMe", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub remember_me: Option<Option<bool>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Password credentials. The same username may be a ChurchTools login name or an email address. LDAP is tried first when configured, followed by local authentication.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LoginCredentials {
/// Account password; preserve spaces exactly.
#[serde(deserialize_with = "crate::lenient::string")]
pub password: String,
/// Login name or email address.
#[serde(deserialize_with = "crate::lenient::string")]
pub username: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Result of the password step. Only success completes the login; totp and twoFactorSetup require further requests using the same browser session.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LoginResult {
/// Suggested navigation location. Pending TOTP uses ?q=twofactor and pending setup uses ?q=twofactorforce. Normal login may return a relative or absolute location, or null.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub location: Option<String>,
/// Human-readable status text; success is localized, while pending two-factor messages are currently fixed English text. Use status for branching.
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
/// Authenticated person ID, also returned before two-factor verification. Pass it to the TOTP step.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// success: session login completed; totp: submit /login/totp; twoFactorSetup: initialize and activate /login/twofactor/setup.
/// Allowed values: `success`, `totp`, `twoFactorSetup`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Persistent person login token. A previously issued token is reused rather than rotated by this endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LoginTokenResult {
/// Person authenticated by the supplied credentials.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Sensitive, persistent credential. Send as Authorization: Login on API requests; this is not an OAuth Bearer token. Logout does not revoke it.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct LoginTotpVerify {
/// Six-digit current authenticator code. Send it as a string to preserve leading zeroes. A code already accepted recently for this person cannot be reused.
#[serde(deserialize_with = "crate::lenient::string")]
pub code: String,
/// Person ID from the password step; must match the pending two-factor session.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Schema for validating markdown conversion requests
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MarkdownRequest {
/// Global options for all sources
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<MarkdownRequestOptions>,
pub sources: Vec<MarkdownRequestSourcesItem>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Global options for all sources
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MarkdownRequestOptions {
#[serde(rename = "commonLanguage", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub common_language: Option<String>,
/// Allowed values: `description`, `document`, `plaintext`, `richline`.
#[serde(rename = "defaultOutputScope", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub default_output_scope: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MarkdownRequestSourcesItem {
/// The scope of the input content
/// Allowed values: `description`, `document`, `plaintext`, `richline`.
#[serde(rename = "inputScope", deserialize_with = "crate::lenient::string")]
pub input_scope: String,
/// The markdown content to be processed
#[serde(deserialize_with = "crate::lenient::string")]
pub markdown: String,
/// Additional processing options
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<MarkdownRequestSourcesItemOptions>,
/// List of output formats for the processed markdown content
/// Allowed values: `html`, `md`, `xml`.
#[serde(rename = "outputFormats")]
pub output_formats: Vec<String>,
/// List of scopes for the output content
/// Allowed values: `description`, `document`, `plaintext`, `richline`.
#[serde(rename = "outputScopes")]
pub output_scopes: Vec<String>,
/// A short identifier for the source
#[serde(rename = "shortName", deserialize_with = "crate::lenient::string")]
pub short_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Additional processing options
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MarkdownRequestSourcesItemOptions {
#[serde(rename = "allowHtml", default, skip_serializing_if = "Option::is_none")]
pub allow_html: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub language: Option<String>,
#[serde(rename = "maxLength", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_length: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Invitation of one person to the stored calendar appointment/series. The response state applies to that request, not to an individual occurrence. Meeting invitations are separate from registration groups and service assignments.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequest {
/// Use `state` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `state` instead"]
pub accepted: Option<bool>,
/// Stored calendar appointment defining a single occurrence or a series. id identifies the whole stored appointment; pair it with a local occurrence start date to address a particular occurrence. startDate/endDate are the base occurrence, not necessarily the occurrence currently being displayed. Service-planning events, registration groups, bookings and meeting requests are separate linked resources.
pub appointment: AppointmentBase,
/// Use `appointment` instead
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `appointment` instead"]
pub appointment_id: Option<i64>,
/// Start of the stored appointment or series, not necessarily its next occurrence. Use nextStartDate when available.
#[serde(rename = "eventDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use nextStartDate when available."]
pub event_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of this meeting request.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Person invited to the appointment.
pub invitee: MeetingRequestInvitee,
/// Person issuing the invitation, derived from onBehalfOfPid when set or the user creating the request.
pub inviter: MeetingRequestInviter,
/// When the invitation mail was sent, or null.
#[serde(rename = "mailSendDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub mail_send_date: Option<chrono::DateTime<chrono::Utc>>,
pub meta: MetaDataEntityId,
/// Next end date when populated by the calling workflow; may be null.
#[serde(rename = "nextEndDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub next_end_date: Option<chrono::DateTime<chrono::Utc>>,
/// Next start date when populated by the calling workflow; may be null.
#[serde(rename = "nextStartDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub next_start_date: Option<chrono::DateTime<chrono::Utc>>,
/// Use `invitee` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `invitee` instead"]
pub person: Option<MeetingRequestPerson>,
/// When the invitee last responded, or null.
#[serde(rename = "responseDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub response_date: Option<chrono::DateTime<chrono::Utc>>,
/// Response state: pending awaits an answer, accepted confirms attendance, declined refuses, tentative is undecided.
/// Allowed values: `accepted`, `declined`, `pending`, `tentative`.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One visible candidate for an appointment invitation. A person can appear through multiple sources; use person.domainIdentifier when selecting invitees.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestCandidate {
/// Source group name for groupMember candidates; null for other sources.
#[serde(rename = "groupName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_name: Option<String>,
/// Source group type name for groupTypeMember candidates; null for other sources.
#[serde(rename = "groupTypeName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_type_name: Option<String>,
/// Whether an email address is recorded; this does not confirm email delivery.
#[serde(rename = "hasEmail")]
pub has_email: bool,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Source person status name for personStatus candidates; null for other sources.
#[serde(rename = "personStatusName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub person_status_name: Option<String>,
/// Candidate source: direct calendar permission, person status, group membership, group type membership, or an existing invitation.
/// Allowed values: `groupMember`, `groupTypeMember`, `meetingRequest`, `person`, `personStatus`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Invite one person to a calendar appointment or series.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestCreate {
/// ID of the person to invite.
#[serde(rename = "inviteeId", deserialize_with = "crate::lenient::number")]
pub invitee_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reply forwarded by the external calendar-mail processor. The token alone identifies and authorizes one invitation; partstat is supplied separately from the ICS payload.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestIcsReply {
/// Raw ICS reply used to compare appointment scope.
#[serde(rename = "icsContent", deserialize_with = "crate::lenient::string")]
pub ics_content: String,
/// Participation status supplied by the calendar-mail processor.
/// Allowed values: `ACCEPTED`, `DECLINED`, `TENTATIVE`.
#[serde(deserialize_with = "crate::lenient::string")]
pub partstat: String,
/// Reply token embedded in the invitation. Must exist in the meetingrequest_reply domain and remain valid. It is not consumed by this request.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person invited to the appointment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestInvitee {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectPersonDomainAttributes,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// user for an ordinary person; user-shield for a censored person placeholder.
/// Allowed values: `user`, `user-shield`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person issuing the invitation, derived from onBehalfOfPid when set or the user creating the request.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestInviter {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectPersonDomainAttributes,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// user for an ordinary person; user-shield for a censored person placeholder.
/// Allowed values: `user`, `user-shield`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Use `invitee` instead
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestPerson {
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::string")]
pub api_url: String,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectPersonDomainAttributes,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// user for an ordinary person; user-shield for a censored person placeholder.
/// Allowed values: `user`, `user-shield`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Answer a meeting request as its invitee. This updates the series-level invitation response.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingRequestUpdate {
/// Answer accepted by meeting-request response endpoints.
/// Allowed values: `accept`, `decline`, `maybe`, `reset`, `tentative`.
#[serde(deserialize_with = "crate::lenient::string")]
pub answer: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reusable feedback form for group meetings. A group selects a template through settings.groupMeeting.templateId. The template defines form fields; a meeting's pollResult contains fields with the recorded answers. A template is not a meeting date, calendar event or attendance list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingTemplate {
/// Name used to select this feedback template in group settings.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ordered feedback fields and section headings. An empty array defines a form with no fields.
pub template: Vec<MeetingTemplateField>,
/// ID referenced by settings.groupMeeting.templateId on a group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Creation and modification timestamps and person IDs for the template.
pub meta: MeetingTemplateMeta,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingTemplateCreate {
/// Name used to select this feedback template in group settings.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Ordered feedback fields and section headings. An empty array defines a form with no fields.
pub template: Vec<MeetingTemplateField>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingTemplateField {
/// Visible field label, or section heading for caption fields.
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
/// Only applicable to select fields, where it is required and non-empty. Strings contain comma-separated legacy options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Form control: input for a single line, textarea for multiple lines, checkbox for a check box, select for an option list, color for a color selection, or caption for a section heading without an answer field.
/// Allowed values: `caption`, `checkbox`, `color`, `input`, `select`, `textarea`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Initial field value in a template, or the recorded answer in a meeting's pollResult. Template write requests accept non-blank text when a value is supplied; omit it to leave the field without an initial value.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub value: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creation and modification timestamps and person IDs for the template.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MeetingTemplateMeta {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "createdPerson")]
pub created_person: MetaDataPersonId,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson")]
pub modified_person: MetaDataPersonId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A role definition and a limited preview of its active, visible group members. Roles without matching members have an empty members array.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MemberPreview {
/// Members selected for this role, limited by members_per_role. Entries omit fields, personFields and optional newsletter/tag enrichments.
pub members: Vec<GroupMember>,
/// Role definition for the group type. Its id matches groupTypeRoleId on each member.
pub role: MemberPreviewRole,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Role definition for the group type. Its id matches groupTypeRoleId on each member.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MemberPreviewRole {
/// ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// ID of the growth path associated with this role, or null for no association. Growth paths track steps in a person's development in ChurchTools.
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
/// Whether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
#[serde(rename = "isHidden")]
pub is_hidden: bool,
/// Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
#[serde(rename = "isLeader", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead; this field is not used to create or update a role."]
pub is_leader: Option<bool>,
/// Stored name of the role. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Abbreviated label for the role, used in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order among roles. Lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Functional classification of the role. Multiple roles with different names can share the same classification.
/// Allowed values: `leader`, `participant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// ID of this role record. For Role this identifies the group-type definition; for GroupRole it identifies the settings record for a specific group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a membership linking the group and person from the path. All properties are optional. Defaults select the group type’s standard role and active status; active membership starts at the current time unless a start is provided.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MembershipCreate {
/// Membership comment; surrounding whitespace is trimmed. Null or empty text clears it. Omission clears an existing comment in the legacy update path.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Values keyed by numeric membership-field definition ID. Only submitted known fields are updated; unknown IDs are ignored. Null clears one field; an omitted/null fields container changes no fields. Field-specific validation applies: text up to 4000 characters, numeric values, dates, timestamps, checkbox booleans, option IDs or labels for select/radioselect, and arrays of option IDs or labels for multiselect.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Option<std::collections::BTreeMap<String, serde_json::Value>>>,
/// New memberships default to active for omitted/null status. On legacy updates omitted/null preserves the previous status. A supplied waiting-list position can override the status to waiting.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_member_status: Option<Option<String>>,
/// Role ID for this group type; 0 or omission selects its default role for creation. Existing memberships retain their role when 0/omitted.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_type_role_id: Option<i64>,
/// Skip the group-capacity check when creating the membership.
#[serde(rename = "ignoreGroupFull", default, skip_serializing_if = "Option::is_none")]
pub ignore_group_full: Option<bool>,
/// Allow the update even when it would exceed waiting-list capacity.
#[serde(rename = "ignoreWaitingListFull", default, skip_serializing_if = "Option::is_none")]
pub ignore_waiting_list_full: Option<bool>,
/// Whether membership-change processing should inform group leaders.
#[serde(rename = "informLeader", default, skip_serializing_if = "Option::is_none")]
pub inform_leader: Option<bool>,
/// End date or null; omission clears an existing end date in the legacy update path.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "memberEndDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<Option<chrono::NaiveDate>>,
/// Date or UTC timestamp not in the future. Omitted/null defaults to now when a new membership becomes active, otherwise null. Explicit null is rejected if active is explicitly submitted. Legacy updates generally retain an existing start when omitted/null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "memberStartDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<Option<crate::DateOrDateTime>>,
/// Reject with 403 if the person already belongs to the group.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub only_add: Option<bool>,
/// 0 selects the next free waiting-list position; a positive value selects that position. Supplied positions set status to waiting and can shift other positions. For creation, null/omission assigns no position. For legacy updates, null/omission preserves it and -1 removes it but also sets status to waiting; -1 on creation reaches an assertion.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial update of an existing membership. Omitted membership properties retain their current values; explicit null clears nullable values. This changes the membership, not the underlying person record.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MembershipUpdate {
/// Membership comment; surrounding whitespace is trimmed. Null or empty text clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Values keyed by numeric membership-field definition ID. Only submitted known fields are updated; unknown IDs are ignored. Null clears one field; an omitted/null fields container changes no fields. Field-specific validation applies: text up to 4000 characters, numeric values, dates, timestamps, checkbox booleans, option IDs or labels for select/radioselect, and arrays of option IDs or labels for multiselect.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Option<std::collections::BTreeMap<String, serde_json::Value>>>,
/// Target membership workflow status; omitted preserves the existing status. Explicit null is not a usable status.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_member_status: Option<String>,
/// Role definition ID belonging to the group type. Null resets to its default role.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_type_role_id: Option<Option<i64>>,
/// Allow the update even when it would exceed waiting-list capacity.
#[serde(rename = "ignoreWaitingListFull", default, skip_serializing_if = "Option::is_none")]
pub ignore_waiting_list_full: Option<bool>,
/// Whether membership-change processing should inform group leaders.
#[serde(rename = "informLeader", default, skip_serializing_if = "Option::is_none")]
pub inform_leader: Option<bool>,
/// End date or null to clear. Must not precede the resulting start date.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "memberEndDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<Option<chrono::NaiveDate>>,
/// Start date or UTC timestamp, not in the future. If the resulting status is active, an explicitly submitted value must not be null; omission preserves the existing value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "memberStartDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<Option<crate::DateOrDateTime>>,
/// Waiting-list position; 0 selects the next free position, null removes it. Legacy -1 reaches a backend assertion and should be avoided. This PATCH does not automatically change status or shift other positions.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MetaDataCreatedId {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "createdPerson")]
pub created_person: MetaDataPersonId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MetaDataEntityId {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "createdPerson", default, skip_serializing_if = "Option::is_none")]
pub created_person: Option<MetaDataPersonId>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "Option::is_none")]
pub modified_person: Option<MetaDataPersonId>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MetaDataEntityPerson {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "createdPerson", default, skip_serializing_if = "Option::is_none")]
pub created_person: Option<DomainObjectPerson>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "Option::is_none")]
pub modified_person: Option<DomainObjectPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MetaDataPersonId {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Proposed booking field. Values are serialized as strings even for IDs, amounts, dates and booleans.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MovementSuggestion {
/// Included only with include\[\]=bills. Suggestions other than the bills marker receive an empty array.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bills: Option<Vec<Bill>>,
/// Generator confidence used to choose between suggestions. Manual changes and user rules use 100.
#[serde(deserialize_with = "crate::lenient::number")]
pub confidence: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Booking field name, such as accountId, contraAccountId, amount, documentDate, documentNumber, costCenterId or bills.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Generator origin, such as import, user, transaction_details or user_rule-. User-rule IDs are appended to the reason; it is not a closed enum.
#[serde(deserialize_with = "crate::lenient::string")]
pub reason: String,
/// Groups fields belonging to one split child. Null identifies global fields.
#[serde(rename = "splitKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub split_key: Option<i64>,
/// Whether the value was manually created or changed.
#[serde(rename = "userOverwrite")]
pub user_overwrite: bool,
/// String representation of the suggested value. The bills field acts as a marker for attached documents.
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MovementSuggestionUpdate {
/// Field to add or modify. Existing entries are matched by name and splitKey.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Split-child key, or null/omitted for a global suggestion. Requires the split-booking feature when non-null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "splitKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub split_key: Option<Option<i64>>,
/// String value; an empty string removes a matching suggestion. Dates use YYYY-MM-DD, amounts use minor units, IDs use decimal strings, booleans use true/false strings.
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct MovementSuggestionsUpdate {
/// Incremental changes. Omitted suggestions are retained; an empty array changes nothing.
pub suggestions: Vec<MovementSuggestionUpdate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored link between one ChurchTools group and one external newsletter list. The provider/list ID pair can be linked to at most one group. This is configuration, not live delivery or subscriber status.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterIntegrationGroupMapping {
/// ChurchTools group whose members are synchronized.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the ChurchTools mapping record; endpoint URLs identify it by group/provider/list instead.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Provider-specific list identifier. The list must not already be associated with another group.
#[serde(rename = "listId", deserialize_with = "crate::lenient::string")]
pub list_id: String,
/// List display name cached when the mapping was created; may be null for legacy records and is not refreshed by this GET.
#[serde(rename = "listName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub list_name: Option<String>,
/// Whether subscriptions require consent; the provider or ChurchTools handles double opt-in depending on provider capability.
#[serde(rename = "optInRequired")]
pub opt_in_required: bool,
/// Stored provider name. Use the canonical provider value returned by GET /newsletter-integrations when creating links.
#[serde(deserialize_with = "crate::lenient::string")]
pub provider: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Connects one existing or newly created external list to the path group and immediately synchronizes eligible existing members. Exactly one non-null listId/createListName is required.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterIntegrationGroupMappingCreate {
/// Create an external list with this name; only use if the provider advertises canCreateLists=true.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "createListName", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub create_list_name: Option<Option<String>>,
/// Controls the initial synchronization only. ignore_opt_in subscribes eligible existing members without double opt-in even when optInRequired=true; the stored flag still governs later synchronization.
/// Allowed values: `ignore_opt_in`, `require_opt_in`.
#[serde(rename = "existingMembersHandling", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub existing_members_handling: Option<String>,
/// Existing provider list ID. The provider/list pair must not already be mapped to any group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "listId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub list_id: Option<Option<String>>,
/// Require double opt-in for subscriptions. Providers with doesDoubleOptIn=true handle confirmation; otherwise ChurchTools sends confirmation emails.
#[serde(rename = "optInRequired")]
pub opt_in_required: bool,
/// Canonical newsletter provider name. Availability depends on the installation configuration; discover active providers using GET /newsletter-integrations. The backend also accepts case variations but stores the supplied spelling.
/// Allowed values: `CleverReach`, `MailChimp`, `Mailjet`.
#[serde(deserialize_with = "crate::lenient::string")]
pub provider: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterIntegrationListOption {
/// Name of the group associated with this list. Omitted when the list is unassigned or the current user cannot view the associated group.
#[serde(rename = "assignedGroupName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub assigned_group_name: Option<String>,
/// Provider-specific remote list ID, normalized to string.
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// Whether any stored ChurchTools group mapping uses this provider/list pair, regardless of visibility or current activity of the mapped group.
#[serde(rename = "isAssigned")]
pub is_assigned: bool,
/// Current remote display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An active configured newsletter provider and the remote lists available for group mappings.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterIntegrationOptions {
/// Whether this provider implementation supports creating a remote list from the group-mapping API.
#[serde(rename = "canCreateLists")]
pub can_create_lists: bool,
/// Whether the provider integration itself uses double opt-in, distinct from the mapping’s ChurchTools optInRequired flag.
#[serde(rename = "doesDoubleOptIn")]
pub does_double_opt_in: bool,
/// Remote lists in provider-returned order. Empty can mean no lists or a caught provider error; assigned lists remain included.
pub lists: Vec<NewsletterIntegrationListOption>,
/// Canonical newsletter provider name. Availability depends on the installation configuration; discover active providers using GET /newsletter-integrations. The backend also accepts case variations but stores the supplied spelling.
/// Allowed values: `CleverReach`, `MailChimp`, `Mailjet`.
#[serde(deserialize_with = "crate::lenient::string")]
pub provider: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored subscription/consent state for a group. Collections use maps when populated and \[\] when empty; this response does not refresh live provider state.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterOptInData {
/// Mappings for currently active providers, keyed by provider:listId.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub newsletter: serde_json::Value,
/// Newsletter-person records keyed by person ID. Includes stored records without filtering current membership/person visibility individually; entries for inactive providers may have an empty newsletter map.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub persons: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One active provider/list mapping represented in the consent overview.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterOptInList {
/// True when consent is required and the provider does not handle double opt-in itself.
#[serde(rename = "ctDoesDoubleOptIn")]
pub ct_does_double_opt_in: bool,
/// Composite provider:listId key.
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
/// External provider list ID.
#[serde(rename = "listId", deserialize_with = "crate::lenient::string")]
pub list_id: String,
/// Cached list name, potentially absent for legacy mappings.
#[serde(rename = "listName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub list_name: Option<String>,
/// Whether this mapping requires consent.
#[serde(rename = "optInRequired")]
pub opt_in_required: bool,
/// Stored provider name.
#[serde(deserialize_with = "crate::lenient::string")]
pub provider: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person with one or more stored newsletter-person records.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterOptInPerson {
/// ChurchTools person ID, not newsletter-person record ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Status keyed by provider:listId for active providers.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub newsletter: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Local synchronization and consent state, which can lag behind external changes.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NewsletterOptInStatus {
/// Date the ChurchTools double opt-in was confirmed; null when not recorded. This does not represent every provider-managed consent.
#[serde(rename = "doiDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub doi_date: Option<chrono::DateTime<chrono::Utc>>,
/// Whether the stored record has been marked successfully synchronized.
#[serde(rename = "isSynced")]
pub is_synced: bool,
/// Whether a local unsubscribe timestamp has been recorded.
#[serde(rename = "isUnsubscribed")]
pub is_unsubscribed: bool,
/// Most recently recorded synchronization error, or null.
#[serde(rename = "syncError", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sync_error: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A note can be linked to multiple business objects. The top-level `domainType`, `domainId`, `securityLevelId`, and `commentViewerId` come from the first stored link, which may differ from the requested route. The note text is shared by every link.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Note {
/// Person-comment visibility category. Used for person-domain filtering, not for other note domains.
#[serde(rename = "commentViewerId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub comment_viewer_id: Option<i64>,
/// ID of the linked business object.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Kinds of objects with attached notes. Notes for `follow_up` can be read here but must be created through the follow-up API.
/// Allowed values: `follow_up`, `group`, `person`, `song_arrangement`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Visibility threshold used for group notes. Other current domains do not filter note lists by this value.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// All linked domains, including links not independently authorized by the requested route. Only the last link for each domain type is serialized.
pub links: NoteLinks,
pub meta: NoteMetadata,
/// Shared note content as stored; historical notes may not match current create/update input constraints.
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Content and link visibility for a new note. The target domain and object ID come from the URL.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteCreate {
/// Visibility category for person notes. Creating a person note requires permission for this category.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "commentViewerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment_viewer_id: Option<Option<i64>>,
/// Group-note security threshold; ignored for list filtering in the other domains. The create handler also accepts legacy string representations.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<Option<i64>>,
/// Note content shared by all links.
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Link from a note to a business object, with the visibility settings for that domain. Several links can share the same note text.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteDomainObjectLink {
/// Person-comment visibility category. Used for person-domain filtering, not for other note domains.
#[serde(rename = "commentViewerId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub comment_viewer_id: Option<i64>,
/// ID of the linked business object.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Kinds of objects with attached notes. Notes for `follow_up` can be read here but must be created through the follow-up API.
/// Allowed values: `follow_up`, `group`, `person`, `song_arrangement`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Visibility threshold used for group notes. Other current domains do not filter note lists by this value.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// All linked domains, including links not independently authorized by the requested route. Only the last link for each domain type is serialized.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteLinks {
/// Link from a note to a business object, with the visibility settings for that domain. Several links can share the same note text.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub follow_up: Option<NoteDomainObjectLink>,
/// Link from a note to a business object, with the visibility settings for that domain. Several links can share the same note text.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<NoteDomainObjectLink>,
/// Link from a note to a business object, with the visibility settings for that domain. Several links can share the same note text.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<NoteDomainObjectLink>,
/// Link from a note to a business object, with the visibility settings for that domain. Several links can share the same note text.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub song_arrangement: Option<NoteDomainObjectLink>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteMetadata {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", serialize_with = "crate::datetime::serialize_utc")]
pub created_date: chrono::DateTime<chrono::Utc>,
/// Resolved author/editor domain object, or an ID-only fallback when the person cannot be loaded.
#[serde(rename = "createdPerson", default, skip_serializing_if = "serde_json::Value::is_null")]
pub created_person: serde_json::Value,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
/// Resolved author/editor domain object, or an ID-only fallback when the person cannot be loaded.
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "serde_json::Value::is_null")]
pub modified_person: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteMetadataCreatedPersonVariant2 {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces note text and visibility values for the first link matching the path `domainType`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct NoteUpdate {
/// Person-comment visibility category. The update handler does not repeat the category permission check used on create.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "commentViewerId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment_viewer_id: Option<Option<i64>>,
/// Group-note security level. Unlike create, the update does not accept legacy string representations.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<Option<i64>>,
/// Note content shared by all links.
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An application registered to use ChurchTools as an OAuth authorization server. This differs from an external-login provider used to sign into ChurchTools. Numeric id is internal; identifier is the OAuth client_id and the management path key. Hidden built-in clients are excluded from management lists.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OAuthClient {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// OAuth client_id. Newly registered clients receive 64 lowercase hexadecimal characters.
#[serde(deserialize_with = "crate::lenient::string")]
pub identifier: String,
/// Whether token requests authenticate with a client secret. Fixed when the client is created.
#[serde(rename = "isConfidential")]
pub is_confidential: bool,
/// Logo resolved from the redirect URI origin, or null when no logo can be found.
#[serde(rename = "logoUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub logo_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Registered redirect URIs. Responses return an array, whereas create and update accept a single string and replace the array with that entry.
#[serde(rename = "redirectUri")]
pub redirect_uri: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Registers a client application. The client identifier and any secret are generated by ChurchTools. Input accepts one redirect URI string; responses use an array.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OAuthClientCreate {
/// true generates a secret for a server application able to keep it private; false creates a public client without a secret. This setting cannot be changed by the update endpoint.
#[serde(rename = "isConfidential", default, skip_serializing_if = "Option::is_none")]
pub is_confidential: Option<bool>,
/// Display name, unique across visible and hidden OAuth clients.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Single callback URI stored as the registered redirect entry.
#[serde(rename = "redirectUri", deserialize_with = "crate::lenient::string")]
pub redirect_uri: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Registered OAuth client. Only confidential clients receive clientSecret, and only in this creation response. Store it securely; management reads and updates cannot retrieve it again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OAuthClientCreated {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// OAuth client_id. Newly registered clients receive 64 lowercase hexadecimal characters.
#[serde(deserialize_with = "crate::lenient::string")]
pub identifier: String,
/// Whether token requests authenticate with a client secret. Fixed when the client is created.
#[serde(rename = "isConfidential")]
pub is_confidential: bool,
/// Logo resolved from the redirect URI origin, or null when no logo can be found.
#[serde(rename = "logoUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub logo_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Registered redirect URIs. Responses return an array, whereas create and update accept a single string and replace the array with that entry.
#[serde(rename = "redirectUri")]
pub redirect_uri: Vec<String>,
/// Generated 64-character hexadecimal secret, present only for confidential clients in their creation response.
#[serde(rename = "clientSecret", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement name and single redirect URI for a visible OAuth client. identifier comes from the URL. This endpoint does not change confidentiality or rotate a secret.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OAuthClientUpdate {
/// Legacy compatibility field.
#[serde(rename = "isConfidential", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub is_confidential: Option<bool>,
/// Display name, unique across visible and hidden OAuth clients.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Single callback URI stored as the registered redirect entry.
#[serde(rename = "redirectUri", deserialize_with = "crate::lenient::string")]
pub redirect_uri: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphActor {
/// The URL or an identifier for the actor's profile.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub profile: Option<String>,
/// The role played by the actor.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub role: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphAlbum {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub disc: Option<i64>,
/// The URL of the album.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphArticle {
/// The authors of the article.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub authors: Option<Vec<String>>,
/// The expiration time of the article.
#[serde(rename = "expirationTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub expiration_time: Option<chrono::DateTime<chrono::Utc>>,
/// The last modified time of the article.
#[serde(rename = "modifiedTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_time: Option<chrono::DateTime<chrono::Utc>>,
/// The publication time of the article.
#[serde(rename = "publishedTime", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub published_time: Option<chrono::DateTime<chrono::Utc>>,
/// The section of the website where the article is located.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub section: Option<String>,
/// Tags associated with the article.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphAudio {
/// The secure URL of the audio.
#[serde(rename = "secureUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub secure_url: Option<String>,
/// The MIME type of the audio.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// The URL of the audio.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphBook {
/// The authors of the book.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub authors: Option<Vec<String>>,
/// The International Standard Book Number of the book.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub isbn: Option<String>,
/// The release date of the book.
#[serde(rename = "releaseDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub release_date: Option<chrono::DateTime<chrono::Utc>>,
/// Tags associated with the book.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphImage {
/// The height of the image in pixels.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub height: Option<i64>,
/// The secure URL of the image.
#[serde(rename = "secureUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub secure_url: Option<String>,
/// The MIME type of the image.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// The URL of the image.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// The width of the image in pixels.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub width: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphMusic {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub album: Option<OpenGraphAlbum>,
/// The creators of the music.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub creators: Option<Vec<String>>,
/// The duration of the music in seconds.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// The musicians involved in the music.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub musicians: Option<Vec<String>>,
/// The release date of the music.
#[serde(rename = "releaseDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub release_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub songs: Option<Vec<OpenGraphSong>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphProfile {
/// The first name of the individual.
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
/// The gender of the individual.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub gender: Option<String>,
/// The last name of the individual.
#[serde(rename = "lastName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
/// The username of the individual on the platform.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A model representing a song in the OpenGraph data structure.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphSong {
/// The disc number on which the song appears, applicable for albums with multiple discs.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub disc: Option<i64>,
/// The track number of the song on its disc.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub track: Option<i64>,
/// The URL where the song can be accessed.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenGraphVideo {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actors: Option<Vec<OpenGraphActor>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub directors: Option<Vec<String>>,
/// The duration of the video in seconds.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub duration: Option<i64>,
/// The height of the video in pixels.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub height: Option<i64>,
/// The release date of the video.
#[serde(rename = "releaseDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub release_date: Option<chrono::DateTime<chrono::Utc>>,
/// The secure URL of the video.
#[serde(rename = "secureUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub secure_url: Option<String>,
/// Tags associated with the video.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// The MIME type of the video.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// The URL of the video.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// The width of the video in pixels.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub width: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub writers: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Unanswered invitation with a remaining occurrence. The next occurrence dates are populated for this view; the embedded appointment retains the stored series data.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OpenMeetingRequest {
/// Use `state` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `state` instead"]
pub accepted: Option<bool>,
/// Stored calendar appointment defining a single occurrence or a series. id identifies the whole stored appointment; pair it with a local occurrence start date to address a particular occurrence. startDate/endDate are the base occurrence, not necessarily the occurrence currently being displayed. Service-planning events, registration groups, bookings and meeting requests are separate linked resources.
pub appointment: AppointmentBase,
/// Use `appointment` instead
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `appointment` instead"]
pub appointment_id: Option<i64>,
/// Start of the stored appointment or series, not necessarily its next occurrence. Use nextStartDate when available.
#[serde(rename = "eventDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use nextStartDate when available."]
pub event_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of this meeting request.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Person invited to the appointment.
pub invitee: MeetingRequestInvitee,
/// Person issuing the invitation, derived from onBehalfOfPid when set or the user creating the request.
pub inviter: MeetingRequestInviter,
/// When the invitation mail was sent, or null.
#[serde(rename = "mailSendDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub mail_send_date: Option<chrono::DateTime<chrono::Utc>>,
pub meta: MetaDataEntityId,
/// Next start plus the stored appointment duration, truncated to whole minutes.
#[serde(rename = "nextEndDate", serialize_with = "crate::datetime::serialize_utc")]
pub next_end_date: chrono::DateTime<chrono::Utc>,
/// Start of the next occurrence found by recurrence calculation.
#[serde(rename = "nextStartDate", serialize_with = "crate::datetime::serialize_utc")]
pub next_start_date: chrono::DateTime<chrono::Utc>,
/// Use `invitee` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `invitee` instead"]
pub person: Option<MeetingRequestPerson>,
/// No answer has been recorded. Tentative answers have a response date and are excluded.
#[serde(rename = "responseDate", default, skip_serializing_if = "serde_json::Value::is_null")]
pub response_date: serde_json::Value,
/// Response state: pending awaits an answer, accepted confirms attendance, declined refuses, tentative is undecided.
/// Allowed values: `accepted`, `declined`, `pending`, `tentative`.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PasswordResetCreate {
/// Stored email address or login name.
#[serde(rename = "emailOrUsername", deserialize_with = "crate::lenient::string")]
pub email_or_username: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchGroupsIdBody {
/// ID of the appointment this group is linked to. Set to `null` to unlink the group from any appointment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub appointment_id: Option<Option<i64>>,
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_type_id: Option<i64>,
/// Start date of the appointment occurrence this group is linked to (used together with `appointmentId` for repeating appointments). Set to `null` to clear.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "startDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Membership statuses that occupy seats when their role counts towards seats. Defaults to active only. An empty array means no membership occupies a seat.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "statusesCountedTowardsSeats", default, skip_serializing_if = "Option::is_none")]
pub statuses_counted_towards_seats: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchPersonsIdBody {
#[serde(rename = "addressAddition", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub age: Option<i64>,
#[serde(rename = "baptisedBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub baptised_by: Option<String>,
#[serde(rename = "birthName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birth_name: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birthplace: Option<String>,
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(rename = "cmsUserId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cms_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBaptism", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_baptism: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBelonging", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_belonging: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfDeath", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfEntry", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_entry: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfResign", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_resign: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Department IDs. At least one department MUST be set for a person. The last department ID cannot be deleted.
#[serde(rename = "departmentIds", default, skip_serializing_if = "Option::is_none")]
pub department_ids: Option<Vec<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Save many eMail addresses for person. If `emails` is present in request `email` is ignored.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub emails: Option<Vec<PersonEmail>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub fax: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "firstContact", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_contact: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job: Option<String>,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mobile: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
#[serde(rename = "optigemId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub optigem_id: Option<String>,
#[serde(rename = "phonePrivate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_private: Option<String>,
#[serde(rename = "phoneWork", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_work: Option<String>,
#[serde(rename = "placeOfBaptism", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub place_of_baptism: Option<String>,
/// This object can be optional or required. Depending on your ChurchTools data security settings.
#[serde(rename = "privacyPolicyAgreement", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement: Option<PatchPersonsIdBodyPrivacyPolicyAgreement>,
#[serde(rename = "referredBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_by: Option<String>,
#[serde(rename = "referredTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_to: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sexId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<Option<i64>>,
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Visibility accepted when creating or updating a person.
/// Allowed values: `hidden`, `visible`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "weddingDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub wedding_date: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// This object can be optional or required. Depending on your ChurchTools data security settings.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchPersonsIdBodyPrivacyPolicyAgreement {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "typeId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub type_id: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "whoId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub who_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchPersonsPersonidMergeDuplicateidData {
#[serde(deserialize_with = "crate::lenient::string")]
pub body: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub uridata: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchSecuritylevelsIdBody {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub forcereorder: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub newid: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PatchSecuritylevelsIdResponse {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One raw stored grant or revocation. Effective access also depends on other sources, inheritance and object policies. A selectable permission uses one row per dataId; write requests accept several data IDs at once.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Permission {
/// Numeric permission key from the internal authorization table
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Concrete selection ID, -1 for unrestricted access including future selections, or null for a permission without a data selection. Null must not be interpreted as unrestricted data access.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<i64>,
/// ID of the object the permission belongs to
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Assignment owner: person status, role template of a group type, role in a concrete group, or direct person assignment. These are assignment sources, not necessarily the objects on which the permission takes effect.
/// Allowed values: `group_role`, `group_type_role`, `person`, `status`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether this source applies through inheritance into subordinate groups; not a statement that the current response row was inherited.
#[serde(rename = "isInherited")]
pub is_inherited: bool,
pub meta: PermissionModification,
/// Optional reason why this permission was assigned
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub reason: Option<String>,
/// Whether the permission grants or revokes access
/// Allowed values: `grant`, `revoke`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentGroup {
/// Group whose role grants the permission
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Group role IDs contributing to this assignment
#[serde(rename = "groupRoleIds")]
pub group_role_ids: Vec<i64>,
/// Number of distinct non-archived persons reached by this assignment
#[serde(rename = "personCount", deserialize_with = "crate::lenient::number")]
pub person_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentGroupType {
/// Group type whose roles grant the permission
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// Group type role IDs contributing to this assignment
#[serde(rename = "groupTypeRoleIds")]
pub group_type_role_ids: Vec<i64>,
/// Number of distinct non-archived persons reached by this assignment
#[serde(rename = "personCount", deserialize_with = "crate::lenient::number")]
pub person_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentPerson {
/// Person with a direct permission assignment
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentStatus {
/// Number of distinct non-archived persons reached by this assignment
#[serde(rename = "personCount", deserialize_with = "crate::lenient::number")]
pub person_count: i64,
/// Person status granting the permission
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Assignment breakdown for one global permission selection. effectivePersonCount includes all effective sources, but the breakdown only groups status, group-type-role, group-role and direct-person sources. Logged-in defaults, public-user rights and super-admin status can therefore contribute to the total without appearing in assignments.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentSummary {
/// Nonempty assignment sources only. Status, group-type and group entries are sorted numerically by their IDs; role IDs within them are unique and sorted. Counts are distinct per entry but overlap across entries.
pub assignments: PermissionAssignmentSummaryAssignments,
/// Numeric permission key
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Selected permission value, or null for boolean permissions
#[serde(rename = "dataId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<i64>,
/// Total number of distinct non-archived persons with the effective permission
#[serde(rename = "effectivePersonCount", deserialize_with = "crate::lenient::number")]
pub effective_person_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Nonempty assignment sources only. Status, group-type and group entries are sorted numerically by their IDs; role IDs within them are unique and sorted. Counts are distinct per entry but overlap across entries.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentSummaryAssignments {
#[serde(rename = "groupTypes")]
pub group_types: Vec<PermissionAssignmentGroupType>,
pub groups: Vec<PermissionAssignmentGroup>,
pub persons: Vec<PermissionAssignmentPerson>,
pub statuses: Vec<PermissionAssignmentStatus>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Selectable assignment owner, including owners without existing permission assignments. The pair domainType and domainId identifies the target and can be passed to the permission write endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionAssignmentTarget {
/// Status, role template, concrete group role, or person ID. For group_role this is neither the group ID nor the role template ID.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Assignment owner: person status, role template of a group type, role in a concrete group, or direct person assignment. These are assignment sources, not necessarily the objects on which the permission takes effect.
/// Allowed values: `group_role`, `group_type_role`, `person`, `status`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Display label localized in the current request language
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionBulkChange {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Allowed values: `group_role`, `group_type_role`, `person`, `status`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Definition of one assignable permission, not an effective grant. Combine the module key and permission key to identify it by name, or use authId in assignment endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionDefinition {
/// Currently always lists status, group_type_role, group_role and person. This is generic metadata and does not establish that every combination is accepted by assignment validation.
/// Allowed values: `group_role`, `group_type_role`, `person`, `status`.
#[serde(rename = "assignmentDomains")]
pub assignment_domains: Vec<String>,
/// Numeric permission key
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Currently the same translated text as name; no separate explanatory description is supplied.
#[serde(deserialize_with = "crate::lenient::string")]
pub description: String,
/// Permission key within its module
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Translated display name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Selectable data IDs, beginning with the all entry (-1). Empty for permissions without a data field. Values follow the underlying catalog order.
pub selections: Vec<PermissionDefinitionSelection>,
/// boolean combines grants as a flag; multiple combines selected IDs; maximum selects the highest level. Selections describe available IDs, and -1 denotes unrestricted access including future values.
/// Allowed values: `boolean`, `maximum`, `multiple`.
#[serde(rename = "valueType", deserialize_with = "crate::lenient::string")]
pub value_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Module containing at least one definition matching the requested scope. Modules follow the application module order; keys can include custom modules.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionDefinitionModule {
/// Technical module key
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Translated module name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
pub permissions: Vec<PermissionDefinition>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionDefinitionSelection {
/// Selection ID; -1 represents unrestricted access to all current and future values
#[serde(rename = "dataId", deserialize_with = "crate::lenient::number")]
pub data_id: i64,
/// Allowed values: `all`, `value`.
#[serde(deserialize_with = "crate::lenient::string")]
pub kind: String,
/// Translated selection name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Select raw assignments to delete. Omitting dataId, null or \[\] removes every data selection for the selected owner/authId/inheritance mode; this does not revoke access from other sources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionDelete {
/// Permission ID. status and person require values below 10000. Role domains also accept internal permission IDs. 10127 is obsolete and returns 410.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Concrete selections to delete. Omission, null or an empty array removes all selection rows, including the null row. A nonempty array uses exact IDs; -1 only matches the unrestricted row.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<Option<Vec<i64>>>,
/// Select inherited-source rows when true, otherwise direct rows. Only role domains allow true.
#[serde(rename = "isInherited", default, skip_serializing_if = "Option::is_none")]
pub is_inherited: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionModification {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
/// ID of the person that last changed the stored assignment, or null when unavailable.
#[serde(rename = "modifiedPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub modified_pid: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonSelection {
/// Permission selection value, or null for permissions without selection values
#[serde(rename = "dataId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<i64>,
/// Matching non-archived person IDs in ascending numeric order. With pagination these are only the requested page, not all matches. System users are not generally excluded.
#[serde(rename = "personIds")]
pub person_ids: Vec<i64>,
/// Present when `include=origins` is requested
#[serde(default, skip_serializing_if = "Option::is_none")]
pub persons: Option<Vec<PermissionPersonWithOrigins>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One registered global permission in definition order. Selections include zero-count values; data-field permissions start with -1 followed by configured IDs in numeric order.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonSummaryEntry {
/// Numeric permission key from the internal authorization table
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
pub selections: Vec<PermissionPersonSummarySelection>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonSummarySelection {
/// Configured selection ID, -1 for unrestricted access including future values, or null for a boolean permission.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<i64>,
/// Distinct matching non-archived persons. Counts overlap across selections; a maximum-level grant contributes to every configured level it reaches.
#[serde(rename = "personCount", deserialize_with = "crate::lenient::number")]
pub person_count: i64,
/// Up to three sorted person IDs for an overview preview
#[serde(rename = "previewPersonIds")]
pub preview_person_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOrigins {
/// Sources that contribute the requested permission selection
pub origins: Vec<serde_json::Value>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant1 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Allowed values: `loggedIn`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant2 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Allowed values: `superAdmin`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant3 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Allowed values: `publicUser`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant4 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// ID of the person the permission is set on directly
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Allowed values: `person`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant5 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// ID of the person status that grants the permission
#[serde(rename = "statusId", deserialize_with = "crate::lenient::number")]
pub status_id: i64,
/// Allowed values: `status`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant6 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Group of the membership that grants the permission. For inherited permissions this is the superior group, not the target group.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the group role (`cdb_group_role`) that grants the permission
#[serde(rename = "groupRoleId", deserialize_with = "crate::lenient::number")]
pub group_role_id: i64,
/// ID of the group type role of the membership
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// Whether the permission reaches the target group through inheritance from a superior group
pub inherited: bool,
/// Allowed values: `groupRole`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonWithOriginsOriginsItemVariant7 {
/// If set, this group type role permission is revoked by the group role with this ID and does not contribute to the effective value
#[serde(rename = "revokedByGroupRoleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub revoked_by_group_role_id: Option<i64>,
/// Value this source contributes: `true` for simple permissions, a number for level permissions (e.g. security levels) or a list of IDs for data permissions
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Group of the membership that grants the permission. For inherited permissions this is the superior group, not the target group.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// ID of the group type whose role grants the permission
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// ID of the group type role of the membership
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// Whether the permission reaches the target group through inheritance from a superior group
pub inherited: bool,
/// Allowed values: `groupTypeRole`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Persons for one permission, grouped by selection. Global queries return one selection; internal data_id=-1 can return several. Pagination and per-person origins are available only for global queries.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersons {
/// Numeric permission key from the internal authorization table
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Present when page, limit or include=origins enables pagination. Nested under data, not a top-level response meta field.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<PermissionPersonsMeta>,
/// Effective persons grouped by the requested permission selection values
pub selections: Vec<PermissionPersonSelection>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Present when page, limit or include=origins enables pagination. Nested under data, not a top-level response meta field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionPersonsMeta {
#[serde(deserialize_with = "crate::lenient::number")]
pub limit: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub page: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub total: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Atomically replace all stored selection rows for one permission, inheritance mode and source owner. An empty dataId list removes the assignment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionReplace {
/// Permission ID. status and person require values below 10000. Role domains also accept internal permission IDs. 10127 is obsolete and returns 410.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Complete replacement selection. Use \[-1\] for unrestricted selection access or \[\] to remove the assignment.
#[serde(rename = "dataId")]
pub data_id: Vec<i64>,
/// Select inherited-source rows when true, otherwise direct rows. Only role domains allow true.
#[serde(rename = "isInherited", default, skip_serializing_if = "Option::is_none")]
pub is_inherited: Option<bool>,
/// Optional explanation for the replacement assignment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub reason: Option<Option<String>>,
/// Grant a permission, or revoke a contribution for a concrete group_role. revoke is rejected for all other source domains.
/// Allowed values: `grant`, `revoke`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Add or update stored assignment rows. This is not full replacement of the owner’s permissions. Path parameters identify the source owner.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionUpdate {
/// Permission ID. status and person require values below 10000. Role domains also accept internal permission IDs. 10127 is obsolete and returns 410.
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Selections to add/update. Omission, null or \[\] writes a null-data row, normally used for boolean permissions. Use \[-1\] for unrestricted selection access. Existing other selections remain. If a -1 row already exists for this key/inheritance mode, any nonempty request currently returns without changing rows, type or reason.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dataId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub data_id: Option<Option<Vec<i64>>>,
/// Select inherited-source rows when true, otherwise direct rows. Only role domains allow true.
#[serde(rename = "isInherited", default, skip_serializing_if = "Option::is_none")]
pub is_inherited: Option<bool>,
/// Trimmed optional explanation. Empty/whitespace input becomes null. No maximum length is validated by the controller.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub reason: Option<Option<String>>,
/// Grant a permission, or revoke a contribution for a concrete group_role. revoke is rejected for all other source domains.
/// Allowed values: `grant`, `revoke`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub r#type: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Permission with recorded origins and its effective value. A record can remain when all contributions were revoked, with false, 0 or \[\] as the effective value.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PermissionWithOrigins {
/// Permission key within the module. Group internal permissions start with `+`.
#[serde(deserialize_with = "crate::lenient::string")]
pub auth: String,
/// Numeric permission key from the internal authorization table
#[serde(rename = "authId", deserialize_with = "crate::lenient::number")]
pub auth_id: i64,
/// Combined effective value: flag, maximum level (99999 for unrestricted), or selected IDs. No effective grant is false, 0 or \[\] according to value type. Multi-value unrestricted grants expand to current IDs, so their original unrestricted assignment is not preserved in this value.
#[serde(rename = "effectiveValue", default, skip_serializing_if = "serde_json::Value::is_null")]
pub effective_value: serde_json::Value,
/// Module the permission belongs to
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
pub origins: Vec<serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A person object includes all fields the logged in user may see depending on the security level. Additional DB fields, created by the admin, are also part of the response. Those fields have the same name as the column name.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Person {
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(default, skip_serializing_if = "Option::is_none")]
pub acceptedsecurity: Option<chrono::NaiveDate>,
#[serde(rename = "addressAddition", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_addition: Option<String>,
/// This computed field contains the age of this person if the date of birth is visible. If this person already dead, the age is calculated until the date of death.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub age: Option<i64>,
#[serde(rename = "baptisedBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub baptised_by: Option<String>,
#[serde(rename = "birthName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birth_name: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<chrono::NaiveDate>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birthplace: Option<String>,
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(rename = "canChat", default, skip_serializing_if = "Option::is_none")]
pub can_chat: Option<bool>,
#[serde(rename = "chatActive", default, skip_serializing_if = "Option::is_none")]
pub chat_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(rename = "cmsUserId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cms_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfBaptism", default, skip_serializing_if = "Option::is_none")]
pub date_of_baptism: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfBelonging", default, skip_serializing_if = "Option::is_none")]
pub date_of_belonging: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfDeath", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfEntry", default, skip_serializing_if = "Option::is_none")]
pub date_of_entry: Option<chrono::NaiveDate>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "dateOfResign", default, skip_serializing_if = "Option::is_none")]
pub date_of_resign: Option<chrono::NaiveDate>,
/// List of department IDs
#[serde(rename = "departmentIds", default, skip_serializing_if = "Option::is_none")]
pub department_ids: Option<Vec<i64>>,
/// Edit security level of the current person. The user can edit fields upto this level.
#[serde(rename = "editSecurityLevelForPerson", deserialize_with = "crate::lenient::number")]
pub edit_security_level_for_person: i64,
/// Primary email address of the person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub emails: Option<Vec<PersonEmailsItem>>,
#[serde(rename = "familyImageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub family_image_url: Option<String>,
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub fax: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "firstContact", default, skip_serializing_if = "Option::is_none")]
pub first_contact: Option<chrono::NaiveDate>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Allowed values: `accepted`, `not_invited`, `pending`.
#[serde(rename = "invitationStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub invitation_status: Option<String>,
#[serde(rename = "isArchived", default, skip_serializing_if = "Option::is_none")]
pub is_archived: Option<bool>,
/// This computed field is true iff a date of death is set for this person.
#[serde(rename = "isDead", default, skip_serializing_if = "Option::is_none")]
pub is_dead: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastEditedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_edited_date: Option<chrono::DateTime<chrono::Utc>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastLogin", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_login: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<f64>,
#[serde(rename = "latitudeLoose", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub latitude_loose: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<f64>,
#[serde(rename = "longitudeLoose", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub longitude_loose: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mobile: Option<String>,
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
/// String with Optigem ID or empty string if no ID is set.
#[serde(rename = "optigemId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub optigem_id: Option<String>,
#[serde(rename = "phonePrivate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_private: Option<String>,
#[serde(rename = "phoneWork", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_work: Option<String>,
#[serde(rename = "placeOfBaptism", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub place_of_baptism: Option<String>,
#[serde(rename = "privacyPolicyAgreement", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub privacy_policy_agreement: Option<PersonPrivacyPolicyAgreement>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "privacyPolicyAgreementDate", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_date: Option<chrono::NaiveDate>,
#[serde(rename = "privacyPolicyAgreementTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_type_id: Option<i64>,
#[serde(rename = "privacyPolicyAgreementWhoId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_who_id: Option<i64>,
#[serde(rename = "referredBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_by: Option<String>,
#[serde(rename = "referredTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_to: Option<String>,
/// Security level of the current person. The user sees fields upto this level.
#[serde(rename = "securityLevelForPerson", deserialize_with = "crate::lenient::number")]
pub security_level_for_person: i64,
#[serde(rename = "sexId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<i64>,
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Extensible visibility of a person.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "weddingDate", default, skip_serializing_if = "Option::is_none")]
pub wedding_date: Option<chrono::NaiveDate>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonDuplicate {
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
pub p1: MetaDataPersonId,
pub p2: MetaDataPersonId,
#[serde(rename = "relationshipId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub relationship_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonEmail {
#[serde(rename = "contactLabelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub contact_label_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Marks the default eMail address.
#[serde(rename = "isDefault", default, skip_serializing_if = "Option::is_none")]
pub is_default: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonEmailsItem {
#[serde(rename = "contactLabelId", deserialize_with = "crate::lenient::number")]
pub contact_label_id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub email: String,
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Download information for a newly generated personal data sheet. The PDF is a separate download, not the body of this API response.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonInformationExport {
/// Absolute download URL of the generated PDF. The stored file is scheduled for deletion after one day; this is not a permanent document URL.
#[serde(rename = "pdfLink", deserialize_with = "crate::lenient::string")]
pub pdf_link: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reference catalogs for People & Groups. These are definitions such as role/status types, not memberships or person records. Each array is returned in full without pagination or per-object visibility filtering.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonMasterData {
/// Age-range classifications for groups.
#[serde(rename = "ageGroups")]
pub age_groups: Vec<AgeGroup>,
/// Profiles of type campus only, ordered by sortKey; church profiles are excluded.
pub campuses: Vec<Campus>,
/// Visibility categories for person comments.
#[serde(rename = "commentViewers")]
pub comment_viewers: Vec<CommentViewer>,
/// Labels for contact information.
#[serde(rename = "contactLabels")]
pub contact_labels: Vec<ContactLabel>,
/// Department definitions used in person/group organization.
pub departments: Vec<Department>,
/// Categories used to organize groups.
#[serde(rename = "groupCategories")]
pub group_categories: Vec<GroupCategory>,
/// Reusable meeting feedback form definitions, not meeting dates.
#[serde(rename = "groupMeetingTemplates")]
pub group_meeting_templates: Vec<MeetingTemplate>,
/// Lifecycle status definitions for groups.
#[serde(rename = "groupStatuses")]
pub group_statuses: Vec<GroupStatus>,
/// Group-type definitions controlling available group features.
#[serde(rename = "groupTypes")]
pub group_types: Vec<GroupType>,
/// Growth-path definitions associated with membership roles.
#[serde(rename = "growPaths")]
pub grow_paths: Vec<GrowPath>,
/// Person relationship definitions, including directional labels.
#[serde(rename = "relationshipTypes")]
pub relationship_types: Vec<RelationshipType>,
/// Membership role definitions across group types, ordered by role type and sortKey. Group-specific role settings are returned elsewhere.
pub roles: Vec<Role>,
/// Sex/gender master-data choices.
pub sexes: Vec<Sex>,
/// Person status definitions; distinct from group status and membership workflow state.
pub statuses: Vec<Status>,
/// Audience classifications for groups.
#[serde(rename = "targetGroups")]
pub target_groups: Vec<TargetGroup>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonMergeGroupDiff {
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::string")]
pub group_member_status: String,
/// ID of the group
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Name of the member role
#[serde(deserialize_with = "crate::lenient::string")]
pub role: String,
/// ID of the member role
#[serde(rename = "roleId", deserialize_with = "crate::lenient::number")]
pub role_id: i64,
/// Name of the group
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Name of the group type
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonMergeGroupsDiff {
/// IDs of groups in which both persons are members
pub both: Vec<i64>,
/// Groups in which the duplicate person is involved
pub new: Vec<PersonMergeGroupDiff>,
/// Groups in which the original person is involved
pub old: Vec<PersonMergeGroupDiff>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonMergeInfo {
#[serde(rename = "groupsDiff")]
pub groups_diff: PersonMergeGroupsDiff,
#[serde(rename = "personDiff")]
pub person_diff: Vec<PersonMergePersonDiff>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonMergePersonDiff {
/// Translation key of the person field
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Name of the person field
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Value from the duplicate person
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub new: serde_json::Value,
/// Value from the original person
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub old: serde_json::Value,
/// Whether the difference should be included in change logs
#[serde(rename = "printDiff")]
pub print_diff: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Password inputs are not trimmed. The minimum length can be configured by the installation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPasswordUpdate {
/// New password satisfying the installation’s length and strength rules.
#[serde(rename = "newPassword", deserialize_with = "crate::lenient::string")]
pub new_password: String,
/// Must exactly match newPassword.
#[serde(rename = "newPasswordConfirm", deserialize_with = "crate::lenient::string")]
pub new_password_confirm: String,
/// Current password, or an empty string for a password-reset session or initial setup without a password.
#[serde(rename = "oldPassword", deserialize_with = "crate::lenient::string")]
pub old_password: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPostStatistics {
#[serde(rename = "countBanned", deserialize_with = "crate::lenient::number")]
pub count_banned: f64,
#[serde(rename = "countExpirationFuture", deserialize_with = "crate::lenient::number")]
pub count_expiration_future: f64,
#[serde(rename = "countExpirationPast", deserialize_with = "crate::lenient::number")]
pub count_expiration_past: f64,
#[serde(rename = "countPublicationFuture", deserialize_with = "crate::lenient::number")]
pub count_publication_future: f64,
#[serde(rename = "countPublished", deserialize_with = "crate::lenient::number")]
pub count_published: f64,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub total: Option<f64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Privacy-consent view for the selected person and their child relationships (relationship type 1). Privacy consent is separate from the confidentiality agreement. Display flags guide the consent UI; mutations still perform their own permission checks.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicy {
/// Minimum age for independent consent and self-registration, even when registration is disabled.
#[serde(rename = "minimumAge", deserialize_with = "crate::lenient::number")]
pub minimum_age: i64,
pub owner: PersonPrivacyPolicyOwner,
pub relationships: Vec<PersonPrivacyPolicyRelationshipsItem>,
/// Whether the configured banner should be shown for outstanding own or child consent.
#[serde(rename = "showBanner")]
pub show_banner: bool,
/// Configured own-consent confirmation text.
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Configured child-consent confirmation text.
#[serde(rename = "textRelations", deserialize_with = "crate::lenient::string")]
pub text_relations: String,
/// Suggested consent type: self-confirmation.
#[serde(rename = "typeId", deserialize_with = "crate::lenient::number")]
pub type_id: i64,
/// Suggested consent-giver category: the person themselves.
#[serde(rename = "whoId", deserialize_with = "crate::lenient::number")]
pub who_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyAgreement {
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(default, skip_serializing_if = "Option::is_none")]
pub date: Option<chrono::NaiveDate>,
#[serde(rename = "typeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub type_id: Option<i64>,
#[serde(rename = "whoId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub who_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Outcome for one child marked accepted in the request. The HTTP 200 response can include non-successful outcomes.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyChildResult {
/// Localized error text for error outcomes; empty string otherwise.
#[serde(deserialize_with = "crate::lenient::string")]
pub error: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Per-child outcome.
/// Allowed values: `error`, `not allowed`, `success`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Child-consent selection consumed by the service. Nested fields are not validated by the controller; supply all fields with the documented types.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyChildUpdate {
/// Whether to request consent for this child.
pub accepted: bool,
/// Birthday as YYYY-MM-DD when adding one, otherwise an empty string. This endpoint does not perform structured date validation.
#[serde(deserialize_with = "crate::lenient::string")]
pub birthday: String,
/// Whether the submitted birthday should be written.
#[serde(rename = "editBirthday")]
pub edit_birthday: bool,
/// Person ID of the child.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyOwner {
pub accepted: bool,
/// Stored consent timestamp, or null. Not normalized to a UTC timestamp by this transformer.
#[serde(rename = "acceptedDate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub accepted_date: Option<String>,
/// Stored label of the consent type, not its ID or a translated label; null without a type. A legacy zero ID can remain 0.
#[serde(rename = "acceptedType", default, skip_serializing_if = "serde_json::Value::is_null")]
pub accepted_type: serde_json::Value,
/// Consent-giver category ID, or null.
#[serde(rename = "acceptedWho", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub accepted_who: Option<i64>,
/// Age in years, or 0 when the birthday is unknown.
#[serde(deserialize_with = "crate::lenient::number")]
pub age: i64,
/// UI flag based on enabled consent banner and the configured minimumAge; not a complete authorization decision.
#[serde(rename = "allowedToAccept")]
pub allowed_to_accept: bool,
/// True when no birthday is stored, independently of consent status.
#[serde(rename = "editBirthday")]
pub edit_birthday: bool,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Image URL of the person.
#[serde(deserialize_with = "crate::lenient::string")]
pub image: String,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Child-side person of a parent/child relationship, with consent flags. Relationships can include adults; their flags normally prevent child-consent actions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyRelationshipsItem {
pub accepted: bool,
/// Stored consent timestamp, or null. Not normalized to a UTC timestamp by this transformer.
#[serde(rename = "acceptedDate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub accepted_date: Option<String>,
/// Stored consent-type label, or an empty string if none is found.
#[serde(rename = "acceptedType", deserialize_with = "crate::lenient::string")]
pub accepted_type: String,
/// Consent-giver category ID, or null.
#[serde(rename = "acceptedWho", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub accepted_who: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub age: i64,
#[serde(rename = "allowedToAccept")]
pub allowed_to_accept: bool,
#[serde(rename = "allowedToDecline")]
pub allowed_to_decline: bool,
/// Stored date of death, if any.
#[serde(rename = "dateOfDeath", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<String>,
#[serde(rename = "editBirthday")]
pub edit_birthday: bool,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image: Option<String>,
/// Archive status of the related person.
#[serde(rename = "isArchived")]
pub is_archived: bool,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
#[serde(rename = "relationshipType")]
pub relationship_type: PersonPrivacyPolicyRelationshipsItemRelationshipType,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyRelationshipsItemRelationshipType {
#[serde(rename = "degreeOfRelationship", deserialize_with = "crate::lenient::string")]
pub degree_of_relationship: String,
/// ID of this relationship instance, not the relationship type.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "relationshipName", deserialize_with = "crate::lenient::string")]
pub relationship_name: String,
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::number")]
pub relationship_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Record own consent and/or consent for child relationships. All flags and the persons array are required, even when a branch is not used. This operation can partially change data before a later error.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonPrivacyPolicyUpdate {
/// Birthday for the URL person if no birthday is stored. Prefer YYYY-MM-DD. Empty text becomes null; malformed date text is not reliably rejected as 400.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<Option<String>>,
/// Whether to process the persons array.
#[serde(rename = "childrenAccepted")]
pub children_accepted: bool,
/// Whether to process consent for the URL person.
#[serde(rename = "ownAccepted")]
pub own_accepted: bool,
/// Child selections; use an empty array when not processing children.
pub persons: Vec<PersonPrivacyPolicyChildUpdate>,
/// Consent-type catalog ID used for own consent; typically the typeId from GET. Child consent always uses self-confirmation (2).
#[serde(rename = "typeId", deserialize_with = "crate::lenient::number")]
pub type_id: i64,
/// Consent-giver catalog ID used for own consent; typically the whoId from GET. Child consent always uses parent (2).
#[serde(rename = "whoId", deserialize_with = "crate::lenient::number")]
pub who_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonProperties {
#[serde(rename = "canChat")]
pub can_chat: bool,
#[serde(rename = "hasEmail")]
pub has_email: bool,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Allowed values: `accepted`, `not_invited`, `pending`.
#[serde(rename = "invitationStatus", deserialize_with = "crate::lenient::string")]
pub invitation_status: String,
#[serde(rename = "isArchived")]
pub is_archived: bool,
#[serde(rename = "isDead")]
pub is_dead: bool,
/// Extensible visibility of a person.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Relationship information of a person. Notice, that a relationship has a security level. That means you only see those relationships, you are allowed to see.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonRelationship {
/// Name of type, what this relative is for the user.
#[serde(rename = "degreeOfRelationship", deserialize_with = "crate::lenient::string")]
pub degree_of_relationship: String,
/// ID of the relationship
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Name of Relationship
#[serde(rename = "relationshipName", deserialize_with = "crate::lenient::string")]
pub relationship_name: String,
/// ID of relationship type
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::number")]
pub relationship_type_id: i64,
/// Person as Domain Object
pub relative: DomainObjectPerson,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update the assignment using personId from the path. The path already provides the assignee; do not supply an external name. The legacy agreed field is accepted as an alias for isAccepted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonServiceRequestUpdate {
/// Legacy alias for isAccepted. Prefer isAccepted in new integrations.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub agreed: Option<bool>,
/// Accepted for compatibility but ignored by this update operation; the replacement record starts without a comment. Use the accept or decline action for a response comment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Accepted for compatibility; this flag does not control notifications in the current implementation. Notifications follow the assignment workflow.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub inform_person: Option<bool>,
/// true creates a confirmed assignment; false creates an assignment awaiting confirmation. false does not decline it.
#[serde(rename = "isAccepted", default, skip_serializing_if = "Option::is_none")]
pub is_accepted: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One stored person preference, identified by module namespace and attribute key. Read endpoints include stored settings beyond the write allowlist. This is not a person master-data field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonSetting {
/// Setting key within the module namespace.
#[serde(deserialize_with = "crate::lenient::string")]
pub attribute: String,
/// Stored namespace. Read results are not restricted to the modules writable through this API.
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Decoded stored value. Serialized arrays/booleans retain their JSON type; un-serialized numeric values can be strings when read from storage. The type depends on the setting and may differ from the immediate PUT response.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Value for one allowed person setting. numeric accepts JSON numbers or numeric strings; boolean requires a JSON boolean; array accepts lists or associative objects; string requires a string. Null is not accepted. The module and attribute are taken from the URL.
///
/// Supported module/attribute pairs and value categories:
///
/// | Module | Attributes (value type) |
/// | --- | --- |
/// | churchcore | `saml-id` (numeric), `hidden-hints` (array), `hidden-hints-temporarily` (string), `alpha-consent` (numeric), `language` (string), `tour-completion-stats` (array) |
/// | churchhome | `startpageWidgets` (array), `hiddenStartpageWidgets` (array) |
/// | churchdb | `group-custom-views` (string), `favorite-groups` (array), `mailerBCC` (numeric), `sendBCCMail` (numeric), `signature` (string), `labelTemplateSelection` (string) |
/// | churchcal | `filterGemeindekalendar` (string), `filterGruppenKalender` (string), `filterPersonalKalender` (string), `currentBirthdayScope` (string) |
/// | churchservice | `file_attachToAllEvents` (numeric), `agendaExportSettings` (array) |
/// | churchcheckin | `category_id` (numeric), `distrikt_id` (numeric), `group_id` (string), `event_datum` (string), `rolename` (string), `viewCheckin` (string), `sortnames` (string), `printer_id` (string), `starthelpReaded` (string), `printgrouplist` (boolean), `station_id` (string), `status_id` (string), `bereich_id` (string), `personsSortBy` (string) |
/// | finance | `selected-client` (numeric), `transaction-mode` (string), `selected-accounting-period` (array), `selected-donation-receipt-letter-template` (string), `selected-donation-receipt-attachment-template` (string), `show-purposes-in-import` (numeric), `donation-download-mode` (string), `donation-download-double-page` (string), `show-entries-without-budget` (boolean), `eubp-mock-scenario` (string), `statements-document-number-type` (array), `statements-booking-number-template` (array) |
/// | wiki | `showMarkdownHints` (numeric) |
/// | global | `recent-searches` (array), `recent-persons` (array), `recent-groups` (array), `recent-wiki_pages` (array), `recent-songs` (array), `recent-appointments` (array), `simulatedPersons` (array), `station` (string) |
/// | app | `excluded-calendars` (array), `excluded-widgets` (array), `sorted-widgets` (array) |
/// | push | `birthday-type` (string), `disableGroupSignUpNotifications` (numeric), `groupSignUpNotificationsAgeGroupIds` (array), `groupSignUpNotificationsTargetGroupIds` (array), `groupSignUpNotificationsCategoryIds` (array) |
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonSettingUpdate {
/// Value of the selected setting, using its required type. Calendar filters require a string containing a JSON array, not a JSON array directly.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One stored person preference, identified by module namespace and attribute key. Read endpoints include stored settings beyond the write allowlist. This is not a person master-data field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonTwoFactorEnabled {
#[serde(deserialize_with = "crate::lenient::string")]
pub attribute: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Whether the person has enabled TOTP authentication. False if no setting exists.
pub value: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One stored person preference, identified by module namespace and attribute key. Read endpoints include stored settings beyond the write allowlist. This is not a person master-data field.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonTwoFactorForce {
#[serde(deserialize_with = "crate::lenient::string")]
pub attribute: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Explicit person-level requirement. Group-role requirements are not included.
pub value: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonTwoFactorForceUpdate {
/// Whether the person must configure two-factor authentication.
pub value: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonTwoFactorVerify {
/// Six-digit current authenticator code. Send it as a string to preserve leading zeroes. A code already accepted recently for this person cannot be reused.
#[serde(deserialize_with = "crate::lenient::string")]
pub code: String,
/// ID of the current person whose initialized secret is checked.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields applicable to upate a person
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PersonUpdateable {
#[serde(rename = "addressAddition", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub age: Option<i64>,
#[serde(rename = "baptisedBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub baptised_by: Option<String>,
#[serde(rename = "birthName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birth_name: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birthplace: Option<String>,
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(rename = "cmsUserId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cms_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBaptism", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_baptism: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBelonging", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_belonging: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfDeath", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfEntry", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_entry: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfResign", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_resign: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Department IDs. At least one department MUST be set for a person. The last department ID cannot be deleted.
#[serde(rename = "departmentIds", default, skip_serializing_if = "Option::is_none")]
pub department_ids: Option<Vec<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Save many eMail addresses for person. If `emails` is present in request `email` is ignored.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub emails: Option<Vec<PersonEmail>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub fax: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "firstContact", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_contact: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job: Option<String>,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mobile: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
#[serde(rename = "optigemId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub optigem_id: Option<String>,
#[serde(rename = "phonePrivate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_private: Option<String>,
#[serde(rename = "phoneWork", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_work: Option<String>,
#[serde(rename = "placeOfBaptism", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub place_of_baptism: Option<String>,
/// This object can be optional or required. Depending on your ChurchTools data security settings.
#[serde(rename = "privacyPolicyAgreement", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement: Option<PatchPersonsIdBodyPrivacyPolicyAgreement>,
#[serde(rename = "referredBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_by: Option<String>,
#[serde(rename = "referredTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_to: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sexId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<Option<i64>>,
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Visibility accepted when creating or updating a person.
/// Allowed values: `hidden`, `visible`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "weddingDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub wedding_date: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Entry in a recursive placeholder menu. Items with `items` are menu groups; items with `placeholder` and `label` are selectable placeholders.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PlaceholderItem {
/// Nested placeholder menu entries. Entries have the same shape as PlaceholderItem, but are documented without a recursive $ref because some OpenAPI tooling cannot resolve recursive schemas.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<PlaceholderItemItemsItem>>,
/// Translated label shown for a selectable placeholder
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Optional shorter label shown in nested placeholder menus
#[serde(rename = "menuLabel", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub menu_label: Option<String>,
/// Translated name of a placeholder menu group
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Placeholder expression to insert into a template
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub placeholder: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PlaceholderItemItemsItem {
/// Further nested placeholder menu entries.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<std::collections::BTreeMap<String, serde_json::Value>>>,
/// Translated label shown for a selectable placeholder
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Optional shorter label shown in nested placeholder menus
#[serde(rename = "menuLabel", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub menu_label: Option<String>,
/// Translated name of a placeholder menu group
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Placeholder expression to insert into a template
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub placeholder: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PlaceholderMenuGroup {
/// Selectable placeholders and further menu groups.
pub items: Vec<PlaceholderItem>,
/// Translated menu-section label.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PollForNewsResult {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Allowed values: `agenda`, `agenda_item`, `appointment`, `booking`, `calendar`, `event`, `event_service`, `follow_up`, `group`, `group_meeting`, `person`, `resource`, `routine`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// The person id of the person that changed the object
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One visible candidate for assigning a service role at an event. Scores are advisory: even unavailable persons remain in the list. Higher scores indicate fewer penalties or stronger preferences. The endpoint does not sort by score.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PossibleEventPerson {
/// Absences overlapping the event interval. Candidates with an absence are retained and receive a score penalty.
pub absences: Vec<Absence>,
/// Connected groups through whose active, visible-role memberships this person was found. A group can occur more than once.
#[serde(rename = "connectedGroups")]
pub connected_groups: Vec<DomainObjectGroup>,
/// Latest valid assignment in the same service group starting strictly before this event, within the loaded history window. Null if none was found.
#[serde(rename = "lastService", default, skip_serializing_if = "Option::is_none")]
pub last_service: Option<ServiceCandidateAssignment>,
/// Counts of valid assignments in the same service group, including outstanding and confirmed assignments. Keys are YYYY-MM, initialized from four months before the event and advanced six times by calendar months; values include zero. Counts are per assignment, not per distinct event.
#[serde(rename = "monthlyUtilization", deserialize_with = "crate::lenient::map")]
pub monthly_utilization: std::collections::BTreeMap<String, i64>,
/// Next valid assignment in the same service group starting strictly after this event, within the loaded history window. Null if none was found.
#[serde(rename = "nextService", default, skip_serializing_if = "Option::is_none")]
pub next_service: Option<ServiceCandidateAssignment>,
/// Whether a person linked as a partner (relationship type 2) has an assignment in this event. The lookup includes historical and unconfirmed records.
#[serde(rename = "partnerServices")]
pub partner_services: bool,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Advisory suitability score. Zero when there are no hints. This is not a probability or a guarantee that assignment will succeed.
#[serde(deserialize_with = "crate::lenient::number")]
pub score: i64,
/// Reasons contributing to the score. An empty array is allowed.
#[serde(rename = "scoreHints")]
pub score_hints: Vec<ServiceCandidateScoreHint>,
#[serde(rename = "serviceGroupPreferences", default, skip_serializing_if = "Option::is_none")]
pub service_group_preferences: Option<ServiceGroupPersonPreference>,
/// Whether servicesOnSameDay is nonempty.
#[serde(rename = "serviceOnSameDay")]
pub service_on_same_day: bool,
/// Selected valid assignment on the same day for another service role. The repository retains at most one other-service assignment per person; this is not an exhaustive conflict list.
#[serde(rename = "servicesOnSameDay")]
pub services_on_same_day: Vec<ServiceCandidateAssignment>,
/// Declined records for this event and service, plus the selected invalid assignment for another service on the same day, if any. The latter can be a superseded record rather than a decline.
#[serde(rename = "servicesPreviouslyDeclined")]
pub services_previously_declined: Vec<ServiceCandidateAssignment>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PossiblePostGroup {
#[serde(rename = "favoriteGroup")]
pub favorite_group: bool,
#[serde(rename = "featuredGroup")]
pub featured_group: bool,
pub group: DomainObjectGroup,
#[serde(rename = "roleName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub role_name: Option<String>,
/// Allowed values: `postPossible`, `signupAndPostPossible`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Post {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub content: Option<String>,
#[serde(rename = "expirationDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub expiration_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "publicationDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub publication_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Allowed values: `group_intern`, `group_visible`.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
/// Person as Domain Object
pub actor: DomainObjectPerson,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub comments: Option<Vec<PostComment>>,
#[serde(rename = "commentsActive")]
pub comments_active: bool,
/// Person identified by expirationPid. Null when expirationPid is null or identifies the post author; otherwise populated with the person who last set or changed the expiration date.
#[serde(rename = "expirationPerson", default, skip_serializing_if = "Option::is_none")]
pub expiration_person: Option<DomainObjectPerson>,
/// ID of the person who last set or changed the expiration date.
#[serde(rename = "expirationPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub expiration_pid: Option<i64>,
pub group: DomainObjectGroup,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(rename = "groupVisibility", deserialize_with = "crate::lenient::string")]
pub group_visibility: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub images: Vec<String>,
#[serde(rename = "imagesMeta")]
pub images_meta: Vec<PostImageMeta>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub instance: Option<PostInstance>,
#[serde(rename = "isBanned")]
pub is_banned: bool,
/// Last edit timestamp only when later than publicationDate; otherwise null.
#[serde(rename = "lastEditedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_edited_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub linkings: Option<Vec<LinkingOpenGraph>>,
pub meta: MetaDataEntityId,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "publishedDate", serialize_with = "crate::datetime::serialize_utc")]
pub published_date: chrono::DateTime<chrono::Utc>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reactions: Option<Vec<PostReaction>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostActionsBody {
/// One or more domain types to filter actions by.
/// Allowed values: `group_membership`, `person`.
pub domain_type: Vec<String>,
/// Optional filter criteria to further narrow the returned actions. The structure depends on the domain type.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub filter: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCaptchaBody {
#[serde(deserialize_with = "crate::lenient::string")]
pub solution: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCaptchaResponse {
#[serde(rename = "isValid")]
pub is_valid: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostComment {
#[serde(deserialize_with = "crate::lenient::string")]
pub content: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
#[serde(rename = "parentCommentId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub parent_comment_id: Option<i64>,
/// Person as Domain Object
pub person: DomainObjectPerson,
#[serde(rename = "postId", deserialize_with = "crate::lenient::number")]
pub post_id: i64,
pub reactions: Vec<PostCommentReaction>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCommentCreate {
#[serde(deserialize_with = "crate::lenient::string")]
pub content: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "parentCommentId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub parent_comment_id: Option<Option<i64>>,
#[serde(rename = "postId", deserialize_with = "crate::lenient::number")]
pub post_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCommentReaction {
#[serde(rename = "commentId", deserialize_with = "crate::lenient::number")]
pub comment_id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub emoji: String,
pub meta: MetaDataEntityId,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCommentReactionCreate {
#[serde(deserialize_with = "crate::lenient::string")]
pub emoji: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostCreate {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub content: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "expirationDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub expiration_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "publicationDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub publication_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Allowed values: `group_intern`, `group_visible`.
#[serde(deserialize_with = "crate::lenient::string")]
pub visibility: String,
#[serde(rename = "commentsActive", default, skip_serializing_if = "Option::is_none")]
pub comments_active: Option<bool>,
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
#[serde(rename = "imageIds", default, skip_serializing_if = "Option::is_none")]
pub image_ids: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostExternalloginsSamlMetadataParseData {
pub descriptors: Vec<SamlIdpMetadataDescriptor>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostFeatureusageBody {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub data: Option<Vec<FeatureUsage>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostFinanceEubpSubmissionsIdGenerateData {
/// URL to download the generated ZIP file
#[serde(rename = "downloadUrl", deserialize_with = "crate::lenient::string")]
pub download_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostGroupsBody {
/// Campus Id if group is connected to a campus
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Need to be true, if another group with that name already exists
#[serde(default, skip_serializing_if = "Option::is_none")]
pub force: Option<bool>,
/// ID of group category
#[serde(rename = "groupCategoryId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_category_id: Option<i64>,
/// ID of the group status. Values are fixed: 1 is active, 2 is pending (draft), 3 is archived, and 4 is finished. ChurchTools clients normally use active for a new group.
#[serde(rename = "groupStatusId", deserialize_with = "crate::lenient::number")]
pub group_status_id: i64,
/// Id of group type
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// Group name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Group ID of parent group
#[serde(rename = "parentGroupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub parent_group_id: Option<i64>,
/// put yourself in this role
#[serde(rename = "roleId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub role_id: Option<i64>,
/// The visibility of a group.
/// Allowed values: `hidden`, `intern`, `public`, `restricted`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostGroupsGroupIdMeetingsMeetingIdMembersMissingBody {
/// Attendance state to assign to currently unsure records.
/// Allowed values: `absent`, `present`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostGroupsIdMeetingsBody {
/// Start of the meeting in UTC.
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostImageMeta {
#[serde(rename = "aspectRatio", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub aspect_ratio: Option<f64>,
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::string")]
pub image_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostInstallationSyncOidcBody {
/// Compact RS256 JWS containing the configuration.
#[serde(rename = "configurationToken", deserialize_with = "crate::lenient::string")]
pub configuration_token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostInstallationSyncOidcData {
#[serde(rename = "externalLoginId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub external_login_id: Option<i64>,
#[serde(rename = "installationId", deserialize_with = "crate::lenient::string")]
pub installation_id: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub revision: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostInstance {
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(rename = "siteName", deserialize_with = "crate::lenient::string")]
pub site_name: String,
#[serde(rename = "siteUrl", deserialize_with = "crate::lenient::string")]
pub site_url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostLabelsData {
/// Absolute URL of the generated file, scheduled to expire after one day.
#[serde(deserialize_with = "crate::lenient::string")]
pub pdf: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Two-factor completion result. The legacy disabled-two-factor branch returns only status and does not complete login.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostLoginTwofactorSetupActivateData {
#[serde(rename = "redirectTo", deserialize_with = "crate::lenient::string")]
pub redirect_to: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostMarkdownCheckBody {
/// Validates the provided Markdown content against the specified scope's rules and restrictions.
/// This ensures the content adheres to the allowed formatting and elements for the given context.
/// Allowed values: `description`, `document`, `plaintext`, `richline`.
#[serde(rename = "inputScope", deserialize_with = "crate::lenient::string")]
pub input_scope: String,
/// The Markdown text to be processed
#[serde(deserialize_with = "crate::lenient::string")]
pub markdown: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostMarkdownCheckData {
/// Indicates if the provided Markdown content adheres to the specified scope's rules. - `true`: The content is valid and contains only allowed elements for the given scope - `false`: The content contains unsupported elements or formatting. Check the `reason` array for specific validation errors.
#[serde(rename = "isValid")]
pub is_valid: bool,
/// Array of validation error messages
pub reason: Vec<PostMarkdownCheckDataReasonItem>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostMarkdownCheckDataReasonItem {
/// The details of the validation error
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub message: Option<String>,
/// The invalid line from the Markdown source
#[serde(rename = "sourceLineContent", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_line_content: Option<String>,
/// The invalid line number in the Markdown source
#[serde(rename = "sourceLineNumber", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub source_line_number: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostNpsBody {
#[serde(deserialize_with = "crate::lenient::number")]
pub score: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostNpsResponse {
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub score: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPermissionsBulkBody {
pub changes: Vec<PermissionBulkChange>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Required IDs must be resolved from this installation's masterdata; optional fields may be omitted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPersonsBody {
#[serde(rename = "addressAddition", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub address_addition: Option<String>,
#[serde(rename = "baptisedBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub baptised_by: Option<String>,
#[serde(rename = "birthName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birth_name: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub birthday: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub birthplace: Option<String>,
/// ID of a campus returned by `GET /person/masterdata`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
#[serde(rename = "cmsUserId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cms_user_id: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBaptism", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_baptism: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfBelonging", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_belonging: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfDeath", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub date_of_death: Option<Option<chrono::NaiveDate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfEntry", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_entry: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "dateOfResign", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_resign: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Department IDs returned by `GET /person/masterdata`. At least one department must be set.
#[serde(rename = "departmentIds")]
pub department_ids: Vec<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// Save many eMail addresses for person. If `emails` is present in request `email` is ignored.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub emails: Option<Vec<PersonEmail>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "familyStatusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub family_status_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub fax: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "firstContact", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub first_contact: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub job: Option<String>,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mobile: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "nationalityId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub nationality_id: Option<Option<i64>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
#[serde(rename = "optigemId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub optigem_id: Option<String>,
#[serde(rename = "phonePrivate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_private: Option<String>,
#[serde(rename = "phoneWork", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone_work: Option<String>,
#[serde(rename = "placeOfBaptism", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub place_of_baptism: Option<String>,
/// Legacy representation of the privacy agreement. Use the three flat `privacyPolicyAgreement*` fields instead. When this object is used, all three values must be provided if privacy agreement fields are mandatory.
#[serde(rename = "privacyPolicyAgreement", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use the three flat `privacyPolicyAgreement*` fields instead."]
pub privacy_policy_agreement: Option<CheckinPersonDataCreatePrivacyPolicyAgreement>,
/// Date of the privacy policy agreement. Required together with agreement type and person when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementDate", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_date: Option<chrono::NaiveDate>,
/// ID of the configured agreement type describing how the agreement was obtained. This is independent from who gave the agreement. Required together with agreement date and person when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementTypeId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_type_id: Option<i64>,
/// ID of the configured agreement source describing who gave the agreement. This is independent from how the agreement was obtained. Required together with agreement date and type when `privacy_policy_fields_mandatory` is enabled.
#[serde(rename = "privacyPolicyAgreementWhoId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_agreement_who_id: Option<i64>,
#[serde(rename = "referredBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_by: Option<String>,
#[serde(rename = "referredTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub referred_to: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sexId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sex_id: Option<Option<i64>>,
/// ID of a person status returned by `GET /person/masterdata`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Visibility accepted when creating or updating a person.
/// Allowed values: `hidden`, `visible`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "weddingDate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub wedding_date: Option<Option<chrono::NaiveDate>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPersonsPersonIdArchiveBody {
/// if true the person is archived, if false the archive operation is undone
#[serde(default, skip_serializing_if = "Option::is_none")]
pub archived: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPersonsPersonIdRelationshipsBody {
#[serde(rename = "otherPersonId", deserialize_with = "crate::lenient::number")]
pub other_person_id: i64,
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::number")]
pub relationship_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPersonsPropertiesBody {
/// Person IDs for which properties should be returned
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ids: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostProbesBody {
/// One or more domain types to filter probes by.
/// Allowed values: `person`.
pub domain_type: Vec<String>,
/// Optional domain-specific filter criteria.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub filter: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPublicgroupsGroupIdMailToLeadersData {
#[serde(deserialize_with = "crate::lenient::string")]
pub success: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPublicgroupsGroupIdSignupResponse {
/// The hash of the group homepage. This allows the client to return to the group homepage.
#[serde(rename = "groupHomepageHash", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_hash: Option<String>,
/// Neutral notice that the anonymous requester should check their email. It does not disclose whether a person matched.
#[serde(rename = "verificationNotice")]
pub verification_notice: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPublicgroupsGroupIdTokenDataVariant2 {
#[serde(deserialize_with = "crate::lenient::string")]
pub success: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostPublicgroupsSignupConfirmConfirmationTokenData {
#[serde(rename = "groupHomepageHash", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_hash: Option<String>,
#[serde(rename = "groupId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub group_id: Option<i64>,
#[serde(rename = "groupName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_name: Option<String>,
/// Allowed values: `active`, `requested`, `waiting`.
#[serde(rename = "membershipStatus", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub membership_status: Option<String>,
/// Allowed values: `closed`, `expired`, `success`.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostQueuesQueueData {
/// Messages from Worker
#[serde(default, skip_serializing_if = "Option::is_none")]
pub messages: Option<Vec<String>>,
/// Name of Queue
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub queue: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostReaction {
#[serde(deserialize_with = "crate::lenient::string")]
pub emoji: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
/// Person as Domain Object
pub person: DomainObjectPerson,
#[serde(rename = "postId", deserialize_with = "crate::lenient::number")]
pub post_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostResetPasswordData {
/// Translated confirmation messages intended for display; wording depends on the user language.
pub infos: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostSecuritylevelsIdBody {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostSecuritylevelsIdResponse {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostSimulateBody {
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostSummarySubscriptionOptions {
/// Which posts to include in the email summary.
/// Allowed values: `all`, `featured_groups`, `my_campus`, `my_groups`.
#[serde(deserialize_with = "crate::lenient::string")]
pub filter: String,
/// Delivery weekdays, Sunday=0 through Saturday=6.
pub weekdays: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostTwofactorTotpData {
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PostUpdate {
#[serde(rename = "commentsActive", default, skip_serializing_if = "Option::is_none")]
pub comments_active: Option<bool>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub content: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "expirationDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub expiration_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(rename = "imageIds", default, skip_serializing_if = "Option::is_none")]
pub image_ids: Option<Vec<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "publicationDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub publication_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Allowed values: `group_intern`, `group_visible`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub visibility: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A printer designated to print check-in codes
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Printer {
/// Whether this printer is active and available for check-in printing.
pub active: bool,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Human-readable location of the printer.
#[serde(deserialize_with = "crate::lenient::string")]
pub location: String,
pub meta: MetaDataEntityId,
/// Human-readable printer name.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An operation that can evaluate domain objects as a predicate.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Probe {
#[serde(rename = "actionMetaData")]
pub action_meta_data: ActionMetaData,
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Domain types for which this probe can evaluate entities.
#[serde(rename = "domainTypes")]
pub domain_types: Vec<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub group: Option<ActionGroup>,
/// Allowed values: `probe-group-meeting-attendance`, `probe-group-membership`, `probe-person-avatar`, `probe-person-email`, `probe-person-field`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProbeInvocation {
/// Probe-specific configuration.
#[serde(deserialize_with = "crate::lenient::map")]
pub data: std::collections::BTreeMap<String, serde_json::Value>,
/// Allowed values: `probe-group-meeting-attendance`, `probe-group-membership`, `probe-person-avatar`, `probe-person-email`, `probe-person-field`.
#[serde(deserialize_with = "crate::lenient::string")]
pub probe: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A logical probe expression. The complete expression may be at most 10 levels deep and contain at most 100 expression nodes.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProbeLogicalExpression {
/// Nested expressions. The `not` operator requires exactly one child; all other operators accept between one and 20 children. Entries have the same shape as ProbeExpression, but are documented without a recursive $ref because some OpenAPI tooling cannot resolve recursive schemas.
pub children: Vec<std::collections::BTreeMap<String, serde_json::Value>>,
/// Allowed values: `and`, `not`, `or`, `xor`.
#[serde(deserialize_with = "crate::lenient::string")]
pub operator: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Matches each source person with any visible related target person. If `where` is supplied, at least one visible target must also match that nested expression.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProbeTraversalExpression {
pub data: ProbeTraversalExpressionData,
#[serde(deserialize_with = "crate::lenient::string")]
pub quantifier: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub traversal: String,
/// Optional nested expression that must match a related person. It has the same shape as ProbeExpression, but is documented without a recursive $ref because some OpenAPI tooling cannot resolve recursive schemas.
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub r#where: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProbeTraversalExpressionData {
/// Allowed values: `person-a-to-person-b`, `person-b-to-person-a`.
#[serde(deserialize_with = "crate::lenient::string")]
pub direction: String,
#[serde(rename = "relationshipTypeId", deserialize_with = "crate::lenient::number")]
pub relationship_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Profiles are representing campuses and the church itself.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Profile {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<std::collections::BTreeMap<String, String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// Will be the same for all profiles.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub association: Option<Association>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub banner: Option<DomainObjectFile>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub denomination: Option<Denomination>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "finderUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub finder_url: Option<String>,
pub gallery: Vec<DomainObjectFile>,
pub groups: Vec<ProfileGroupsItem>,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isPublished")]
pub is_published: bool,
/// Indicates whether registration is currently available for this profile. Only present when registration is active.
#[serde(rename = "isRegistrationOpen", default, skip_serializing_if = "Option::is_none")]
pub is_registration_open: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub logo: Option<DomainObjectFile>,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
/// church: Church profile for this installation; campus: one specific campus profile
/// Allowed values: `campus`, `church`.
#[serde(rename = "profileType", deserialize_with = "crate::lenient::string")]
pub profile_type: String,
/// Use `serviceBanner_new` instead.
#[serde(rename = "serviceBanner", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `serviceBanner_new` instead."]
pub service_banner: Option<String>,
#[serde(rename = "serviceBanner_new", default, skip_serializing_if = "Option::is_none")]
pub service_banner_new: Option<DomainObjectFile>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub services: Option<Vec<ProfileServicesItem>>,
#[serde(rename = "shortName", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
#[serde(rename = "signUpGroup", default, skip_serializing_if = "Option::is_none")]
pub sign_up_group: Option<ProfileSignUpGroupVariant1>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub slug: Option<String>,
#[serde(rename = "socialMedia", deserialize_with = "crate::lenient::map")]
pub social_media: std::collections::BTreeMap<String, String>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
pub tags: Vec<ProfileTagsItem>,
pub team: Vec<ProfileTeamItem>,
#[serde(rename = "teamTitle", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub team_title: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub visitors: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub website: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileAddressUpdate {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub city: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub country: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub district: Option<Option<String>>,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub latitude: serde_json::Value,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub longitude: serde_json::Value,
/// Alias for `name` in the API request.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub meeting_at: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub street: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileGroupsItem {
pub group: DomainObjectGroup,
#[serde(rename = "groupHomepageApi", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_api: Option<String>,
#[serde(rename = "groupHomepageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_url: Option<String>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileServicesItem {
#[serde(deserialize_with = "crate::lenient::number")]
pub day: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Allowed values: `biweekly`, `every_fourth_week`, `every_third_week`, `monthly`, `weekly`.
#[serde(deserialize_with = "crate::lenient::string")]
pub repetition: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub time: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileSignUpGroupVariant1 {
pub group: DomainObjectGroup,
#[serde(rename = "groupHomepageApi", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_api: Option<String>,
#[serde(rename = "groupHomepageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_url: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileTagsItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileTeamItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Person as Domain Object
pub person: DomainObjectPerson,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileUpdate {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub address: Option<Option<ProfileAddressUpdate>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "associationId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub association_id: Option<Option<i64>>,
/// Either exact denomination key or denomination object with name property.
/// Allowed values: `denomination.catholic`, `denomination.ecumenical`, `denomination.free.evangelical`, `denomination.none`, `denomination.orthodox`, `denomination.protestant`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub denomination: serde_json::Value,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub email: Option<Option<String>>,
/// List of group IDs shown on the profile.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub groups: Option<Vec<i64>>,
#[serde(rename = "isPublished", default, skip_serializing_if = "Option::is_none")]
pub is_published: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub phone: Option<Option<String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub services: Option<Vec<ProfileUpdateServicesItem>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "shortName", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub short_name: Option<Option<String>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Group ID used for profile sign-up or null to disable sign-up.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "signUpGroupId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sign_up_group_id: Option<Option<i64>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub slug: Option<Option<String>>,
/// Key-Value Pair, where key is the name of the network and value is the absolute link
#[serde(rename = "socialMedia", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub social_media: Option<std::collections::BTreeMap<String, String>>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// List of tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub team: Option<Vec<ProfileUpdateTeamItem>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "teamTitle", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub team_title: Option<Option<String>>,
/// Single integer, which represents a range.
/// Allowed values: `0`, `1`, `100`, `1000`, `250`, `50`, `500`.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub visitors: Option<i64>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub website: Option<Option<String>>,
/// Campus profile ID. For `/profiles/church`, this is ignored.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileUpdateDenominationVariant2 {
/// Allowed values: `denomination.catholic`, `denomination.ecumenical`, `denomination.free.evangelical`, `denomination.none`, `denomination.orthodox`, `denomination.protestant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileUpdateServicesItem {
#[serde(deserialize_with = "crate::lenient::number")]
pub day: i64,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Allowed values: `biweekly`, `every_fourth_week`, `every_third_week`, `monthly`, `weekly`.
#[serde(deserialize_with = "crate::lenient::string")]
pub repetition: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub time: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileUpdateTeamItem {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// DomainObject
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<ProfileUpdateTeamItemPerson>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// DomainObject
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ProfileUpdateTeamItemPerson {
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::number")]
pub domain_identifier: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Information about a public group, e.g. to be displayed on a group homepage.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroup {
/// Compatibility aliases emitted by the transformer.
#[serde(rename = "@deprecated")]
pub deprecated: PublicGroupDeprecated,
/// If true, group sign is allowed even if group is full.
#[serde(rename = "allowWaitinglist")]
pub allow_waitinglist: bool,
/// If true, group sign up requests will be accepted automatically.
#[serde(rename = "autoAccept")]
pub auto_accept: bool,
/// Indicates if the current user (either logged in or not) can sign up. This summarizes the information in signUpConditions.
#[serde(rename = "canSignUp")]
pub can_sign_up: bool,
/// Direct active, non-hidden hierarchy child IDs. These are not re-filtered against displayed groups and can reference a group excluded by page depth/public eligibility.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub children: Option<Vec<i64>>,
/// Occupied seats, accounting for membership status and role seat-counting rules; not necessarily the number of membership rows.
#[serde(rename = "currentMemberCount", deserialize_with = "crate::lenient::number")]
pub current_member_count: i64,
/// The public group ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// General information about the group.
pub information: PublicGroupInformation,
/// Maximum number of members until the group is considered as full.
#[serde(rename = "maxMemberCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_member_count: Option<i64>,
/// Name of the group, e.g. to be displayed as title.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Use `requestedSeatsCount` instead.
#[serde(rename = "requestedPlacesCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `requestedSeatsCount` instead."]
pub requested_places_count: Option<i64>,
/// Number of requested seats
#[serde(rename = "requestedSeatsCount", deserialize_with = "crate::lenient::number")]
pub requested_seats_count: i64,
/// Use `requestedWaitinglistSeatsCount` instead.
#[serde(rename = "requestedWaitinglistPlacesCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `requestedWaitinglistSeatsCount` instead."]
pub requested_waitinglist_places_count: Option<i64>,
/// Number of requested seats with waiting list position
#[serde(rename = "requestedWaitinglistSeatsCount", deserialize_with = "crate::lenient::number")]
pub requested_waitinglist_seats_count: i64,
pub settings: PublicGroupSettings,
#[serde(rename = "showPublicCannotViewGroup")]
pub show_public_cannot_view_group: bool,
/// Specifies conditions required to sign up in this group. Not all conditions apply to any user, e.g. some of the conditions only apply to users that are not logged in.
#[serde(rename = "signUpConditions")]
pub sign_up_conditions: GroupSignUpConditions,
/// Whether a normal signup occupies a seat, based on its assigned role and membership status.
#[serde(rename = "signUpCountsTowardsSeats")]
pub sign_up_counts_towards_seats: bool,
/// Text which can be displayed as a headline for the sign up section
#[serde(rename = "signUpHeadline", deserialize_with = "crate::lenient::string")]
pub sign_up_headline: String,
/// Only returned by the single-public-group detail endpoint, not by a homepage list. Eligible persons depend on the signed-in user and signup settings.
#[serde(rename = "signUpPersons", default, skip_serializing_if = "Option::is_none")]
pub sign_up_persons: Option<Vec<PublicGroupSignUpPersonsItem>>,
/// Maximum number of persons on the waiting list.
#[serde(rename = "waitinglistMaxPersons", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_max_persons: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Public group meeting place. If showStreet=false, street/addition and precise latitude/longitude aliases are omitted; loose coordinates and the remaining location metadata remain.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupAddress {
#[serde(rename = "@deprecated")]
pub deprecated: StoredAddressDeprecated,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// A country's ISO-code
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
/// The identifier of the domain object. This field is set automatically from the path parameter and should not be included in the request body.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// The domain type of the address. This field is set automatically from the path parameter and should not be included in the request body.
/// Allowed values: `appointment`, `campus`, `church`, `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Use `latitude` instead
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub geo_lat: Option<String>,
/// Use `longitude` instead
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub geo_lng: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
/// Use `latitude` instead
#[serde(rename = "latitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub latitude_loose: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
/// Use `longitude` instead
#[serde(rename = "longitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub longitude_loose: Option<String>,
/// Allowed values: `default`, `parent`, `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(rename = "markerColor", default, skip_serializing_if = "serde_json::Value::is_null")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_color: serde_json::Value,
/// Use `icon` instead
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `icon` instead"]
pub marker_icon: Option<String>,
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_url: Option<String>,
/// Use `name` instead
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `name` instead"]
pub meeting_at: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Use `zip` instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `zip` instead"]
pub postalcode: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility aliases emitted by the transformer.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupDeprecated {
#[serde(rename = "requestedPlacesCount", deserialize_with = "crate::lenient::string")]
pub requested_places_count: String,
#[serde(rename = "requestedWaitinglistPlacesCount", deserialize_with = "crate::lenient::string")]
pub requested_waitinglist_places_count: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Single public-group response, including eligible signup persons.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupDetail {
/// Compatibility aliases emitted by the transformer.
#[serde(rename = "@deprecated")]
pub deprecated: PublicGroupDeprecated,
/// If true, group sign is allowed even if group is full.
#[serde(rename = "allowWaitinglist")]
pub allow_waitinglist: bool,
/// If true, group sign up requests will be accepted automatically.
#[serde(rename = "autoAccept")]
pub auto_accept: bool,
/// Indicates if the current user (either logged in or not) can sign up. This summarizes the information in signUpConditions.
#[serde(rename = "canSignUp")]
pub can_sign_up: bool,
/// Direct active, non-hidden hierarchy child IDs. These are not re-filtered against displayed groups and can reference a group excluded by page depth/public eligibility.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub children: Option<Vec<i64>>,
/// Occupied seats, accounting for membership status and role seat-counting rules; not necessarily the number of membership rows.
#[serde(rename = "currentMemberCount", deserialize_with = "crate::lenient::number")]
pub current_member_count: i64,
/// The public group ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// General information about the group.
pub information: PublicGroupInformation,
/// Maximum number of members until the group is considered as full.
#[serde(rename = "maxMemberCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_member_count: Option<i64>,
/// Name of the group, e.g. to be displayed as title.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Use `requestedSeatsCount` instead.
#[serde(rename = "requestedPlacesCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `requestedSeatsCount` instead."]
pub requested_places_count: Option<i64>,
/// Number of requested seats
#[serde(rename = "requestedSeatsCount", deserialize_with = "crate::lenient::number")]
pub requested_seats_count: i64,
/// Use `requestedWaitinglistSeatsCount` instead.
#[serde(rename = "requestedWaitinglistPlacesCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `requestedWaitinglistSeatsCount` instead."]
pub requested_waitinglist_places_count: Option<i64>,
/// Number of requested seats with waiting list position
#[serde(rename = "requestedWaitinglistSeatsCount", deserialize_with = "crate::lenient::number")]
pub requested_waitinglist_seats_count: i64,
pub settings: PublicGroupSettings,
#[serde(rename = "showPublicCannotViewGroup")]
pub show_public_cannot_view_group: bool,
/// Specifies conditions required to sign up in this group. Not all conditions apply to any user, e.g. some of the conditions only apply to users that are not logged in.
#[serde(rename = "signUpConditions")]
pub sign_up_conditions: GroupSignUpConditions,
/// Whether a normal signup occupies a seat, based on its assigned role and membership status.
#[serde(rename = "signUpCountsTowardsSeats")]
pub sign_up_counts_towards_seats: bool,
/// Text which can be displayed as a headline for the sign up section
#[serde(rename = "signUpHeadline", deserialize_with = "crate::lenient::string")]
pub sign_up_headline: String,
/// Only returned by the single-public-group detail endpoint, not by a homepage list. Eligible persons depend on the signed-in user and signup settings.
#[serde(rename = "signUpPersons")]
pub sign_up_persons: Vec<PublicGroupSignUpPersonsItem>,
/// Maximum number of persons on the waiting list.
#[serde(rename = "waitinglistMaxPersons", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_max_persons: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupFormField {
/// Configured default, including checkbox booleans; not necessarily a string.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub default: serde_json::Value,
/// Allowed values: `api`, `checkbox`, `date`, `datetime`, `multiselect`, `number`, `radioselect`, `select`, `text`, `textarea`.
#[serde(rename = "fieldTypeCode", default, skip_serializing_if = "serde_json::Value::is_null")]
pub field_type_code: serde_json::Value,
/// ID of the form field. Only IDs within the same form field type are unique, i.e. a form field is identified by its type and its ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// A human readable label for the form field.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
/// Maximum length when available.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// If this is true, the field is required.
pub mandatory: bool,
/// The field's internal name. Not intended to be displayed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// A note for the user filling out the form, e.g. to explain why certain information is required.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Provides the set of allowed options for select fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<PublicGroupFormFieldOptionsItem>>,
/// Person field is locked, for example an email captured by the token.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub readonly: Option<bool>,
/// Form fields should be sorted by this key ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Field domain; combine with id to identify a submitted field.
/// Allowed values: `comment`, `custom`, `person`, `privacy`, `privacyForChild`, `privacyForOther`, `privacyForSelf`, `relation`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupFormFieldOptionsItem {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub id: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupFormResult {
#[serde(rename = "acceptPrivacyForChildForm")]
pub accept_privacy_for_child_form: Vec<PublicGroupFormField>,
#[serde(rename = "acceptPrivacyForOtherForm")]
pub accept_privacy_for_other_form: Vec<PublicGroupFormField>,
#[serde(rename = "acceptPrivacyForSelfForm")]
pub accept_privacy_for_self_form: Vec<PublicGroupFormField>,
#[serde(rename = "addChildForm", default, skip_serializing_if = "Option::is_none")]
pub add_child_form: Option<Vec<PublicGroupFormField>>,
#[serde(rename = "addOtherForm", default, skip_serializing_if = "Option::is_none")]
pub add_other_form: Option<Vec<PublicGroupFormField>>,
#[serde(rename = "addSpouseForm", default, skip_serializing_if = "Option::is_none")]
pub add_spouse_form: Option<Vec<PublicGroupFormField>>,
/// If the user is not yet signed in, this specifies the email address the user has provided.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// List of form fields.
pub form: Vec<PublicGroupFormField>,
/// Information about a public group, e.g. to be displayed on a group homepage.
pub group: PublicGroup,
/// If the user is signed in, this specifies the user ID of the requester.
#[serde(rename = "requesterId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub requester_id: Option<i64>,
/// Lists all persons the current user is allowed to sign up. This includes spouses, children below the age of 16 and all persons with the same email address.
#[serde(rename = "signUpPersons")]
pub sign_up_persons: Vec<PublicGroupFormResultSignUpPersonsItem>,
/// The sign up token.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupFormResultSignUpPersonsItem {
/// List of form field values
#[serde(rename = "formData")]
pub form_data: Vec<PublicGroupFormResultSignUpPersonsItemFormDataItem>,
#[serde(rename = "hasAcceptedPrivacy")]
pub has_accepted_privacy: bool,
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Relation of this sign-up person to the requester.
/// Allowed values: `child`, `other`, `spouse`.
#[serde(rename = "relationType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub relation_type: Option<String>,
/// Specifies whether this person is already in the group (IN_GROUP), in pending state for the group (REQUESTED), or selected by the user to be added into the group (CLICKED). Otherwise NOT_CLICKED.
/// Allowed values: `CLICKED`, `IN_GROUP`, `NOT_CLICKED`, `REQUESTED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupFormResultSignUpPersonsItemFormDataItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored person-field value; may be null or a scalar/list/object depending on the field.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// General information about the group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupInformation {
/// List of target age groups for this group.
#[serde(rename = "ageGroups")]
pub age_groups: Vec<AgeGroup>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub campus: Option<Campus>,
/// Color key used for displaying the group.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub color: Option<String>,
#[serde(rename = "dateOfFoundation", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub date_of_foundation: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "groupCategory", default, skip_serializing_if = "Option::is_none")]
pub group_category: Option<GroupCategory>,
/// Meeting places are returned regardless of the showMap UI flag. showStreet controls removal of street/addition/precise coordinates.
#[serde(rename = "groupPlaces")]
pub group_places: Vec<PublicGroupAddress>,
#[serde(rename = "groupStatusId", deserialize_with = "crate::lenient::number")]
pub group_status_id: i64,
/// Whether the group image was generated with AI.
#[serde(rename = "imageAiGenerated", default, skip_serializing_if = "Option::is_none")]
pub image_ai_generated: Option<bool>,
/// Annotation text for the group image if provided.
#[serde(rename = "imageAnnotation", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_annotation: Option<String>,
/// Link to the original source of the group image if provided.
#[serde(rename = "imageAnnotationLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_annotation_link: Option<String>,
/// Alternative text describing the group image if provided.
#[serde(rename = "imageDescription", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_description: Option<String>,
/// URL to a group image if provided.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// List of person objects of all group leaders if the group is set to display leaders.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub leader: Option<Vec<DomainObjectPerson>>,
/// Free text field when group meetings take place.
#[serde(rename = "meetingTime", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub meeting_time: Option<String>,
/// The group description.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
#[serde(rename = "targetGroup", default, skip_serializing_if = "Option::is_none")]
pub target_group: Option<TargetGroup>,
/// Meeting weekday master data, or null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub weekday: Option<Weekday>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupLeaderMailCreate {
/// E-Mail Address of the sender.
#[serde(deserialize_with = "crate::lenient::string")]
pub email: String,
/// Message to be sent.
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
/// Name of the sender.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Required when normal group signup access is unavailable.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupPossibleRequesters {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "groupName", deserialize_with = "crate::lenient::string")]
pub group_name: String,
#[serde(rename = "possibleRequesters")]
pub possible_requesters: Vec<PublicGroupSignUpPersonsItem>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSettings {
#[serde(rename = "allowChildRegistration")]
pub allow_child_registration: bool,
#[serde(rename = "allowOtherRegistration")]
pub allow_other_registration: bool,
#[serde(rename = "allowSameEmailRegistration", default, skip_serializing_if = "Option::is_none")]
pub allow_same_email_registration: Option<bool>,
/// Use `allowSameEmailRegistration` instead.
#[serde(rename = "allowSameemailRegistration", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `allowSameEmailRegistration` instead."]
pub allow_sameemail_registration: Option<bool>,
#[serde(rename = "allowSpouseRegistration")]
pub allow_spouse_registration: bool,
/// Controls email verification for anonymous group signups.
/// Allowed values: `all`, `existing`, `none`.
#[serde(rename = "emailVerificationMode", deserialize_with = "crate::lenient::string")]
pub email_verification_mode: String,
#[serde(rename = "hideContactLeader")]
pub hide_contact_leader: bool,
#[serde(rename = "hideLogin")]
pub hide_login: bool,
#[serde(rename = "showStreet")]
pub show_street: bool,
/// Last signup-notification timestamp, or null.
#[serde(rename = "signUpNotificationSent", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub sign_up_notification_sent: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Select memberships to withdraw. Use an existing requester’s sign-up token, or omit token and use the current user’s permissions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignOutRequest {
/// Person IDs, not membership IDs. Each person must be the requester or have been registered by the requester, and must be eligible for self sign-out. An empty list is accepted.
#[serde(rename = "personIds")]
pub person_ids: Vec<i64>,
/// Sign-up token belonging to this group and an existing requester. A token for a new, not-yet-created person cannot be used for sign-out.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignUpPersonsItem {
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Existing membership/request status, or NOT_CLICKED for an eligible person not yet requested. CLICKED is a client state and is not returned.
/// Allowed values: `IN_GROUP`, `NOT_CLICKED`, `REQUESTED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignoutData {
pub group: DomainObjectGroup,
#[serde(rename = "groupHasAutoAccept")]
pub group_has_auto_accept: bool,
#[serde(rename = "leaderSignOutPersons", default, skip_serializing_if = "Option::is_none")]
pub leader_sign_out_persons: Option<Vec<DomainObjectPerson>>,
/// Only present for the special no-person-created requester.
#[serde(rename = "noUserCreated", default, skip_serializing_if = "Option::is_none")]
pub no_user_created: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub requester: Option<DomainObjectPerson>,
#[serde(rename = "requesterEmail", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub requester_email: Option<String>,
#[serde(rename = "selfSignOutPersons", default, skip_serializing_if = "Option::is_none")]
pub self_sign_out_persons: Option<Vec<DomainObjectPerson>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignupCreate {
/// One entry per signup person; the controller does not enforce a nonempty list.
pub forms: Vec<PublicGroupSignupCreateFormsItem>,
/// Required when any new spouse, child or other-person form is included.
#[serde(rename = "hasAcceptedPrivacyForOther", default, skip_serializing_if = "Option::is_none")]
pub has_accepted_privacy_for_other: Option<bool>,
/// Url used in the mail sent to the user.
#[serde(rename = "signOutUrlTemplate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sign_out_url_template: Option<String>,
/// The sign up token.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignupCreateFormsItem {
/// The form data for the current person.
pub form: Vec<PublicGroupSignupCreateFormsItemFormItem>,
/// The person ID the current form applies to. Can be empty if a single new user is about to sign up.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupSignupCreateFormsItemFormItem {
/// Field ID paired with its type; use the IDs from the form response.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Allowed values: `comment`, `custom`, `person`, `privacy`, `privacyForChild`, `privacyForOther`, `privacyForSelf`, `relation`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Value according to the dynamic field definition: scalar, null, or an array for multiple choices.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub value: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupToken {
/// Provide eMail
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// The group model structures all information in different objects: `information`, `settings`, `followUp`, and `roles`. Custom group fields are added to the root level of this model.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub group: serde_json::Value,
/// Provided PersonId
#[serde(rename = "requesterId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub requester_id: Option<i64>,
/// Sign Up Token
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Link To Sign Up Form
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicGroupTokenCreate {
/// Array of person ids, which are clicked on group detail page. Those persons, will be also checked on the form site.
/// The `clicked` field will be saved only in combination with `personId`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub clicked: Option<Vec<i64>>,
/// Email address of an anonymous requester. Required in verification mode `all` when `personId` is not supplied. May be omitted in modes `existing` and `none`; in mode `existing`, matching uses the email from the signup form.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// The hash of the group homepage. If specified, the user can return to the group homepage after the sign up was successful.
#[serde(rename = "groupHomepageHash", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub group_homepage_hash: Option<String>,
/// Current logged-in person ID; an arbitrary person cannot be selected here.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_id: Option<i64>,
/// Email link template. $groupId and $token are replaced; omission uses the ChurchTools public signup page.
#[serde(rename = "signUpUrlTemplate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub sign_up_url_template: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicRelationGroupHomepage {
/// Absolute public URL of the group homepage.
#[serde(rename = "groupHomepageUrl", deserialize_with = "crate::lenient::string")]
pub group_homepage_url: String,
/// ID of the group that owns the public group homepage.
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicRelationTag {
/// Technical enum case name used by ChurchTools.
/// Allowed values: `ACTIVE`, `BIBLICALLY_DEVOTED`, `CHARISMATIC`, `CHILD_FRIENDLY`, `CLASSICAL`, `CONTEMPLATIVE`, `INTERNATIONAL`, `LIVELY`, `MISSIONARY`, `MODERN`, `OPEN_TO_GUESTS`, `PERSONAL`, `PROGRESSIVE`, `TRADITIONAL`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Translation key of the public relation profile tag.
/// Allowed values: `active`, `biblically.devoted`, `charismatic`, `child.friendly`, `classical`, `contemplative`, `international`, `lively`, `missionary`, `modern`, `open.to.guests`, `personal`, `progressive`, `traditional`.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Localized public relation profile tag name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Master data used by the public relations and public profile UI.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PublicRelationsMasterData {
/// Associations that can be assigned to a public profile.
pub associations: Vec<Association>,
/// Denominations that can be assigned to a public profile.
pub denominations: Vec<Denomination>,
/// Public group homepages with their owning group IDs and URLs.
#[serde(rename = "groupHomepages")]
pub group_homepages: Vec<PublicRelationGroupHomepage>,
/// Supported social media channels for public profile links.
/// Allowed values: `Facebook`, `Instagram`, `Pinterest`, `Snapchat`, `Soundcloud`, `Spotify`, `Telegram`, `TikTok`, `Twitter`, `Vimeo`, `WhatsApp`, `YouTube`.
#[serde(rename = "socialMedia")]
pub social_media: Vec<String>,
/// Tags that can describe a public profile.
pub tags: Vec<PublicRelationTag>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutConfigRequest {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub accept_datasecurity: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub access_control_allow_origins: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub admin_message: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_available_generation_tests: Option<f64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_count: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ai_description_generation_enabled: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub allowaiassistant: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub authorized_persons: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ccli_auto_reporting_enabled: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcal_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_css: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_firstdayinweek: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_maincalname: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcal_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcal_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_group_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_allow_person_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_delete_event_chat_after_x_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_event_chat: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchchat_invite_ct_group_chat: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_before_x_days: Option<i64>,
/// A stringified array of calendar ids
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchchat_start_event_chat_for_calendars: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_child: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_parent: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_label_standard: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchcheckin_tags: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_archivedeletehistory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_birthdaylist_status: Option<String>,
/// Allowed values: `false`, `true`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_cleverreach_connected: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_emailseparator: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchdb_groupnotchoosable: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lat: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_home_lng: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_apikey: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailchimp_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_apisecret: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_mailjet_connected: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_station: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_memberlist_status: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchdb_sendgroupmails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchdb_smscmtelecom_apikey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchdb_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchfinance_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchfinance_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchgroup_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchgroup_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchreport_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchreport_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchreport_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_anonymize_for_public_user: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_entries_last_days: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchresource_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchresource_send_emails: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchresource_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_agendashowenumeration: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_ccli_token_secret: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_entries_last_days: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_invite_persons: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchservice_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_openservice_rememberdays: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_reminderhours: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchservice_songwithcategoryasdir: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchservice_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchsync_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchsync_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchsync_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub churchwiki_active: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub churchwiki_sortcode: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cronjob_delay: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub data_privacy_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub datasecurity_banner_enabled: Option<bool>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text: Option<String>,
/// Only in extended config
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub datasecurity_privacy_agreement_text_for_children: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub deactivate_default_login: Option<bool>,
/// Allowed values: `churchtools`, `own`.
#[serde(rename = "emailServer", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub email_server: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_api_key: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_url: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub evangelische_termine_vid: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub feature_sessionless_login: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hide_licensetab: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_external_link: Option<String>,
/// This is a string that can only be true or false.
/// Allowed values: `0`, `1`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub impressum_internal: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub invite_email_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_blog_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_churchtools_onboarding_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_pr_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_rss_widget_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub ldap_otp_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub login_message: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mail_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_host: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_password: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_port: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_smtpsecure: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub mail_smtp_args_username: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub matomo_uri: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub max_uploadfile_size_kb: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_active: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_edit_time_limited: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_enabled: Option<bool>,
/// Allowed values: `all`, `featured_groups`, `my_groups`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_filter: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_email_summary_default_weekdays: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_featured_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_inmenu: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub post_sortcode: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub post_wizard_completed: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub post_wizard_groups: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub prevent_export: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_external_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_fields_mandatory_api: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub privacy_policy_internal: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub rss_widget_link: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub send_data_security_mails: Option<bool>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub show_remember_me: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_licensekey: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_logo: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_mail: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_name: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub site_offline: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_region: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub site_startpage: Option<String>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "support-user-active-since", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub support_user_active_since: Option<chrono::DateTime<chrono::Utc>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub timezone: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub welcome_subtext: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutDynamicgroupsIdRulesetResponse {
#[serde(rename = "dynamicGroupRuleSet", default, skip_serializing_if = "Option::is_none")]
pub dynamic_group_rule_set: Option<Vec<DynamicGroupRule>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutGroupsGroupIdMeetingsMeetingIdBody {
/// Meeting notes; omitted, null or blank text clears them.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Whether the meeting was canceled. Canceling retains the meeting record.
#[serde(rename = "isCanceled")]
pub is_canceled: bool,
/// Whether attendance and feedback have been marked as completed. Attendance changes through check-in endpoints are rejected while this is true.
#[serde(rename = "isCompleted")]
pub is_completed: bool,
/// Additional guest headcount entered for the meeting, or null when unspecified. This does not create person or attendance records.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "numGuests", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub num_guests: Option<Option<i64>>,
/// Feedback data to store for this meeting, typically MeetingTemplateField objects with answer values. The endpoint validates the outer array but not individual field contents. Omit or send null to clear.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "pollResult", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub poll_result: Option<Option<Vec<serde_json::Value>>>,
/// New start timestamp in UTC; dateFrom is a legacy alias.
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A person’s membership in one group. The membership has its own record ID, a role defined by the group type, and an independent membership status. Use person.domainIdentifier as personId in membership endpoint URLs; id identifies the membership record. Field visibility depends on the current user’s permissions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutGroupsGroupIdMembersPersonIdData {
/// Legacy response-field mapping emitted by the membership transformer.
#[serde(rename = "@deprecated")]
pub deprecated: GroupMemberDeprecated,
/// Comment about this membership. Only included when the current user can view basic group member fields.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Visible additional fields stored on this membership. Each entry identifies the group member field and its value. This is an array in responses; write requests use an object keyed by field ID.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Vec<GroupMemberFieldsItem>>,
/// Group to which this membership belongs.
pub group: GroupMemberGroup,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::string")]
pub group_member_status: String,
/// ID of the role definition for the group type, matching Role.id from GET /roles. This identifies the member’s role (for example, participant or leader); GroupRole.id identifies a group-specific role configuration.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// ID of the membership record linking the person and group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Membership end date, or null if none is set. Only included when the current user can view basic group member fields.
#[serde(rename = "memberEndDate", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<chrono::NaiveDate>,
/// Date on which the membership began (YYYY-MM-DD), or null if no start date is set.
#[serde(rename = "memberStartDate", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<chrono::NaiveDate>,
/// Newsletter subscription information, included when the member list is requested with include=newsletter.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub newsletter: Option<GroupMemberNewsletter>,
/// Person who belongs to the group. domainIdentifier is the person ID as a string.
pub person: GroupMemberPerson,
/// Requested additional person fields, keyed by field name. Values are subject to person-field permissions. Returned as an empty array when no fields were requested. These values belong to the person, whereas fields contains values belonging to this membership.
#[serde(rename = "personFields", default, skip_serializing_if = "serde_json::Value::is_null")]
pub person_fields: serde_json::Value,
/// use person.domainIdentifier (type: string) instead.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Person ID recorded as having registered this member, or null if none is recorded.
#[serde(rename = "registeredBy", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub registered_by: Option<i64>,
/// Timestamp of the most recent role change.
#[serde(rename = "roleChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub role_changed_date: chrono::DateTime<chrono::Utc>,
/// Timestamp of the most recent membership status change.
#[serde(rename = "statusChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub status_changed_date: chrono::DateTime<chrono::Utc>,
/// Person tags, included when the member list is requested with include=tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Position on the group’s waiting list, or null when no position is assigned.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<i64>,
/// Legacy duplicate of this membership.
#[serde(rename = "0", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub f_0: Option<PutGroupsGroupIdMembersPersonIdDataT0>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy duplicate of this membership.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutGroupsGroupIdMembersPersonIdDataT0 {
/// Legacy response-field mapping emitted by the membership transformer.
#[serde(rename = "@deprecated")]
pub deprecated: GroupMemberDeprecated,
/// Comment about this membership. Only included when the current user can view basic group member fields.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Visible additional fields stored on this membership. Each entry identifies the group member field and its value. This is an array in responses; write requests use an object keyed by field ID.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Vec<GroupMemberFieldsItem>>,
/// Group to which this membership belongs.
pub group: GroupMemberGroup,
/// State of a person's membership in a group, independent of their role. active is an active membership; requested awaits confirmation; waiting is on the waiting list; to_delete is pending removal. Use GET /group/memberstatus for localized display names. A pending-removal membership still exists.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::string")]
pub group_member_status: String,
/// ID of the role definition for the group type, matching Role.id from GET /roles. This identifies the member’s role (for example, participant or leader); GroupRole.id identifies a group-specific role configuration.
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// ID of the membership record linking the person and group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Membership end date, or null if none is set. Only included when the current user can view basic group member fields.
#[serde(rename = "memberEndDate", default, skip_serializing_if = "Option::is_none")]
pub member_end_date: Option<chrono::NaiveDate>,
/// Date on which the membership began (YYYY-MM-DD), or null if no start date is set.
#[serde(rename = "memberStartDate", default, skip_serializing_if = "Option::is_none")]
pub member_start_date: Option<chrono::NaiveDate>,
/// Newsletter subscription information, included when the member list is requested with include=newsletter.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub newsletter: Option<GroupMemberNewsletter>,
/// Person who belongs to the group. domainIdentifier is the person ID as a string.
pub person: GroupMemberPerson,
/// Requested additional person fields, keyed by field name. Values are subject to person-field permissions. Returned as an empty array when no fields were requested. These values belong to the person, whereas fields contains values belonging to this membership.
#[serde(rename = "personFields", default, skip_serializing_if = "serde_json::Value::is_null")]
pub person_fields: serde_json::Value,
/// use person.domainIdentifier (type: string) instead.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Person ID recorded as having registered this member, or null if none is recorded.
#[serde(rename = "registeredBy", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub registered_by: Option<i64>,
/// Timestamp of the most recent role change.
#[serde(rename = "roleChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub role_changed_date: chrono::DateTime<chrono::Utc>,
/// Timestamp of the most recent membership status change.
#[serde(rename = "statusChangedDate", serialize_with = "crate::datetime::serialize_utc")]
pub status_changed_date: chrono::DateTime<chrono::Utc>,
/// Person tags, included when the member list is requested with include=tags.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<Tag>>,
/// Position on the group’s waiting list, or null when no position is assigned.
#[serde(rename = "waitinglistPosition", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub waitinglist_position: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct PutPermissionsLockedData {
pub permissions: Vec<LockedPermission>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Pending self-registration.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Registration {
/// Configuration GUID, despite the `configId` property name.
#[serde(rename = "configId", deserialize_with = "crate::lenient::string")]
pub config_id: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub email: String,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
pub meta: MetaDataEntityId,
/// Only included after confirmation when active persons share the default email address; omitted when there are no matches.
#[serde(rename = "possibleMatches", default, skip_serializing_if = "Option::is_none")]
pub possible_matches: Option<Vec<RegistrationPossibleMatchesItem>>,
#[serde(rename = "redirectAfterRegistration", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redirect_after_registration: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Self-registration form configuration. Administrative properties are included for callers with "churchcore administer persons" permission.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfig {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub deprecated: Option<String>,
/// Administrators only. Blocked email patterns; `*` matches arbitrary text, case-insensitively.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub blacklist: Option<Vec<String>>,
pub campuses: Vec<RegistrationConfigCampusesItem>,
/// Administrators only. Departments assigned to newly created persons.
#[serde(rename = "departmentIds", default, skip_serializing_if = "Option::is_none")]
pub department_ids: Option<Vec<i64>>,
pub fields: Vec<RegistrationConfigFieldsItem>,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isActive")]
pub is_active: bool,
/// True when `statusId` is set and department/campus configurations are nonempty; independent of `isActive`.
#[serde(rename = "isComplete")]
pub is_complete: bool,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
#[serde(rename = "minimumAge", deserialize_with = "crate::lenient::number")]
pub minimum_age: i64,
/// Shows the registration entry point and permits numeric-ID public reads.
#[serde(rename = "showButton")]
pub show_button: bool,
/// Administrators only. Status assigned to newly created persons.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
/// Administrative compatibility alias for `tagsForNewPersons`.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub tags: Option<Vec<String>>,
/// Administrators only. Person tag names added when linking an existing person.
#[serde(rename = "tagsForExistingPersons", default, skip_serializing_if = "Option::is_none")]
pub tags_for_existing_persons: Option<Vec<String>>,
/// Administrators only. Person tag names added to newly created persons.
#[serde(rename = "tagsForNewPersons", default, skip_serializing_if = "Option::is_none")]
pub tags_for_new_persons: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configuration as returned to administrators; includes assignment settings and audit metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigAdmin {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::string")]
pub deprecated: String,
/// Administrators only. Blocked email patterns; `*` matches arbitrary text, case-insensitively.
pub blacklist: Vec<String>,
pub campuses: Vec<RegistrationConfigCampusesItem>,
/// Administrators only. Departments assigned to newly created persons.
#[serde(rename = "departmentIds")]
pub department_ids: Vec<i64>,
pub fields: Vec<RegistrationConfigFieldsItem>,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isActive")]
pub is_active: bool,
/// True when `statusId` is set and department/campus configurations are nonempty; independent of `isActive`.
#[serde(rename = "isComplete")]
pub is_complete: bool,
pub meta: MetaDataEntityId,
#[serde(rename = "minimumAge", deserialize_with = "crate::lenient::number")]
pub minimum_age: i64,
/// Shows the registration entry point and permits numeric-ID public reads.
#[serde(rename = "showButton")]
pub show_button: bool,
/// Administrators only. Status assigned to newly created persons.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<i64>,
/// Administrative compatibility alias for `tagsForNewPersons`.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub tags: Option<Vec<String>>,
/// Administrators only. Person tag names added when linking an existing person.
#[serde(rename = "tagsForExistingPersons")]
pub tags_for_existing_persons: Vec<String>,
/// Administrators only. Person tag names added to newly created persons.
#[serde(rename = "tagsForNewPersons")]
pub tags_for_new_persons: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigCampusesItem {
/// Profiles are representing campuses and the church itself.
pub campus: Profile,
#[serde(rename = "campusId", deserialize_with = "crate::lenient::number")]
pub campus_id: i64,
/// Automatic membership groups for new persons; administrators only.
#[serde(rename = "groupIds", default, skip_serializing_if = "Option::is_none")]
pub group_ids: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigFieldsItem {
/// Expanded database-field definition when resolvable.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub field: Option<RegistrationConfigFieldsItemField>,
#[serde(rename = "fieldId", deserialize_with = "crate::lenient::number")]
pub field_id: i64,
#[serde(rename = "isRequired")]
pub is_required: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Expanded database-field definition when resolvable.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigFieldsItemField {
/// Whether a person field’s value is cleared on archiving. Cannot be true for a non-nullable field.
#[serde(rename = "deleteOnArchive")]
pub delete_on_archive: bool,
/// Whether the field is enabled for normal use.
#[serde(rename = "isActive")]
pub is_active: bool,
/// Whether routines may use this field.
#[serde(rename = "isAvailableInRoutines")]
pub is_available_in_routines: bool,
/// Whether the field is available on new-person forms; primarily relevant to person categories.
#[serde(rename = "isNewPersonField")]
pub is_new_person_field: bool,
/// Configured field length.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub length: Option<i64>,
/// Legacy display-layout setting, retained for compatibility.
#[serde(rename = "lineEnding", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub line_ending: Option<String>,
/// Stored display name or translation key. nameTranslated is its localized display text.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Security-level ID governing access to this field, resolved from installation masterdata.
#[serde(rename = "securityLevel", deserialize_with = "crate::lenient::number")]
pub security_level: i64,
/// Abbreviated label.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Display-order value within its category.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether the field may be used as a placeholder.
#[serde(rename = "useAsPlaceholder")]
pub use_as_placeholder: bool,
/// Compatibility mappings emitted by the backend.
#[serde(rename = "@deprecated")]
pub deprecated: DbFieldDeprecated,
/// Underlying database column; prefer key for API requests.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub column: Option<String>,
/// True for a custom field created by this ChurchTools installation.
#[serde(rename = "createdByChurch")]
pub created_by_church: bool,
/// Stored field category and its underlying entity table. Use internCode when creating a field.
#[serde(rename = "fieldCategory")]
pub field_category: DbFieldCategory,
/// Database-field type definition. internCode selects the input/validation behavior; the numeric ID is referenced by field definitions. The name can be a translation key.
#[serde(rename = "fieldType")]
pub field_type: DbFieldType,
/// Stored flag controlling frontend visibility; current updates reset it to false.
#[serde(rename = "hideInFrontend")]
pub hide_in_frontend: bool,
/// Field-definition ID used in /dbfields paths.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether the field is marked as basic information; current updates reset it to false.
#[serde(rename = "isBasicInfo")]
pub is_basic_info: bool,
/// Whether the field is marked as non-configurable; current updates reset it to false.
#[serde(rename = "isNotConfigurable")]
pub is_not_configurable: bool,
/// Whether stored field values may be null. Custom checkbox fields are non-nullable.
#[serde(rename = "isNullable")]
pub is_nullable: bool,
/// API property name. Built-in columns are mapped to API names; custom fields normally retain their generated column name.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Localized display name for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Deprecated alias of isNotConfigurable.
#[serde(rename = "notConfigurable", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub not_configurable: Option<bool>,
/// Deprecated alias of isNullable.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub nullable: Option<bool>,
/// Optional choices, included by an unfiltered list with include\[\]=options. The row shape depends on the field. Campus and group-visibility fields use specialized representations in this expansion.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<DbFieldOption>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial self-registration configuration update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigUpdate {
/// Case-insensitive email patterns; `*` is a wildcard. Replaces the full blacklist.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub blacklist: Option<Vec<String>>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub campuses: Option<Vec<RegistrationConfigUpdateCampusesItem>>,
#[serde(rename = "departmentIds", default, skip_serializing_if = "Option::is_none")]
pub department_ids: Option<Vec<i64>>,
/// Complete replacement of configured person fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub fields: Option<Vec<RegistrationConfigUpdateFieldsItem>>,
#[serde(rename = "isActive", default, skip_serializing_if = "Option::is_none")]
pub is_active: Option<bool>,
#[serde(rename = "minimumAge", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub minimum_age: Option<i64>,
#[serde(rename = "showButton", default, skip_serializing_if = "Option::is_none")]
pub show_button: Option<bool>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "statusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub status_id: Option<Option<i64>>,
/// Legacy input alias; prefer `tagsForNewPersons`.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub tags: Option<Vec<String>>,
#[serde(rename = "tagsForExistingPersons", default, skip_serializing_if = "Option::is_none")]
pub tags_for_existing_persons: Option<Vec<String>>,
#[serde(rename = "tagsForNewPersons", default, skip_serializing_if = "Option::is_none")]
pub tags_for_new_persons: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigUpdateCampusesItem {
#[serde(rename = "campusId", deserialize_with = "crate::lenient::number")]
pub campus_id: i64,
#[serde(rename = "groupIds")]
pub group_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfigUpdateFieldsItem {
#[serde(rename = "fieldId", deserialize_with = "crate::lenient::number")]
pub field_id: i64,
#[serde(rename = "isRequired")]
pub is_required: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConfirm {
/// Confirmation token from the emailed link.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConvert {
/// Consent fields plus configured person fields by numeric field ID or modern field name.
#[serde(rename = "formData")]
pub form_data: RegistrationConvertFormData,
/// Eligible existing person to link; without it, a new person is created.
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub person_id: Option<i64>,
/// Same token used for email confirmation.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Consent fields plus configured person fields by numeric field ID or modern field name.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationConvertFormData {
/// Explicit acceptance of the data privacy policy.
#[serde(rename = "acceptDataPrivacy")]
pub accept_data_privacy: bool,
/// Required when `accept_datasecurity` is enabled.
#[serde(rename = "acceptDataSecurity", default, skip_serializing_if = "Option::is_none")]
pub accept_data_security: Option<bool>,
/// Configured campus for a new person. Required with multiple campus choices.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationCreate {
/// GUID from `RegistrationConfig.guid`.
#[serde(rename = "configId", deserialize_with = "crate::lenient::string")]
pub config_id: String,
/// Email address used for confirmation.
#[serde(deserialize_with = "crate::lenient::string")]
pub email: String,
/// Given name.
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
/// Applicant confirms the configured minimum age.
#[serde(rename = "hasMinimumAge", default, skip_serializing_if = "Option::is_none")]
pub has_minimum_age: Option<bool>,
/// Family name.
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Must satisfy the configured password-strength requirements.
#[serde(deserialize_with = "crate::lenient::string")]
pub password: String,
/// Destination for the client after completion.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "redirectAfterRegistration", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub redirect_after_registration: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RegistrationPossibleMatchesItem {
/// Person as Domain Object
#[serde(rename = "domainObject")]
pub domain_object: DomainObjectPerson,
/// Configured active person fields, keyed by person field name. Available for the email-verified applicant.
#[serde(rename = "formData", deserialize_with = "crate::lenient::map")]
pub form_data: std::collections::BTreeMap<String, serde_json::Value>,
#[serde(rename = "hasPassword")]
pub has_password: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Definition of a relationship between two persons, such as Parent / Child or Friend / Friend. This is catalog metadata, not an actual relationship between named persons. The two role labels describe its sides; identical stored labels make it undirected in the backend. Security and export settings concern use of relationships of this type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RelationshipType {
/// Role label for side A. Identical labels on both sides make the type undirected.
#[serde(rename = "degreeNameA", deserialize_with = "crate::lenient::string")]
pub degree_name_a: String,
/// Role label for side B and counterpart of `degreeNameA`.
#[serde(rename = "degreeNameB", deserialize_with = "crate::lenient::string")]
pub degree_name_b: String,
/// Heading for the combined export column. The export otherwise uses the type name or synthesized role labels.
#[serde(rename = "exportTitle", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub export_title: Option<String>,
/// Whether selected export values from both relationship directions are combined in one column. `false` still permits separate-direction export.
#[serde(rename = "includeInExport")]
pub include_in_export: bool,
/// Stored type name or translation key. Use `nameTranslated` for the synthesized display label.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Security level configured for relationships of this type.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::number")]
pub security_level_id: i64,
/// Primary ascending catalog sort key. Ties are ordered by stored name, not by the translated or synthesized display name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Side A role label translated for the current language.
#[serde(rename = "degreeNameATranslated", deserialize_with = "crate::lenient::string")]
pub degree_name_a_translated: String,
/// Side B role label translated for the current language.
#[serde(rename = "degreeNameBTranslated", deserialize_with = "crate::lenient::string")]
pub degree_name_b_translated: String,
/// Built-in behavior flags; always an array, empty for ordinary custom types. `nodelete` protects the type from deletion; `noduplicate` and `openduplicate` identify types used by duplicate-person handling.
/// Allowed values: `nodelete`, `noduplicate`, `openduplicate`.
#[serde(rename = "functionKeys")]
pub function_keys: Vec<String>,
/// Relationship-type ID used when creating or reading a relationship between persons.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Translated display name, using the translated side labels as a fallback.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates a relationship-type catalog definition, not a relationship between persons.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RelationshipTypeCreate {
/// Role label for side A. Identical labels on both sides make the type undirected.
#[serde(rename = "degreeNameA", deserialize_with = "crate::lenient::string")]
pub degree_name_a: String,
/// Role label for side B and counterpart of `degreeNameA`.
#[serde(rename = "degreeNameB", deserialize_with = "crate::lenient::string")]
pub degree_name_b: String,
/// Heading for the combined export column. The export otherwise uses the type name or synthesized role labels.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "exportTitle", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub export_title: Option<Option<String>>,
/// Controls column aggregation when this relationship is selected for person export. `true` combines both directions into one column; `false` uses separate columns. It does not disable export.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "includeInExport", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub include_in_export: Option<Option<bool>>,
/// Stored name or translation key. The response derives `nameTranslated` from the side labels when necessary.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// ID of an existing, installation-specific security level for relationships of this type.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::number")]
pub security_level_id: i64,
/// Ascending catalog sort key.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement fields for an existing relationship type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RelationshipTypeUpdate {
/// Role label for side A. Identical labels on both sides make the type undirected.
#[serde(rename = "degreeNameA", deserialize_with = "crate::lenient::string")]
pub degree_name_a: String,
/// Role label for side B and counterpart of `degreeNameA`.
#[serde(rename = "degreeNameB", deserialize_with = "crate::lenient::string")]
pub degree_name_b: String,
/// Heading for the combined export column. The export otherwise uses the type name or synthesized role labels.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "exportTitle", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub export_title: Option<Option<String>>,
/// Controls column aggregation when this relationship is selected for person export. `true` combines both directions into one column; `false` uses separate columns. It does not disable export.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "includeInExport", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub include_in_export: Option<Option<bool>>,
/// Stored name or translation key. The response derives `nameTranslated` from the side labels when necessary.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// ID of an existing, installation-specific security level for relationships of this type.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::number")]
pub security_level_id: i64,
/// Ascending catalog sort key.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Echo of the transient recurrence definition.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RepeatCalculationBase {
pub additions: Vec<std::collections::BTreeMap<String, serde_json::Value>>,
#[serde(rename = "allDay")]
pub all_day: bool,
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
pub exceptions: Vec<std::collections::BTreeMap<String, serde_json::Value>>,
/// Placeholder ID because no appointment is stored.
/// Allowed values: `-1`.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<i64>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::number")]
pub repeat_id: i64,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<i64>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
#[serde(rename = "repeatUntil", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<chrono::NaiveDate>,
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Calculate occurrence dates without persisting an appointment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RepeatCalculationCreate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub additionals: Option<Vec<AppointmentAdditionalCreate>>,
/// End of the base occurrence. For timed appointments it must be later than startDate. For all-day appointments this date is inclusive and may equal startDate for a one-day appointment.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub exceptions: Option<Vec<AppointmentExceptionCreate>>,
/// Interval between repetitions; use a positive integer for automatic patterns, for example 2 with repeatId=7 for every two weeks. Irrelevant for once/manual patterns.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatFrequency", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_frequency: Option<Option<i64>>,
/// Recurrence pattern: 0 = once, 1 = daily, 7 = weekly, 31 = monthly by date, 32 = monthly by weekday, 365 = yearly, 999 = manually selected dates. Automatic patterns use repeatFrequency and repeatUntil; manual dates use additionals.
/// Allowed values: `0`, `1`, `31`, `32`, `365`, `7`, `999`.
#[serde(rename = "repeatId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub repeat_id: Option<i64>,
/// For repeatId=32, ordinal of the weekday within the month: 1–5 for first through fifth, 6 for last. The weekday comes from startDate.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatOption", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_option: Option<Option<i64>>,
/// Inclusive last date of an automatic series. Supply this with automatic recurrence; omission does not represent an unlimited series in these write endpoints.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "repeatUntil", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub repeat_until: Option<Option<chrono::NaiveDate>>,
/// Start of the base occurrence. For all-day appointments, send YYYY-MM-DD.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One computed occurrence of a transient recurrence definition. No iCalendar UID is assigned.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RepeatCalculationOccurrence {
/// Echo of the transient recurrence definition.
pub base: RepeatCalculationBase,
pub calculated: RepeatCalculationOccurrenceCalculated,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RepeatCalculationOccurrenceCalculated {
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "endDate")]
pub end_date: crate::DateOrDateTime,
/// Use a UTC timestamp for a timed appointment or YYYY-MM-DD for an all-day appointment. ChurchTools interprets dates in the installation’s timezone. Seconds on appointment input are discarded.
#[serde(rename = "startDate")]
pub start_date: crate::DateOrDateTime,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Report {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
pub meta: MetaDataEntityId,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub reporter: serde_json::Value,
/// Allowed values: `accepted`, `declined`, `pending`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ReportAnswer {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Allowed values: `post`, `post_comment`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Allowed values: `accept`, `decline`.
#[serde(deserialize_with = "crate::lenient::string")]
pub response: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ReportCreate {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub captcha: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Allowed values: `post`, `post_comment`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reporter: Option<ReportCreateReporter>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ReportCreateReporter {
#[serde(deserialize_with = "crate::lenient::string")]
pub email: String,
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ReportObjectPost {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
pub reports: Vec<Report>,
/// Allowed values: `accepted`, `declined`, `pending`, `pending-again`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
#[serde(rename = "domainObject")]
pub domain_object: Post,
/// Allowed values: `post`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ReportObjectPostComment {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
pub reports: Vec<Report>,
/// Allowed values: `accepted`, `declined`, `pending`, `pending-again`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
#[serde(rename = "domainObject")]
pub domain_object: PostComment,
/// Allowed values: `post_comment`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A compact object returned by the registered domain resolver. Match results by `domainType` and `domainIdentifier`, not by array index.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResolvedDomainObject {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
pub infos: Vec<String>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An individual bookable resource, such as a room, vehicle or item of equipment. A resource type groups similar resources. Bookings reserve this resource for specific dates.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Resource {
/// Persons responsible for this resource. Resource administrators can view and administer its bookings; changing resource settings still requires permission to edit resource master data.
#[serde(rename = "adminIds")]
pub admin_ids: Vec<i64>,
/// Additional information about the resource, such as capacity or available equipment.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Location text used in the resource’s iCalendar export.
#[serde(rename = "iCalLocation", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub i_cal_location: Option<String>,
/// Automatically approves pending bookings when there are no conflicts. For virtual resources, automatic approval bypasses the conflict check. This does not grant permission to edit resource settings.
#[serde(rename = "isAutoAccept")]
pub is_auto_accept: bool,
/// Whether this is a virtual resource. Virtual bookings have a separate creation permission and bypass conflicts when checking automatic approval.
#[serde(rename = "isVirtual")]
pub is_virtual: bool,
/// Internal location of the resource.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub location: Option<String>,
/// Name of the individual resource, for example a room or vehicle.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Number of units available for simultaneous bookings.
#[serde(deserialize_with = "crate::lenient::number")]
pub quantity: i64,
/// Access token used by the legacy public iCalendar export. Changing or clearing it invalidates subscriptions using the previous token.
#[serde(rename = "randomString", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub random_string: Option<String>,
/// Resource type used to group this resource, such as rooms or vehicles. Resource types are available from `/resourcetypes`.
#[serde(rename = "resourceTypeId", deserialize_with = "crate::lenient::number")]
pub resource_type_id: i64,
/// Sort value for displaying resources.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Use `needsAppointment` instead.
#[serde(rename = "doesRequireCalEntry", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `needsAppointment` instead."]
pub does_require_cal_entry: Option<bool>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Included with `include[]=involvedPersonsDomainObjects`. Contains person references for resolvable `adminIds`; missing persons are omitted.
#[serde(rename = "involvedPersonsDomainObjects", default, skip_serializing_if = "Option::is_none")]
pub involved_persons_domain_objects: Option<BookingCalculatedWithIncludesBaseResourceInvolvedPersonsDomainObjects>,
pub meta: MetaDataEntityId,
/// Resource name translated for the current language, falling back to name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Whether bookings must be linked to a calendar appointment. Legacy resources can return null.
#[serde(rename = "needsAppointment", default, skip_serializing_if = "Option::is_none")]
pub needs_appointment: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configuration for an individual bookable resource.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceCreate {
/// Persons responsible for this resource. Resource administrators can view and administer its bookings; changing resource settings still requires permission to edit resource master data.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<i64>>,
/// Additional information about the resource, such as capacity or available equipment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Location text used in the resource’s iCalendar export.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "iCalLocation", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub i_cal_location: Option<Option<String>>,
/// Automatically approves pending bookings when there are no conflicts. For virtual resources, automatic approval bypasses the conflict check. This does not grant permission to edit resource settings.
#[serde(rename = "isAutoAccept", default, skip_serializing_if = "Option::is_none")]
pub is_auto_accept: Option<bool>,
/// Whether this is a virtual resource. Virtual bookings have a separate creation permission and bypass conflicts when checking automatic approval.
#[serde(rename = "isVirtual", default, skip_serializing_if = "Option::is_none")]
pub is_virtual: Option<bool>,
/// Internal location of the resource.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub location: Option<Option<String>>,
/// Name of the individual resource, for example a room or vehicle.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Number of units available for simultaneous bookings.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Access token used by the legacy public iCalendar export. Changing or clearing it invalidates subscriptions using the previous token.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "randomString", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub random_string: Option<Option<String>>,
/// Resource type used to group this resource, such as rooms or vehicles. Resource types are available from `/resourcetypes`.
#[serde(rename = "resourceTypeId", deserialize_with = "crate::lenient::number")]
pub resource_type_id: i64,
/// Sort value for displaying resources.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Requires bookings to be linked to a calendar appointment. When true, create bookings through the appointment APIs; `POST /bookings` cannot create independent bookings for this resource.
#[serde(rename = "needsAppointment", default, skip_serializing_if = "Option::is_none")]
pub needs_appointment: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Resource planning reference data: all resource types and the resources visible to the current user.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceMasterData {
/// All resource types ordered by sortKey ascending, including types without visible resources.
#[serde(rename = "resourceTypes")]
pub resource_types: Vec<ResourceType>,
/// Resources the current user is allowed to view.
pub resources: Vec<Resource>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Pending booking workload for one resource.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceStatistics {
/// Number of pending booking occurrences from now onward, rather than distinct booking IDs. Candidate series are selected in a ten-year lookahead window; their remaining occurrences are then expanded without an upper date limit.
#[serde(rename = "numRequestedBookingsInFuture", deserialize_with = "crate::lenient::number")]
pub num_requested_bookings_in_future: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Category used by `Resource.resourceTypeId`. Resource types are returned even when the reader has no visible resources of that type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceType {
/// Associated campus, or null for no campus assignment.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Singular label for one resource of this type.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Plural label for resources of this type.
#[serde(rename = "namePlural", deserialize_with = "crate::lenient::string")]
pub name_plural: String,
/// Sort value for displaying resource types.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Plural label translated for the current language.
#[serde(rename = "namePluralTranslated", deserialize_with = "crate::lenient::string")]
pub name_plural_translated: String,
/// Singular label translated for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A category for resources, such as rooms or vehicles. A campus is an organizational location in ChurchTools; `campusId` is optional.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceTypeCreate {
/// Associated campus, or null for no campus assignment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Singular label for one resource of this type.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Plural label for resources of this type.
#[serde(rename = "namePlural", deserialize_with = "crate::lenient::string")]
pub name_plural: String,
/// Sort value for displaying resource types.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Complete resource-type input. The resource type ID is supplied in the path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceTypeUpdate {
/// Associated campus, or null for no campus assignment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Singular label for one resource of this type.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Plural label for resources of this type.
#[serde(rename = "namePlural", deserialize_with = "crate::lenient::string")]
pub name_plural: String,
/// Sort value for displaying resource types.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Complete resource configuration. The resource ID is supplied in the path.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ResourceUpdate {
/// Persons responsible for this resource. Resource administrators can view and administer its bookings; changing resource settings still requires permission to edit resource master data.
#[serde(rename = "adminIds", default, skip_serializing_if = "Option::is_none")]
pub admin_ids: Option<Vec<i64>>,
/// Additional information about the resource, such as capacity or available equipment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Location text used in the resource’s iCalendar export.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "iCalLocation", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub i_cal_location: Option<Option<String>>,
/// Automatically approves pending bookings when there are no conflicts. For virtual resources, automatic approval bypasses the conflict check. This does not grant permission to edit resource settings.
#[serde(rename = "isAutoAccept", default, skip_serializing_if = "Option::is_none")]
pub is_auto_accept: Option<bool>,
/// Whether this is a virtual resource. Virtual bookings have a separate creation permission and bypass conflicts when checking automatic approval.
#[serde(rename = "isVirtual", default, skip_serializing_if = "Option::is_none")]
pub is_virtual: Option<bool>,
/// Internal location of the resource.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub location: Option<Option<String>>,
/// Name of the individual resource, for example a room or vehicle.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Number of units available for simultaneous bookings.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub quantity: Option<i64>,
/// Access token used by the legacy public iCalendar export. Changing or clearing it invalidates subscriptions using the previous token.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "randomString", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub random_string: Option<Option<String>>,
/// Resource type used to group this resource, such as rooms or vehicles. Resource types are available from `/resourcetypes`.
#[serde(rename = "resourceTypeId", deserialize_with = "crate::lenient::number")]
pub resource_type_id: i64,
/// Sort value for displaying resources.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Requires bookings to be linked to a calendar appointment. When true, create bookings through the appointment APIs; `POST /bookings` cannot create independent bookings for this resource.
#[serde(rename = "needsAppointment", default, skip_serializing_if = "Option::is_none")]
pub needs_appointment: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A membership role defined for a group type, such as leader or participant. Groups of that type use this definition and add their own settings through GroupRole. A role describes a person's function; MemberStatus separately describes whether their membership is active, requested, waiting or pending removal.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Role {
/// ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// ID of the growth path associated with this role, or null for no association. Growth paths track steps in a person's development in ChurchTools.
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
/// Whether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
#[serde(rename = "isHidden")]
pub is_hidden: bool,
/// Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
#[serde(rename = "isLeader", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead; this field is not used to create or update a role."]
pub is_leader: Option<bool>,
/// Stored name of the role. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Abbreviated label for the role, used in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order among roles. Lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Functional classification of the role. Multiple roles with different names can share the same classification.
/// Allowed values: `leader`, `participant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// ID of this role record. For Role this identifies the group-type definition; for GroupRole it identifies the settings record for a specific group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoleCreate {
/// ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
#[serde(rename = "groupTypeId", deserialize_with = "crate::lenient::number")]
pub group_type_id: i64,
/// ID of the growth path associated with this role, or null for no association. Growth paths track steps in a person's development in ChurchTools.
#[serde(rename = "growPathId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub grow_path_id: Option<i64>,
/// Whether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
#[serde(rename = "isDefault")]
pub is_default: bool,
/// Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
#[serde(rename = "isHidden")]
pub is_hidden: bool,
/// Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
#[serde(rename = "isLeader", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use type instead; this field is not used to create or update a role."]
pub is_leader: Option<bool>,
/// Stored name of the role. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Abbreviated label for the role, used in compact displays.
#[serde(deserialize_with = "crate::lenient::string")]
pub shorty: String,
/// Display order among roles. Lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Functional classification of the role. Multiple roles with different names can share the same classification.
/// Allowed values: `leader`, `participant`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Personal setting containing the secret used by a roster calendar subscription.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RosterICalSetting {
/// Allowed values: `rosterICalSecret`.
#[serde(deserialize_with = "crate::lenient::string")]
pub attribute: String,
/// Allowed values: `churchservice`.
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Secret identifying the person in the subscription URL. Creating a new roster link replaces this value.
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Automation definition, including enabled and disabled steps as a nested tree. Domain context bindings and per-membership execution progress are separate resources.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Routine {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Allowed values: `group_membership`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isEnabled")]
pub is_enabled: bool,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub priority: i64,
/// Root steps in sort order, with children nested on their parent steps. Empty child arrays are omitted by the serializer.
pub steps: Vec<serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineActionValidation {
/// Action-specific data. Omission defaults to an empty PHP array.
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Registered action key, or special:wait / special:repeat.
#[serde(rename = "actionKey", deserialize_with = "crate::lenient::string")]
pub action_key: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineCreate {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Context for the currently supported group_membership domain. Group and role IDs are required by the domain handler.
#[serde(rename = "domainContext")]
pub domain_context: RoutineCreateDomainContext,
/// Allowed values: `group_membership`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "isEnabled", default, skip_serializing_if = "Option::is_none")]
pub is_enabled: Option<bool>,
/// Trimmed automation name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub priority: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Context for the currently supported group_membership domain. Group and role IDs are required by the domain handler.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineCreateDomainContext {
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Optional membership status for the binding; null means the active/default status representation.
/// Allowed values: `active`, `requested`, `to_delete`, `waiting`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "groupMemberStatus", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub group_member_status: Option<Option<String>>,
#[serde(rename = "groupTypeRoleId", deserialize_with = "crate::lenient::number")]
pub group_type_role_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineRun {
/// Current iteration while in a loop, otherwise this attribute is undefined
#[serde(rename = "currentIteration", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub current_iteration: Option<i64>,
/// Group membership ID, not a person or group ID.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Only present with include\[\]=domainObject; null when resolution fails.
#[serde(rename = "domainObject", default, skip_serializing_if = "Option::is_none")]
pub domain_object: Option<DomainObjectGroupMembership>,
/// Allowed values: `group_membership`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Allowed values: `exception-thrown`, `invalid-step-id`, `loop-detected`.
#[serde(rename = "errorCode", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub error_code: Option<String>,
/// Can be either an error message or an translatable messageKey
#[serde(rename = "errorMessage", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub error_message: Option<String>,
/// Persisted run ID, or null for an unpersisted potential run.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<MetaDataEntityId>,
#[serde(rename = "routineId", deserialize_with = "crate::lenient::number")]
pub routine_id: i64,
#[serde(rename = "routineStepId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub routine_step_id: Option<i64>,
/// Allowed values: `failed`, `finished`, `not-started`, `paused`, `rerun-step`, `started`, `waiting`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "waitingSince", default, skip_serializing_if = "Option::is_none")]
pub waiting_since: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineRunBulkUpdate {
/// Run IDs processed sequentially. Duplicates are not rejected.
#[serde(rename = "runIds")]
pub run_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Only read for the update action. At most one state field can be supplied; an empty object is accepted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineRunUpdate {
/// Update the current iteration for a special:repeat step
#[serde(rename = "currentIteration", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub current_iteration: Option<i64>,
/// Update the waiting since date for a special:wait step
#[serde(rename = "waitingSince", default, skip_serializing_if = "Option::is_none")]
pub waiting_since: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Persisted repeat step. Unlike the create payload, an empty children list is omitted in responses.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineStepRepeat {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "routineId", deserialize_with = "crate::lenient::number")]
pub routine_id: i64,
#[serde(rename = "actionData")]
pub action_data: RoutineStepRepeatActionData,
/// Allowed values: `special:repeat`.
#[serde(rename = "actionKey", deserialize_with = "crate::lenient::string")]
pub action_key: String,
/// Child steps when present. Omitted for an empty repeat step.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub children: Option<Vec<RoutineStepWithoutRepeat>>,
#[serde(rename = "isEnabled")]
pub is_enabled: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineStepRepeatActionData {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub count: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineStepUpdateRepeat {
#[serde(rename = "actionData")]
pub action_data: RoutineStepRepeatActionData,
/// Allowed values: `special:repeat`.
#[serde(rename = "actionKey", deserialize_with = "crate::lenient::string")]
pub action_key: String,
pub children: Vec<RoutineStepUpdateWithoutRepeat>,
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finish: Option<Vec<serde_json::Value>>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "isEnabled")]
pub is_enabled: bool,
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reposition: Option<Vec<serde_json::Value>>,
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub restart: Option<Vec<serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineStepUpdateWithoutRepeat {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub reposition: Option<Vec<serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineStepWithoutRepeat {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "routineId", deserialize_with = "crate::lenient::number")]
pub routine_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RoutineUpdate {
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Source step IDs or run status buckets. not-started materializes potential runs; this is not a list of run IDs.
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub finish: Option<Vec<serde_json::Value>>,
#[serde(rename = "isEnabled", default, skip_serializing_if = "Option::is_none")]
pub is_enabled: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub priority: Option<i64>,
/// Source step IDs or run status buckets. not-started materializes potential runs; this is not a list of run IDs.
/// Allowed values: `finished`, `not-started`, `started`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub restart: Option<Vec<serde_json::Value>>,
/// Complete replacement tree; omitted existing steps are removed.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub steps: Option<Vec<serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct RssFeed {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
pub items: Vec<BlogItem>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "totalCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub total_count: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One usable IdP descriptor found in the uploaded document. This is parsed configuration data, not proof of metadata authenticity or a working login.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SamlIdpMetadataDescriptor {
/// Deduplicated PEM certificate strings for this usage. A key descriptor with no use attribute can appear in both lists. Certificates must parse as X.509; this operation does not establish trust or verify metadata signatures.
#[serde(rename = "encryptionCertificates")]
pub encryption_certificates: Vec<String>,
/// Nonempty entityID from the EntityDescriptor.
#[serde(rename = "entityId", deserialize_with = "crate::lenient::string")]
pub entity_id: String,
/// Deduplicated PEM certificate strings for this usage. A key descriptor with no use attribute can appear in both lists. Certificates must parse as X.509; this operation does not establish trust or verify metadata signatures.
#[serde(rename = "signingCertificates")]
pub signing_certificates: Vec<String>,
/// Optional supported SLO endpoints. May be empty.
#[serde(rename = "singleLogoutServices")]
pub single_logout_services: Vec<SamlMetadataEndpoint>,
/// Supported SSO endpoints. Descriptors without any usable SSO endpoint are skipped.
#[serde(rename = "singleSignOnServices")]
pub single_sign_on_services: Vec<SamlMetadataEndpoint>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An endpoint using the supported HTTP-Redirect binding. Unsupported bindings and invalid endpoint URLs are excluded.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SamlMetadataEndpoint {
/// Allowed values: `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect`.
#[serde(deserialize_with = "crate::lenient::string")]
pub binding: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Read-only request to parse a SAML IdP metadata document. The server never fetches a metadata URL for this operation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SamlMetadataParseCreate {
/// XML document with EntityDescriptor or EntitiesDescriptor root in the SAML metadata namespace. Trimmed UTF-8 input is limited to 1,048,576 bytes. DOCTYPE and ENTITY declarations are rejected.
#[serde(deserialize_with = "crate::lenient::string")]
pub xml: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SecurityLevel {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub sortkey: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A reusable role in event planning, such as Lead vocals. It belongs to a service group. A person assigned to this role at a particular event is a separate service assignment.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Service {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Enable chat for this service.
#[serde(rename = "allowChat")]
pub allow_chat: bool,
/// Allow a comment when confirming a service request.
#[serde(rename = "allowCommentOnConfirmation")]
pub allow_comment_on_confirmation: bool,
/// Allow persons assigned to this service to control the live agenda.
#[serde(rename = "allowControlLiveAgenda")]
pub allow_control_live_agenda: bool,
/// Allow assigned persons to decline service requests.
#[serde(rename = "allowDecline")]
pub allow_decline: bool,
/// Allow assigned persons to request an exchange of their service assignment.
#[serde(rename = "allowExchange")]
pub allow_exchange: bool,
/// Template for the calendar text of this service.
#[serde(rename = "calTextTemplate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub cal_text_template: Option<String>,
/// Use `description` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `description` instead."]
pub comment: Option<String>,
/// use `allowCommentOnConfirmation` instead
#[serde(rename = "commentOnConfirmation", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub comment_on_confirmation: Option<bool>,
/// Description of the role.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// IDs of connected person groups used for service planning.
#[serde(rename = "groupIds")]
pub group_ids: Vec<i64>,
/// Hide assigned persons from viewers without the service or service-group permissions needed to see them.
#[serde(rename = "hidePersonName")]
pub hide_person_name: bool,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Name of the planning role, for example Lead vocals. A service is reusable master data; the assignment of a person to this role belongs to an event.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Name translated for the current language; falls back to the stored name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Restrict assignment candidates to the connected person groups.
#[serde(rename = "onlyAssignFromGroups")]
pub only_assign_from_groups: bool,
/// Enable reminder emails for service assignments.
#[serde(rename = "sendReminderMails")]
pub send_reminder_mails: bool,
/// Enable emails for service requests.
#[serde(rename = "sendServiceRequestEmails")]
pub send_service_request_emails: bool,
/// ID of the existing service group that organizes this role, for example Music or Technical team. This is not a person group.
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Whether this service is marked as a standard service for event planning.
pub standard: bool,
/// IDs of connected tags used for service planning.
#[serde(rename = "tagIds")]
pub tag_ids: Vec<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceCandidate {
/// Person’s full name.
#[serde(rename = "fullName", deserialize_with = "crate::lenient::string")]
pub full_name: String,
/// ID of the person.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceCandidateAssignment {
/// Event as Domain Object
pub event: DomainObjectEvent,
/// Concrete assignment record. Serialized directly here, so comment is always `null` even when a comment is stored.
#[serde(rename = "eventService")]
pub event_service: ServiceCandidateAssignmentEventService,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Concrete assignment record. Serialized directly here, so comment is always `null` even when a comment is stored.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceCandidateAssignmentEventService {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Use `isAccepted` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `isAccepted` instead"]
pub agreed: Option<bool>,
#[serde(rename = "allowChat")]
pub allow_chat: bool,
/// Confirmation or decline comment. Null when absent or hidden by permissions.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Use `index` instead
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `index` instead"]
pub counter: Option<i64>,
pub event: ServiceRequestEvent,
/// ID of this particular assignment record. Updating or answering a request may create a new record; use the ID returned by the operation.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Slot index when an event requires several persons for the same service; null if no index is assigned.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub index: Option<i64>,
/// Whether this record was confirmed. Interpret together with isValid, as an older confirmed record can be invalid.
#[serde(rename = "isAccepted")]
pub is_accepted: bool,
/// Whether this record is still the active assignment for its slot. Superseded and declined records are invalid.
#[serde(rename = "isValid")]
pub is_valid: bool,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Optional computed assignment permissions. These request endpoints do not populate them and normally return null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub permissions: Option<ServiceRequestPermissions>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Deprecated alias for `meta.modifiedDate`.
#[serde(rename = "requestedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requested_date: Option<chrono::DateTime<chrono::Utc>>,
/// Person as Domain Object
#[serde(rename = "requesterPerson")]
pub requester_person: DomainObjectPerson,
#[serde(rename = "requesterPersonId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requester_person_id: Option<i64>,
/// ID of the reusable service role from /services, not the request ID.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
#[serde(rename = "serviceName", deserialize_with = "crate::lenient::string")]
pub service_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceCandidateScoreHint {
/// Human-readable explanation in the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Stable reason key for a score contribution. Monthly utilization reasons include a YYYY-MM suffix. The spelling always-seperated is part of the wire format.
/// Allowed values: `absence`, `last.service.near`, `next.service.near`, `preference.always-seperated`, `preference.daytime`, `preference.max-reached`, `preference.with-partner`, `service.previously-declined`, `service.same-day`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub reason: serde_json::Value,
/// Contribution to the total score; positive values favor the candidate and negative values penalize it.
#[serde(deserialize_with = "crate::lenient::number")]
pub score: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields for creating a reusable service role. Free-text fields are not restricted to predefined values.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceCreate {
/// Enable chat for this service.
#[serde(rename = "allowChat", default, skip_serializing_if = "Option::is_none")]
pub allow_chat: Option<bool>,
/// Allow a comment when confirming a service request.
#[serde(rename = "allowCommentOnConfirmation", default, skip_serializing_if = "Option::is_none")]
pub allow_comment_on_confirmation: Option<bool>,
/// Allow persons assigned to this service to control the live agenda.
#[serde(rename = "allowControlLiveAgenda", default, skip_serializing_if = "Option::is_none")]
pub allow_control_live_agenda: Option<bool>,
/// Allow assigned persons to decline service requests.
#[serde(rename = "allowDecline", default, skip_serializing_if = "Option::is_none")]
pub allow_decline: Option<bool>,
/// Allow assigned persons to request an exchange of their service assignment.
#[serde(rename = "allowExchange", default, skip_serializing_if = "Option::is_none")]
pub allow_exchange: Option<bool>,
/// Template for the calendar text of this service.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "calTextTemplate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cal_text_template: Option<Option<String>>,
/// Deprecated input alias for description. Use description for new integrations.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use description for new integrations."]
pub comment: Option<Option<String>>,
/// Description of the role.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// IDs of connected person groups used for service planning. Nonexistent IDs are silently removed. Duplicates are retained. An empty list clears the connections.
#[serde(rename = "groupIds", default, skip_serializing_if = "Option::is_none")]
pub group_ids: Option<Vec<i64>>,
/// Hide assigned persons from viewers without the service or service-group permissions needed to see them.
#[serde(rename = "hidePersonName", default, skip_serializing_if = "Option::is_none")]
pub hide_person_name: Option<bool>,
/// Name of the planning role, for example Lead vocals. A service is reusable master data; the assignment of a person to this role belongs to an event.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Restrict assignment candidates to the connected person groups.
#[serde(rename = "onlyAssignFromGroups", default, skip_serializing_if = "Option::is_none")]
pub only_assign_from_groups: Option<bool>,
/// Enable reminder emails for service assignments.
#[serde(rename = "sendReminderMails", default, skip_serializing_if = "Option::is_none")]
pub send_reminder_mails: Option<bool>,
/// Enable emails for service requests.
#[serde(rename = "sendServiceRequestEmails", default, skip_serializing_if = "Option::is_none")]
pub send_service_request_emails: Option<bool>,
/// ID of the existing service group that organizes this role, for example Music or Technical team. This is not a person group.
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Whether this service is marked as a standard service for event planning.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub standard: Option<bool>,
/// IDs of connected tags used for service planning. Nonexistent IDs are silently removed. Duplicates are retained. An empty list clears the connections.
#[serde(rename = "tagIds", default, skip_serializing_if = "Option::is_none")]
pub tag_ids: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangeCandidate {
/// Start of the candidate event.
#[serde(rename = "eventDate", serialize_with = "crate::datetime::serialize_utc")]
pub event_date: chrono::DateTime<chrono::Utc>,
/// ID of a concrete event-service assignment (service request), not the reusable service master-data ID from /services.
#[serde(rename = "eventServiceId", deserialize_with = "crate::lenient::number")]
pub event_service_id: i64,
/// Title of the calendar appointment associated with the candidate event.
#[serde(rename = "eventTitle", deserialize_with = "crate::lenient::string")]
pub event_title: String,
/// Legacy person object loaded for service exchanges, not the response schema of `/persons/{personId}` or a person domain object. Additional legacy model fields may be present.
pub person: ServiceExchangePerson,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangeEvent {
/// ID of the event.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Event name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy person object loaded for service exchanges, not the response schema of `/persons/{personId}` or a person domain object. Additional legacy model fields may be present.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangePerson {
#[serde(rename = "firstName", deserialize_with = "crate::lenient::string")]
pub first_name: String,
/// Person GUID, if available.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub guid: Option<String>,
/// ID of the person.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Avatar URL, if available.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
#[serde(rename = "isArchived")]
pub is_archived: bool,
#[serde(rename = "lastName", deserialize_with = "crate::lenient::string")]
pub last_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A request to exchange two concrete event-service assignments. Creating it does not swap the persons; accepting it does. List operations enrich the event and person fields where available. Write responses are not enriched, so those fields can be `null`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangeRequest {
/// ID of the exchange request.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Whether this exchange is archived. Person-level lists exclude archived exchanges; the assignment-level list does not.
#[serde(rename = "isArchived")]
pub is_archived: bool,
pub meta: ServiceExchangeRequestMeta,
#[serde(rename = "requestedEvent", default, skip_serializing_if = "Option::is_none")]
pub requested_event: Option<ServiceExchangeEvent>,
#[serde(rename = "requestedPerson", default, skip_serializing_if = "Option::is_none")]
pub requested_person: Option<ServiceExchangePerson>,
/// Assignment requested in return. ID of a concrete event-service assignment (service request), not the reusable service master-data ID from /services.
#[serde(rename = "requestedServiceId", deserialize_with = "crate::lenient::number")]
pub requested_service_id: i64,
#[serde(rename = "requestingEvent", default, skip_serializing_if = "Option::is_none")]
pub requesting_event: Option<ServiceExchangeEvent>,
#[serde(rename = "requestingPerson", default, skip_serializing_if = "Option::is_none")]
pub requesting_person: Option<ServiceExchangePerson>,
/// Assignment offered by the requester. ID of a concrete event-service assignment (service request), not the reusable service master-data ID from /services.
#[serde(rename = "requestingServiceId", deserialize_with = "crate::lenient::number")]
pub requesting_service_id: i64,
/// `UNANSWERED`: awaiting a reply; `AGREED`: exchange accepted; `DECLINED`: recipient declined; `CANCELLED`: requester cancelled. Archiving is tracked separately by `isArchived`.
/// Allowed values: `AGREED`, `CANCELLED`, `DECLINED`, `UNANSWERED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangeRequestCreate {
/// Target assignment to exchange with. Use eventServiceId from the candidates endpoint. ID of a concrete event-service assignment (service request), not the reusable service master-data ID from /services.
#[serde(rename = "requestedServiceId", deserialize_with = "crate::lenient::number")]
pub requested_service_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceExchangeRequestMeta {
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A category of service roles, such as Music or Technical team, optionally associated with a campus. It is not a group of persons.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceGroup {
/// ID of an existing campus, or `null` for no campus association.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Description of the service group.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Name of a category of service roles, for example Technical team. This is separate from person groups.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Name translated for the current language; falls back to the stored name.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Show this service group only when filtering by its campus.
#[serde(rename = "onlyVisibleInCampusFilter")]
pub only_visible_in_campus_filter: bool,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Make this service group visible through the general service-group viewing permissions.
#[serde(rename = "viewAll")]
pub view_all: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Create a category that organizes service roles.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceGroupCreate {
/// ID of an existing campus, or `null` for no campus association.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Description of the service group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Name of a category of service roles, for example Technical team. This is separate from person groups.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Show this service group only when filtering by its campus.
#[serde(rename = "onlyVisibleInCampusFilter", default, skip_serializing_if = "Option::is_none")]
pub only_visible_in_campus_filter: Option<bool>,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Make this service group visible through the general service-group viewing permissions.
#[serde(rename = "viewAll", default, skip_serializing_if = "Option::is_none")]
pub view_all: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceGroupPersonPreference {
/// Reaching or exceeding it adds a score penalty; it is not an assignment limit.
#[serde(rename = "maxPerMonth", deserialize_with = "crate::lenient::number")]
pub max_per_month: i64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", serialize_with = "crate::datetime::serialize_utc")]
pub modified_date: chrono::DateTime<chrono::Utc>,
#[serde(rename = "modifiedPerson")]
pub modified_person: ServiceGroupPersonPreferenceModifiedPerson,
/// 0: no preference; 1: prefer morning; 2: only morning; 3: prefer afternoon/evening; 4: only afternoon/evening. Candidate scoring treats event starts before 13:00 as morning. These preferences influence the score; they do not remove candidates.
/// Allowed values: `0`, `1`, `2`, `3`, `4`.
#[serde(rename = "morningWeight", deserialize_with = "crate::lenient::number")]
pub morning_weight: i64,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// 0: no preference; 1: prefer serving with the partner; 2: prefer serving separately. Influences candidate scoring when a related partner has an assignment at the event.
/// Allowed values: `0`, `1`, `2`.
#[serde(rename = "relationWeight", deserialize_with = "crate::lenient::number")]
pub relation_weight: i64,
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceGroupPersonPreferenceModifiedPerson {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields for updating a service group.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceGroupUpdate {
/// ID of an existing campus, or `null` for no campus association.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Description of the service group.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Name of a category of service roles, for example Technical team. This is separate from person groups.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Show this service group only when filtering by its campus.
#[serde(rename = "onlyVisibleInCampusFilter", default, skip_serializing_if = "Option::is_none")]
pub only_visible_in_campus_filter: Option<bool>,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Make this service group visible through the general service-group viewing permissions.
#[serde(rename = "viewAll", default, skip_serializing_if = "Option::is_none")]
pub view_all: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A concrete event-service assignment, also called a service request. This is separate from the reusable service role. A valid record may be unassigned, awaiting confirmation or confirmed. The comment is only exposed to authorized viewers; otherwise it is null. Historical records can still be fetched individually.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequest {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Use `isAccepted` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `isAccepted` instead"]
pub agreed: Option<bool>,
#[serde(rename = "allowChat")]
pub allow_chat: bool,
/// Confirmation or decline comment. Null when absent or hidden by permissions.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Use `index` instead
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `index` instead"]
pub counter: Option<i64>,
pub event: ServiceRequestEvent,
/// ID of this particular assignment record. Updating or answering a request may create a new record; use the ID returned by the operation.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Slot index when an event requires several persons for the same service; null if no index is assigned.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub index: Option<i64>,
/// Whether this record was confirmed. Interpret together with isValid, as an older confirmed record can be invalid.
#[serde(rename = "isAccepted")]
pub is_accepted: bool,
/// Whether this record is still the active assignment for its slot. Superseded and declined records are invalid.
#[serde(rename = "isValid")]
pub is_valid: bool,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Optional computed assignment permissions. These request endpoints do not populate them and normally return null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub permissions: Option<ServiceRequestPermissions>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Deprecated alias for `meta.modifiedDate`.
#[serde(rename = "requestedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requested_date: Option<chrono::DateTime<chrono::Utc>>,
/// Person as Domain Object
#[serde(rename = "requesterPerson")]
pub requester_person: DomainObjectPerson,
#[serde(rename = "requesterPersonId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requester_person_id: Option<i64>,
/// ID of the reusable service role from /services, not the request ID.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
#[serde(rename = "serviceName", deserialize_with = "crate::lenient::string")]
pub service_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestAnswer {
/// Optional response comment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestEvent {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "startDate", serialize_with = "crate::datetime::serialize_utc")]
pub start_date: chrono::DateTime<chrono::Utc>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Optional computed assignment permissions. These request endpoints do not populate them and normally return null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestPermissions {
#[serde(rename = "enterSelfIfFree", default, skip_serializing_if = "Option::is_none")]
pub enter_self_if_free: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestUndoCreate {
/// ID of the person assigned to the record being undone. Must be the current user.
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Assignment returned after undoing an acceptance or decline.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestUndoResult {
#[serde(rename = "@deprecated", deserialize_with = "crate::lenient::map")]
pub deprecated: std::collections::BTreeMap<String, String>,
/// Use `isAccepted` instead
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `isAccepted` instead"]
pub agreed: Option<bool>,
#[serde(rename = "allowChat")]
pub allow_chat: bool,
/// Confirmation or decline comment. Null when absent or hidden by permissions.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// Use `index` instead
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `index` instead"]
pub counter: Option<i64>,
pub event: ServiceRequestEvent,
/// ID of this particular assignment record. Updating or answering a request may create a new record; use the ID returned by the operation.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Slot index when an event requires several persons for the same service; null if no index is assigned.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub index: Option<i64>,
/// Whether this record was confirmed. Interpret together with isValid, as an older confirmed record can be invalid.
#[serde(rename = "isAccepted")]
pub is_accepted: bool,
/// Whether this record is still the active assignment for its slot. Superseded and declined records are invalid.
#[serde(rename = "isValid")]
pub is_valid: bool,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Optional computed assignment permissions. These request endpoints do not populate them and normally return null.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub permissions: Option<ServiceRequestPermissions>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub person: Option<DomainObjectPerson>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub person_id: Option<i64>,
/// Deprecated alias for `meta.modifiedDate`.
#[serde(rename = "requestedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requested_date: Option<chrono::DateTime<chrono::Utc>>,
/// Person as Domain Object
#[serde(rename = "requesterPerson")]
pub requester_person: DomainObjectPerson,
#[serde(rename = "requesterPersonId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub requester_person_id: Option<i64>,
/// ID of the reusable service role from /services, not the request ID.
#[serde(rename = "serviceId", deserialize_with = "crate::lenient::number")]
pub service_id: i64,
#[serde(rename = "serviceName", deserialize_with = "crate::lenient::string")]
pub service_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Assign a person or external name to a service slot. The previous active record is invalidated and a new assignment record is returned.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceRequestUpdate {
/// Legacy alias for isAccepted. Prefer isAccepted in new integrations.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub agreed: Option<bool>,
/// Accepted for compatibility but ignored by this update operation; the replacement record starts without a comment. Use the accept or decline action for a response comment.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub comment: Option<Option<String>>,
/// Accepted for compatibility; this flag does not control notifications in the current implementation. Notifications follow the assignment workflow.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub inform_person: Option<bool>,
/// true creates a confirmed assignment; false creates an assignment awaiting confirmation. false does not decline it.
#[serde(rename = "isAccepted", default, skip_serializing_if = "Option::is_none")]
pub is_accepted: Option<bool>,
/// Name of an external assignee without a person record.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Existing person to assign. Supply exactly one non-`null` value: `personId` or name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "personId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub person_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Update a service role.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ServiceUpdate {
/// Enable chat for this service.
#[serde(rename = "allowChat", default, skip_serializing_if = "Option::is_none")]
pub allow_chat: Option<bool>,
/// Allow a comment when confirming a service request.
#[serde(rename = "allowCommentOnConfirmation", default, skip_serializing_if = "Option::is_none")]
pub allow_comment_on_confirmation: Option<bool>,
/// Allow persons assigned to this service to control the live agenda.
#[serde(rename = "allowControlLiveAgenda", default, skip_serializing_if = "Option::is_none")]
pub allow_control_live_agenda: Option<bool>,
/// Allow assigned persons to decline service requests.
#[serde(rename = "allowDecline", default, skip_serializing_if = "Option::is_none")]
pub allow_decline: Option<bool>,
/// Allow assigned persons to request an exchange of their service assignment.
#[serde(rename = "allowExchange", default, skip_serializing_if = "Option::is_none")]
pub allow_exchange: Option<bool>,
/// Template for the calendar text of this service.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "calTextTemplate", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cal_text_template: Option<Option<String>>,
/// Deprecated input alias for description. Use description for new integrations.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use description for new integrations."]
pub comment: Option<Option<String>>,
/// Description of the role.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// IDs of connected person groups used for service planning. Nonexistent IDs are silently removed. Duplicates are retained. An empty list clears the connections.
#[serde(rename = "groupIds", default, skip_serializing_if = "Option::is_none")]
pub group_ids: Option<Vec<i64>>,
/// Hide assigned persons from viewers without the service or service-group permissions needed to see them.
#[serde(rename = "hidePersonName", default, skip_serializing_if = "Option::is_none")]
pub hide_person_name: Option<bool>,
/// Name of the planning role, for example Lead vocals. A service is reusable master data; the assignment of a person to this role belongs to an event.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Restrict assignment candidates to the connected person groups.
#[serde(rename = "onlyAssignFromGroups", default, skip_serializing_if = "Option::is_none")]
pub only_assign_from_groups: Option<bool>,
/// Enable reminder emails for service assignments.
#[serde(rename = "sendReminderMails", default, skip_serializing_if = "Option::is_none")]
pub send_reminder_mails: Option<bool>,
/// Enable emails for service requests.
#[serde(rename = "sendServiceRequestEmails", default, skip_serializing_if = "Option::is_none")]
pub send_service_request_emails: Option<bool>,
/// ID of the existing service group that organizes this role, for example Music or Technical team. This is not a person group.
#[serde(rename = "serviceGroupId", deserialize_with = "crate::lenient::number")]
pub service_group_id: i64,
/// Display order. Lists are sorted by `sortKey` and then name, both ascending.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Whether this service is marked as a standard service for event planning.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub standard: Option<bool>,
/// IDs of connected tags used for service planning. Nonexistent IDs are silently removed. Duplicates are retained. An empty list clears the connections.
#[serde(rename = "tagIds", default, skip_serializing_if = "Option::is_none")]
pub tag_ids: Option<Vec<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configurable sex master-data entry, including localized salutations and audit metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Sex {
/// Stored name or translation key. Use nameTranslated for display in the current language.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
#[serde(rename = "salutationFormal", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub salutation_formal: Option<String>,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
#[serde(rename = "salutationInformal", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub salutation_informal: Option<String>,
/// Stored sort order.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Catalog ID referenced by person records. IDs 1 and 2 are protected against deletion.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Display name translated for the current language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Localized salutation; empty string when the stored salutation is null.
#[serde(rename = "salutationFormalTranslated", deserialize_with = "crate::lenient::string")]
pub salutation_formal_translated: String,
/// Localized salutation; empty string when the stored salutation is null.
#[serde(rename = "salutationInformalTranslated", deserialize_with = "crate::lenient::string")]
pub salutation_informal_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Writable catalog values for a person’s sex and associated salutations. Text is trimmed; translation keys and literal display text are accepted.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SexCreate {
/// Stored name or translation key. Use nameTranslated for display in the current language.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "salutationFormal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub salutation_formal: Option<Option<String>>,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "salutationInformal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub salutation_informal: Option<Option<String>>,
/// Sort order. Omission or null becomes 0.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces the catalog entry’s writable values. name is required; omitted sortKey becomes 0 and omitted salutations become null. The ID comes from the URL.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SexUpdate {
/// Stored name or translation key. Use nameTranslated for display in the current language.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "salutationFormal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub salutation_formal: Option<Option<String>>,
/// Stored salutation text or translation key. Omission, null, empty string and whitespace-only input all become null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "salutationInformal", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub salutation_informal: Option<Option<String>>,
/// Sort order. Omission or null becomes 0.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SimpleAppointment {
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Wiki page metadata for one version. Text and previews are optional enrichments depending on the endpoint. A page is addressed by category ID and stable GUID; version identifies its revision.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SimpleWikiPage {
/// Compatibility marker used by existing clients.
#[serde(rename = "@deprecated")]
pub deprecated: SimpleWikiPageDeprecated,
/// Stable page GUID across versions in its category.
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
/// Deprecated alias for `guid`. Use `guid` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `guid` instead."]
pub identifier: Option<String>,
/// Whether page text is Markdown rather than legacy HTML.
#[serde(rename = "isMarkdown")]
pub is_markdown: bool,
pub meta: MetaDataEntityPerson,
/// Whether the page is configured to appear on the wiki start page.
#[serde(rename = "onStartpage")]
pub on_startpage: bool,
/// Page editing/deletion capabilities for the current user; system pages have additional restrictions.
pub permissions: SimpleWikiPagePermissions,
/// Stored redirect title. API reads return the page and this value; they do not follow the redirect.
#[serde(rename = "redirectTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redirect_to: Option<String>,
/// Query-focused preview snippet. Present when the page list endpoint is called with a search query.
#[serde(rename = "searchPreview", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub search_preview: Option<String>,
/// Markdown source or sanitized legacy HTML. Absent from category lists and from /wiki/pages unless include\[\]=text is requested. Null stored content is returned as an empty string.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub text: Option<String>,
/// Unrendered prefix of stored page text, truncated by Unicode characters. May contain raw HTML or incomplete markup. Present only with include\[\]=preview; not sanitized like text.
#[serde(rename = "textPreview", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub text_preview: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Revision number of this page.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// A category organizes wiki pages and is the unit of wiki access permissions.
#[serde(rename = "wikiCategory")]
pub wiki_category: WikiCategory,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility marker used by existing clients.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SimpleWikiPageDeprecated {
#[serde(deserialize_with = "crate::lenient::string")]
pub identifier: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Page editing/deletion capabilities for the current user; system pages have additional restrictions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SimpleWikiPagePermissions {
#[serde(rename = "canDelete")]
pub can_delete: bool,
#[serde(rename = "canEdit")]
pub can_edit: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Song with its category and all arrangements. Agenda-specific selection, order and timing belong to agenda items, not to this song record.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Song {
/// Compatibility markers included in serialized song records.
#[serde(rename = "@deprecated")]
pub deprecated: SongDeprecated,
/// All musical versions, always returned by the current API, even without include=arrangements. Each version has its own key, tempo and attachments.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub arrangements: Option<Vec<Arrangement>>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub author: Option<String>,
/// Configurable category for organizing songs.
pub category: SongCategory,
/// CCLI song number, stored as text.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub ccli: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub copyright: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Deprecated compatibility field, returned as an empty string.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub note: Option<String>,
/// Whether the song is marked for rehearsal.
#[serde(rename = "shouldPractice")]
pub should_practice: bool,
/// Song tags, included only when GET requests use include=tags. An empty array means no tags are assigned. The count on each tag defaults to 1; it is not a total across all songs.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<TagWithCount>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configurable category for organizing songs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongCategory {
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Stored, configurable name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display name after translation, or the original name when no translation is available.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for a configurable song category.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongCategoryCreate {
/// Existing campus ID associated with the category.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Configurable category name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for replacing a song category.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongCategoryUpdate {
/// Existing campus ID associated with the category.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Configurable category name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A song, optionally with initial arrangements and tags. A song is the composition; arrangements describe its musical versions and are selected by event agenda items.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongCreate {
/// Author or composer credits.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub author: Option<Option<String>>,
/// ID of an existing song category from GET /song/categories. Categories organize songs and determine access permissions. Changing it requires edit permission for both the old and the new category.
#[serde(rename = "categoryId", deserialize_with = "crate::lenient::number")]
pub category_id: i64,
/// CCLI song number, stored as text.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub ccli: Option<Option<String>>,
/// Copyright or licensing notice.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub copyright: Option<Option<String>>,
/// Song title.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Marks the song for rehearsal.
#[serde(rename = "shouldPractice", default, skip_serializing_if = "Option::is_none")]
pub should_practice: Option<bool>,
/// Tag names to assign. Existing tags are reused by name; missing tags are created. During update, this replaces the song's tag set.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// Initial musical versions. The first arrangement becomes the default unless a later item has `isDefault: true`.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub arrangements: Option<Vec<ArrangementCreate>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility markers included in serialized song records.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongDeprecated {
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub arrangements: serde_json::Value,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub note: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Source associated with song arrangements, such as a hymnal or songbook.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongSource {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Stored, configurable name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display name after translation, or the original name when no translation is available.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for a song source, such as a hymnal or songbook.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongSourceCreate {
/// Configurable source name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display abbreviation.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for replacing a song source.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongSourceUpdate {
/// Configurable source name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display abbreviation.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// Display order; lower values come first.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Song details shared by creation and update. Inline arrangements are supported only during creation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SongUpdate {
/// Author or composer credits.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub author: Option<Option<String>>,
/// ID of an existing song category from GET /song/categories. Categories organize songs and determine access permissions. Changing it requires edit permission for both the old and the new category.
#[serde(rename = "categoryId", deserialize_with = "crate::lenient::number")]
pub category_id: i64,
/// CCLI song number, stored as text.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub ccli: Option<Option<String>>,
/// Copyright or licensing notice.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub copyright: Option<Option<String>>,
/// Song title.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Marks the song for rehearsal.
#[serde(rename = "shouldPractice", default, skip_serializing_if = "Option::is_none")]
pub should_practice: Option<bool>,
/// Tag names to assign. Existing tags are reused by name; missing tags are created. During update, this replaces the song's tag set.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A parent grouping ordinary accounting bookings into one gross amount. All submitted non-tax children share either their debit account or their credit account, and an account cannot occur on both sides. The parent is not itself an ordinary transaction row. Generated tax bookings also appear in splitChildren; their amounts plus the corresponding net children make up the gross total.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SplitTransaction {
/// Total amount in the currency's smallest denomination (e.g. cents). Must equal the sum of all `splitChildren` amounts.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Parent receipts, included when include\[\]=bills is requested.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bills: Option<Vec<Bill>>,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Document number of the split transaction. Auto-generated when the accounting period increments document numbers, otherwise required.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::string")]
pub document_number: String,
/// ID of the split parent, distinct from each ordinary child transaction ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Free-text note describing the split booking.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Ordinary child bookings, including generated tax rows. A fresh read orders them by transaction ID. Child IDs can be read through /finance/transactions/{id}; edit the group through the split endpoint.
#[serde(rename = "splitChildren")]
pub split_children: Vec<Transaction>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One non-tax part of a split booking. Parent documentDate/documentNumber are applied automatically. Supply its gross amount when taxRateId is present. Do not copy generated tax rows from a read response into a new request; they are created from their main rows. Use real JSON numbers and booleans because child normalization is currently discarded.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SplitTransactionChildCreate {
/// ID of the debit account the amount is posted to.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Gross booking amount in integer minor currency units. With taxRateId, tax is calculated from this amount and split into a separate booking; the returned main booking contains the remaining net amount.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Cash discount in the smallest currency unit. Used only together with cashDiscountId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountAmount", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_amount: Option<Option<i64>>,
/// Cash-discount definition from the same accounting period. When supplied, cashDiscountAmount must also be non-null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_id: Option<Option<i64>>,
/// ID of the credit (contra) account the amount is posted from. Must differ from `accountId`.
#[serde(rename = "contraAccountId", deserialize_with = "crate::lenient::number")]
pub contra_account_id: i64,
/// Cost center from the same accounting period. Omission or null clears the assignment on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// Donor person ID. Normally required when only the credit account is a donation account. Donor assignments are retained only when exactly one side is a donation account.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_id: Option<Option<i64>>,
/// Spouse for joint donation receipts. Requires a different donor person and an existing spouse relationship; inconsistent assignments return 422.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse_id: Option<Option<i64>>,
/// Existing ordinary booking to update/adopt. Omit or use null for a new booking. Existing children from another split cannot be moved through the regular multi-child update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub id: Option<Option<i64>>,
/// Sync marker used for newly created children; existing children retain their marker.
#[serde(rename = "isSynced", default, skip_serializing_if = "Option::is_none")]
pub is_synced: Option<bool>,
/// Whether this is a donation through waived reimbursement of expenses. Defaults to false, including on update.
#[serde(rename = "isWaiverOfReimbursementOfExpenses", default, skip_serializing_if = "Option::is_none")]
pub is_waiver_of_reimbursement_of_expenses: Option<bool>,
/// Child booking note. Validation checks the trimmed length, but the current implementation writes the original child value.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Tax rate from the same period. On update an explicit null removes the existing tax booking; omission currently retains it because child defaults are discarded.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Input for a grouped booking. At least one child is needed; child amounts must sum exactly to amount. All children must share one debit or one credit account, with no account used on both sides. Parent and child notes may be null. A single child is saved as an ordinary transaction and yields HTTP 204.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SplitTransactionCreate {
/// Total gross amount in minor currency units, equal to the sum of submitted child amounts.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Document date applied to all children.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Parent number. Required unless the period generates numbers; omission or null then generates a number, including on update. Multi-child bookings receive suffixes -1, -2, and so on.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub document_number: Option<Option<String>>,
/// Parent note; trimmed, with an empty result stored as null. For single-child conversion this replaces the child note.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Complete replacement list. Existing IDs keep/update rows; omitted previous rows are deleted. Omit id to create a new child.
#[serde(rename = "splitChildren")]
pub split_children: Vec<SplitTransactionChildCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SplitTransactionStornoCreate {
/// Cancellation reason; trimmed before being added to parent and child notes.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Complete replacement of a split parent identified by the URL. Preserve IDs of existing children, omit IDs for new children and omit old rows to delete them. One remaining child converts the group to an ordinary booking and returns no body.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SplitTransactionUpdate {
/// Total gross amount in minor currency units, equal to the sum of submitted child amounts.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Document date applied to all children.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Parent number. Required unless the period generates numbers; omission or null then generates a number, including on update. Multi-child bookings receive suffixes -1, -2, and so on.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub document_number: Option<Option<String>>,
/// Parent note; trimmed, with an empty result stored as null. For single-child conversion this replaces the child note.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Complete replacement list. Existing IDs keep/update rows; omitted previous rows are deleted. Omit id to create a new child.
#[serde(rename = "splitChildren")]
pub split_children: Vec<SplitTransactionChildCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Public login-screen entry for a visible OAuth, OpenID Connect or SAML provider.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SsoLogin {
/// Whether account registration is configured for this provider.
#[serde(rename = "hasRegistration")]
pub has_registration: bool,
/// External login provider ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// URL that starts authentication; navigate the browser to it.
#[serde(rename = "loginLink", deserialize_with = "crate::lenient::string")]
pub login_link: String,
/// Optional provider logo URL.
#[serde(rename = "logoUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub logo_url: Option<String>,
/// Label shown for the provider.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Whether the provider is marked as the primary login option.
#[serde(rename = "primaryLogin")]
pub primary_login: bool,
/// Optional explanatory text for the login screen.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub subtitle: Option<String>,
/// Authentication protocol implemented by the provider.
/// Allowed values: `oauth`, `oidc`, `saml`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StartStopChat {
pub enabled: bool,
#[serde(rename = "triggerChatInviteMail", default, skip_serializing_if = "Option::is_none")]
pub trigger_chat_invite_mail: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One imported bank-statement movement and its proposed booking fields. Suggestions are always included; include\[\]=bills additionally expands supporting documents on the suggestions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StatementMovement {
/// Movement amount in minor currency units. isDebit distinguishes outgoing from incoming funds.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub description: String,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub identifier: String,
/// True for outgoing funds, false for incoming funds.
#[serde(rename = "isDebit")]
pub is_debit: bool,
/// Donation indicator recorded by the import.
#[serde(rename = "isDonation")]
pub is_donation: bool,
/// Original sequence number used as the secondary sort key.
#[serde(rename = "numberInStatement", deserialize_with = "crate::lenient::number")]
pub number_in_statement: i64,
#[serde(rename = "personName", deserialize_with = "crate::lenient::string")]
pub person_name: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub purpose: String,
/// Normally open, booked or ignored. The current mutation endpoint also stores other strings without validating an enum.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
pub suggestions: Vec<MovementSuggestion>,
#[serde(rename = "transactionCode", deserialize_with = "crate::lenient::string")]
pub transaction_code: String,
/// Associated transaction, or null before booking. For a split booking this identifies the first non-tax child, not the split parent.
#[serde(rename = "transactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub transaction_id: Option<i64>,
/// A simple date in ISO format, e.g. '2022-10-19'
pub valuta: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StatementMovementUpdate {
/// Target movement state. Returning from booked to another state does not undo or delete the existing transaction.
/// Allowed values: `booked`, `ignored`, `open`.
#[serde(deserialize_with = "crate::lenient::string")]
pub state: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StatementStatistics {
/// Sum of open, booked and ignored movements.
#[serde(deserialize_with = "crate::lenient::number")]
pub all: i64,
/// Number of booked movements.
#[serde(deserialize_with = "crate::lenient::number")]
pub booked: i64,
/// Number of ignored movements.
#[serde(deserialize_with = "crate::lenient::number")]
pub ignored: i64,
/// Number of open movements.
#[serde(deserialize_with = "crate::lenient::number")]
pub open: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Configurable person status, independent of a person’s memberships in groups. Status IDs are installation-specific and are not an enum.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Status {
/// ID of status
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Flag if status is member of the church
#[serde(rename = "isMember")]
pub is_member: bool,
/// Flag if that status is searchable
#[serde(rename = "isSearchable")]
pub is_searchable: bool,
/// Status name
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Translated status name
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Existing security-level definition associated with this status. Retrieve available IDs from GET /securitylevels.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::number")]
pub security_level_id: i64,
/// Abbreviation of name.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<String>,
/// Localized abbreviation. Present even when shorty is null.
#[serde(rename = "shortyTranslated", deserialize_with = "crate::lenient::string")]
pub shorty_translated: String,
/// Used to sort all statuses
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Person status definition, such as member or guest.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StatusCreate {
/// Whether this status marks a person as a church member.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "isMember", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub is_member: Option<Option<bool>>,
/// Whether persons with this status are eligible for the corresponding free-text person selection. This flag does not replace person visibility permissions.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "isSearchable", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub is_searchable: Option<Option<bool>>,
/// Status name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Existing security-level definition associated with this status. Retrieve available IDs from `GET /securitylevels`.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::number")]
pub security_level_id: i64,
/// Abbreviation of the status name.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
/// Display-order value.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<Option<i64>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Fields to update; omitted fields remain unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StatusUpdate {
#[serde(rename = "isMember", default, skip_serializing_if = "Option::is_none")]
pub is_member: Option<bool>,
#[serde(rename = "isSearchable", default, skip_serializing_if = "Option::is_none")]
pub is_searchable: Option<bool>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Existing security-level definition associated with this status.
#[serde(rename = "securityLevelId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub security_level_id: Option<i64>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub shorty: Option<Option<String>>,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub sort_key: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored address with its numeric ID, owning domain object and legacy compatibility fields. Coordinates are serialized as strings or null. The current serializer also returns a stored coordinate of zero as null.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StoredAddress {
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub addition: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub city: Option<String>,
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`, `default`, `parent`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// A country's ISO-code
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub district: Option<String>,
/// The identifier of the domain object. This field is set automatically from the path parameter and should not be included in the request body.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// The domain type of the address. This field is set automatically from the path parameter and should not be included in the request body.
/// Allowed values: `appointment`, `campus`, `church`, `group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub latitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub longitude: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub street: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub zip: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "@deprecated")]
pub deprecated: StoredAddressDeprecated,
/// Use `latitude` instead
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub geo_lat: Option<String>,
/// Use `longitude` instead
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub geo_lng: Option<String>,
/// Use `latitude` instead
#[serde(rename = "latitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `latitude` instead"]
pub latitude_loose: Option<String>,
/// Use `longitude` instead
#[serde(rename = "longitudeLoose", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `longitude` instead"]
pub longitude_loose: Option<String>,
/// Allowed values: `default`, `parent`, `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(rename = "markerColor", default, skip_serializing_if = "serde_json::Value::is_null")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_color: serde_json::Value,
/// Use `icon` instead
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `icon` instead"]
pub marker_icon: Option<String>,
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub marker_url: Option<String>,
/// Use `name` instead
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `name` instead"]
pub meeting_at: Option<String>,
/// Use `zip` instead
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `zip` instead"]
pub postalcode: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct StoredAddressDeprecated {
/// Allowed values: `latitude`.
#[serde(rename = "geoLat", deserialize_with = "crate::lenient::string")]
pub geo_lat: String,
/// Allowed values: `longitude`.
#[serde(rename = "geoLng", deserialize_with = "crate::lenient::string")]
pub geo_lng: String,
/// Allowed values: `color`.
#[serde(rename = "markerColor", deserialize_with = "crate::lenient::string")]
pub marker_color: String,
/// Allowed values: `icon`.
#[serde(rename = "markerIcon", deserialize_with = "crate::lenient::string")]
pub marker_icon: String,
/// Allowed values: `@deleted use icon and color instead`.
#[serde(rename = "markerUrl", deserialize_with = "crate::lenient::string")]
pub marker_url: String,
/// Allowed values: `name`.
#[serde(rename = "meetingAt", deserialize_with = "crate::lenient::string")]
pub meeting_at: String,
/// Allowed values: `zip`.
#[serde(deserialize_with = "crate::lenient::string")]
pub postalcode: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionGroup {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `group`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionGroupMeta {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "createdPerson", default, skip_serializing_if = "Option::is_none")]
pub created_person: Option<SubscriptionGroupMetaCreatedPerson>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub modified_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "modifiedPerson", default, skip_serializing_if = "Option::is_none")]
pub modified_person: Option<SubscriptionGroupMetaCreatedPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionGroupMetaCreatedPerson {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy list alias for the corresponding canonical root subscription. Prefer the singular canonical subject for new clients.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionLegacyMeetingRequests {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Legacy list alias for the corresponding canonical root subscription. Prefer the singular canonical subject for new clients.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionLegacyServiceRequests {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionMeetingRequests {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `meetingrequest`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionPost {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `post`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionPostSummary {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
pub options: SubscriptionPostSummaryOptions,
/// Allowed values: `post_summary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionPostSummaryOptions {
/// Allowed values: `all`, `featured_groups`, `my_campus`, `my_groups`.
#[serde(deserialize_with = "crate::lenient::string")]
pub filter: String,
pub weekdays: Vec<serde_json::Value>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionPublicChannel {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `public_channel`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionResource {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// root for the resource notification umbrella, or a resource ID as a string. Read results are filtered to administrable resources.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `resource`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Effective notification subscription. origin=default means an explicit stored override; other origins are computed defaults. Deleting an explicit override may reveal an active default again.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionServiceRequests {
/// Translation key for a brief description addressed to the end user.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub hint: Option<String>,
/// Whether this subscription enables notifications; inactive overrides can suppress an active implicit default.
#[serde(rename = "isActive")]
pub is_active: bool,
/// True for a stored override, false for an implicit default or legacy list alias.
#[serde(rename = "isExplicit")]
pub is_explicit: bool,
/// Audit metadata for explicit overrides; null for implicit defaults and legacy aliases.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub meta: Option<SubscriptionGroupMeta>,
/// Reason this subscription exists; default means an explicit override.
/// Allowed values: `default`, `group-settings`, `meetingrequests-default`, `post-summary-default`, `resource-admin`, `resource-permission`, `resource-root-default`, `servicerequests-default`.
#[serde(deserialize_with = "crate::lenient::string")]
pub origin: String,
/// Deprecated alias for `hint`.
#[serde(rename = "originHint", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub origin_hint: Option<String>,
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Subject-specific identifier represented as a string, including numeric IDs.
#[serde(rename = "subjectIdentifier", deserialize_with = "crate::lenient::string")]
pub subject_identifier: String,
/// Subject-specific options; null when none are stored. Most subjects do not interpret these options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Allowed values: `servicerequest`.
#[serde(deserialize_with = "crate::lenient::string")]
pub subject: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Explicit override. Subject and identifier come from the path. post_summary requires PostSummarySubscriptionOptions; other subjects accept optional opaque options.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SubscriptionUpdate {
/// Omission enables the override, including when replacing an existing inactive setting.
#[serde(rename = "isActive", default, skip_serializing_if = "Option::is_none")]
pub is_active: Option<bool>,
/// Required structured email-summary options for post_summary. For other subjects, omission clears stored options.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub options: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SumBalanceReportCreate {
/// Accepted by the shared validator but ignored by the sum-balance report.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "accountTypes", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub account_types: Option<Option<Vec<i64>>>,
/// Accounting period owning the accounts. Requires finance edit masterdata or explicit view/edit permission for this period.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// PDF creates a file and returns its URL with HTTP 201. CSV/XLSX return the file directly with HTTP 200. Accept: text/html overrides this selection.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub format: Option<String>,
/// Calendar month in the year of the accounting period’s start date. The report includes month totals and cumulative totals from January.
#[serde(deserialize_with = "crate::lenient::number")]
pub month: i64,
/// Include account-group grouping/columns in the report.
#[serde(rename = "showAccountGroups", default, skip_serializing_if = "Option::is_none")]
pub show_account_groups: Option<bool>,
/// Include zero-value accounts according to the selected report’s balance/activity calculation.
#[serde(rename = "showEmptyAccounts", default, skip_serializing_if = "Option::is_none")]
pub show_empty_accounts: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Registered adapter service with a masked `token`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncAdapter {
/// Unique adapter lookup name used by external systems and the proxy.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fixed mask; the stored token is not returned.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Base URL of the adapter service.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Adapter ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Registration of a sync adapter service. Names are configured by the installation, not a fixed list of vendors.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncAdapterCreate {
/// Unique adapter lookup name used by external systems and the proxy.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Authentication token sent to the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Base URL of the adapter service.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces the adapter name, URL and authentication token.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncAdapterUpdate {
/// Unique adapter lookup name used by external systems and the proxy.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Authentication token sent to the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub token: String,
/// Base URL of the adapter service.
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncConflictCreate {
pub data: Vec<SyncConflictDataCreate>,
/// Relationship affected by the conflict.
#[serde(rename = "entityMappingId", deserialize_with = "crate::lenient::number")]
pub entity_mapping_id: i64,
/// Identifier of the sync job run that produced the conflict; not the numeric job configuration ID.
#[serde(rename = "jobId", deserialize_with = "crate::lenient::string")]
pub job_id: String,
/// Conflict category. Values use underscores and are case-sensitive; CT denotes ChurchTools.
/// Allowed values: `create`, `delete_or_create`, `duplicate_in_CT`, `duplicate_in_source`, `link_and_update`, `update`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncConflictData {
/// Conflict-specific data key.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Conflict-specific value.
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncConflictDataCreate {
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replace conflict classification, job, entity mapping and the complete data list.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncConflictUpdate {
pub data: Vec<SyncConflictDataCreate>,
/// Relationship affected by the conflict.
#[serde(rename = "entityMappingId", deserialize_with = "crate::lenient::number")]
pub entity_mapping_id: i64,
/// Identifier of the sync job run that produced the conflict; not the numeric job configuration ID.
#[serde(rename = "jobId", deserialize_with = "crate::lenient::string")]
pub job_id: String,
/// Conflict category. Values use underscores and are case-sensitive; CT denotes ChurchTools.
/// Allowed values: `create`, `delete_or_create`, `duplicate_in_CT`, `duplicate_in_source`, `link_and_update`, `update`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored conflict record. Updating or deleting this record does not itself synchronize or resolve the underlying entities.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncConflicts {
pub data: Vec<SyncConflictData>,
/// Relationship affected by the conflict.
#[serde(rename = "entityMappingId", deserialize_with = "crate::lenient::number")]
pub entity_mapping_id: i64,
/// Conflict ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Identifier of the sync job run that produced the conflict; not the numeric job configuration ID.
#[serde(rename = "jobId", deserialize_with = "crate::lenient::string")]
pub job_id: String,
pub meta: MetaDataEntityId,
/// Conflict category. Values use underscores and are case-sensitive; CT denotes ChurchTools.
/// Allowed values: `create`, `delete_or_create`, `duplicate_in_CT`, `duplicate_in_source`, `link_and_update`, `update`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored link between a ChurchTools entity and an external record; deleting it does not delete either record.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncEntityMapping {
/// ChurchTools entity ID as text.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// ChurchTools domain types accepted by entity and field mapping validation. Adapter support can be a smaller subset.
/// Allowed values: `account`, `account_class`, `account_group`, `account_type`, `accounting_period`, `agenda`, `agenda_item`, `appointment`, `appointment_image`, `appointment_occurrence`, `appointment_template_image`, `attachments`, `avatar`, `booking`, `bulkletter_template`, `client`, `cost_center`, `custom_module`, `donation_attachment_template`, `donation_cover_letter_template`, `eubp_attachment`, `eubp_submission`, `event`, `eventchat`, `familyavatar`, `file`, `finance_template`, `follow_up`, `further_link`, `group`, ….
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Mapping ID
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "lastSyncedDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_synced_date: Option<chrono::DateTime<chrono::Utc>>,
pub meta: MetaDataEntityId,
/// Adapter-specific context key.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub scope: Option<String>,
/// ID in the external system.
#[serde(rename = "sourceEntityId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_entity_id: Option<String>,
/// External connection ID (the source system).
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::number")]
pub source_id: i64,
/// State of the relationship: synchronized, unresolved conflict, or deleted in ChurchTools.
/// Allowed values: `conflict`, `deleted in CT`, `synced`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Persists a record relationship. Provided ChurchTools or external IDs must not be linked for the same domain and source.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncEntityMappingCreate {
/// ChurchTools entity ID as text.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// ChurchTools domain types accepted by entity and field mapping validation. Adapter support can be a smaller subset.
/// Allowed values: `account`, `account_class`, `account_group`, `account_type`, `accounting_period`, `agenda`, `agenda_item`, `appointment`, `appointment_image`, `appointment_occurrence`, `appointment_template_image`, `attachments`, `avatar`, `booking`, `bulkletter_template`, `client`, `cost_center`, `custom_module`, `donation_attachment_template`, `donation_cover_letter_template`, `eubp_attachment`, `eubp_submission`, `event`, `eventchat`, `familyavatar`, `file`, `finance_template`, `follow_up`, `further_link`, `group`, ….
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Last synchronization timestamp. Prefer an explicit timezone.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "lastSyncedDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_synced_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Adapter-specific context key.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub scope: Option<Option<String>>,
/// ID in the external system.
#[serde(rename = "sourceEntityId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_entity_id: Option<String>,
/// External connection ID (the source system).
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::number")]
pub source_id: i64,
/// State of the relationship: synchronized, unresolved conflict, or deleted in ChurchTools.
/// Allowed values: `conflict`, `deleted in CT`, `synced`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces a record relationship.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncEntityMappingUpdate {
/// ChurchTools entity ID as text.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// ChurchTools domain types accepted by entity and field mapping validation. Adapter support can be a smaller subset.
/// Allowed values: `account`, `account_class`, `account_group`, `account_type`, `accounting_period`, `agenda`, `agenda_item`, `appointment`, `appointment_image`, `appointment_occurrence`, `appointment_template_image`, `attachments`, `avatar`, `booking`, `bulkletter_template`, `client`, `cost_center`, `custom_module`, `donation_attachment_template`, `donation_cover_letter_template`, `eubp_attachment`, `eubp_submission`, `event`, `eventchat`, `familyavatar`, `file`, `finance_template`, `follow_up`, `further_link`, `group`, ….
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Last synchronization timestamp. Prefer an explicit timezone.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "lastSyncedDate", deserialize_with = "crate::lenient::double_option", serialize_with = "crate::datetime::serialize_double_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub last_synced_date: Option<Option<chrono::DateTime<chrono::Utc>>>,
/// Adapter-specific context key.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub scope: Option<Option<String>>,
/// ID in the external system.
#[serde(rename = "sourceEntityId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_entity_id: Option<String>,
/// External connection ID (the source system).
#[serde(rename = "sourceId", deserialize_with = "crate::lenient::number")]
pub source_id: i64,
/// State of the relationship: synchronized, unresolved conflict, or deleted in ChurchTools.
/// Allowed values: `conflict`, `deleted in CT`, `synced`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionBehavior {
pub create: SyncExecutionBehaviorCreate,
pub delete: SyncExecutionBehaviorDelete,
pub link: SyncExecutionBehaviorLink,
pub update: SyncExecutionBehaviorUpdate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionBehaviorCreate {
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "behaviorES", deserialize_with = "crate::lenient::string")]
pub behavior_es: String,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "behaviorMaster", deserialize_with = "crate::lenient::string")]
pub behavior_master: String,
/// Adapter-specific JSON object or list.
#[serde(rename = "defaultsES", default, skip_serializing_if = "serde_json::Value::is_null")]
pub defaults_es: serde_json::Value,
/// Adapter-specific JSON object or list.
#[serde(rename = "defaultsMaster", default, skip_serializing_if = "serde_json::Value::is_null")]
pub defaults_master: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionBehaviorDelete {
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "behaviorES", deserialize_with = "crate::lenient::string")]
pub behavior_es: String,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "behaviorMaster", deserialize_with = "crate::lenient::string")]
pub behavior_master: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionBehaviorLink {
/// Whether matching records are linked: never, use an existing record, or merge when linking.
/// Allowed values: `alwaysMerge`, `alwaysUse`, `never`.
#[serde(deserialize_with = "crate::lenient::string")]
pub behavior: String,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub data: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionBehaviorUpdate {
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(deserialize_with = "crate::lenient::string")]
pub behavior: String,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub data: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionCounts {
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub create: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub delete: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub link: Option<i64>,
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub update: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionCreate {
/// Schedule a dry run; the worker is instructed not to change synchronized records.
#[serde(rename = "isDryRun", default, skip_serializing_if = "Option::is_none")]
pub is_dry_run: Option<bool>,
/// Schedule configuration validation only.
#[serde(rename = "isValidationOnly", default, skip_serializing_if = "Option::is_none")]
pub is_validation_only: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionDetails {
/// Domain saved with this execution.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Filter snapshot indexed by domain, then by ES and Master.
#[serde(deserialize_with = "crate::lenient::map")]
pub filter: std::collections::BTreeMap<String, SyncExecutionDetailsFilterValue>,
/// Numeric job configuration ID.
#[serde(rename = "jobId", deserialize_with = "crate::lenient::number")]
pub job_id: i64,
/// Mapping snapshot indexed by the configured domain name.
#[serde(deserialize_with = "crate::lenient::map")]
pub mapping: std::collections::BTreeMap<String, SyncExecutionMapping>,
#[serde(rename = "syncBehavior")]
pub sync_behavior: SyncExecutionBehavior,
#[serde(rename = "systemES")]
pub system_es: SyncExecutionDetailsSystemES,
/// Adapter credentials are removed from this snapshot.
#[serde(rename = "systemMaster")]
pub system_master: Vec<serde_json::Value>,
#[serde(rename = "validationOnly")]
pub validation_only: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionDetailsFilterValue {
#[serde(rename = "ES")]
pub es: Vec<SyncJobFilter>,
#[serde(rename = "Master")]
pub master: Vec<SyncJobFilter>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionDetailsSystemES {
/// External connection ID.
#[serde(rename = "systemId", deserialize_with = "crate::lenient::number")]
pub system_id: i64,
/// External connection name.
#[serde(rename = "systemName", deserialize_with = "crate::lenient::string")]
pub system_name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionMapping {
#[serde(rename = "propertyMappingsESToMaster", default, skip_serializing_if = "serde_json::Value::is_null")]
pub property_mappings_es_to_master: serde_json::Value,
#[serde(rename = "propertyMappingsMasterToES", default, skip_serializing_if = "serde_json::Value::is_null")]
pub property_mappings_master_to_es: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored directional field mapping. No separate entry ID is returned.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionProperty {
/// Source field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub from: String,
/// Adapter-specific source-field qualifier.
#[serde(rename = "fromFilter", deserialize_with = "crate::lenient::string")]
pub from_filter: String,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub others: serde_json::Value,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Target field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub to: String,
/// Adapter-specific target-field qualifier.
#[serde(rename = "toFilter", deserialize_with = "crate::lenient::string")]
pub to_filter: String,
#[serde(rename = "valueMapping", default, skip_serializing_if = "serde_json::Value::is_null")]
pub value_mapping: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExecutionSummary {
pub both: SyncExecutionCounts,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "createdDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub created_date: Option<chrono::DateTime<chrono::Utc>>,
/// Latest log timestamp; this is not necessarily a completion timestamp.
#[serde(rename = "endDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::DateTime<chrono::Utc>>,
#[serde(rename = "errorCount", deserialize_with = "crate::lenient::number")]
pub error_count: i64,
pub es: SyncExecutionCounts,
/// Background execution ID.
#[serde(rename = "executionId", deserialize_with = "crate::lenient::string")]
pub execution_id: String,
#[serde(rename = "isDryRun")]
pub is_dry_run: bool,
/// Numeric sync job configuration ID.
#[serde(rename = "jobId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub job_id: Option<i64>,
pub master: SyncExecutionCounts,
/// Earliest log timestamp.
#[serde(rename = "startDate", deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<chrono::DateTime<chrono::Utc>>,
/// Background execution status, distinct from entity mapping status.
/// Allowed values: `CANCELED`, `DONE`, `ERROR`, `IN_PROGRESS`, `QUEUED`.
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Proposed connection settings to test. `id` loads an existing connection and merges the supplied headers before testing; connection configuration is not saved.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncExternalSystemTestCreate {
/// Adapter-specific HTTP header values used to access the external system.
#[serde(rename = "accessHeaderValues", default, skip_serializing_if = "serde_json::Value::is_null")]
pub access_header_values: serde_json::Value,
/// Name of a registered adapter from `/sync/adapters`. Custom adapter names are supported.
#[serde(deserialize_with = "crate::lenient::string")]
pub adapter: String,
/// Display name of the external connection.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Existing connection to base the test on.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncFieldMappingEntries {
#[serde(rename = "propertyMappingsESToMaster")]
pub property_mappings_es_to_master: Vec<FieldMappingEntry>,
#[serde(rename = "propertyMappingsMasterToES")]
pub property_mappings_master_to_es: Vec<FieldMappingEntry>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncFieldMappingEntryCreate {
/// Source field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub from: String,
/// Adapter-specific source-field qualifier.
#[serde(rename = "fromFilter", deserialize_with = "crate::lenient::string")]
pub from_filter: String,
/// Adapter-specific JSON object or list.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub others: serde_json::Value,
/// Target field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub to: String,
/// Adapter-specific target-field qualifier.
#[serde(rename = "toFilter", deserialize_with = "crate::lenient::string")]
pub to_filter: String,
/// Adapter-specific JSON object or list.
#[serde(rename = "valueMapping", default, skip_serializing_if = "serde_json::Value::is_null")]
pub value_mapping: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces both direction lists. The enclosing list sets `system`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncFieldMappingUpdate {
#[serde(rename = "propertyMappingsESToMaster")]
pub property_mappings_es_to_master: Vec<SyncFieldMappingEntryCreate>,
#[serde(rename = "propertyMappingsMasterToES")]
pub property_mappings_master_to_es: Vec<SyncFieldMappingEntryCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobConfigurationCreate {
/// Whether the periodic scheduler can start this job.
#[serde(rename = "autoScheduleEnabled")]
pub auto_schedule_enabled: bool,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorES", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub create_behavior_es: Option<String>,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorMaster", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub create_behavior_master: Option<String>,
#[serde(rename = "createDefaultsES", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_es: serde_json::Value,
#[serde(rename = "createDefaultsMaster", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_master: serde_json::Value,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorES", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub delete_behavior_es: Option<String>,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorMaster", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub delete_behavior_master: Option<String>,
/// Domain supported by the adapter, such as person. Job configuration accepts adapter-specific domain names.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether matching records are linked: never, use an existing record, or merge when linking.
/// Allowed values: `alwaysMerge`, `alwaysUse`, `never`.
#[serde(rename = "linkBehavior", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link_behavior: Option<String>,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "linkData", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link_data: Option<String>,
/// Job display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "updateBehavior", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub update_behavior: Option<String>,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "updateData", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub update_data: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Updates the job configuration.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobConfigurationUpdate {
/// Whether the periodic scheduler can start this job.
#[serde(rename = "autoScheduleEnabled")]
pub auto_schedule_enabled: bool,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorES", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub create_behavior_es: Option<String>,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "createBehaviorMaster", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub create_behavior_master: Option<String>,
/// Adapter-specific defaults for newly created records on this side.
#[serde(rename = "createDefaultsES", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_es: serde_json::Value,
/// Adapter-specific defaults for newly created records on this side.
#[serde(rename = "createDefaultsMaster", default, skip_serializing_if = "serde_json::Value::is_null")]
pub create_defaults_master: serde_json::Value,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorES", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub delete_behavior_es: Option<String>,
/// How deletions are handled on the specified side: retain, archive or delete.
/// Allowed values: `alwaysArchive`, `alwaysDelete`, `never`.
#[serde(rename = "deleteBehaviorMaster", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub delete_behavior_master: Option<String>,
/// Domain supported by the adapter, such as person. Job configuration accepts adapter-specific domain names.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Whether matching records are linked: never, use an existing record, or merge when linking.
/// Allowed values: `alwaysMerge`, `alwaysUse`, `never`.
#[serde(rename = "linkBehavior", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link_behavior: Option<String>,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "linkData", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub link_data: Option<String>,
/// Job display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Whether records may be created or updated.
/// Allowed values: `always`, `never`.
#[serde(rename = "updateBehavior", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub update_behavior: Option<String>,
/// Which side supplies data: the most recently updated record, ChurchTools, or the external system.
/// Allowed values: `es`, `lastUpdated`, `master`.
#[serde(rename = "updateData", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub update_data: Option<String>,
/// Existing job configuration ID.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobFilter {
/// Adapter field to filter.
#[serde(deserialize_with = "crate::lenient::string")]
pub field: String,
/// Adapter-specific comparison operator. ChurchTools does not enforce a fixed operator list.
#[serde(deserialize_with = "crate::lenient::string")]
pub operator: String,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Adapter-specific filter values.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub values: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobFilterCreate {
/// Adapter field to filter.
#[serde(deserialize_with = "crate::lenient::string")]
pub field: String,
/// Adapter-specific comparison operator. ChurchTools does not enforce a fixed operator list.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub operator: Option<String>,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Filter values passed to the adapter. Value types depend on the field and adapter.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub values: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobFilters {
pub es: Vec<SyncJobFilter>,
pub master: Vec<SyncJobFilter>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces all job filters, grouped by each entry's `system`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobFiltersUpdate {
pub es: Vec<SyncJobFilterCreate>,
pub master: Vec<SyncJobFilterCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobProperties {
/// Domain configured for the job.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Configured external connection with masked access credentials.
#[serde(rename = "externalSystem")]
pub external_system: ExternalSystem,
pub properties: SyncJobPropertyLists,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces the selected fields in both directions. Each entry's `system` determines its stored direction.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobPropertiesUpdate {
#[serde(rename = "propertyMappingsESToMaster")]
pub property_mappings_es_to_master: Vec<SyncJobPropertyCreate>,
#[serde(rename = "propertyMappingsMasterToES")]
pub property_mappings_master_to_es: Vec<SyncJobPropertyCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Selected job field. `valueMapping` and `others` are resolved from the referenced field mapping.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobProperty {
/// Field mapping whose domain must match the job.
#[serde(rename = "fieldMappingId", deserialize_with = "crate::lenient::number")]
pub field_mapping_id: i64,
/// Source field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub from: String,
/// Adapter-specific source-field qualifier.
#[serde(rename = "fromFilter", deserialize_with = "crate::lenient::string")]
pub from_filter: String,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Target field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub to: String,
/// Adapter-specific target-field qualifier.
#[serde(rename = "toFilter", deserialize_with = "crate::lenient::string")]
pub to_filter: String,
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub others: serde_json::Value,
#[serde(rename = "valueMapping", default, skip_serializing_if = "serde_json::Value::is_null")]
pub value_mapping: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobPropertyCreate {
/// Field mapping whose domain must match the job.
#[serde(rename = "fieldMappingId", deserialize_with = "crate::lenient::number")]
pub field_mapping_id: i64,
/// Source field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub from: String,
/// Adapter-specific source-field qualifier.
#[serde(rename = "fromFilter", deserialize_with = "crate::lenient::string")]
pub from_filter: String,
/// Side of synchronization: `master` is ChurchTools and `es` is the configured external system.
/// Allowed values: `es`, `master`.
#[serde(deserialize_with = "crate::lenient::string")]
pub system: String,
/// Target field name supported by the adapter.
#[serde(deserialize_with = "crate::lenient::string")]
pub to: String,
/// Adapter-specific target-field qualifier.
#[serde(rename = "toFilter", deserialize_with = "crate::lenient::string")]
pub to_filter: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncJobPropertyLists {
#[serde(rename = "propertyMappingsESToMaster")]
pub property_mappings_es_to_master: Vec<SyncJobProperty>,
#[serde(rename = "propertyMappingsMasterToES")]
pub property_mappings_master_to_es: Vec<SyncJobProperty>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Log entry during a sync execution.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLog {
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(serialize_with = "crate::datetime::serialize_utc")]
pub date: chrono::DateTime<chrono::Utc>,
/// `domainId` of the affected record.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<String>,
/// `domainType` of the affected record.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub domain_type: Option<String>,
/// Background execution identifier.
#[serde(rename = "executionId", deserialize_with = "crate::lenient::string")]
pub execution_id: String,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "isDryRun")]
pub is_dry_run: bool,
pub job: SyncLogJob,
/// PSR log severity.
/// Allowed values: `alert`, `critical`, `debug`, `emergency`, `error`, `info`, `notice`, `warning`.
#[serde(deserialize_with = "crate::lenient::string")]
pub level: String,
/// Rendered, translated log message including formatted changes. Original messageKey and args are not returned.
#[serde(deserialize_with = "crate::lenient::string")]
pub message: String,
/// `sourceEntityId` of the affected record.
#[serde(rename = "sourceEntityId", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub source_entity_id: Option<String>,
/// Allowed values: `both`, `es`, `master`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub system: Option<String>,
/// Operation described by a sync log entry.
/// Allowed values: `create`, `delete`, `execution`, `link`, `update`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogCreate {
/// Translation arguments; keys and values are passed to the translation system.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub args: serde_json::Value,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub changes: Option<Vec<SyncLogCreateChangesItem>>,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(serialize_with = "crate::datetime::serialize_utc")]
pub date: chrono::DateTime<chrono::Utc>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "domainId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub domain_id: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub domain_type: Option<Option<String>>,
/// Background execution identifier, not the job configuration ID.
#[serde(rename = "executionId", deserialize_with = "crate::lenient::string")]
pub execution_id: String,
#[serde(rename = "isDryRun", default, skip_serializing_if = "Option::is_none")]
pub is_dry_run: Option<bool>,
#[serde(rename = "jobId", deserialize_with = "crate::lenient::number")]
pub job_id: i64,
/// PSR log severity.
/// Allowed values: `alert`, `critical`, `debug`, `emergency`, `error`, `info`, `notice`, `warning`.
#[serde(deserialize_with = "crate::lenient::string")]
pub level: String,
/// Translation Key
#[serde(rename = "messageKey", deserialize_with = "crate::lenient::string")]
pub message_key: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "sourceEntityId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub source_entity_id: Option<Option<String>>,
/// Affected side.
/// Allowed values: `both`, `es`, `master`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub system: Option<Option<String>>,
/// Operation described by a sync log entry.
/// Allowed values: `create`, `delete`, `execution`, `link`, `update`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogCreateChangesItem {
/// Secondary value for FieldName. Used for Group Roles.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "fieldAttribute", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub field_attribute: Option<Option<String>>,
/// Name of field. Translation Key allowed
#[serde(rename = "fieldName", deserialize_with = "crate::lenient::string")]
pub field_name: String,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "newValue", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub new_value: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "oldValue", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub old_value: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogJob {
#[serde(rename = "externalSystem")]
pub external_system: SyncLogJobExternalSystem,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogJobExternalSystem {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogsCreate {
pub logs: Vec<SyncLogCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct SyncLogsPersisted {
/// Number of stored entries.
#[serde(deserialize_with = "crate::lenient::number")]
pub persisted: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Tag label and display properties. The REST tag controller does not return the tag domain or audit metadata.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Tag {
/// Stored semantic color, or `basic` when no color is stored.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "modifiedAt", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_at: Option<String>,
#[serde(rename = "modifiedBy", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_by: Option<i64>,
#[serde(rename = "modifiedDate", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_date: Option<String>,
#[serde(rename = "modifiedPid", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub modified_pid: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TagAssignmentCreate {
/// Name of an existing or newly created tag in this domain.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TagCreate {
/// Semantic tag color; responses use `basic` when unset.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Tag name, unique within the domain.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement tag properties. The tag’s domain cannot be changed.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TagUpdate {
/// Semantic tag color; responses use `basic` when unset.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub color: Option<Option<String>>,
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub description: Option<Option<String>>,
/// Tag name, unique within the domain.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Tag with contextual count. The domain-wide list computes its total links; creation returns `0`. Other operations normally return the serializer’s fallback `1`, not a freshly calculated total.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TagWithCount {
/// Stored semantic color, or `basic` when no color is stored.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Link count only for the domain-wide catalog; other endpoint contexts use `0` on creation or normally `1`.
#[serde(deserialize_with = "crate::lenient::number")]
pub count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// An intended audience for a group, such as families or students. A group can reference one audience through information.targetGroupId. This is descriptive master data, not a collection of person records or a group membership.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TargetGroup {
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// ID of this master-data record in this ChurchTools installation. Use it when assigning this classification to a group.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Localized display name, translated from the stored name when a translation exists.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TargetGroupCreate {
/// Stored label configured in this installation. Use nameTranslated from the response for a localized display name.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Display order. Lower values come first; list endpoints sort equal values by the stored name.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A tax rate combines a tax type, a percentage and the ledger account receiving the tax amount. Its accounting period is determined by that account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxRate {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Description, trimmed before storage. Omitted, null or blank clears it.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Percentage points: 7 means 7%. Legacy or internally created records can contain null.
#[serde(deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub rate: Option<f64>,
/// Existing tax type from /finance/taxtypes.
#[serde(rename = "taxTypeId", deserialize_with = "crate::lenient::number")]
pub tax_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A tax rate combines a tax type, a percentage and the ledger account receiving the tax amount. Its accounting period is determined by that account.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxRateCreate {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Description, trimmed before storage. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Percentage points: 7 means 7%, not 0.07. The API validates a number but does not enforce a percentage range.
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: f64,
/// Existing tax type from /finance/taxtypes.
#[serde(rename = "taxTypeId", deserialize_with = "crate::lenient::number")]
pub tax_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for this tax rate. If transactions already reference it, only note may change; send the existing rate, taxTypeId and accountId unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxRateUpdate {
/// ID of the existing ledger account receiving this amount. It also determines the accounting period.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Description, trimmed before storage. Omitted, null or blank clears it.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub note: Option<Option<String>>,
/// Percentage points: 7 means 7%, not 0.07. The API validates a number but does not enforce a percentage range.
#[serde(deserialize_with = "crate::lenient::number")]
pub rate: f64,
/// Existing tax type from /finance/taxtypes.
#[serde(rename = "taxTypeId", deserialize_with = "crate::lenient::number")]
pub tax_type_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Tax types group tax rates by their accounting purpose, for example input tax or output tax. The percentage and receiving ledger account are configured on each tax rate.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxType {
/// Unique name, trimmed before storage. Omitted, null or blank becomes null, including on update.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Ascending display order. Required for creation and update; there is no API default.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
pub meta: MetaDataEntityId,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Tax types group tax rates by their accounting purpose, for example input tax or output tax. The percentage and receiving ledger account are configured on each tax rate.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxTypeCreate {
/// Unique name, trimmed before storage. Omitted, null or blank becomes null, including on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Ascending display order. Required for creation and update; there is no API default.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement values for this tax type.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TaxTypeUpdate {
/// Unique name, trimmed before storage. Omitted, null or blank becomes null, including on update.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub name: Option<Option<String>>,
/// Ascending display order. Required for creation and update; there is no API default.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A single accounting transaction (a booking). Every transaction posts a given `amount` between a debit account (`accountId`) and a credit account (`contraAccountId`) within one accounting period. Equal account IDs represent a transfer from `costCenterId` to `contraCostCenterId`. Monetary values are always integers in the currency's smallest denomination (e.g. cents). A transaction that belongs to a split transaction references its parent via `splitTransactionId` and cannot be edited or deleted on its own.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Transaction {
/// Compatibility marker mapping the deprecated donor ID fields to their replacements.
#[serde(rename = "@deprecated")]
pub deprecated: TransactionDeprecated,
/// ID of the debit account the amount is posted to.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Stored booking amount in minor currency units. When this is the main booking of a tax split, it excludes the separate taxTransactionId amount; add both amounts to obtain the gross input amount.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Receipts attached to this booking, included when include\[\]=bills is requested.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub bills: Option<Vec<Bill>>,
/// Granted cash discount in the currency's smallest denomination (e.g. cents). `null` if no cash discount applies.
#[serde(rename = "cashDiscountAmount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_amount: Option<i64>,
/// ID of the applied cash discount, or `null` if none.
#[serde(rename = "cashDiscountId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_id: Option<i64>,
/// ID of the credit (contra) account the amount is posted from.
#[serde(rename = "contraAccountId", deserialize_with = "crate::lenient::number")]
pub contra_account_id: i64,
/// ID of the target cost center for a cost center transfer. Required when `accountId` and `contraAccountId` are equal, otherwise it must be `null`.
#[serde(rename = "contraCostCenterId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub contra_cost_center_id: Option<i64>,
/// ID of the assigned cost center, or `null` if none. For a cost center transfer this is the source cost center.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<i64>,
/// Document date of the booking. Used for accounting-period validation, date filters and accounting reports.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Document number of the transaction. Auto-generated when the accounting period increments document numbers, otherwise required on creation.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::string")]
pub document_number: String,
/// Resolved donor person, or null when no person has been resolved. Without donor visibility the response contains a censored person placeholder.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub donator: Option<DomainObjectPerson>,
/// Deprecated: use `donator` instead.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub donator_id: Option<i64>,
/// Resolved spouse for joint donation receipts, or null. Without donor visibility the response contains a censored person placeholder.
#[serde(rename = "donatorSpouse", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse: Option<DomainObjectPerson>,
/// Deprecated: use `donatorSpouse` instead.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub donator_spouse_id: Option<i64>,
/// Unique ID of the transaction.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// If a transaction is immutable, none of its fields can be changed and it cannot be deleted (it has been finalized/locked).
#[serde(rename = "isImmutable")]
pub is_immutable: bool,
/// True, if the transaction has been created through a sync.
#[serde(rename = "isSynced")]
pub is_synced: bool,
/// True, if this transaction is a waiver of reimbursement of expenses ("Aufwandsspende").
#[serde(rename = "isWaiverOfReimbursementOfExpenses")]
pub is_waiver_of_reimbursement_of_expenses: bool,
pub meta: MetaDataEntityId,
/// Free-text booking note. Null when unset or hidden because the current user may view the transaction but not its donor information.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub note: Option<String>,
/// Permissions calculated for the current caller, or null when this booking was serialized without a permission collection, for example a newly generated tax child.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub permissions: Option<TransactionPermissions>,
/// ID of the parent split transaction, or `null` if this is a normal standalone transaction.
#[serde(rename = "splitTransactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub split_transaction_id: Option<i64>,
/// Reference to the transaction which gets stornoed by this transaction.
#[serde(rename = "stornoBaseId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub storno_base_id: Option<i64>,
/// Reference to the transaction which stornoed this transaction.
#[serde(rename = "stornoTransactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub storno_transaction_id: Option<i64>,
/// Reference to the transaction which is the base for a tax split booking.
#[serde(rename = "taxBaseId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tax_base_id: Option<i64>,
/// If a tax rate is set for the transaction, the corresponding tax transaction is returned in the field taxTransactionId.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<i64>,
/// Reference to the transaction which is a split booking for taxes.
#[serde(rename = "taxTransactionId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub tax_transaction_id: Option<i64>,
/// Date on which the transaction was created, derived from meta.createdDate. Date filters and accounting reports use documentDate.
#[serde(rename = "transactionDate")]
pub transaction_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One accounting-period scope. Conditions within it are combined with AND; filter objects are combined with OR. Empty includeIds/excludeIds arrays impose no ID restriction. Exclusions apply only inside their own filter.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionBatchFilter {
/// Filter by account/contra account. All transactions match, where either account or contra account is in the list.
#[serde(rename = "accountIds", default, skip_serializing_if = "Option::is_none")]
pub account_ids: Option<Vec<i64>>,
/// ID of accounting period to get master data for
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Filter by cost centers.
#[serde(rename = "costCenterIds", default, skip_serializing_if = "Option::is_none")]
pub cost_center_ids: Option<Vec<i64>>,
/// Filter by person ID. Get all transactions the person has created. But only show those the user can see.
#[serde(rename = "createdPid", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub created_pid: Option<i64>,
/// Person IDs matching either donor or spouse, including donors of the original booking when matching cancellations.
#[serde(rename = "donatorIds", default, skip_serializing_if = "Option::is_none")]
pub donator_ids: Option<Vec<i64>>,
/// Inclusive upper bound for documentDate.
#[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::NaiveDate>,
/// Legacy alias for excludeIds. When both are present, this alias takes precedence.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub exclude: Option<Vec<i64>>,
/// Filter by ids to exclude.
#[serde(rename = "excludeIds", default, skip_serializing_if = "Option::is_none")]
pub exclude_ids: Option<Vec<i64>>,
/// Legacy alias for includeIds. When both are present, this alias takes precedence.
#[serde(default, skip_serializing_if = "Option::is_none")]
#[deprecated = "deprecated in the ChurchTools API"]
pub include: Option<Vec<i64>>,
/// Filter by ids to include.
#[serde(rename = "includeIds", default, skip_serializing_if = "Option::is_none")]
pub include_ids: Option<Vec<i64>>,
/// Currently, either true or false selects bookings with a positive donor ID. Omit this parameter to include both donations and other bookings.
#[serde(rename = "isDonation", default, skip_serializing_if = "Option::is_none")]
pub is_donation: Option<bool>,
/// Filter transactions, whether transaction is immutable.
#[serde(rename = "isImmutable", default, skip_serializing_if = "Option::is_none")]
pub is_immutable: Option<bool>,
/// True selects a cash-asset debit account and a non-cash-asset credit account (income); false selects the reverse (expense). Transfers between two cash-asset accounts or two non-cash-asset accounts match neither value.
#[serde(rename = "isIncome", default, skip_serializing_if = "Option::is_none")]
pub is_income: Option<bool>,
/// Sort by document date, amount, modification time, document number, note, account number, contra-account number, cost-center number, donor name or receipt count. Date and modification time plus ID break ties where applicable. Document numbers use their stored text, numeric and split suffix parts.
/// Allowed values: `account`, `amount`, `bills`, `contra_account`, `cost_center`, `date`, `donator`, `modified`, `note`, `number`.
#[serde(rename = "orderBy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub order_by: Option<String>,
/// Search note, document number or amount. For amount matching, leading zeros and decimal separators are removed.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub query: Option<String>,
/// Inclusive lower bound for documentDate.
#[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<chrono::NaiveDate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Result counters. They do not enumerate the affected booking IDs.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionBatchResult {
/// Finalization: selected and automatically added related bookings. Deletion: initial selected rows, excluding additional rows removed through dependencies.
#[serde(rename = "affectedRows", deserialize_with = "crate::lenient::number")]
pub affected_rows: i64,
/// Finalization: previously mutable rows actually updated. Deletion currently always reports zero, even when rows were deleted.
#[serde(rename = "changedRows", deserialize_with = "crate::lenient::number")]
pub changed_rows: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A batch action and its non-empty list of accounting-period scopes. Always provide at least one filter: the current backend does not safely scope an empty filters array.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionBatchUpdate {
/// Use isImmutable=true to finalize or delete=true to delete. If both are true, finalization takes precedence. No recognized true trigger results in a no-op.
pub changeset: TransactionBatchUpdateChangeset,
/// Scopes to combine with OR. Each scope requires an accountingPeriodId.
pub filters: Vec<TransactionBatchFilter>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Use isImmutable=true to finalize or delete=true to delete. If both are true, finalization takes precedence. No recognized true trigger results in a no-op.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionBatchUpdateChangeset {
/// Delete matched bookings, including immutable ones. This is the period-cleanup operation, not ordinary per-booking deletion.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub delete: Option<bool>,
/// Finalize the matched bookings and related tax/base bookings.
#[serde(rename = "isImmutable", default, skip_serializing_if = "Option::is_none")]
pub is_immutable: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// One booking in a bulk request. Unlike single creation, documentNumber is required even when the period normally generates numbers. Send actual JSON booleans and numbers: the bulk implementation uses the original body after validation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionBulkCreateItem {
/// ID of the debit account the amount is posted to.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Gross booking amount in integer minor currency units. With taxRateId, tax is calculated from this amount and split into a separate booking; the returned main booking contains the remaining net amount.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Cash discount in the smallest currency unit. Used only together with cashDiscountId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountAmount", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_amount: Option<Option<i64>>,
/// Cash-discount definition from the same accounting period. When supplied, cashDiscountAmount must also be non-null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_id: Option<Option<i64>>,
/// ID of the credit (contra) account the amount is posted from. Equal to `accountId` only for a cost center transfer.
#[serde(rename = "contraAccountId", deserialize_with = "crate::lenient::number")]
pub contra_account_id: i64,
/// ID of the target cost center for a cost center transfer. Required when `accountId` and `contraAccountId` are equal, otherwise it must be omitted or `null`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "contraCostCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub contra_cost_center_id: Option<Option<i64>>,
/// Cost center from the same accounting period. Omission or null clears the assignment on update. Required as the source cost center for a cost center transfer.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// Date printed on the underlying document/receipt.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Donor person ID. Normally required when only the credit account is a donation account. Donor assignments are retained only when exactly one side is a donation account.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_id: Option<Option<i64>>,
/// Spouse for joint donation receipts. Requires a different donor person and an existing spouse relationship; inconsistent assignments return 422.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse_id: Option<Option<i64>>,
/// Whether this is a donation through waived reimbursement of expenses. Defaults to false, including on update.
#[serde(rename = "isWaiverOfReimbursementOfExpenses", default, skip_serializing_if = "Option::is_none")]
pub is_waiver_of_reimbursement_of_expenses: Option<bool>,
/// Free-text note describing the booking.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Tax rate from the same accounting period. Generates or updates a separate tax booking. On update, omission or null removes the existing tax booking.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Explicit document number for this item.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::string")]
pub document_number: String,
/// Mark this booking as created through a sync.
#[serde(rename = "isSynced", default, skip_serializing_if = "Option::is_none")]
pub is_synced: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Creates one booking. The document date must lie within the open accounting period. Supply documentNumber unless the period generates numbers; omission or null then requests an automatically suggested number. Donation-validation bypass for this endpoint is a query parameter.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionCreate {
/// ID of the debit account the amount is posted to.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Gross booking amount in integer minor currency units. With taxRateId, tax is calculated from this amount and split into a separate booking; the returned main booking contains the remaining net amount.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Cash discount in the smallest currency unit. Used only together with cashDiscountId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountAmount", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_amount: Option<Option<i64>>,
/// Cash-discount definition from the same accounting period. When supplied, cashDiscountAmount must also be non-null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_id: Option<Option<i64>>,
/// ID of the credit (contra) account the amount is posted from. Equal to `accountId` only for a cost center transfer.
#[serde(rename = "contraAccountId", deserialize_with = "crate::lenient::number")]
pub contra_account_id: i64,
/// ID of the target cost center for a cost center transfer. Required when `accountId` and `contraAccountId` are equal, otherwise it must be omitted or `null`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "contraCostCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub contra_cost_center_id: Option<Option<i64>>,
/// Cost center from the same accounting period. Omission or null clears the assignment on update. Required as the source cost center for a cost center transfer.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// Date printed on the underlying document/receipt.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Donor person ID. Normally required when only the credit account is a donation account. Donor assignments are retained only when exactly one side is a donation account.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_id: Option<Option<i64>>,
/// Spouse for joint donation receipts. Requires a different donor person and an existing spouse relationship; inconsistent assignments return 422.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse_id: Option<Option<i64>>,
/// Whether this is a donation through waived reimbursement of expenses. Defaults to false, including on update.
#[serde(rename = "isWaiverOfReimbursementOfExpenses", default, skip_serializing_if = "Option::is_none")]
pub is_waiver_of_reimbursement_of_expenses: Option<bool>,
/// Free-text note describing the booking.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Tax rate from the same accounting period. Generates or updates a separate tax booking. On update, omission or null removes the existing tax booking.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Document number, required unless automatic numbering is enabled. An explicitly supplied value is used as-is.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub document_number: Option<Option<String>>,
/// Mark this booking as created through a sync.
#[serde(rename = "isSynced", default, skip_serializing_if = "Option::is_none")]
pub is_synced: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compatibility marker mapping the deprecated donor ID fields to their replacements.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionDeprecated {
/// Allowed values: `donator`.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::string")]
pub donator_id: String,
/// Allowed values: `donatorSpouse`.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::string")]
pub donator_spouse_id: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Permissions calculated for the current caller, or null when this booking was serialized without a permission collection, for example a newly generated tax child.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionPermissions {
/// Flag if user can edit this transaction
#[serde(rename = "canEdit", default, skip_serializing_if = "Option::is_none")]
pub can_edit: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A transaction purpose is a reusable preset for simplified bookkeeping. It fixes one ledger account, offers a list of accounts for the other side, and can assign a cost center. isIncome selects an income or expense preset; it is not the free-text note of a bank statement.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionPurpose {
/// Resolved, distinct ledger account IDs. Can be empty when input IDs could not be resolved. No order is guaranteed.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Optional cost center. Omitted or null removes it, including on update. If supplied, its period must match the fixed account and all resolved accountIds.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<i64>,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// True for income presets, false for expense presets. Determines which side of a transaction uses purposeAccountId.
#[serde(rename = "isIncome")]
pub is_income: bool,
pub meta: MetaDataEntityId,
/// Trimmed display name. Names are not required to be unique.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fixed ledger account: the contra account for income, or the account for expenses. Its period must be open.
#[serde(rename = "purposeAccountId", deserialize_with = "crate::lenient::number")]
pub purpose_account_id: i64,
/// Ascending display order. Required in creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A transaction purpose is a reusable preset for simplified bookkeeping. It fixes one ledger account, offers a list of accounts for the other side, and can assign a cost center. isIncome selects an income or expense preset; it is not the free-text note of a bank statement.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionPurposeCreate {
/// Accounts offered for the other side of the posting. Duplicate IDs are collapsed; unknown IDs are currently omitted by the lookup. Supply existing accounts.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Optional cost center. Omitted or null removes it, including on update. If supplied, its period must match the fixed account and all resolved accountIds.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// True for income presets, false for expense presets. Determines which side of a transaction uses purposeAccountId.
#[serde(rename = "isIncome")]
pub is_income: bool,
/// Trimmed display name. Names are not required to be unique.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fixed ledger account: the contra account for income, or the account for expenses. Its period must be open.
#[serde(rename = "purposeAccountId", deserialize_with = "crate::lenient::number")]
pub purpose_account_id: i64,
/// Ascending display order. Required in creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement preset, including the complete accountIds selection. Omitted costCenterId clears the linked cost center.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionPurposeUpdate {
/// Accounts offered for the other side of the posting. Duplicate IDs are collapsed; unknown IDs are currently omitted by the lookup. Supply existing accounts.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Optional cost center. Omitted or null removes it, including on update. If supplied, its period must match the fixed account and all resolved accountIds.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// True for income presets, false for expense presets. Determines which side of a transaction uses purposeAccountId.
#[serde(rename = "isIncome")]
pub is_income: bool,
/// Trimmed display name. Names are not required to be unique.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Fixed ledger account: the contra account for income, or the account for expenses. Its period must be open.
#[serde(rename = "purposeAccountId", deserialize_with = "crate::lenient::number")]
pub purpose_account_id: i64,
/// Ascending display order. Required in creation and update.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Reason to record when cancelling a booking.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionStornoCreate {
/// Reason added to the original booking note in a localized cancellation prefix. A repeated cancellation keeps the existing cancellation note.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Income, expense and net amount for the selected cost centers. Previous-year values are null when no previous period exists.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCostCenter {
pub periods: TransactionSummaryCostCenterPeriods,
pub summary: TransactionSummaryCostCenterSummary,
/// Allowed values: `costcenter-sum`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCostCenterPeriods {
#[serde(rename = "endDate")]
pub end_date: TransactionSummaryCostCenterPeriodsEndDate,
#[serde(rename = "startDate")]
pub start_date: TransactionSummaryCostCenterPeriodsEndDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCostCenterPeriodsEndDate {
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "lastYear")]
pub last_year: chrono::NaiveDate,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "thisYear")]
pub this_year: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCostCenterSummary {
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub income: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub outcome: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub sum: FinanceYearValueComparison,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Debit, credit and balance totals for selected accounts. Accounts must share the same balance-account classification. Total previous-year values are null unless all selected accounts have a previous-year counterpart.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCreditDebit {
pub periods: TransactionSummaryCostCenterPeriods,
pub summary: TransactionSummaryCreditDebitSummary,
/// Allowed values: `credit-debit`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCreditDebitSummary {
/// Selected accounts, with separate debit, credit and balance comparisons. Balance is debit minus credit for balance-sheet accounts and credit minus debit for other accounts.
pub accounts: Vec<TransactionSummaryCreditDebitSummaryAccountsItem>,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub credit: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub debit: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub sum: FinanceYearValueComparison,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryCreditDebitSummaryAccountsItem {
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub balance: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub credit: FinanceYearValueComparison,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub debit: FinanceYearValueComparison,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub number: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Net donations with repayments subtracted and cancellation pairs excluded. Missing previous-year donations are represented by zero.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryDonation {
pub periods: TransactionSummaryCostCenterPeriods,
pub summary: TransactionSummaryDonationSummary,
/// Allowed values: `donation-sum`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryDonationSummary {
/// Net donations grouped by primary donor. A spouse filter can select bookings attributed to the primary donor. Persons that cannot be resolved or viewed are omitted.
pub donators: Vec<TransactionSummaryDonationSummaryDonatorsItem>,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub sum: FinanceYearValueComparison,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionSummaryDonationSummaryDonatorsItem {
/// Person as Domain Object
pub person: DomainObjectPerson,
/// Amounts in integer minor currency units for the selected date interval and its previous-year counterpart. A missing comparison value can be null; zero represents a calculated zero.
pub sum: FinanceYearValueComparison,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replaces required booking fields. Omitted cost center, donor/spouse and tax rate are cleared; waiver defaults to false. Cash-discount fields are retained when cashDiscountId is omitted or null. Existing immutable bookings, generated tax bookings, cancellations and split children cannot be updated through the ordinary endpoint.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TransactionUpdate {
/// ID of the debit account the amount is posted to.
#[serde(rename = "accountId", deserialize_with = "crate::lenient::number")]
pub account_id: i64,
/// Gross booking amount in integer minor currency units. With taxRateId, tax is calculated from this amount and split into a separate booking; the returned main booking contains the remaining net amount.
#[serde(deserialize_with = "crate::lenient::number")]
pub amount: i64,
/// Cash discount in the smallest currency unit. Used only together with cashDiscountId.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountAmount", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_amount: Option<Option<i64>>,
/// Cash-discount definition from the same accounting period. When supplied, cashDiscountAmount must also be non-null.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "cashDiscountId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cash_discount_id: Option<Option<i64>>,
/// ID of the credit (contra) account the amount is posted from. Equal to `accountId` only for a cost center transfer.
#[serde(rename = "contraAccountId", deserialize_with = "crate::lenient::number")]
pub contra_account_id: i64,
/// ID of the target cost center for a cost center transfer. Required when `accountId` and `contraAccountId` are equal, otherwise it must be omitted or `null`.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "contraCostCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub contra_cost_center_id: Option<Option<i64>>,
/// Cost center from the same accounting period. Omission or null clears the assignment on update. Required as the source cost center for a cost center transfer.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "costCenterId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub cost_center_id: Option<Option<i64>>,
/// Date printed on the underlying document/receipt.
#[serde(rename = "documentDate")]
pub document_date: chrono::NaiveDate,
/// Donor person ID. Normally required when only the credit account is a donation account. Donor assignments are retained only when exactly one side is a donation account.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_id: Option<Option<i64>>,
/// Spouse for joint donation receipts. Requires a different donor person and an existing spouse relationship; inconsistent assignments return 422.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "donatorSpouseId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub donator_spouse_id: Option<Option<i64>>,
/// Whether this is a donation through waived reimbursement of expenses. Defaults to false, including on update.
#[serde(rename = "isWaiverOfReimbursementOfExpenses", default, skip_serializing_if = "Option::is_none")]
pub is_waiver_of_reimbursement_of_expenses: Option<bool>,
/// Free-text note describing the booking.
#[serde(deserialize_with = "crate::lenient::string")]
pub note: String,
/// Tax rate from the same accounting period. Generates or updates a separate tax booking. On update, omission or null removes the existing tax booking.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "taxRateId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub tax_rate_id: Option<Option<i64>>,
/// Replacement document number; never generated automatically on update.
#[serde(rename = "documentNumber", deserialize_with = "crate::lenient::string")]
pub document_number: String,
/// Skip the normal donation-account/donor constraint. Spouse-consistency checks still apply when assignments change.
#[serde(rename = "ignoreDonationConstraint", default, skip_serializing_if = "Option::is_none")]
pub ignore_donation_constraint: Option<bool>,
/// Finalize this booking and its tax booking. This cannot unlock an already immutable booking.
#[serde(rename = "isImmutable", default, skip_serializing_if = "Option::is_none")]
pub is_immutable: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Text and maintenance flags for one language of a translation key. The enclosing map identifies the language code.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Translation {
/// Whether this language entry is marked deleted.
pub deleted: bool,
/// Whether this translation needs review.
#[serde(rename = "needsCheck")]
pub needs_check: bool,
/// The translation value for the key
#[serde(deserialize_with = "crate::lenient::string")]
pub translation: String,
/// Last updated
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub updated: Option<chrono::DateTime<chrono::Utc>>,
/// Determines if the translation was updated or created by the church
#[serde(rename = "updatedByChurch")]
pub updated_by_church: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Translation identifier and its texts by language code. Local keys are marked createdByChurch; supplied product keys cannot be renamed or deleted through these endpoints.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TranslationKey {
/// Whether the key was created locally by this installation.
#[serde(rename = "createdByChurch")]
pub created_by_church: bool,
/// Whether the key is marked deleted.
pub deleted: bool,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Translations keyed by language code, for example de or en. An empty collection serializes as \[\].
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub translations: serde_json::Value,
/// Last updated
#[serde(deserialize_with = "crate::lenient::opt_datetime", serialize_with = "crate::datetime::serialize_opt_utc", default, skip_serializing_if = "Option::is_none")]
pub updated: Option<chrono::DateTime<chrono::Utc>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Rename or move a locally created translation key to a module. Both fields are required; translation texts are unchanged.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TranslationKeyUpdate {
/// Translation key, trimmed before validation.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Module grouping, trimmed before validation. This value is stored as text rather than checked against a fixed module enum.
#[serde(deserialize_with = "crate::lenient::string")]
pub module: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TurnoverReportCreate {
/// Account-type IDs. Omission, null or \[\] selects all types. Existing IDs must be JSON integers; numeric strings do not match. Unknown IDs are ignored. If no supplied ID matches, the turnover calculator falls back to all types.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "accountTypes", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub account_types: Option<Option<Vec<i64>>>,
/// Accounting period owning the accounts. Requires finance edit masterdata or explicit view/edit permission for this period.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// PDF creates a file and returns its URL with HTTP 201. CSV/XLSX return the file directly with HTTP 200. Accept: text/html overrides this selection.
/// Allowed values: `csv`, `pdf`, `xlsx`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub format: Option<String>,
/// Use twelve calendar-month columns or four calendar-quarter columns for the year of the accounting period’s start date.
/// Allowed values: `monthly`, `quarterly`.
#[serde(deserialize_with = "crate::lenient::string")]
pub period: String,
/// Accepted by the shared validator but ignored by the turnover report.
#[serde(rename = "showAccountGroups", default, skip_serializing_if = "Option::is_none")]
pub show_account_groups: Option<bool>,
/// Include zero-value accounts according to the selected report’s balance/activity calculation.
#[serde(rename = "showEmptyAccounts", default, skip_serializing_if = "Option::is_none")]
pub show_empty_accounts: Option<bool>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Two-factor completion result. The legacy disabled-two-factor branch returns only status and does not complete login.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TwoFactorLoginResult {
/// Suggested post-login navigation target from the pending session or external-link completion. Can be relative, absolute or empty. Absent in the legacy disabled-two-factor branch.
#[serde(rename = "redirectTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redirect_to: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TwoFactorSetupActivate {
/// Six-digit current authenticator code. Send it as a string to preserve leading zeroes. A code already accepted recently for this person cannot be reused.
#[serde(deserialize_with = "crate::lenient::string")]
pub code: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// New authenticator enrollment material. Both fields contain the same sensitive TOTP secret; initialize once and keep the result for activation.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct TwoFactorSetupSecret {
/// QR-code image as a data URI, suitable for an image element. It is not an HTTP URL.
#[serde(deserialize_with = "crate::lenient::string")]
pub qrcode: String,
/// New Base32 authenticator secret.
#[serde(deserialize_with = "crate::lenient::string")]
pub secret: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Stored statement suggestion rule. Historical values are returned as stored, including unsupported values accepted by the write validator.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UserRule {
/// Accounts whose statement movements are eligible when allAccounts is false. An empty list then matches no accounts.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Accounting period owning these rules.
#[serde(rename = "accountingPeriodId", deserialize_with = "crate::lenient::number")]
pub accounting_period_id: i64,
/// Apply to all statement accounts in this accounting period instead of accountIds.
#[serde(rename = "allAccounts")]
pub all_accounts: bool,
/// Generated ID, replaced when the rule set is saved.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// True matches incoming movements, false matches outgoing movements.
#[serde(rename = "isIncome")]
pub is_income: bool,
/// contains and = compare case-insensitively. regex uses PHP preg_match with the supplied pattern and flags. The storage API also accepts other strings; unsupported search types/operators produce no match.
#[serde(deserialize_with = "crate::lenient::string")]
pub operator: String,
/// Text to match against the movement purpose, or a complete PHP regular expression including delimiters for regex (for example /donation/i).
#[serde(rename = "searchString", deserialize_with = "crate::lenient::string")]
pub search_string: String,
/// Movement field to search. Only purpose is implemented. The storage API also accepts other strings; unsupported search types/operators produce no match.
#[serde(rename = "searchType", deserialize_with = "crate::lenient::string")]
pub search_type: String,
/// Ascending rule order. IDs are regenerated when the complete rule set is replaced.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Booking field for which a value is suggested. The storage API also accepts other strings; unsupported search types/operators produce no match.
#[serde(rename = "suggestionType", deserialize_with = "crate::lenient::string")]
pub suggestion_type: String,
/// Suggested account or cost-center ID encoded as a string. Referenced IDs are not validated when saving the rules.
#[serde(rename = "suggestionValue", deserialize_with = "crate::lenient::string")]
pub suggestion_value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Rule for generating booking suggestions from imported statement movements. Rules belong to an accounting period, not to the currently logged-in person.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UserRuleCreate {
/// Accounts whose statement movements are eligible when allAccounts is false. An empty list then matches no accounts.
#[serde(rename = "accountIds")]
pub account_ids: Vec<i64>,
/// Apply to all statement accounts in this accounting period instead of accountIds.
#[serde(rename = "allAccounts")]
pub all_accounts: bool,
/// True matches incoming movements, false matches outgoing movements.
#[serde(rename = "isIncome")]
pub is_income: bool,
/// contains and = compare case-insensitively. regex uses PHP preg_match with the supplied pattern and flags.
/// Allowed values: `=`, `contains`, `regex`.
#[serde(deserialize_with = "crate::lenient::string")]
pub operator: String,
/// Text to match against the movement purpose, or a complete PHP regular expression including delimiters for regex (for example /donation/i).
#[serde(rename = "searchString", deserialize_with = "crate::lenient::string")]
pub search_string: String,
/// Movement field to search. Only purpose is implemented.
/// Allowed values: `purpose`.
#[serde(rename = "searchType", deserialize_with = "crate::lenient::string")]
pub search_type: String,
/// Ascending rule order. IDs are regenerated when the complete rule set is replaced.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Booking field for which a value is suggested.
/// Allowed values: `accountId`, `contraAccountId`, `costCenterId`.
#[serde(rename = "suggestionType", deserialize_with = "crate::lenient::string")]
pub suggestion_type: String,
/// Suggested account or cost-center ID encoded as a string. Referenced IDs are not validated when saving the rules.
#[serde(rename = "suggestionValue", deserialize_with = "crate::lenient::string")]
pub suggestion_value: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Complete replacement of an accounting period’s rules. Existing rule IDs are discarded.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UserRulesUpdate {
/// All rules to retain. An empty array removes every rule for this period.
pub rules: Vec<UserRuleCreate>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataCalendar {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::number")]
pub additional_id: i64,
/// Calendar containing appointments and their series. Calendar settings, appointment editing and calendar administration are separate concerns. The type selects the applicable administration category; effective visibility depends on permissions. This object is also embedded in appointment responses.
#[serde(rename = "domainData", default, skip_serializing_if = "Option::is_none")]
pub domain_data: Option<Calendar>,
/// Allowed values: `calendar`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataCreate {
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub additional_id: Option<i64>,
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
/// Allowed values: `calendar`, `person`, `posts-in-group`, `staff`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataPerson {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// The role id
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::number")]
pub additional_id: i64,
#[serde(rename = "domainData", default, skip_serializing_if = "Option::is_none")]
pub domain_data: Option<WebsiteDataPersonDomainData>,
/// Allowed values: `person`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataPersonDomainData {
pub group: DomainObjectGroup,
pub members: Vec<DomainObjectPerson>,
/// A membership role defined for a group type, such as leader or participant. Groups of that type use this definition and add their own settings through GroupRole. A role describes a person's function; MemberStatus separately describes whether their membership is active, requested, waiting or pending removal.
pub role: Role,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataPostsInGroup {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::number")]
pub additional_id: i64,
#[serde(rename = "domainData", default, skip_serializing_if = "Option::is_none")]
pub domain_data: Option<WebsiteDataPostsInGroupDomainData>,
/// Allowed values: `posts-in-group`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataPostsInGroupDomainData {
pub group: DomainObjectGroup,
#[serde(rename = "groupVisiblePostCount", deserialize_with = "crate::lenient::number")]
pub group_visible_post_count: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataStaff {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::number")]
pub additional_id: i64,
/// Person as Domain Object
#[serde(rename = "domainData", default, skip_serializing_if = "Option::is_none")]
pub domain_data: Option<DomainObjectPerson>,
/// Allowed values: `staff`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebsiteDataWithoutInclude {
#[serde(rename = "domainId", deserialize_with = "crate::lenient::number")]
pub domain_id: i64,
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(rename = "additionalId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub additional_id: Option<i64>,
/// Allowed values: `calendar`, `person`, `posts-in-group`, `staff`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct Weekday {
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionAllBirthdaysAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.allBirthdays.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionAppointmentsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.appointments.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataAppointment {
#[serde(rename = "appointmentId", deserialize_with = "crate::lenient::number")]
pub appointment_id: i64,
#[serde(rename = "calendarId", deserialize_with = "crate::lenient::number")]
pub calendar_id: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataBooking {
#[serde(rename = "bookingId", deserialize_with = "crate::lenient::number")]
pub booking_id: i64,
/// A simple date in ISO format, e.g. '2022-10-19'
#[serde(rename = "startDate")]
pub start_date: chrono::NaiveDate,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataEvent {
#[serde(rename = "eventId", deserialize_with = "crate::lenient::number")]
pub event_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataGroup {
#[serde(rename = "groupId", deserialize_with = "crate::lenient::number")]
pub group_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataPerson {
#[serde(rename = "personId", deserialize_with = "crate::lenient::number")]
pub person_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataPostExternal {
#[serde(rename = "groupGuid", deserialize_with = "crate::lenient::string")]
pub group_guid: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(rename = "instanceGuid", deserialize_with = "crate::lenient::string")]
pub instance_guid: String,
#[serde(rename = "postId", deserialize_with = "crate::lenient::number")]
pub post_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataPostInternal {
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
#[serde(rename = "postId", deserialize_with = "crate::lenient::number")]
pub post_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataResource {
#[serde(rename = "resourceId", deserialize_with = "crate::lenient::number")]
pub resource_id: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionDataUrl {
#[serde(deserialize_with = "crate::lenient::string")]
pub url: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionExchangeRequestsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.exchange-requests.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionFavoriteGroupsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.favorite-groups.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionGeneralUrl {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.general.url`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataUrl>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionGroupMeetingAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.groupmeeting.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionMyBookingsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.my-bookings.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionMyGroupsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.my-groups.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionMyResourcesAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.my-resources.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionPostsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.posts.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionServiceRequestsAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.service-requests.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionSongsToLearnAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.songsToLearn.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetActionUpcomingServicesAll {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.upcoming-services.all`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Avatar for widget items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetAvatar {
#[serde(rename = "primaryDomainObject", default, skip_serializing_if = "serde_json::Value::is_null")]
pub primary_domain_object: serde_json::Value,
#[serde(rename = "secondaryDomainObject", default, skip_serializing_if = "serde_json::Value::is_null")]
pub secondary_domain_object: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetCommon {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Settings specific to common widgets
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetSettingsCommon,
/// Grouping configuration for widgets
#[serde(deserialize_with = "crate::lenient::map")]
pub groupings: std::collections::BTreeMap<String, WidgetGroupingOption>,
pub items: Vec<WidgetCommonItem>,
/// Allowed values: `common`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Common widget item structure
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetCommonItem {
#[serde(rename = "actionData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub action_data: serde_json::Value,
pub actions: Vec<serde_json::Value>,
/// Details for common widget items
pub details: WidgetCommonItemDetails,
#[serde(rename = "filterKeys")]
pub filter_keys: Vec<String>,
#[serde(rename = "groupingKeys", default, skip_serializing_if = "Option::is_none")]
pub grouping_keys: Option<Vec<String>>,
pub infos: Vec<WidgetDomainObjectItemInfosItem>,
#[serde(rename = "summaryText", deserialize_with = "crate::lenient::string")]
pub summary_text: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Details for common widget items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetCommonItemDetails {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub avatar: Option<WidgetAvatar>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub count: Option<WidgetCount>,
#[serde(rename = "infoLists")]
pub info_lists: Vec<WidgetInfoList>,
#[serde(rename = "initialInfoList", default, skip_serializing_if = "Option::is_none")]
pub initial_info_list: Option<WidgetInfoList>,
#[serde(rename = "primaryInfoList", default, skip_serializing_if = "Option::is_none")]
pub primary_info_list: Option<WidgetInfoList>,
#[serde(rename = "topLine", default, skip_serializing_if = "Option::is_none")]
pub top_line: Option<WidgetTopLine>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Count display for widgets
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetCount {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Allowed values: `bubble`, `regular`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDate {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetDateWidgetSettings,
pub items: Vec<WidgetDateItem>,
/// Allowed values: `date`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateFilterVariant1 {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub options: Option<Vec<WidgetDateFilterVariant1OptionsItem>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateFilterVariant1OptionsItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub id: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Total number of groups available for this filter option.
#[serde(rename = "totalCount", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub total_count: Option<i64>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Item for widget date lists
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateItem {
#[serde(rename = "actionData")]
pub action_data: WidgetActionDataAppointment,
pub actions: Vec<serde_json::Value>,
pub details: WidgetDateItemDetails,
#[serde(rename = "filterKeys", default, skip_serializing_if = "serde_json::Value::is_null")]
pub filter_keys: serde_json::Value,
pub infos: Vec<WidgetDateItemInfosItem>,
#[serde(rename = "summaryText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub summary_text: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateItemDetails {
#[serde(rename = "allDay")]
pub all_day: bool,
/// A timestamp in Zulu time format, e.g. '2022-10-19T12:00:00Z'
#[serde(rename = "dateTime", serialize_with = "crate::datetime::serialize_utc")]
pub date_time: chrono::DateTime<chrono::Utc>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateItemInfosItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDateWidgetSettings {
/// Value for Tailwind color
#[serde(rename = "backgroundColor", default, skip_serializing_if = "Option::is_none")]
pub background_color: Option<Color>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetail {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetDateWidgetSettings,
pub items: Vec<WidgetDetailItem>,
/// Allowed values: `detail`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Item for widget detail lists
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailItem {
#[serde(rename = "actionData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub action_data: serde_json::Value,
pub actions: Vec<serde_json::Value>,
pub rows: Vec<serde_json::Value>,
#[serde(rename = "summaryText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub summary_text: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub title: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Entry row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailItemRowEntry {
/// Value for Tailwind color
pub color: Color,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Allowed values: `entry`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Domain objects row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowDomainObjects {
#[serde(rename = "domainObjects")]
pub domain_objects: Vec<serde_json::Value>,
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Allowed values: `domainObjects`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Info line row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowInfoLine {
pub infos: Vec<String>,
/// Allowed values: `info-line`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Primary row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowPrimary {
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Allowed values: `primary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Properties row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowProperties {
pub properties: Vec<WidgetDetailRowPropertiesPropertiesItem>,
/// Allowed values: `properties`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowPropertiesPropertiesItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
pub property: Vec<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Status row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowStatus {
pub status: Vec<WidgetDetailRowStatusStatusItem>,
/// Allowed values: `status`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowStatusStatusItem {
/// Value for Tailwind color
pub color: Color,
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
pub infos: Vec<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub status: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Top line row type for widget detail items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDetailRowTopLine {
/// Value for Tailwind color
pub color: Color,
pub infos: Vec<String>,
/// Allowed values: `top-line`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDomainObject {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetDateWidgetSettings,
pub items: Vec<WidgetDomainObjectItem>,
/// Allowed values: `domainObject`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Item for widget domain object lists
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDomainObjectItem {
#[serde(rename = "actionData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub action_data: serde_json::Value,
pub actions: Vec<serde_json::Value>,
pub details: WidgetDomainObjectItemDetails,
#[serde(rename = "filterKeys", default, skip_serializing_if = "serde_json::Value::is_null")]
pub filter_keys: serde_json::Value,
pub infos: Vec<WidgetDomainObjectItemInfosItem>,
#[serde(rename = "summaryText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub summary_text: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDomainObjectItemDetails {
#[serde(rename = "domainObject", default, skip_serializing_if = "serde_json::Value::is_null")]
pub domain_object: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetDomainObjectItemInfosItem {
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Individual grouping option configuration
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetGroupingOption {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub count: Option<WidgetCount>,
#[serde(rename = "filterKeys")]
pub filter_keys: Vec<String>,
#[serde(rename = "infoList", default, skip_serializing_if = "Option::is_none")]
pub info_list: Option<WidgetInfoList>,
/// The title
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetHidden {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetDateWidgetSettings,
/// Allowed values: `hidden`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Information item for widget lists
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetInfoItem {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(rename = "iconBefore", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon_before: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub label: Option<String>,
#[serde(rename = "subItems")]
pub sub_items: Vec<WidgetInfoSubItem>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub text: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// List of information items for widgets
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetInfoList {
/// Direction for widget info lists
/// Allowed values: `horizontal`, `vertical`, `wrapped`.
#[serde(deserialize_with = "crate::lenient::string")]
pub direction: String,
#[serde(rename = "infoItems")]
pub info_items: Vec<WidgetInfoItem>,
/// Size options for widget info lists
/// Allowed values: `medium`, `small`.
#[serde(deserialize_with = "crate::lenient::string")]
pub size: String,
#[serde(rename = "withLabel")]
pub with_label: bool,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Sub-item for widget information items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetInfoSubItem {
/// A color in ChurchTools
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(deserialize_with = "crate::lenient::string")]
pub color: String,
#[serde(rename = "iconBefore", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon_before: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub text: Option<String>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionAppointmentDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.appointment.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataAppointment>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionBirthdayDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.birthday.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataPerson>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionBookingDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.my-bookings.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataBooking>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionEventAgenda {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.event.agenda`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataEvent>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionEventDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.event.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataEvent>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionEventfactDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.eventfact.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataEvent>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionExchangeRequests {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.exchangeRequests.accept`, `action.exchangeRequests.cancel`, `action.exchangeRequests.decline`, `action.exchangeRequests.request`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionGroupDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.group.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataGroup>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionMyResourcesDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.my-resources.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<WidgetActionDataResource>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionPostDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.post.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub action_data: serde_json::Value,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionServiceRequests {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.serviceRequests.absence`, `action.serviceRequests.accept`, `action.serviceRequests.comment`, `action.serviceRequests.decline`, `action.serviceRequests.exchange`, `action.serviceRequests.undo`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetItemActionSongsToLearnDetails {
/// Flavor of widget action
/// Allowed values: `accent`, `basic`, `constructive`, `destructive`, `magic`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub flavor: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
/// Allowed values: `action.songsToLearn.details`.
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub label: String,
#[serde(deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub props: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Type of widget action
/// Allowed values: `details`, `other`, `primary`, `secondary`.
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
#[serde(rename = "actionData", deserialize_with = "crate::lenient::opt_map", default, skip_serializing_if = "Option::is_none")]
pub action_data: Option<std::collections::BTreeMap<String, serde_json::Value>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetPost {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub actions: Option<Vec<serde_json::Value>>,
/// Strategy for handling empty widget content
/// Allowed values: `HIDE`, `SHOW`.
#[serde(rename = "emptyStrategy", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_strategy: Option<String>,
#[serde(rename = "emptyText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub empty_text: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub filter: Option<WidgetDateFilterVariant1>,
#[serde(rename = "helpLink", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub help_link: Option<String>,
#[serde(rename = "isMandatory", default, skip_serializing_if = "Option::is_none")]
pub is_mandatory: Option<bool>,
#[serde(deserialize_with = "crate::lenient::string")]
pub key: String,
/// Allowed values: `horizontal`, `vertical`.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub orientation: Option<String>,
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub replacement: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "widgetSettings")]
pub widget_settings: WidgetDateWidgetSettings,
pub items: Vec<WidgetPostItem>,
/// Allowed values: `post`.
#[serde(rename = "widgetType", deserialize_with = "crate::lenient::string")]
pub widget_type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Item for widget post lists
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetPostItem {
#[serde(rename = "actionData", default, skip_serializing_if = "serde_json::Value::is_null")]
pub action_data: serde_json::Value,
pub actions: Vec<serde_json::Value>,
pub details: WidgetPostItemDetails,
#[serde(rename = "filterKeys", default, skip_serializing_if = "serde_json::Value::is_null")]
pub filter_keys: serde_json::Value,
pub infos: Vec<WidgetDomainObjectItemInfosItem>,
#[serde(rename = "summaryText", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub summary_text: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetPostItemDetails {
pub post: Post,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Settings specific to common widgets
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetSettingsCommon {
/// Density options for common widgets
/// Allowed values: `compact`, `default`, `divided`.
#[serde(deserialize_with = "crate::lenient::string")]
pub density: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Top line text for widget items
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WidgetTopLine {
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// A category organizes wiki pages and is the unit of wiki access permissions.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiCategory {
/// Campus association, or null when no campus is assigned.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::opt_number", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<i64>,
/// Whether files in this wiki category can be read without category-view permission. This flag does not make the wiki pages themselves public.
#[serde(rename = "fileAccessWithoutPermission")]
pub file_access_without_permission: bool,
/// Whether the category should appear in navigation menus; it is still returned by the category catalog when false.
#[serde(rename = "inMenu")]
pub in_menu: bool,
/// Category name; unlike page titles it is not trimmed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order; negative values are accepted.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Wiki category ID used in category/page endpoint URLs.
#[serde(deserialize_with = "crate::lenient::number")]
pub id: i64,
/// Display name translated for the current request language.
#[serde(rename = "nameTranslated", deserialize_with = "crate::lenient::string")]
pub name_translated: String,
/// Page-operation hints based on category edit rights. Populated by the category list; normally empty in create/update and embedded page categories.
pub permissions: GroupWikiCategoryPagesItemCategoryPermissions,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiCategoryCreate {
/// Optional campus association. Omission/null clears it; an unknown ID currently also resolves to no campus.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Whether files in this wiki category can be read without category-view permission. This flag does not make the wiki pages themselves public.
#[serde(rename = "fileAccessWithoutPermission")]
pub file_access_without_permission: bool,
/// Whether the category should appear in navigation menus; it is still returned by the category catalog when false.
#[serde(rename = "inMenu")]
pub in_menu: bool,
/// Category name; unlike page titles it is not trimmed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order; negative values are accepted.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Replacement category settings. The optional campus association is cleared on omission.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiCategoryUpdate {
/// Optional campus association. Omission/null clears it; an unknown ID currently also resolves to no campus.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(rename = "campusId", deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub campus_id: Option<Option<i64>>,
/// Whether files in this wiki category can be read without category-view permission. This flag does not make the wiki pages themselves public.
#[serde(rename = "fileAccessWithoutPermission")]
pub file_access_without_permission: bool,
/// Whether the category should appear in navigation menus; it is still returned by the category catalog when false.
#[serde(rename = "inMenu")]
pub in_menu: bool,
/// Category name; unlike page titles it is not trimmed.
#[serde(deserialize_with = "crate::lenient::string")]
pub name: String,
/// Sort order; negative values are accepted.
#[serde(rename = "sortKey", deserialize_with = "crate::lenient::number")]
pub sort_key: i64,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Wiki page metadata for one version. Text and previews are optional enrichments depending on the endpoint. A page is addressed by category ID and stable GUID; version identifies its revision.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiPage {
/// Compatibility marker used by existing clients.
#[serde(rename = "@deprecated")]
pub deprecated: SimpleWikiPageDeprecated,
/// Stable page GUID across versions in its category.
#[serde(deserialize_with = "crate::lenient::string")]
pub guid: String,
/// Deprecated alias for `guid`. Use `guid` instead.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
#[deprecated = "Use `guid` instead."]
pub identifier: Option<String>,
/// Whether page text is Markdown rather than legacy HTML.
#[serde(rename = "isMarkdown")]
pub is_markdown: bool,
pub meta: MetaDataEntityPerson,
/// Whether the page is configured to appear on the wiki start page.
#[serde(rename = "onStartpage")]
pub on_startpage: bool,
/// Page editing/deletion capabilities for the current user; system pages have additional restrictions.
pub permissions: SimpleWikiPagePermissions,
/// Stored redirect title. API reads return the page and this value; they do not follow the redirect.
#[serde(rename = "redirectTo", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub redirect_to: Option<String>,
/// Query-focused preview snippet. Present when the page list endpoint is called with a search query.
#[serde(rename = "searchPreview", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub search_preview: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub text: String,
/// Unrendered prefix of stored page text, truncated by Unicode characters. May contain raw HTML or incomplete markup. Present only with include\[\]=preview; not sanitized like text.
#[serde(rename = "textPreview", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub text_preview: Option<String>,
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Revision number of this page.
#[serde(deserialize_with = "crate::lenient::number")]
pub version: i64,
/// A category organizes wiki pages and is the unit of wiki access permissions.
#[serde(rename = "wikiCategory")]
pub wiki_category: WikiCategory,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiPageCreate {
/// Whether text is Markdown. False selects legacy HTML, sanitized on normal text reads.
#[serde(rename = "isMarkdown", default, skip_serializing_if = "Option::is_none")]
pub is_markdown: Option<bool>,
/// Whether this page is marked for display on the wiki start page.
#[serde(rename = "onStartpage", default, skip_serializing_if = "Option::is_none")]
pub on_startpage: Option<bool>,
/// Trimmed Markdown or legacy HTML according to isMarkdown. Omitted, null or blank content is stored as null and read back as an empty string.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub text: Option<Option<String>>,
/// Trimmed unique page title; Unicode ellipsis is normalized to three periods.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Partial page update; an empty object is accepted. The page title, GUID and category are not editable here.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiPageUpdate {
#[serde(rename = "isMarkdown", default, skip_serializing_if = "Option::is_none")]
pub is_markdown: Option<bool>,
#[serde(rename = "onStartpage", default, skip_serializing_if = "Option::is_none")]
pub on_startpage: Option<bool>,
/// Trimmed replacement content. A different stored value creates a new version; null or blank clears the text. Omission leaves it unchanged.
///
/// `None` leaves the field out, `Some(None)` sends `null`.
#[serde(deserialize_with = "crate::lenient::double_option", default, skip_serializing_if = "Option::is_none")]
pub text: Option<Option<String>>,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}
/// Compact, domain-independent representation for displaying a link to a ChurchTools object. It is not the full resource returned by the object’s own API.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WikiSearchResult {
/// URL for the full API resource, if available. Some legacy domain implementations produce inconsistent URLs.
#[serde(rename = "apiUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub api_url: Option<String>,
/// Optional display color.
/// Allowed values: `accent`, `amber`, `basic`, `blue`, `constructive`, `critical`, `cyan`, `destructive`, `emerald`, `error`, `fuchsia`, `gray`, `green`, `indigo`, `info`, `lime`, `magic`, `orange`, `pink`, `purple`, `red`, `rose`, `sky`, `success`, `teal`, `violet`, `warning`, `yellow`.
#[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
pub color: serde_json::Value,
/// Opaque identifier within the domain; do not assume that every domain uses a numeric ID.
#[serde(rename = "domainIdentifier", deserialize_with = "crate::lenient::string")]
pub domain_identifier: String,
/// Optional image URL.
#[serde(rename = "imageUrl", deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub image_url: Option<String>,
/// Additional localized display lines; not structured resource fields.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub infos: Option<Vec<String>>,
/// Optional initials for an avatar fallback.
#[serde(deserialize_with = "crate::lenient::opt_string", default, skip_serializing_if = "Option::is_none")]
pub initials: Option<String>,
/// Display title of the referenced object.
#[serde(deserialize_with = "crate::lenient::string")]
pub title: String,
#[serde(rename = "domainAttributes")]
pub domain_attributes: DomainObjectWikiPageDomainAttributes,
/// Allowed values: `wiki_page`.
#[serde(rename = "domainType", deserialize_with = "crate::lenient::string")]
pub domain_type: String,
#[serde(rename = "frontendUrl", deserialize_with = "crate::lenient::string")]
pub frontend_url: String,
/// Allowed values: `file`.
#[serde(deserialize_with = "crate::lenient::string")]
pub icon: String,
/// Search excerpt, possibly empty, with Markdown emphasis for matching text.
#[serde(deserialize_with = "crate::lenient::string")]
pub preview: String,
#[serde(deserialize_with = "crate::lenient::string")]
pub r#type: String,
/// Fields not described by the spec, e.g. instance-specific DB fields.
#[serde(flatten)]
pub extra: serde_json::Map<String, serde_json::Value>,
}