Skip to content

Commit ea4e98e

Browse files
committed
Add methods for inviting codes and fix docs
Documentation note about unclear documentation has their wording tweaked.
1 parent 112822f commit ea4e98e

7 files changed

Lines changed: 210 additions & 40 deletions

File tree

Sources/ATProtoKit/Models/Lexicons/com.atproto/Admin/AtprotoAdminDefs.swift

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -370,17 +370,17 @@ public struct AdminReportViewDetail: Codable {
370370
public var comment: String? = nil
371371
/// The subject of the report.
372372
///
373-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
373+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
374374
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
375375
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
376-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
376+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
377377
public let subject: RepoViewUnion
378378
/// The status for the subject of the report. Optional.
379379
///
380-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
380+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
381381
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
382382
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
383-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
383+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
384384
public var subjectStatus: AdminSubjectStatusView? = nil
385385
/// The user who created the report.
386386
public let reportedBy: String
@@ -452,10 +452,10 @@ public struct AdminRepoView: Codable {
452452
public var email: String? = nil
453453
/// The related records of the user.
454454
///
455-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
455+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
456456
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
457457
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
458-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
458+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
459459
public let relatedRecords: UnknownType
460460
/// The date and time the user was indexed.
461461
@DateFormatting public var indexedAt: Date
@@ -535,10 +535,10 @@ public struct AdminRepoViewDetail: Codable {
535535
public var email: String? = nil
536536
/// The user's related records.
537537
///
538-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
538+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
539539
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
540540
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
541-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
541+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
542542
public let relatedRecords: UnknownType
543543
/// The date and time the user was last indexed.
544544
@DateFormatting public var indexedAt: Date
@@ -636,10 +636,10 @@ public struct AdminAccountView: Codable {
636636
public var email: String? = nil
637637
/// The user's related records. Optional.
638638
///
639-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
639+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
640640
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
641641
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
642-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
642+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
643643
public var relatedRecords: [UnknownType]? = nil
644644
/// The date and time the user was last indexed.
645645
@DateFormatting public var indexedAt: Date
@@ -771,28 +771,28 @@ public struct AdminRecordView: Codable {
771771
public let cidHash: String
772772
/// The value of the record.
773773
///
774-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
774+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
775775
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
776776
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
777-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
777+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
778778
public let value: UnknownType
779779
/// An array of CID hashes for blobs.
780780
public let blobCIDHashes: [String]
781781
/// The date and time the record is indexed.
782782
@DateFormatting public var indexedAt: Date
783783
/// The status of the subject.
784784
///
785-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
785+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
786786
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
787787
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
788-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
788+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
789789
public let moderation: AdminModeration
790790
/// The repository view of the record.
791791
///
792-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
792+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
793793
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
794794
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
795-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
795+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
796796
public let repo: AdminRepoView
797797

798798
public init(recordURI: String, cidHash: String, value: UnknownType, blobCIDHashes: [String], indexedAt: Date, moderation: AdminModeration, repo: AdminRepoView) {
@@ -852,10 +852,10 @@ public struct AdminRecordViewDetail: Codable {
852852
public let cidHash: String
853853
/// The value of the record.
854854
///
855-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
855+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
856856
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
857857
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
858-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
858+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
859859
public let value: String
860860
/// An array of CID hashes for blobs.
861861
public let blobs: [AdminBlobView]
@@ -865,17 +865,17 @@ public struct AdminRecordViewDetail: Codable {
865865
@DateFormatting public var indexedAt: Date
866866
/// The repository view of the record.
867867
///
868-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
868+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
869869
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
870870
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
871-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
871+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
872872
public let moderation: AdminModerationDetail
873873
/// The repository view of the record.
874874
///
875-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
875+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
876876
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
877877
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
878-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
878+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
879879
public let repo: AdminRepoView
880880

881881
public init(recordURI: String, cidHash: String, value: String, blobs: [AdminBlobView], labels: [Label]? = nil, indexedAt: Date, moderation: AdminModerationDetail, repo: AdminRepoView) {
@@ -943,41 +943,41 @@ public struct AdminRecordViewNotFound: Codable {
943943

944944
/// A data model of a definition for moderation.
945945
///
946-
/// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. Our documentation here is based on:\
946+
/// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. The documentation here is based on:\
947947
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
948948
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
949-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
949+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
950950
///
951951
/// - SeeAlso: This is based on the [`com.atproto.admin.defs`][github] lexicon.
952952
///
953953
/// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/admin/defs.json
954954
public struct AdminModeration: Codable {
955955
/// The status of the subject. Optional.
956956
///
957-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
957+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
958958
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
959959
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
960-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
960+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
961961
public var subjectStatus: AdminSubjectStatusView? = nil
962962
}
963963

964964
/// A data model of a definition for a detailed moderation.
965965
///
966-
/// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. Our documentation here is based on:\
966+
/// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. The documentation here is based on:\
967967
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
968968
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
969-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
969+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
970970
///
971971
/// - SeeAlso: This is based on the [`com.atproto.admin.defs`][github] lexicon.
972972
///
973973
/// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/admin/defs.json
974974
public struct AdminModerationDetail: Codable {
975975
/// The status of the subject. Optional.
976976
///
977-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
977+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
978978
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
979979
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
980-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
980+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
981981
public var subjectStatus: AdminSubjectStatusView? = nil
982982
}
983983

Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationDefs.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import Foundation
1111
///
1212
/// - SeeAlso: This is based on the [`com.atproto.moderation.defs`][github] lexicon.
1313
///
14-
/// - Important: The item associated with this enum is undocumented in the AT Protocol specifications. Our documentation here is based on:\
14+
/// - Important: The item associated with this enum is undocumented in the AT Protocol specifications. The documentation here is based on:\
1515
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
1616
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
17-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
17+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
1818
/// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/moderation/defs.json
1919
public enum ModerationReasonType: String, Codable {
2020
/// Indicates spam as the reason.

Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCheckAccountStatus.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,27 @@ public struct ServerCheckAccountStatusOutput: Codable {
1919
public let isActivated: Bool
2020
/// Indicates whether the user's account has a valid ID.
2121
public let isValidID: Bool
22-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
22+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
2323
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
2424
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
25-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
25+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
2626
public let repositoryCommit: String
27-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
27+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
2828
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
2929
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
30-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
30+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
3131
public let repositoryRev: String
32-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
32+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
3333
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
3434
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
35-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
35+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
3636
public let repositoryBlocks: Int
3737
/// The number of indexed records in the user's account.
3838
public let indexedRecords: Int
39-
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. Our documentation here is based on:\
39+
/// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\
4040
/// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\
4141
/// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\
42-
/// Clarifications from Bluesky are essential for definitive understanding and usage.
42+
/// Clarifications from Bluesky are needed in order to fully understand the this item.
4343
public let privateStateValues: Int
4444
/// The expected number of blobs in the user's account.
4545
public let expectedBlobs: Int

0 commit comments

Comments
 (0)