use reqwest::Method;
use serde::{Deserialize, Serialize};
use crate::{
core::{
api_req::ApiRequest,
api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
constants::AccessTokenType,
endpoints::cloud_docs::*,
http::Transport,
req_option::RequestOption,
SDKResult,
},
service::sheets::v3::SpreadsheetService,
};
use super::create::ProtectRangeData;
impl SpreadsheetService {
pub async fn get_protect_ranges(
&self,
request: GetProtectRangesRequest,
option: Option<RequestOption>,
) -> SDKResult<BaseResponse<GetProtectRangesResponseData>> {
let mut api_req = request.api_request;
api_req.http_method = Method::GET;
api_req.api_path =
SHEETS_V3_SPREADSHEET_PROTECT_RANGE.replace("{}", &request.spreadsheet_token);
api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
if let Some(sheet_id) = &request.sheet_id {
api_req.query_params.insert("sheet_id", sheet_id.clone());
}
let api_resp = Transport::request(api_req, &self.config, option).await?;
Ok(api_resp)
}
}
#[derive(Default, Debug, Serialize, Deserialize)]
pub struct GetProtectRangesRequest {
#[serde(skip)]
api_request: ApiRequest,
spreadsheet_token: String,
#[serde(skip_serializing_if = "Option::is_none")]
sheet_id: Option<String>,
}
impl GetProtectRangesRequest {
pub fn builder() -> GetProtectRangesRequestBuilder {
GetProtectRangesRequestBuilder::default()
}
}
#[derive(Default)]
pub struct GetProtectRangesRequestBuilder {
request: GetProtectRangesRequest,
}
impl GetProtectRangesRequestBuilder {
pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
self.request.spreadsheet_token = spreadsheet_token.to_string();
self
}
pub fn sheet_id(mut self, sheet_id: impl ToString) -> Self {
self.request.sheet_id = Some(sheet_id.to_string());
self
}
pub fn build(mut self) -> GetProtectRangesRequest {
self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
self.request
}
}
#[derive(Deserialize, Debug)]
pub struct ProtectRangeInfo {
pub protect_id: String,
#[serde(flatten)]
pub protect_range: ProtectRangeData,
}
#[derive(Deserialize, Debug)]
pub struct GetProtectRangesResponseData {
pub items: Vec<ProtectRangeInfo>,
#[serde(default)]
pub has_more: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub page_token: Option<String>,
}
impl ApiResponseTrait for GetProtectRangesResponseData {
fn data_format() -> ResponseFormat {
ResponseFormat::Data
}
}
#[cfg(test)]
#[allow(unused_variables, unused_unsafe)]
mod test {
use super::*;
use serde_json::json;
#[test]
fn test_get_protect_ranges_response() {
let json = json!({
"items": [
{
"protect_id": "protect_001",
"dimension": "ROWS",
"sheet_id": "Sheet1",
"start_index": 1,
"end_index": 10,
"lock_info": "user1@example.com"
},
{
"protect_id": "protect_002",
"dimension": "COLUMNS",
"sheet_id": "Sheet1",
"start_index": 1,
"end_index": 5,
"lock_info": "user2@example.com"
}
],
"has_more": false
});
let response: GetProtectRangesResponseData = serde_json::from_value(json).unwrap();
assert_eq!(response.items.len(), 2);
assert_eq!(response.items[0].protect_id, "protect_001");
assert_eq!(response.items[1].protect_range.dimension, "COLUMNS");
assert!(!response.has_more);
}
}