@atproto/bsky 0.0.198 → 0.0.200

package/dist/lexicon/lexicons.d.ts

@@ -1614,6 +1614,318 @@ export declare const schemaDict: {
             };
         };
     };
+    readonly AppBskyContactDefs: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.defs";
+        readonly defs: {
+            readonly matchAndContactIndex: {
+                readonly description: "Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match.";
+                readonly type: "object";
+                readonly required: ["match", "contactIndex"];
+                readonly properties: {
+                    readonly match: {
+                        readonly description: "Profile of the matched user.";
+                        readonly type: "ref";
+                        readonly ref: "lex:app.bsky.actor.defs#profileView";
+                    };
+                    readonly contactIndex: {
+                        readonly description: "The index of this match in the import contact input.";
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 999;
+                    };
+                };
+            };
+            readonly syncStatus: {
+                readonly type: "object";
+                readonly required: ["syncedAt", "matchesCount"];
+                readonly properties: {
+                    readonly syncedAt: {
+                        readonly description: "Last date when contacts where imported.";
+                        readonly type: "string";
+                        readonly format: "datetime";
+                    };
+                    readonly matchesCount: {
+                        readonly description: "Number of existing contact matches resulting of the user imports and of their imported contacts having imported the user. Matches stop being counted when the user either follows the matched contact or dismisses the match.";
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                };
+            };
+        };
+    };
+    readonly AppBskyContactDismissMatch: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.dismissMatch";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["subject"];
+                        readonly properties: {
+                            readonly subject: {
+                                readonly description: "The subject's DID to dismiss the match with.";
+                                readonly type: "string";
+                                readonly format: "did";
+                            };
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {};
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactGetMatches: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.getMatches";
+        readonly defs: {
+            readonly main: {
+                readonly type: "query";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.";
+                readonly parameters: {
+                    readonly type: "params";
+                    readonly properties: {
+                        readonly limit: {
+                            readonly type: "integer";
+                            readonly minimum: 1;
+                            readonly maximum: 100;
+                            readonly default: 50;
+                        };
+                        readonly cursor: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["matches"];
+                        readonly properties: {
+                            readonly cursor: {
+                                readonly type: "string";
+                            };
+                            readonly matches: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "ref";
+                                    readonly ref: "lex:app.bsky.actor.defs#profileView";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactGetSyncStatus: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.getSyncStatus";
+        readonly defs: {
+            readonly main: {
+                readonly type: "query";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Gets the user's current contact import status. Requires authentication.";
+                readonly parameters: {
+                    readonly type: "params";
+                    readonly properties: {};
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly syncStatus: {
+                                readonly description: "If present, indicates the user has imported their contacts. If not present, indicates the user never used the feature or called `app.bsky.contact.removeData` and didn't import again since.";
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.contact.defs#syncStatus";
+                            };
+                        };
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactImportContacts: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.importContacts";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["token", "contacts"];
+                        readonly properties: {
+                            readonly token: {
+                                readonly description: "JWT to authenticate the call. Use the JWT received as a response to the call to `app.bsky.contact.verifyPhone`.";
+                                readonly type: "string";
+                            };
+                            readonly contacts: {
+                                readonly description: "List of phone numbers in global E.164 format (e.g., '+12125550123'). Phone numbers that cannot be normalized into a valid phone number will be discarded. Should not repeat the 'phone' input used in `app.bsky.contact.verifyPhone`.";
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                                readonly minLength: 1;
+                                readonly maxLength: 1000;
+                            };
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["matchesAndContactIndexes"];
+                        readonly properties: {
+                            readonly matchesAndContactIndexes: {
+                                readonly description: "The users that matched during import and their indexes on the input contacts, so the client can correlate with its local list.";
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "ref";
+                                    readonly ref: "lex:app.bsky.contact.defs#matchAndContactIndex";
+                                };
+                            };
+                        };
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactRemoveData: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.removeData";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {};
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {};
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactStartPhoneVerification: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.startPhoneVerification";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["phone"];
+                        readonly properties: {
+                            readonly phone: {
+                                readonly description: "The phone number to receive the code via SMS.";
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly properties: {};
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
+    readonly AppBskyContactVerifyPhone: {
+        readonly lexicon: 1;
+        readonly id: "app.bsky.contact.verifyPhone";
+        readonly defs: {
+            readonly main: {
+                readonly type: "procedure";
+                readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.";
+                readonly input: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["phone", "code"];
+                        readonly properties: {
+                            readonly phone: {
+                                readonly description: "The phone number to verify. Should be the same as the one passed to `app.bsky.contact.startPhoneVerification`.";
+                                readonly type: "string";
+                            };
+                            readonly code: {
+                                readonly description: "The code received via SMS as a result of the call to `app.bsky.contact.startPhoneVerification`.";
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                readonly output: {
+                    readonly encoding: "application/json";
+                    readonly schema: {
+                        readonly type: "object";
+                        readonly required: ["token"];
+                        readonly properties: {
+                            readonly token: {
+                                readonly description: "JWT to be used in a call to `app.bsky.contact.importContacts`. It is only valid for a single call.";
+                                readonly type: "string";
+                            };
+                        };
+                    };
+                };
+                readonly errors: [{
+                    readonly name: "TODO";
+                    readonly description: "TODO";
+                }];
+            };
+        };
+    };
     readonly AppBskyEmbedDefs: {
         readonly lexicon: 1;
         readonly id: "app.bsky.embed.defs";
@@ -4147,6 +4459,26 @@ export declare const schemaDict: {
                         readonly format: "at-uri";
                         readonly description: "if the actor is followed by this DID, contains the AT-URI of the follow record";
                     };
+                    readonly blocking: {
+                        readonly type: "string";
+                        readonly format: "at-uri";
+                        readonly description: "if the actor blocks this DID, this is the AT-URI of the block record";
+                    };
+                    readonly blockedBy: {
+                        readonly type: "string";
+                        readonly format: "at-uri";
+                        readonly description: "if the actor is blocked by this DID, contains the AT-URI of the block record";
+                    };
+                    readonly blockingByList: {
+                        readonly type: "string";
+                        readonly format: "at-uri";
+                        readonly description: "if the actor blocks this DID via a block list, this is the AT-URI of the listblock record";
+                    };
+                    readonly blockedByList: {
+                        readonly type: "string";
+                        readonly format: "at-uri";
+                        readonly description: "if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record";
+                    };
                 };
             };
         };
@@ -14925,6 +15257,310 @@ export declare const schemas: ({
             };
         };
     };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.defs";
+    readonly defs: {
+        readonly matchAndContactIndex: {
+            readonly description: "Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match.";
+            readonly type: "object";
+            readonly required: ["match", "contactIndex"];
+            readonly properties: {
+                readonly match: {
+                    readonly description: "Profile of the matched user.";
+                    readonly type: "ref";
+                    readonly ref: "lex:app.bsky.actor.defs#profileView";
+                };
+                readonly contactIndex: {
+                    readonly description: "The index of this match in the import contact input.";
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 999;
+                };
+            };
+        };
+        readonly syncStatus: {
+            readonly type: "object";
+            readonly required: ["syncedAt", "matchesCount"];
+            readonly properties: {
+                readonly syncedAt: {
+                    readonly description: "Last date when contacts where imported.";
+                    readonly type: "string";
+                    readonly format: "datetime";
+                };
+                readonly matchesCount: {
+                    readonly description: "Number of existing contact matches resulting of the user imports and of their imported contacts having imported the user. Matches stop being counted when the user either follows the matched contact or dismisses the match.";
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+            };
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.dismissMatch";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["subject"];
+                    readonly properties: {
+                        readonly subject: {
+                            readonly description: "The subject's DID to dismiss the match with.";
+                            readonly type: "string";
+                            readonly format: "did";
+                        };
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {};
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.getMatches";
+    readonly defs: {
+        readonly main: {
+            readonly type: "query";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.";
+            readonly parameters: {
+                readonly type: "params";
+                readonly properties: {
+                    readonly limit: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 100;
+                        readonly default: 50;
+                    };
+                    readonly cursor: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["matches"];
+                    readonly properties: {
+                        readonly cursor: {
+                            readonly type: "string";
+                        };
+                        readonly matches: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.actor.defs#profileView";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.getSyncStatus";
+    readonly defs: {
+        readonly main: {
+            readonly type: "query";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Gets the user's current contact import status. Requires authentication.";
+            readonly parameters: {
+                readonly type: "params";
+                readonly properties: {};
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly syncStatus: {
+                            readonly description: "If present, indicates the user has imported their contacts. If not present, indicates the user never used the feature or called `app.bsky.contact.removeData` and didn't import again since.";
+                            readonly type: "ref";
+                            readonly ref: "lex:app.bsky.contact.defs#syncStatus";
+                        };
+                    };
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.importContacts";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["token", "contacts"];
+                    readonly properties: {
+                        readonly token: {
+                            readonly description: "JWT to authenticate the call. Use the JWT received as a response to the call to `app.bsky.contact.verifyPhone`.";
+                            readonly type: "string";
+                        };
+                        readonly contacts: {
+                            readonly description: "List of phone numbers in global E.164 format (e.g., '+12125550123'). Phone numbers that cannot be normalized into a valid phone number will be discarded. Should not repeat the 'phone' input used in `app.bsky.contact.verifyPhone`.";
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                            readonly minLength: 1;
+                            readonly maxLength: 1000;
+                        };
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["matchesAndContactIndexes"];
+                    readonly properties: {
+                        readonly matchesAndContactIndexes: {
+                            readonly description: "The users that matched during import and their indexes on the input contacts, so the client can correlate with its local list.";
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "ref";
+                                readonly ref: "lex:app.bsky.contact.defs#matchAndContactIndex";
+                            };
+                        };
+                    };
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.removeData";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {};
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {};
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.startPhoneVerification";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to `app.bsky.contact.verifyPhone`. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["phone"];
+                    readonly properties: {
+                        readonly phone: {
+                            readonly description: "The phone number to receive the code via SMS.";
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly properties: {};
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
+} | {
+    readonly lexicon: 1;
+    readonly id: "app.bsky.contact.verifyPhone";
+    readonly defs: {
+        readonly main: {
+            readonly type: "procedure";
+            readonly description: "WARNING: This is unstable and under active development, don't use it while this warning is here. Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.";
+            readonly input: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["phone", "code"];
+                    readonly properties: {
+                        readonly phone: {
+                            readonly description: "The phone number to verify. Should be the same as the one passed to `app.bsky.contact.startPhoneVerification`.";
+                            readonly type: "string";
+                        };
+                        readonly code: {
+                            readonly description: "The code received via SMS as a result of the call to `app.bsky.contact.startPhoneVerification`.";
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly output: {
+                readonly encoding: "application/json";
+                readonly schema: {
+                    readonly type: "object";
+                    readonly required: ["token"];
+                    readonly properties: {
+                        readonly token: {
+                            readonly description: "JWT to be used in a call to `app.bsky.contact.importContacts`. It is only valid for a single call.";
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+            readonly errors: [{
+                readonly name: "TODO";
+                readonly description: "TODO";
+            }];
+        };
+    };
 } | {
     readonly lexicon: 1;
     readonly id: "app.bsky.embed.defs";
@@ -17426,6 +18062,26 @@ export declare const schemas: ({
                     readonly format: "at-uri";
                     readonly description: "if the actor is followed by this DID, contains the AT-URI of the follow record";
                 };
+                readonly blocking: {
+                    readonly type: "string";
+                    readonly format: "at-uri";
+                    readonly description: "if the actor blocks this DID, this is the AT-URI of the block record";
+                };
+                readonly blockedBy: {
+                    readonly type: "string";
+                    readonly format: "at-uri";
+                    readonly description: "if the actor is blocked by this DID, contains the AT-URI of the block record";
+                };
+                readonly blockingByList: {
+                    readonly type: "string";
+                    readonly format: "at-uri";
+                    readonly description: "if the actor blocks this DID via a block list, this is the AT-URI of the listblock record";
+                };
+                readonly blockedByList: {
+                    readonly type: "string";
+                    readonly format: "at-uri";
+                    readonly description: "if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record";
+                };
             };
         };
     };
@@ -26444,6 +27100,14 @@ export declare const ids: {
     readonly AppBskyBookmarkDefs: "app.bsky.bookmark.defs";
     readonly AppBskyBookmarkDeleteBookmark: "app.bsky.bookmark.deleteBookmark";
     readonly AppBskyBookmarkGetBookmarks: "app.bsky.bookmark.getBookmarks";
+    readonly AppBskyContactDefs: "app.bsky.contact.defs";
+    readonly AppBskyContactDismissMatch: "app.bsky.contact.dismissMatch";
+    readonly AppBskyContactGetMatches: "app.bsky.contact.getMatches";
+    readonly AppBskyContactGetSyncStatus: "app.bsky.contact.getSyncStatus";
+    readonly AppBskyContactImportContacts: "app.bsky.contact.importContacts";
+    readonly AppBskyContactRemoveData: "app.bsky.contact.removeData";
+    readonly AppBskyContactStartPhoneVerification: "app.bsky.contact.startPhoneVerification";
+    readonly AppBskyContactVerifyPhone: "app.bsky.contact.verifyPhone";
     readonly AppBskyEmbedDefs: "app.bsky.embed.defs";
     readonly AppBskyEmbedExternal: "app.bsky.embed.external";
     readonly AppBskyEmbedImages: "app.bsky.embed.images";