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.

//! Search 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 `Search`.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct SearchParams {
    /// Recording types to include. Use `key` values from the metadata
    /// endpoint's `recording_search_types`. Available since Basecamp 5.
    pub type_names: Option<Vec<String>>,
    /// Project IDs to filter by. Available since Basecamp 5.
    pub bucket_ids: Option<Vec<i64>>,
    /// Creator person IDs to filter by. Available since Basecamp 5.
    pub creator_ids: Option<Vec<i64>>,
    /// Filter attachments by type. Use `key` values from the metadata
    /// endpoint's `file_search_types`.
    pub file_type: Option<String>,
    /// Set to true to exclude chat results.
    pub exclude_chat: Option<bool>,
    /// last_7_days|last_30_days|last_90_days|last_12_months|forever
    pub since: Option<String>,
    /// best_match|recency
    pub sort: Option<String>,
    /// Deprecated: prefer type_names\[\].
    #[deprecated(note = "prefer type_names[].")]
    pub r#type: Option<String>,
    /// Deprecated: prefer bucket_ids\[\].
    #[deprecated(note = "prefer bucket_ids[].")]
    pub bucket_id: Option<i64>,
    /// Deprecated: prefer creator_ids\[\].
    #[deprecated(note = "prefer creator_ids[].")]
    pub creator_id: Option<i64>,
    /// 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>,
}

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

impl<'a> SearchService<'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
    }

    /// Get search metadata (available filter options)
    ///
    /// `GET /searches/metadata.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
    pub async fn metadata(&self) -> Result<GetSearchMetadataResponseContent, Error> {
        let operation = self.client.operation(&routes::GET_SEARCH_METADATA, &[]);
        self.client.send(operation).await
    }

    /// Search for content across the account
    ///
    /// `GET /search.json` — idempotent; retries up to 3 attempt(s) on 429, 503.
    #[allow(deprecated)]
    pub async fn search(
        &self,
        q: &str,
        params: &SearchParams,
    ) -> Result<Page<SearchResponseContent>, Error> {
        let mut operation = self.client.operation(&routes::SEARCH, &[]);
        operation.query("q", q);
        operation.query_list_optional("type_names[]", params.type_names.as_deref());
        operation.query_list_optional("bucket_ids[]", params.bucket_ids.as_deref());
        operation.query_list_optional("creator_ids[]", params.creator_ids.as_deref());
        operation.query_optional("file_type", params.file_type.as_ref());
        operation.query_optional("exclude_chat", params.exclude_chat.as_ref());
        operation.query_optional("since", params.since.as_ref());
        operation.query_optional("sort", params.sort.as_ref());
        operation.query_optional("type", params.r#type.as_ref());
        operation.query_optional("bucket_id", params.bucket_id.as_ref());
        operation.query_optional("creator_id", params.creator_id.as_ref());
        operation.query_optional("page", params.page.as_ref());
        self.client.send_page(operation).await
    }
}