Update lexicon models and methods

Author: MasterJ93

Sources/ATProtoKit/APIReference/AdminAndModeratorAPI/GetReporterStats.swift

@@ -0,0 +1,68 @@
+//
+//  GetReporterStats.swift
+//
+//
+//  Created by Christopher Jr Riley on 2025-02-20.
+//
+
+import Foundation
+
+extension ATProtoAdmin {
+
+    /// Retrieves statistics about reporters for a list of users.
+    /// 
+    /// - Note: According to the AT Protocol specifications: "Get reporter stats for a list
+    /// of users."
+    /// 
+    /// - SeeAlso: This is based on the [`tools.ozone.moderation.getReporterStats`][github] lexicon.
+    /// 
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/tools/ozone/moderation/getReporterStats.json
+    /// 
+    /// - Parameter dids: An array of Decentralized Identifiers (DIDs) to extract the
+    /// repository information. Limits to 100 items.
+    /// - Returns: An array of reporter statistics.
+    ///
+    /// - Throws: An ``ATProtoError``-conforming error type, depending on the issue. Go to
+    /// ``ATAPIError`` and ``ATRequestPrepareError`` for more details.
+    public func getReporterStats(from dids: [String]) async throws -> ToolsOzoneLexicon.Moderation.GetReporterStatsOutput {
+        guard session != nil,
+              let accessToken = session?.accessToken else {
+            throw ATRequestPrepareError.missingActiveSession
+        }
+
+        guard let sessionURL = session?.pdsURL,
+              let requestURL = URL(string: "\(sessionURL)/xrpc/tools.ozone.moderation.getReporterStats") else {
+            throw ATRequestPrepareError.invalidRequestURL
+        }
+
+        var queryItems = [(String, String)]()
+
+        let cappedDIDArray = dids.prefix(100)
+        queryItems += cappedDIDArray.map { ("dids", $0) }
+
+        let queryURL: URL
+
+        do {
+            queryURL = try APIClientService.setQueryItems(
+                for: requestURL,
+                with: queryItems
+            )
+
+            let request = APIClientService.createRequest(
+                forRequest: queryURL,
+                andMethod: .get,
+                acceptValue: "application/json",
+                contentTypeValue: nil,
+                authorizationValue: "Bearer \(accessToken)"
+            )
+            let response = try await APIClientService.shared.sendRequest(
+                request,
+                decodeTo: ToolsOzoneLexicon.Moderation.GetReporterStatsOutput.self
+            )
+
+            return response
+        } catch {
+            throw error
+        }
+    }
+}

Sources/ATProtoKit/APIReference/AdminAndModeratorAPI/ListMembersAsAdmin.swift

