@sanity/client 8.4.0 → 8.6.0

package/dist/index.node.d.ts

@@ -1043,7 +1043,10 @@ type TranslateDocumentSync<T extends Record<string, Any> = Record<string, Any>>
 type TranslateDocumentAsync = TranslateRequestBase & AgentActionAsync;
 /** @beta */
 type TranslateDocument<T extends Record<string, Any> = Record<string, Any>> = TranslateDocumentSync<T> | TranslateDocumentAsync;
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableAgentsActionClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -1069,7 +1072,10 @@ declare class ObservableAgentsActionClient {
     _id: string;
   } : IdentifiedSanityDocumentStub & DocumentShape>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class AgentActionsClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -1108,7 +1114,10 @@ declare class AgentActionsClient {
     _id: string;
   } : IdentifiedSanityDocumentStub & DocumentShape>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableAssetsClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -1143,7 +1152,10 @@ declare class ObservableAssetsClient {
     document: SanityAssetDocument | SanityImageAssetDocument;
   }>>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class AssetsClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -2189,7 +2201,7 @@ interface paths {
     get?: never;
     /**
      * Record a conversation
-     * @description Upserts the conversation telemetry for one thread. `threadId` identifies the conversation within your organization — reuse means the same conversation. Messages replace the stored transcript wholesale; `metadata` and model fields only overwrite when present. Last write per thread wins — retries are safe.
+     * @description Upserts the conversation telemetry for one thread. `threadId` identifies the conversation within your organization — reuse means the same conversation. Messages replace the stored transcript wholesale; `metadata`, `sharing`, and model fields only overwrite when present. Last write per thread wins — retries are safe. `sharing` records your opt-in to share telemetry with Sanity: metadata-only metrics, or full transcripts.
      */
     put: operations['saveConversation'];
     post?: never;
@@ -2259,6 +2271,15 @@ interface components {
       /** Format: date-time */
       classifiedAt: string | null;
       classificationError: string | null;
+      /**
+       * @description ConversationSharing
+       * @default null
+       */
+      sharing: {
+        metrics?: boolean;
+        conversations?: boolean;
+        contact?: string;
+      } | null;
     };
     /** @description A `sanity.context.entry` document, one outline node stored in the bound dataset. Not returned by any endpoint; published so GROQ reads against the dataset can be typed. The entries endpoints serve the validated wire view. */
     EntryDoc: {
@@ -2614,6 +2635,11 @@ interface operations {
               refreshInFlight: boolean;
               openIssueCount: number;
               instructionCount: number;
+              /** @description Actor */
+              createdBy: {
+                id: string | null;
+                displayName: string | null;
+              } | null;
               /** Format: date-time */
               createdAt: string;
               /** Format: date-time */
@@ -2706,6 +2732,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -2788,6 +2819,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -2902,6 +2938,11 @@ interface operations {
             refreshInFlight: boolean;
             openIssueCount: number;
             instructionCount: number;
+            /** @description Actor */
+            createdBy: {
+              id: string | null;
+              displayName: string | null;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -3915,6 +3956,12 @@ interface operations {
           metadata?: {
             [key: string]: string | string[];
           };
+          /** @description ConversationSharing */
+          sharing?: {
+            metrics?: boolean;
+            conversations?: boolean;
+            contact?: string;
+          };
         };
       };
     };
@@ -3967,6 +4014,12 @@ interface operations {
             /** Format: date-time */
             classifiedAt: string | null;
             classificationError: string | null;
+            /** @description ConversationSharing */
+            sharing: {
+              metrics?: boolean;
+              conversations?: boolean;
+              contact?: string;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -4048,6 +4101,12 @@ interface operations {
             /** Format: date-time */
             classifiedAt: string | null;
             classificationError: string | null;
+            /** @description ConversationSharing */
+            sharing: {
+              metrics?: boolean;
+              conversations?: boolean;
+              contact?: string;
+            } | null;
             /** Format: date-time */
             createdAt: string;
             /** Format: date-time */
@@ -4957,6 +5016,7 @@ declare class ObservableContextClient {
 }
 /**
  * @public
+ * @inline
  */
 declare class LiveClient {
   #private;
@@ -5334,7 +5394,10 @@ declare class ObservableTransaction extends BaseTransaction {
    */
   patch(patch: ObservablePatch): this;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableDatasetsClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -5378,7 +5441,10 @@ declare class ObservableDatasetsClient {
    */
   editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Observable<void>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class DatasetsClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -5518,7 +5584,10 @@ declare class FunctionsClient {
   }): Promise<R>;
   invoke<R = unknown>(functionName: string, request?: InvokeFunctionRequest, options?: InvokeFunctionOptions): Promise<R | undefined>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableMediaLibraryVideoClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -5530,7 +5599,10 @@ declare class ObservableMediaLibraryVideoClient {
    */
   getPlaybackInfo(assetIdentifier: MediaLibraryAssetInstanceIdentifier, options?: MediaLibraryPlaybackInfoOptions): Observable<VideoPlaybackInfo>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class MediaLibraryVideoClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -5553,7 +5625,10 @@ type OmittedProjectFields<T extends ListOptions | undefined> = (T extends {
 } ? 'members' : never) | (T extends {
   includeFeatures: false;
 } ? 'features' : never);
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ObservableProjectsClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -5574,7 +5649,10 @@ declare class ObservableProjectsClient {
    */
   getById(projectId: string): Observable<SanityProject>;
 }
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 declare class ProjectsClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -5595,7 +5673,10 @@ declare class ProjectsClient {
    */
   getById(projectId: string): Promise<SanityProject>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableReleasesClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -5840,7 +5921,10 @@ declare class ObservableReleasesClient {
     releaseId: string;
   }, options?: BaseMutationOptions): Observable<RawQueryResponse<SanityDocument[]>>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ReleasesClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -6076,7 +6160,10 @@ declare class ReleasesClient {
     releaseId: string;
   }, options?: BaseMutationOptions): Promise<RawQueryResponse<SanityDocument[]>>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class ObservableUsersClient {
   #private;
   constructor(client: ObservableSanityClient, httpRequest: HttpRequest);
@@ -6087,7 +6174,10 @@ declare class ObservableUsersClient {
    */
   getById<T extends string>(id: T): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>;
 }
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 declare class UsersClient {
   #private;
   constructor(client: SanityClient, httpRequest: HttpRequest);
@@ -6101,15 +6191,52 @@ declare class UsersClient {
 /** @public */
 declare class ObservableSanityClient {
   #private;
+  /**
+   * Upload, fetch and delete assets (images and files) in the configured dataset
+   *
+   * @category Assets
+   */
   assets: ObservableAssetsClient;
+  /**
+   * Create, list, edit and delete datasets in the configured project
+   *
+   * @category Projects & Datasets
+   */
   datasets: ObservableDatasetsClient;
+  /**
+   * Subscribe to live content updates through the Live Content API
+   *
+   * @category Real-time
+   */
   live: LiveClient;
+  /**
+   * Interact with Media Library assets
+   *
+   * @category Assets
+   */
   mediaLibrary: {
+    /** Upload and manage Media Library video assets */
     video: ObservableMediaLibraryVideoClient;
   };
+  /**
+   * Fetch information about the projects the authenticated user has access to
+   *
+   * @category Projects & Datasets
+   */
   projects: ObservableProjectsClient;
+  /**
+   * Fetch information about users in the configured project
+   *
+   * @category Projects & Datasets
+   */
   users: ObservableUsersClient;
+  /**
+   * Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+   *
+   * @category Agent Actions
+   */
   agent: {
+    /** Run individual Agent Action operations */
     action: ObservableAgentsActionClient;
   };
   collaboration: {
@@ -6117,20 +6244,31 @@ declare class ObservableSanityClient {
     comments: ObservableCollaborationCommentsClient;
   };
   functions: ObservableFunctionsClient;
+  /**
+   * Create and manage content releases and their scheduled publishing
+   *
+   * @category Releases
+   */
   releases: ObservableReleasesClient;
   /** @beta */
   context: ObservableContextClient;
   /**
-   * Instance properties
+   * Listen to document changes matching a GROQ query, delivered as server-sent events
+   *
+   * @category Real-time
    */
   listen: typeof _listen;
   constructor(httpRequest: HttpRequest, config?: ClientConfig);
   /**
    * Clone the client - returns a new instance
+   *
+   * @category Configuration
    */
   clone(): ObservableSanityClient;
   /**
    * Returns the current client configuration
+   *
+   * @category Configuration
    */
   config(): InitializedClientConfig;
   /**
@@ -6140,12 +6278,16 @@ declare class ObservableSanityClient {
   /**
    * Clone the client with a new (partial) configuration.
    *
+   * @category Configuration
+   *
    * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig>): ObservableSanityClient;
   /**
    * Perform a GROQ-query against the configured dataset.
    *
+   * @category Querying
+   *
    * @param query - GROQ-query to perform
    */
   fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams, const G extends string = string>(query: G, params?: Q | QueryWithoutParams): Observable<ClientReturn<G, R>>;
@@ -6176,6 +6318,8 @@ declare class ObservableSanityClient {
   /**
    * Fetch a single document with the given ID.
    *
+   * @category Querying
+   *
    * @param id - Document ID to fetch
    * @param options - Request options
    */
@@ -6203,6 +6347,8 @@ declare class ObservableSanityClient {
    * The order/position of documents is preserved based on the original array of IDs.
    * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to fetch
    * @param options - Request options
    */
@@ -6213,6 +6359,8 @@ declare class ObservableSanityClient {
    * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
    * Returns a set of the IDs that exist.
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to check
    * @param options - Request options
    */
@@ -6224,6 +6372,8 @@ declare class ObservableSanityClient {
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6264,6 +6414,8 @@ declare class ObservableSanityClient {
    * Create a document if no document with the same ID already exists.
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6304,6 +6456,8 @@ declare class ObservableSanityClient {
    * Create a document if it does not exist, or replace a document with the same document ID
    * Returns an observable that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to either create or replace
    * @param options - Mutation options
    */
@@ -6428,6 +6582,8 @@ declare class ObservableSanityClient {
    * Deletes a document with the given document ID.
    * Returns an observable that resolves to the deleted document.
    *
+   * @category Mutations
+   *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
@@ -6513,6 +6669,8 @@ declare class ObservableSanityClient {
    * * Discarding a version with no `releaseId` will discard the draft version of the published document.
    * * If the draft or release version does not exist, any error will throw.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to discard the document from.
    *   - `publishedId` - The published ID of the document to discard.
@@ -6548,6 +6706,8 @@ declare class ObservableSanityClient {
    * * Replacing a version with no `releaseId` will replace the draft version of the published document.
    * * At least one of the **version** or **published** documents must exist.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `document` - The new document to replace the version with.
    *   - `releaseId` - The ID of the release where the document version is replaced.
@@ -6620,6 +6780,8 @@ declare class ObservableSanityClient {
    * @remarks
    * * If the published document does not exist, an error will be thrown.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to unpublish the document from.
    *   - `publishedId` - The published ID of the document to unpublish.
@@ -6640,6 +6802,8 @@ declare class ObservableSanityClient {
    * Perform mutation operations against the configured dataset
    * Returns an observable that resolves to the first mutated document.
    *
+   * @category Mutations
+   *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
    */
@@ -6679,6 +6843,8 @@ declare class ObservableSanityClient {
   /**
    * Create a new buildable patch of operations to perform
    *
+   * @category Mutations
+   *
    * @param documentId - Document ID to patch
    * @param operations - Optional object of patch operations to initialize the patch instance with
    * @returns Patch instance - call `.commit()` to perform the operations defined
@@ -6703,12 +6869,16 @@ declare class ObservableSanityClient {
   /**
    * Create a new transaction of mutations
    *
+   * @category Mutations
+   *
    * @param operations - Optional array of mutation operations to initialize the transaction instance with
    */
   transaction<R extends Record<string, Any> = Record<string, Any>>(operations?: Mutation<R>[]): ObservableTransaction;
   /**
    * Perform action operations against the configured dataset
    *
+   * @category Mutations
+   *
    * @param operations - Action operation(s) to execute
    * @param options - Action options
    */
@@ -6716,12 +6886,16 @@ declare class ObservableSanityClient {
   /**
    * Perform an HTTP request against the Sanity API
    *
+   * @category HTTP
+   *
    * @param options - Request options
    */
   request<R = Any>(options: RawRequestOptions): Observable<R>;
   /**
    * Get a Sanity API URL for the URI provided
    *
+   * @category HTTP
+   *
    * @param uri - URI/path to build URL for
    * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
@@ -6729,6 +6903,8 @@ declare class ObservableSanityClient {
   /**
    * Get a Sanity API URL for the data operation and path provided
    *
+   * @category HTTP
+   *
    * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
    * @param path - Path to append after the operation
    */
@@ -6737,15 +6913,52 @@ declare class ObservableSanityClient {
 /** @public */
 declare class SanityClient {
   #private;
+  /**
+   * Upload, fetch and delete assets (images and files) in the configured dataset
+   *
+   * @category Assets
+   */
   assets: AssetsClient;
+  /**
+   * Create, list, edit and delete datasets in the configured project
+   *
+   * @category Projects & Datasets
+   */
   datasets: DatasetsClient;
+  /**
+   * Subscribe to live content updates through the Live Content API
+   *
+   * @category Real-time
+   */
   live: LiveClient;
+  /**
+   * Interact with Media Library assets
+   *
+   * @category Assets
+   */
   mediaLibrary: {
+    /** Upload and manage Media Library video assets */
     video: MediaLibraryVideoClient;
   };
+  /**
+   * Fetch information about the projects the authenticated user has access to
+   *
+   * @category Projects & Datasets
+   */
   projects: ProjectsClient;
+  /**
+   * Fetch information about users in the configured project
+   *
+   * @category Projects & Datasets
+   */
   users: UsersClient;
+  /**
+   * Run Agent Actions - AI-powered operations to generate, transform, translate, prompt and patch documents
+   *
+   * @category Agent Actions
+   */
   agent: {
+    /** Run individual Agent Action operations */
     action: AgentActionsClient;
   };
   collaboration: {
@@ -6753,24 +6966,37 @@ declare class SanityClient {
     comments: CollaborationCommentsClient;
   };
   functions: FunctionsClient;
+  /**
+   * Create and manage content releases and their scheduled publishing
+   *
+   * @category Releases
+   */
   releases: ReleasesClient;
   /** @beta */
   context: ContextClient;
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
+   *
+   * @category Configuration
    */
   observable: ObservableSanityClient;
   /**
-   * Instance properties
+   * Listen to document changes matching a GROQ query, delivered as server-sent events
+   *
+   * @category Real-time
    */
   listen: typeof _listen;
   constructor(httpRequest: HttpRequest, config?: ClientConfig);
   /**
    * Clone the client - returns a new instance
+   *
+   * @category Configuration
    */
   clone(): SanityClient;
   /**
    * Returns the current client configuration
+   *
+   * @category Configuration
    */
   config(): InitializedClientConfig;
   /**
@@ -6780,12 +7006,16 @@ declare class SanityClient {
   /**
    * Clone the client with a new (partial) configuration.
    *
+   * @category Configuration
+   *
    * @param newConfig - New client configuration properties, shallowly merged with existing configuration
    */
   withConfig(newConfig?: Partial<ClientConfig>): SanityClient;
   /**
    * Perform a GROQ-query against the configured dataset.
    *
+   * @category Querying
+   *
    * @param query - GROQ-query to perform
    */
   fetch<R = Any, Q extends QueryWithoutParams = QueryWithoutParams, const G extends string = string>(query: G, params?: Q | QueryWithoutParams): Promise<ClientReturn<G, R>>;
@@ -6816,6 +7046,8 @@ declare class SanityClient {
   /**
    * Fetch a single document with the given ID.
    *
+   * @category Querying
+   *
    * @param id - Document ID to fetch
    * @param options - Request options
    */
@@ -6843,6 +7075,8 @@ declare class SanityClient {
    * The order/position of documents is preserved based on the original array of IDs.
    * If any of the documents are missing, they will be replaced by a `null` entry in the returned array
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to fetch
    * @param options - Request options
    */
@@ -6854,6 +7088,8 @@ declare class SanityClient {
    * Convenient and bandwidth efficient method of checking wether a set of document IDs exists.
    * Returns a set of the IDs that exist.
    *
+   * @category Querying
+   *
    * @param ids - Document IDs to check
    * @param options - Request options
    */
@@ -6865,6 +7101,8 @@ declare class SanityClient {
    * Create a document. Requires a `_type` property. If no `_id` is provided, it will be generated by the database.
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6905,6 +7143,8 @@ declare class SanityClient {
    * Create a document if no document with the same ID already exists.
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to create
    * @param options - Mutation options
    */
@@ -6945,6 +7185,8 @@ declare class SanityClient {
    * Create a document if it does not exist, or replace a document with the same document ID
    * Returns a promise that resolves to the created document.
    *
+   * @category Mutations
+   *
    * @param document - Document to either create or replace
    * @param options - Mutation options
    */
@@ -7057,6 +7299,8 @@ declare class SanityClient {
    * Deletes a document with the given document ID.
    * Returns a promise that resolves to the deleted document.
    *
+   * @category Mutations
+   *
    * @param id - Document ID to delete
    * @param options - Options for the mutation
    */
@@ -7142,6 +7386,8 @@ declare class SanityClient {
    * * Discarding a version with no `releaseId` will discard the draft version of the published document.
    * * If the draft or release version does not exist, any error will throw.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to discard the document from.
    *   - `publishedId` - The published ID of the document to discard.
@@ -7177,6 +7423,8 @@ declare class SanityClient {
    * * Replacing a version with no `releaseId` will replace the draft version of the published document.
    * * At least one of the **version** or **published** documents must exist.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `document` - The new document to replace the version with.
    *   - `releaseId` - The ID of the release where the document version is replaced.
@@ -7249,6 +7497,8 @@ declare class SanityClient {
    * @remarks
    * * If the published document does not exist, an error will be thrown.
    *
+   * @category Versions
+   *
    * @param params - Version action parameters:
    *   - `releaseId` - The ID of the release to unpublish the document from.
    *   - `publishedId` - The published ID of the document to unpublish.
@@ -7269,6 +7519,8 @@ declare class SanityClient {
    * Perform mutation operations against the configured dataset
    * Returns a promise that resolves to the first mutated document.
    *
+   * @category Mutations
+   *
    * @param operations - Mutation operations to execute
    * @param options - Mutation options
    */
@@ -7308,6 +7560,8 @@ declare class SanityClient {
   /**
    * Create a new buildable patch of operations to perform
    *
+   * @category Mutations
+   *
    * @param documentId - Document ID to patch
    * @param operations - Optional object of patch operations to initialize the patch instance with
    * @returns Patch instance - call `.commit()` to perform the operations defined
@@ -7332,6 +7586,8 @@ declare class SanityClient {
   /**
    * Create a new transaction of mutations
    *
+   * @category Mutations
+   *
    * @param operations - Optional array of mutation operations to initialize the transaction instance with
    */
   transaction<R extends Record<string, Any> = Record<string, Any>>(operations?: Mutation<R>[]): Transaction;
@@ -7339,6 +7595,8 @@ declare class SanityClient {
    * Perform action operations against the configured dataset
    * Returns a promise that resolves to the transaction result
    *
+   * @category Mutations
+   *
    * @param operations - Action operation(s) to execute
    * @param options - Action options
    */
@@ -7347,6 +7605,8 @@ declare class SanityClient {
    * Perform a request against the Sanity API
    * NOTE: Only use this for Sanity API endpoints, not for your own APIs!
    *
+   * @category HTTP
+   *
    * @param options - Request options
    * @returns Promise resolving to the response body
    */
@@ -7365,6 +7625,8 @@ declare class SanityClient {
   /**
    * Get a Sanity API URL for the URI provided
    *
+   * @category HTTP
+   *
    * @param uri - URI/path to build URL for
    * @param canUseCdn - Whether or not to allow using the API CDN for this route
    */
@@ -7372,6 +7634,8 @@ declare class SanityClient {
   /**
    * Get a Sanity API URL for the data operation and path provided
    *
+   * @category HTTP
+   *
    * @param operation - Data operation (eg `query`, `mutate`, `listen` or similar)
    * @param path - Path to append after the operation
    */
@@ -8170,7 +8434,7 @@ type DatasetAclMode = 'public' | 'private' | 'custom';
 /** @public */
 type DatasetCreateOptions = {
   aclMode?: DatasetAclMode;
-  description?: string;
+  description?: string | null;
   embeddings?: {
     enabled: boolean;
     projection?: string;
@@ -8179,7 +8443,7 @@ type DatasetCreateOptions = {
 /** @public */
 type DatasetEditOptions = {
   aclMode?: DatasetAclMode;
-  description?: string;
+  description?: string | null;
 };
 /** @public */
 type EmbeddingsSettings = {
@@ -8196,13 +8460,13 @@ type EmbeddingsSettingsBody = {
 type DatasetResponse = {
   datasetName: string;
   aclMode: DatasetAclMode;
-  description: string;
+  description: string | null;
 };
 /** @public */
 type DatasetsResponse = {
   name: string;
   aclMode: DatasetAclMode;
-  description: string;
+  description?: string;
   createdAt: string;
   createdByUserId: string;
   addonFor: string | null;
@@ -9578,8 +9842,46 @@ interface LiveEventGoAway {
 }
 /** @public */
 type LiveEvent = LiveEventRestart | LiveEventReconnect | LiveEventMessage | LiveEventWelcome | LiveEventGoAway;
-/** @public */
-interface SanityQueries {}
+declare global {
+  /**
+   * Query result types, keyed by GROQ query string. Empty by default, `sanity typegen` registers
+   * the queries it finds:
+   * ```ts
+   * declare global {
+   *   interface SanityQueries {
+   *     '*[_type == "post"]': PostsQueryResult
+   *   }
+   * }
+   * ```
+   * `client.fetch(query)` and `ClientReturn<typeof query>` then resolve to the registered type.
+   *
+   * The registry is a global rather than a module augmentation of `@sanity/client` so that it
+   * does not depend on module resolution: it resolves the same whether `@sanity/client` is a
+   * direct dependency, how many copies of it are installed, and from every subpath export.
+   */
+  interface SanityQueries {}
+}
+/**
+ * The query registry as seen from `@sanity/client`. Inherits every query registered on the global
+ * `SanityQueries` interface, and still accepts the older module augmentation form:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries {
+ *     '*[_type == "post"]': PostsQueryResult
+ *   }
+ * }
+ * ```
+ * `@sanity/client` releases that predate the global registry only read this interface, so a
+ * generated file that registers queries globally can bridge them with an augmentation that adds
+ * the global as a base type. It is harmless on releases that already inherit it:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries extends globalThis.SanityQueries {}
+ * }
+ * ```
+ * @public
+ */
+interface SanityQueries extends globalThis.SanityQueries {}
 /** @public */
 type ClientReturn<GroqString extends string, Fallback = Any> = GroqString extends keyof SanityQueries ? SanityQueries[GroqString] : Fallback;
 /**