smbcloud-ascapi-aso 0.3.0

//! An `AppScreenshotSet` groups the screenshots for one device/display
//! class (e.g. Apple Vision Pro, iPhone 6.7") within one localization of an
//! `AppStoreVersion`. Screenshots themselves are a separate resource
//! ([`crate::app_screenshot`]) that belongs to a set.

use async_trait::async_trait;
use reqwest::Method;
use serde::{Deserialize, Serialize};
use smbcloud_ascapi_core::jsonapi::{
    CreateBody, CreateData, Document, Resource, ResourceId, ToOne,
};
use smbcloud_ascapi_core::Client;
use smbcloud_ascapi_core::Result;

pub const RESOURCE_TYPE: &str = "appScreenshotSets";

/// The device/display class a screenshot set targets. Apple documents the
/// full set at
/// <https://developer.apple.com/documentation/appstoreconnectapi/screenshotdisplaytype>;
/// this covers the App Store (non-iMessage) display classes in current use.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ScreenshotDisplayType {
    #[serde(rename = "APP_APPLE_VISION_PRO")]
    AppleVisionPro,
    #[serde(rename = "APP_IPHONE_67")]
    Iphone67,
    #[serde(rename = "APP_IPHONE_65")]
    Iphone65,
    #[serde(rename = "APP_IPHONE_61")]
    Iphone61,
    #[serde(rename = "APP_IPHONE_58")]
    Iphone58,
    #[serde(rename = "APP_IPHONE_55")]
    Iphone55,
    #[serde(rename = "APP_IPHONE_47")]
    Iphone47,
    #[serde(rename = "APP_IPHONE_40")]
    Iphone40,
    #[serde(rename = "APP_IPHONE_35")]
    Iphone35,
    #[serde(rename = "APP_IPAD_PRO_3GEN_129")]
    IpadPro3Gen129,
    #[serde(rename = "APP_IPAD_PRO_3GEN_11")]
    IpadPro3Gen11,
    #[serde(rename = "APP_IPAD_PRO_129")]
    IpadPro129,
    #[serde(rename = "APP_IPAD_105")]
    Ipad105,
    #[serde(rename = "APP_IPAD_97")]
    Ipad97,
    #[serde(rename = "APP_DESKTOP")]
    Desktop,
    #[serde(rename = "APP_APPLE_TV")]
    AppleTv,
    #[serde(rename = "APP_WATCH_ULTRA")]
    WatchUltra,
    #[serde(rename = "APP_WATCH_SERIES_10")]
    WatchSeries10,
    #[serde(rename = "APP_WATCH_SERIES_7")]
    WatchSeries7,
    #[serde(rename = "APP_WATCH_SERIES_4")]
    WatchSeries4,
    #[serde(rename = "APP_WATCH_SERIES_3")]
    WatchSeries3,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AppScreenshotSetAttributes {
    pub screenshot_display_type: ScreenshotDisplayType,
}

pub type AppScreenshotSet = Resource<AppScreenshotSetAttributes>;

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppScreenshotSetCreateAttributes {
    pub screenshot_display_type: ScreenshotDisplayType,
}

#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AppScreenshotSetRelationships {
    pub app_store_version_localization: ToOne,
}

/// Per-device-class screenshot buckets.
///
/// An extension trait rather than inherent methods, because `Client`
/// lives in the core crate and Rust only allows inherent impls in the
/// crate that defines the type. Import it, or the crate's `prelude`,
/// to call these on a `Client`.
#[async_trait]
pub trait AppScreenshotSetsApi {
    /// `GET /v1/appStoreVersionLocalizations/{id}/appScreenshotSets`.
    async fn list_app_screenshot_sets(
        &self,
        app_store_version_localization_id: &str,
    ) -> Result<Vec<AppScreenshotSet>>;

    /// `POST /v1/appScreenshotSets` — adds a device/display class's
    /// screenshot bucket to a localization. Screenshots are then added to
    /// the returned set with [`AppScreenshotsApi::create_app_screenshot`](crate::app_screenshot::AppScreenshotsApi::create_app_screenshot) /
    /// [`AppScreenshotsApi::upload_app_screenshot`](crate::app_screenshot::AppScreenshotsApi::upload_app_screenshot).
    async fn create_app_screenshot_set(
        &self,
        app_store_version_localization_id: &str,
        attributes: AppScreenshotSetCreateAttributes,
    ) -> Result<AppScreenshotSet>;

    /// `DELETE /v1/appScreenshotSets/{id}`.
    async fn delete_app_screenshot_set(&self, id: &str) -> Result<()>;
}

#[async_trait]
impl AppScreenshotSetsApi for Client {
    async fn list_app_screenshot_sets(
        &self,
        app_store_version_localization_id: &str,
    ) -> Result<Vec<AppScreenshotSet>> {
        let path = format!(
            "/v1/appStoreVersionLocalizations/{app_store_version_localization_id}/appScreenshotSets"
        );
        self.list_all::<AppScreenshotSetAttributes>(&path, &[])
            .await
    }

    async fn create_app_screenshot_set(
        &self,
        app_store_version_localization_id: &str,
        attributes: AppScreenshotSetCreateAttributes,
    ) -> Result<AppScreenshotSet> {
        let body = CreateBody {
            data: CreateData {
                resource_type: RESOURCE_TYPE,
                attributes,
                relationships: Some(AppScreenshotSetRelationships {
                    app_store_version_localization: ToOne {
                        data: ResourceId {
                            resource_type: crate::app_store_version_localization::RESOURCE_TYPE,
                            id: app_store_version_localization_id.to_string(),
                        },
                    },
                }),
            },
        };
        let doc: Document<AppScreenshotSetAttributes> = self
            .request(Method::POST, "/v1/appScreenshotSets", &[], Some(&body))
            .await?;
        Ok(doc.data)
    }

    async fn delete_app_screenshot_set(&self, id: &str) -> Result<()> {
        let path = format!("/v1/appScreenshotSets/{id}");
        self.request_no_content::<()>(Method::DELETE, &path, &[], None)
            .await
    }
}