// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: tools.ozone.queue.updateQueue
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{CowStr, BosStr, DefaultStr, FromStaticStr};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::tools_ozone::queue::QueueView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct UpdateQueue<S: BosStr = DefaultStr> {
    ///Optional description of the queue
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<S>,
    ///Enable or disable the queue
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    ///New display name for the queue
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<S>,
    ///ID of the queue to update
    pub queue_id: i64,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct UpdateQueueOutput<S: BosStr = DefaultStr> {
    pub queue: QueueView<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `tools.ozone.queue.updateQueue` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `UpdateQueueOutput<S>` for this endpoint.*/
pub struct UpdateQueueResponse;
impl jacquard_common::xrpc::XrpcResp for UpdateQueueResponse {
    const NSID: &'static str = "tools.ozone.queue.updateQueue";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = UpdateQueueOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for UpdateQueue<S> {
    const NSID: &'static str = "tools.ozone.queue.updateQueue";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = UpdateQueueResponse;
}

/** Endpoint marker for the `tools.ozone.queue.updateQueue` procedure.

Path: `/xrpc/tools.ozone.queue.updateQueue`. The request payload type is `UpdateQueue<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct UpdateQueueRequest;
impl jacquard_common::xrpc::XrpcEndpoint for UpdateQueueRequest {
    const PATH: &'static str = "/xrpc/tools.ozone.queue.updateQueue";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = UpdateQueue<S>;
    type Response = UpdateQueueResponse;
}

pub mod update_queue_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type QueueId;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type QueueId = Unset;
    }
    ///State transition - sets the `queue_id` field to Set
    pub struct SetQueueId<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetQueueId<St> {}
    impl<St: State> State for SetQueueId<St> {
        type QueueId = Set<members::queue_id>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `queue_id` field
        pub struct queue_id(());
    }
}

/// Builder for constructing an instance of this type.
pub struct UpdateQueueBuilder<St: update_queue_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<bool>, Option<S>, Option<i64>),
    _type: PhantomData<fn() -> S>,
}

impl UpdateQueue<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> UpdateQueueBuilder<update_queue_state::Empty, DefaultStr> {
        UpdateQueueBuilder::new()
    }
}

impl<S: BosStr> UpdateQueue<S> {
    /// Create a new builder for this type
    pub fn builder() -> UpdateQueueBuilder<update_queue_state::Empty, S> {
        UpdateQueueBuilder::builder()
    }
}

impl UpdateQueueBuilder<update_queue_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        UpdateQueueBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr> UpdateQueueBuilder<update_queue_state::Empty, S> {
    /// Create a new builder with all fields unset
    pub fn builder() -> Self {
        UpdateQueueBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<St: update_queue_state::State, S: BosStr> UpdateQueueBuilder<St, S> {
    /// Set the `description` field (optional)
    pub fn description(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `description` field to an Option value (optional)
    pub fn maybe_description(mut self, value: Option<S>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<St: update_queue_state::State, S: BosStr> UpdateQueueBuilder<St, S> {
    /// Set the `enabled` field (optional)
    pub fn enabled(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `enabled` field to an Option value (optional)
    pub fn maybe_enabled(mut self, value: Option<bool>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<St: update_queue_state::State, S: BosStr> UpdateQueueBuilder<St, S> {
    /// Set the `name` field (optional)
    pub fn name(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `name` field to an Option value (optional)
    pub fn maybe_name(mut self, value: Option<S>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<St, S: BosStr> UpdateQueueBuilder<St, S>
where
    St: update_queue_state::State,
    St::QueueId: update_queue_state::IsUnset,
{
    /// Set the `queueId` field (required)
    pub fn queue_id(
        mut self,
        value: impl Into<i64>,
    ) -> UpdateQueueBuilder<update_queue_state::SetQueueId<St>, S> {
        self._fields.3 = Option::Some(value.into());
        UpdateQueueBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> UpdateQueueBuilder<St, S>
where
    St: update_queue_state::State,
    St::QueueId: update_queue_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> UpdateQueue<S> {
        UpdateQueue {
            description: self._fields.0,
            enabled: self._fields.1,
            name: self._fields.2,
            queue_id: self._fields.3.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> UpdateQueue<S> {
        UpdateQueue {
            description: self._fields.0,
            enabled: self._fields.1,
            name: self._fields.2,
            queue_id: self._fields.3.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}