Add /wpcom/v2/sites/:siteid/subscribers

Author: kean

Package.swift

@@ -11,8 +11,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "WordPressKit",
-            url: "https://github.com/user-attachments/files/19732825/WordPressKit.zip",
-            checksum: "0ecd8b19cd00a4ef363ab6e826f92166c1efa4693db8f3218533510a3f951dbb"
+            url: "https://github.com/user-attachments/files/19949670/WordPressKit.zip",
+            checksum: "69e4a2bec7a641336c4121c1ba23357b6222bf9db8353fe162328852780558ef"
         ),
     ]
 )

Sources/CoreAPI/WordPressComRestApi.swift

@@ -376,7 +376,7 @@ open class WordPressComRestApi: NSObject {
     open func perform(
         _ method: HTTPRequestBuilder.Method,
         URLString: String,
-        parameters: [String: AnyObject]? = nil,
+        parameters: [String: Any]? = nil,
         fulfilling progress: Progress? = nil
     ) async -> APIResult<AnyObject> {
         await perform(method, URLString: URLString, parameters: parameters, fulfilling: progress) {
@@ -387,7 +387,7 @@ open class WordPressComRestApi: NSObject {
     open func perform<T: Decodable>(
         _ method: HTTPRequestBuilder.Method,
         URLString: String,
-        parameters: [String: AnyObject]? = nil,
+        parameters: [String: Any]? = nil,
         fulfilling progress: Progress? = nil,
         jsonDecoder: JSONDecoder? = nil,
         type: T.Type = T.self
@@ -401,7 +401,7 @@ open class WordPressComRestApi: NSObject {
     private func perform<T>(
         _ method: HTTPRequestBuilder.Method,
         URLString: String,
-        parameters: [String: AnyObject]?,
+        parameters: [String: Any]?,
         fulfilling progress: Progress?,
         decoder: @escaping (Data) throws -> T
     ) async -> APIResult<T> {

Sources/WordPressKit/Models/RemoteSubscriber.swift

@@ -0,0 +1,23 @@
+import Foundation
+
+public struct RemoteSubscriber: Decodable {
+    public let userID: Int
+    public let subscriptionID: Int
+    public let emailAddress: String?
+    public let dateSubscribed: Date
+    public let isEmailSubscriber: Bool
+    public let subscriptionStatus: String?
+    public let displayName: String?
+    public let avatar: String?
+
+    private enum CodingKeys: String, CodingKey {
+        case userID = "user_id"
+        case subscriptionID = "subscription_id"
+        case emailAddress = "email_address"
+        case dateSubscribed = "date_subscribed"
+        case isEmailSubscriber = "is_email_subscriber"
+        case subscriptionStatus = "subscription_status"
+        case displayName = "display_name"
+        case avatar
+    }
+}

Sources/WordPressKit/Services/PeopleServiceRemote.swift

@@ -173,6 +173,96 @@ public class PeopleServiceRemote: ServiceRemoteWordPressComREST {
         })
     }
 
+    public struct SubscribersParameters {
+        public var sortField: SortField?
+        public var sortOrder: SortOrder?
+        public var filters: [Filter]
+
+        public enum SortField: String {
+            case dateSubscribed = "date_subscribed"
+            case email = "email"
+            case name = "name"
+            case plan = "plan"
+            case subscriptionStatus = "subscription_status"
+        }
+
+        public enum SortOrder: String {
+            case ascending = "asc"
+            case descending = "dsc"
+        }
+
+        public protocol Filter: CustomStringConvertible {}
+
+        public enum FilterSubscriptionType: String, Filter {
+            case email = "email_subscriber"
+            case reader = "reader_subscriber"
+            case unconfirmed = "unconfirmed_subscriber"
+            case blocked = "blocked_subscriber"
+
+            public var description: String { rawValue }
+        }
+
+        public enum FilterPaymentType: String, Filter {
+            case free
+            case paid
+
+            public var description: String { rawValue }
+        }
+
+        public init(sortField: SortField? = nil, sortOrder: SortOrder? = nil, filters: [Filter] = []) {
+            self.sortField = sortField
+            self.sortOrder = sortOrder
+            self.filters = filters
+        }
+    }
+
+    public struct SubscribersResponse: Decodable {
+        public var total: Int
+        public var pages: Int
+        public var page: Int
+        public var perPage: Int
+        public var subscribers: [RemoteSubscriber]
+
+        private enum CodingKeys: String, CodingKey {
+            case total = "total"
+            case pages = "pages"
+            case page = "page"
+            case perPage = "per_page"
+            case subscribers = "subscribers"
+        }
+    }
+
+    public func getSubscribers(
+        siteID: Int,
+        page: Int? = nil,
+        perPage: Int? = 25,
+        parameters: SubscribersParameters = .init(),
+    ) async throws -> SubscribersResponse {
+        let url = self.path(forEndpoint: "sites/\(siteID)/subscribers", withVersion: ._2_0)
+        var query: [String: Any] = [:]
+        if let page {
+            query["page"] = page
+        }
+        if let perPage {
+            query["per_page"] = perPage
+        }
+        if let sortField = parameters.sortField {
+            query["sort"] = sortField.rawValue
+        }
+        if let sortOrder = parameters.sortOrder {
+            query["sort_order"] = sortOrder.rawValue
+        }
+        if !parameters.filters.isEmpty {
+            query["filters"] = parameters.filters.map { $0.description }
+        }
+        return try await wordPressComRestApi.perform(
+            .get,
+            URLString: url,
+            jsonDecoder: JSONDecoder.apiDecoder,
+            type: SubscribersResponse.self
+        ).get().body
+    }
+
     /// Updates a specified User's Role
     ///
     /// - Parameters:

WordPressKit.xcodeproj/project.pbxproj

@@ -50,6 +50,7 @@
 		0CCD4C5C2C41700B00B53F9A /* UIDevice+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CCD4C5B2C41700B00B53F9A /* UIDevice+Extensions.swift */; };
 		0CCD4C5F2C41711800B53F9A /* NSObject-SafeExpectations in Frameworks */ = {isa = PBXBuildFile; productRef = 0CCD4C5E2C41711800B53F9A /* NSObject-SafeExpectations */; };
 		0CCD4C622C41712800B53F9A /* wpxmlrpc in Frameworks */ = {isa = PBXBuildFile; productRef = 0CCD4C612C41712800B53F9A /* wpxmlrpc */; };
+		0CE4E8252DC027AC00056DD9 /* RemoteSubscriber.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CE4E8242DC027AC00056DD9 /* RemoteSubscriber.swift */; };
 		0CED1FE82B617CF300E6DD52 /* AtomicSiteServiceRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CED1FE72B617CF300E6DD52 /* AtomicSiteServiceRemote.swift */; };
 		0CED1FEB2B617D7D00E6DD52 /* AtomicLogs.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CED1FEA2B617D7D00E6DD52 /* AtomicLogs.swift */; };
 		1769DEAA24729AFF00F42EFC /* HomepageSettingsServiceRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1769DEA924729AFF00F42EFC /* HomepageSettingsServiceRemote.swift */; };
