Add WP.com Subscribers Endpoints (#735)

* Add Subscribers Endpoints

* Use strum instead of manually deriving display

* Use `UserId` for Subscriber

* Spacing improvement

* subscriptions -> subscribers

* Rename list params

* Clarify GetSubscriberQuery variants

* SubscriberImportJobStatus improvements

* Use parameterized testing for wp_utc_date_time

* Swift fix

Author: jkmassel

native/swift/Sources/wordpress-api/Exports.swift

@@ -135,4 +135,11 @@ public typealias WpSiteHealthTestsRequestExecutor = WordPressAPIInternal.WpSiteH
 public typealias WordPressOrgApiClient = WordPressAPIInternal.WordPressOrgApiClient
 
 // MARK: - WordPress.com
+
+// MARK: OAuth2
 public typealias TokenValidationParameters = WordPressAPIInternal.TokenValidationParameters
+
+// MARK: Subscribers
+public typealias SubscribersListParams = WordPressAPIInternal.SubscribersListParams
+public typealias SubscriberImportJobsListParams = WordPressAPIInternal.SubscriberImportJobsListParams
+public typealias AddSubscribersParams = WordPressAPIInternal.AddSubscribersParams

native/swift/Sources/wordpress-api/WPComApiClient.swift

@@ -17,4 +17,8 @@ public class WPComApiClient {
     public var jetpackConnection: JetpackConnectionRequestExecutor {
         internalClient.jetpackConnection()
     }
+
+    public var subscribers: SubscribersRequestExecutor {
+        internalClient.subscribers()
+    }
 }

wp_api/src/api_error.rs

@@ -154,6 +154,10 @@ impl WpError {
     pub fn try_parse(response_body: &[u8]) -> Option<Self> {
         serde_json::from_slice::<WpError>(response_body).ok()
     }
+
+    pub fn try_parse_from_file(file: std::fs::File) -> Option<Self> {
+        serde_json::from_reader(file).ok()
+    }
 }
 
 #[derive(Debug, Clone, Deserialize, PartialEq, Eq, uniffi::Error)]

wp_api/src/wp_com/client.rs

@@ -2,6 +2,7 @@ use super::endpoint::jetpack_connection_endpoint::{
     JetpackConnectionRequestBuilder, JetpackConnectionRequestExecutor,
 };
 use super::endpoint::oauth2::{Oauth2RequestBuilder, Oauth2RequestExecutor};
+use super::endpoint::subscribers::{SubscribersRequestBuilder, SubscribersRequestExecutor};
 use crate::api_client_generate_request_builder;
 use crate::{
     ParsedUrl, WpApiClientDelegate, api_client_generate_api_client,
@@ -27,6 +28,7 @@ impl UniffiWpComApiRequestBuilder {
 pub struct WpComApiRequestBuilder {
     jetpack_connection: Arc<JetpackConnectionRequestBuilder>,
     oauth2: Arc<Oauth2RequestBuilder>,
+    subscribers: Arc<SubscribersRequestBuilder>,
 }
 
 impl WpComApiRequestBuilder {
@@ -35,7 +37,8 @@ impl WpComApiRequestBuilder {
             api_root_url,
             auth_provider;
             jetpack_connection,
-            oauth2
+            oauth2,
+            subscribers
         )
     }
 }
@@ -58,6 +61,7 @@ impl UniffiWpComApiClient {
 pub struct WpComApiClient {
     jetpack_connection: Arc<JetpackConnectionRequestExecutor>,
     oauth2: Arc<Oauth2RequestExecutor>,
+    subscribers: Arc<SubscribersRequestExecutor>,
 }
 
 impl WpComApiClient {
@@ -69,9 +73,11 @@ impl WpComApiClient {
             api_root_url,
             delegate;
             jetpack_connection,
-            oauth2
+            oauth2,
+            subscribers
         )
     }
 }
 api_client_generate_endpoint_impl!(WpComApi, jetpack_connection);
 api_client_generate_endpoint_impl!(WpComApi, oauth2);
+api_client_generate_endpoint_impl!(WpComApi, subscribers);

wp_api/src/wp_com/endpoint.rs

@@ -1,2 +1,3 @@
 pub mod jetpack_connection_endpoint;
 pub mod oauth2;
+pub mod subscribers;

wp_api/src/wp_com/endpoint/subscribers.rs

@@ -0,0 +1,34 @@
+use crate::{
+    request::endpoint::{AsNamespace, DerivedRequest},
+    wp_com::{
+        WpComNamespace, WpComSiteId,
+        subscribers::{
+            AddSubscribersParams, AddSubscribersResponse, GetSubscriberQuery,
+            ListSubscribersResponse, SubscriberImportJob, SubscriberImportJobsListParams,
+            SubscriberStatsResponse, SubscribersListParams, UploadId,
+        },
+    },
+};
+use wp_derive_request_builder::WpDerivedRequest;
+
+#[derive(WpDerivedRequest)]
+enum SubscribersRequest {
+    #[get(url = "/sites/<wp_com_site_id>/subscribers", params = &SubscribersListParams, output = ListSubscribersResponse)]
+    ListSubscribers,
+    #[get(url = "/sites/<wp_com_site_id>/subscribers/individual", params = &GetSubscriberQuery, output = SubscriberImportJob)]
+    GetSubscriber,
+    #[get(url = "/sites/<wp_com_site_id>/subscribers/import", params = &SubscriberImportJobsListParams, output = Vec<SubscriberImportJob>)]
+    ListSubscriberImportJobs,
+    #[get(url = "/sites/<wp_com_site_id>/subscribers/import/<upload_id>", output = SubscriberImportJob)]
+    GetSubscriberImportJob,
+    #[post(url = "/sites/<wp_com_site_id>/subscribers/import", params = &AddSubscribersParams, output = AddSubscribersResponse)]
+    AddSubscribers,
+    #[get(url = "/sites/<wp_com_site_id>/subscribers/stats", output = SubscriberStatsResponse)]
+    GetSubscriberStats,
+}
+
+impl DerivedRequest for SubscribersRequest {
+    fn namespace() -> impl AsNamespace {
+        WpComNamespace::V2
+    }
+}

wp_api/src/wp_com/mod.rs

@@ -6,6 +6,7 @@ pub mod client;
 pub mod endpoint;
 pub mod jetpack_connection;
 pub mod oauth2;
+pub mod subscribers;
 
 impl_as_query_value_for_new_type!(WpComSiteId);
 uniffi::custom_newtype!(WpComSiteId, u64);