nominal-api 0.1240.0

use conjure_http::endpoint;
/// The attachment service provides functionality for creating, updating, and archiving attachments uploaded to S3.
#[conjure_http::conjure_client(name = "AttachmentService")]
pub trait AttachmentService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Create a new attachment. Assumes the file is already uploaded to S3 through the upload service.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::CreateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get an attachment by its RID.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get a set of attachments by their RIDs.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments/batch",
        name = "getBatch",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_batch(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::GetAttachmentsRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::GetAttachmentsResponse,
        conjure_http::private::Error,
    >;
    /// Get the binary content of an attachment.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/content",
        name = "getContent",
        accept = conjure_http::client::conjure::BinaryResponseDeserializer
    )]
    fn get_content(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<I, conjure_http::private::Error>;
    /// Get a pre-signed URI to download an attachment. The link expires in 1 minute.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/uri",
        name = "getUri",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_uri(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::AttachmentUri,
        conjure_http::private::Error,
    >;
    /// Update an attachment. Only the fields that are set in the request will be updated.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}",
        name = "update",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::UpdateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Archive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// The attachment service provides functionality for creating, updating, and archiving attachments uploaded to S3.
#[conjure_http::conjure_client(name = "AttachmentService")]
pub trait AsyncAttachmentService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Create a new attachment. Assumes the file is already uploaded to S3 through the upload service.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::CreateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get an attachment by its RID.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get a set of attachments by their RIDs.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments/batch",
        name = "getBatch",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_batch(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::GetAttachmentsRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::GetAttachmentsResponse,
        conjure_http::private::Error,
    >;
    /// Get the binary content of an attachment.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/content",
        name = "getContent",
        accept = conjure_http::client::conjure::BinaryResponseDeserializer
    )]
    async fn get_content(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<I, conjure_http::private::Error>;
    /// Get a pre-signed URI to download an attachment. The link expires in 1 minute.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/uri",
        name = "getUri",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_uri(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::AttachmentUri,
        conjure_http::private::Error,
    >;
    /// Update an attachment. Only the fields that are set in the request will be updated.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}",
        name = "update",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::UpdateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Archive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// The attachment service provides functionality for creating, updating, and archiving attachments uploaded to S3.
#[conjure_http::conjure_client(name = "AttachmentService", local)]
pub trait LocalAsyncAttachmentService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Create a new attachment. Assumes the file is already uploaded to S3 through the upload service.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::CreateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get an attachment by its RID.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Get a set of attachments by their RIDs.
    #[endpoint(
        method = POST,
        path = "/attachments/v1/attachments/batch",
        name = "getBatch",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_batch(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::GetAttachmentsRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::GetAttachmentsResponse,
        conjure_http::private::Error,
    >;
    /// Get the binary content of an attachment.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/content",
        name = "getContent",
        accept = conjure_http::client::conjure::BinaryResponseDeserializer
    )]
    async fn get_content(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<I, conjure_http::private::Error>;
    /// Get a pre-signed URI to download an attachment. The link expires in 1 minute.
    #[endpoint(
        method = GET,
        path = "/attachments/v1/attachments/{rid}/uri",
        name = "getUri",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_uri(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<
        super::super::super::super::objects::attachments::api::AttachmentUri,
        conjure_http::private::Error,
    >;
    /// Update an attachment. Only the fields that are set in the request will be updated.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}",
        name = "update",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::attachments::api::UpdateAttachmentRequest,
    ) -> Result<
        super::super::super::super::objects::attachments::api::Attachment,
        conjure_http::private::Error,
    >;
    /// Archive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchive an attachment.
    #[endpoint(
        method = PUT,
        path = "/attachments/v1/attachments/{rid}/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::rids::AttachmentRid,
    ) -> Result<(), conjure_http::private::Error>;
}