@@ -824,6 +825,7 @@
 		0CB1905F2A2A6943004D3E80 /* blaze-campaigns-search.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "blaze-campaigns-search.json"; sourceTree = "<group>"; };
 		0CB190642A2A7569004D3E80 /* BlazeCampaignsSearchResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BlazeCampaignsSearchResponse.swift; sourceTree = "<group>"; };
 		0CCD4C5B2C41700B00B53F9A /* UIDevice+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UIDevice+Extensions.swift"; sourceTree = "<group>"; };
+		0CE4E8242DC027AC00056DD9 /* RemoteSubscriber.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RemoteSubscriber.swift; sourceTree = "<group>"; };
 		0CED1FE72B617CF300E6DD52 /* AtomicSiteServiceRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AtomicSiteServiceRemote.swift; sourceTree = "<group>"; };
 		0CED1FEA2B617D7D00E6DD52 /* AtomicLogs.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AtomicLogs.swift; sourceTree = "<group>"; };
 		1769DEA924729AFF00F42EFC /* HomepageSettingsServiceRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HomepageSettingsServiceRemote.swift; sourceTree = "<group>"; };
@@ -1866,6 +1868,7 @@
 				4A68E3DC294070A7004AC3DC /* RemoteReaderSite.swift */,
 				4A68E3E0294076C1004AC3DC /* RemoteReaderSiteInfo.swift */,
 				9F3E0B9A208732B2009CB5BA /* RemoteReaderSiteInfoSubscription.swift */,
+				0CE4E8242DC027AC00056DD9 /* RemoteSubscriber.swift */,
 				4A68E3DE29407100004AC3DC /* RemoteReaderTopic.swift */,
 				74E2295D1F1E777B0085F7F2 /* RemoteSharingButton.swift */,
 				7430C9C81F192F260051B8E6 /* RemoteSourcePostAttribution.h */,
@@ -3491,6 +3494,7 @@
 				3FD634F32BC3AD6200CEDF5E /* Result+Callback.swift in Sources */,
 				B5A4822E20AC6C1A009D95F6 /* WPKitLogging.m in Sources */,
 				3FE2E97C2BC3A332002CA2E1 /* WordPressComRestApi.swift in Sources */,
+				0CE4E8252DC027AC00056DD9 /* RemoteSubscriber.swift in Sources */,
 				FE6C673C2BB739950083ECAB /* NSAttributedString+extensions.swift in Sources */,
 				7430C9A61F1927180051B8E6 /* ReaderSiteServiceRemote.m in Sources */,
 				FEE4EF57272FDD4B003CDA3C /* RemoteCommentV2.swift in Sources */,