@@ -10,26 +10,31 @@ import Foundation
 extension ATProtoAdmin {
 
     /// Lists all of the ozone service members as an administrator.
-    ///
+    /// 
     /// - Important: This is an administrator task and as such, regular users won't be able to
     /// access this; if they attempt to do so, an error will occur.
-    ///
+    /// 
     /// - Note: According to the AT Protocol specifications: "List all members with access to the
     /// ozone service."
-    ///
+    /// 
     /// - SeeAlso: This is based on the [`tools.ozone.team.listMembers`][github] lexicon.
-    ///
+    /// 
     /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/tools/ozone/team/listMembers.json
-    ///
+    /// 
     /// - Parameters:
+    ///   - isDisabled: Determines whether the members are disabled. Optional.
+    ///   - roles: An array of roles for the members. Optional.
     ///   - limit: The number of invite codes in the list. Defaults to `50`.
     ///   - cursor: The mark used to indicate the starting point for the next set
     ///   of results. Optional.
-    /// - Returns: An array of members in the ozone service that the administrator is in.
-    ///
+    /// - Returns: An array of members in the ozone service that the administrator is in, with an
+    /// optional cursor to extend the array.
+    /// 
     /// - Throws: An ``ATProtoError``-conforming error type, depending on the issue. Go to
     /// ``ATAPIError`` and ``ATRequestPrepareError`` for more details.
     public func listMembers(
+        isDisabled: Bool? = nil,
+        roles: [String]? = nil,
         limit: Int? = 50,
         cursor: String? = nil
     ) async throws -> ToolsOzoneLexicon.Team.ListMembersOutput {

Sources/ATProtoKit/APIReference/ComAtprotoAPI/ListRepositoriesByCollection.swift

@@ -0,0 +1,83 @@
+//
+//  ListRepositoriesByCollection.swift
+//
+//
+//  Created by Christopher Jr Riley on 2025-02-20.
+//
+
+import Foundation
+
+extension ATProtoKit {
+
+    /// Enumerates all decentralized identifiers (DIDs) with records in the given collection's
+    /// Namespace Identifier (NSID).
+    /// 
+    /// - Note: According to the AT Protocol specifications: "Enumerates all the DIDs which have
+    /// records with the given collection NSID."
+    /// 
+    /// - SeeAlso: This is based on the [`com.atproto.sync.listReposByCollection`][github] lexicon.
+    /// 
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/sync/listReposByCollection.json
+    /// 
+    /// - Parameters:
+    ///   - collection: The Namespaced Identifier (NSID) of the repository.
+    ///   - limit: The number of repositories in the array. Optional. Defaults to `500`. Can only
+    ///   choose between `1` and `2,000`.
+    ///   - cursor: The mark used to indicate the starting point for the next set
+    ///   of results. Optional.
+    ///   - pdsURL: The URL of the Personal Data Server (PDS). Defaults to `https://api.bsky.app`.
+    /// - Returns: An array of repositories, with an optional cursor to extend the array.
+    ///
+    /// - Throws: An ``ATProtoError``-conforming error type, depending on the issue. Go to
+    /// ``ATAPIError`` and ``ATRequestPrepareError`` for more details.
+    public func listRepositoriesByCollection(
+        collection: String,
+        limit: Int? = 500,
+        cursor: String? = nil,
+        pdsURL: String = "https://api.bsky.app"
+    ) async throws -> ComAtprotoLexicon.Sync.ListRepositoriesByCollectionOutput {
+        let finalPDSURL = self.determinePDSURL(customPDSURL: pdsURL)
+
+        guard let requestURL = URL(string: "\(finalPDSURL)/xrpc/com.atproto.sync.listReposByCollection") else {
+            throw ATRequestPrepareError.invalidRequestURL
+        }
+
+        var queryItems = [(String, String)]()
+
+        queryItems.append(("collection", String(collection)))
+
+        if let limit {
+            let finalLimit = max(1, min(limit, 2_000))
+            queryItems.append(("limit", "\(finalLimit)"))
+        }
+
+        if let cursor {
+            queryItems.append(("cursor", cursor))
+        }
+
+        let queryURL: URL
+
+        do {
+            queryURL = try APIClientService.setQueryItems(
+                for: requestURL,
+                with: queryItems
+            )
+
+            let request = APIClientService.createRequest(
+                forRequest: queryURL,
+                andMethod: .get,
+                acceptValue: "application/json",
+                contentTypeValue: nil,
+                authorizationValue: nil
+            )
+            let response = try await APIClientService.shared.sendRequest(
+                request,
+                decodeTo: ComAtprotoLexicon.Sync.ListRepositoriesByCollectionOutput.self
+            )
+
+            return response
+        } catch {
+            throw error
+        }
+    }
+}

Sources/ATProtoKit/ATProtoKit.docc/Extensions/Lexicons/Models/com.atproto/ComAtprotoSync.md

@@ -20,6 +20,11 @@
 - ``ComAtprotoLexicon/Sync/ListRepositories``
 - ``ComAtprotoLexicon/Sync/ListRepositoriesOutput``
 
+### com.atproto.sync.listReposByCollection
+
+- ``ComAtprotoLexicon/Sync/ListRepositories``
+- ``ComAtprotoLexicon/Sync/ListRepositoriesOutput``
+
 ### com.atproto.sync.subscribeRepos
 
 - ``ComAtprotoLexicon/Sync/SubscribeRepos``

Sources/ATProtoKit/ATProtoKit.docc/Extensions/Lexicons/Models/tools.ozone/ToolsOzoneModeration.md

@@ -41,6 +41,7 @@
 - ``ToolsOzoneLexicon/Moderation/VideoDetailsDefinition``
 - ``ToolsOzoneLexicon/Moderation/AccountHostingDefinition``
 - ``ToolsOzoneLexicon/Moderation/RecordHostingDefinition``
+- ``ToolsOzoneLexicon/Moderation/ReporterStatsDefinition``
 
 ### tools.ozone.moderation.emitEvent
 
@@ -50,6 +51,10 @@
 
 - ``ToolsOzoneLexicon/Moderation/GetRecordsOutput``
 
+### tools.ozone.moderation.getReporterStats
+
+- ``ToolsOzoneLexicon/Moderation/GetReporterStatsOutput``
+
 ### tools.ozone.moderation.getRepos
 
 - ``ToolsOzoneLexicon/Moderation/GetRepositoriesOutput``

Sources/ATProtoKit/Models/Lexicons/com.atproto/Sync/ComAtprotoSyncListReposByCollection.swift

@@ -0,0 +1,48 @@
+//
+//  ComAtprotoSyncListReposByCollection.swift
+//
+//
+//  Created by Christopher Jr Riley on 2025-02-20.
+//
+
+import Foundation
+
+extension ComAtprotoLexicon.Sync {
+
+    /// A definition model for enumerating all decentralized identifiers (DIDs) with records
+    /// in the given collection's Namespace Identifier (NSID).
+    ///
+    /// - Note: According to the AT Protocol specifications: "Enumerates all the DIDs which have
+    /// records with the given collection NSID."
+    ///
+    /// - SeeAlso: This is based on the [`com.atproto.sync.listReposByCollection`][github] lexicon.
+    ///
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/sync/listReposByCollection.json
+    public struct ListRepositoriesByCollection: Sendable, Codable {
+
+        /// A repository.
+        public struct Repository: Sendable, Codable {
+
+            /// The decentralized identifier of the repository.
+            public let did: String
+        }
+    }
+
+    /// An output model for enumerating all decentralized identifiers (DIDs) with records
+    /// in the given collection's Namespace Identifiers (NSID).
+    ///
+    /// - Note: According to the AT Protocol specifications: "Enumerates all the DIDs which have
+    /// records with the given collection NSID."
+    ///
+    /// - SeeAlso: This is based on the [`com.atproto.sync.listReposByCollection`][github] lexicon.
+    ///
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/sync/listReposByCollection.json
+    public struct ListRepositoriesByCollectionOutput: Sendable, Codable {
+
+        /// The mark used to indicate the starting point for the next set of results. Optional.
+        public let cursor: String?
+
+        /// An array of repositories.
+        public let repositories: [ListRepositoriesByCollection.Repository]
+    }
+}

Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/ToolsOzoneModerationDefs.swift

@@ -1708,4 +1708,63 @@ extension ToolsOzoneLexicon.Moderation {
             case unknown
         }
     }
+
+    /// A definition model for the reporter's statistics.
+    ///
+    /// - SeeAlso: This is based on the [`tools.ozone.moderation.defs`][github] lexicon.
+    ///
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/admin/defs.json
+    public struct ReporterStatsDefinition: Sendable, Codable {
+
+        /// The decentralized identifier (DID) of the reporter.
+        public let did: String
+
+        /// The number of reports made by the user on accounts.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of reports made
+        /// by the user on accounts."
+        public let accountReportCount: Int
+
+        /// The number of reports made by the user.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of reports made
+        /// by the user on records."
+        public let recordReportCount: Int
+
+        /// The number of accounts reported by the user.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of accounts
+        /// reported by the user."
+        public let reportedAccountCount: Int
+
+        /// The number of records reported by the user.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of records
+        /// reported by the user."
+        public let reportedRecordCount: Int
+
+        /// The number of accounts taken down due to user reports.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of accounts
+        /// taken down as a result of the user's reports."
+        public let takendownAccountCount: Int
+
+        /// The number of records taken down due to user reports.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of records
+        /// taken down as a result of the user's reports."
+        public let takendownRecordCount: Int
+
+        /// The number of accounts labeled by the user’s reports.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of accounts
+        /// labeled as a result of the user's reports."
+        public let labeledAccountCount: Int
+
+        /// The number of records labeled based on user reports.
+        ///
+        /// - Note: According to the AT Protocol specifications: "The total number of records
+        /// labeled as a result of the user's reports."
+        public let labeledRecordCount: Int
+    }
 }

Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/ToolsOzoneModerationGetReporterStats.swift

@@ -0,0 +1,25 @@
+//
+//  ToolsOzoneModeratorGetReporterStats.swift
+//
+//
+//  Created by Christopher Jr Riley on 2025-02-20.
+//
+
+import Foundation
+
+extension ToolsOzoneLexicon.Moderation {
+
+    /// An output model for retrieving statistics about reporters for a list of users.
+    ///
+    /// - Note: According to the AT Protocol specifications: "Get reporter stats for a list
+    /// of users."
+    ///
+    /// - SeeAlso: This is based on the [`tools.ozone.moderation.getReporterStats`][github] lexicon.
+    ///
+    /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/tools/ozone/moderation/getReporterStats.json
+    public struct GetReporterStatsOutput: Sendable, Codable {
+
+        /// An array of reporter statistics.
+        public let stats: [ToolsOzoneLexicon.Moderation.ReporterStatsDefinition]
+    }
+}