basecamp-sdk 0.38.0

Official client for Basecamp - https://basecamp.com
Documentation
// Generated by basecamp-sdk-generator from openapi.json and behavior-model.json. DO NOT EDIT.

//! Messages operations.

#![allow(
    clippy::too_many_arguments,
    clippy::wildcard_imports,
    clippy::doc_markdown
)]

use crate::client::AccountClient;
use crate::error::Error;
use crate::generated::routes;
#[allow(unused_imports)]
use crate::generated::types::*;
use crate::pagination::Page;

/// Optional query parameters for `ListMessages`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct ListMessagesParams {
    /// created_at|updated_at
    pub sort: Option<String>,
    /// asc|desc
    pub direction: Option<String>,
    /// Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.
    pub page: Option<i32>,
}

/// `Messages` operations, sent through one [`AccountClient`].
#[derive(Debug, Clone, Copy)]
pub struct MessagesService<'a> {
    client: &'a AccountClient,
}

impl<'a> MessagesService<'a> {
    pub(crate) fn new(client: &'a AccountClient) -> Self {
        Self { client }
    }

    /// The client this service sends through.
    pub fn client(&self) -> &'a AccountClient {
        self.client
    }

    /// Create a new message on a message board
    ///
    /// `POST /message_boards/{boardId}/messages.json` — not idempotent, sent exactly once.
    pub async fn create(
        &self,
        board_id: i64,
        body: &CreateMessageRequestContent,
    ) -> Result<CreateMessageResponseContent, Error> {
        let mut operation = self.client.operation(&routes::CREATE_MESSAGE, &[&board_id]);
        operation.json(body)?;
        self.client.send(operation).await
    }

    /// Get a single message by id
    ///
    /// `GET /messages/{messageId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
    pub async fn get(&self, message_id: i64) -> Result<GetMessageResponseContent, Error> {
        let operation = self.client.operation(&routes::GET_MESSAGE, &[&message_id]);
        self.client.send(operation).await
    }

    /// List messages on a message board
    ///
    /// **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL
    /// to fetch additional pages. X-Total-Count header provides total count.
    ///
    /// `GET /message_boards/{boardId}/messages.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
    pub async fn list(
        &self,
        board_id: i64,
        params: &ListMessagesParams,
    ) -> Result<Page<ListMessagesResponseContent>, Error> {
        let mut operation = self.client.operation(&routes::LIST_MESSAGES, &[&board_id]);
        operation.query_optional("sort", params.sort.as_ref());
        operation.query_optional("direction", params.direction.as_ref());
        operation.query_optional("page", params.page.as_ref());
        self.client.send_page(operation).await
    }

    /// Pin a message to the top of the message board
    ///
    /// `POST /recordings/{messageId}/pin.json` — not idempotent, sent exactly once.
    pub async fn pin(&self, message_id: i64) -> Result<(), Error> {
        let operation = self.client.operation(&routes::PIN_MESSAGE, &[&message_id]);
        self.client.send_unit(operation).await
    }

    /// Unpin a message from the message board
    ///
    /// `DELETE /recordings/{messageId}/pin.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
    pub async fn unpin(&self, message_id: i64) -> Result<(), Error> {
        let operation = self
            .client
            .operation(&routes::UNPIN_MESSAGE, &[&message_id]);
        self.client.send_unit(operation).await
    }

    /// Update an existing message
    ///
    /// `PUT /messages/{messageId}` — idempotent; retries up to 3 attempt(s) on 429, 503.
    pub async fn update(
        &self,
        message_id: i64,
        body: &UpdateMessageRequestContent,
    ) -> Result<UpdateMessageResponseContent, Error> {
        let mut operation = self
            .client
            .operation(&routes::UPDATE_MESSAGE, &[&message_id]);
        operation.json(body)?;
        self.client.send(operation).await
    }
}