@gleanwork/api-client 0.13.20 → 0.14.0

package/src/react-query/clientAnnouncementsCreate.ts

@@ -12,17 +12,38 @@ import { clientAnnouncementsCreate } from "../funcs/clientAnnouncementsCreate.js
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnnouncementsCreateMutationVariables = {
-  request: components.CreateAnnouncementRequest;
+  createAnnouncementRequest: components.CreateAnnouncementRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnnouncementsCreateMutationData = components.Announcement;
 
+export type ClientAnnouncementsCreateMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Create Announcement
  *
@@ -32,12 +53,12 @@ export type ClientAnnouncementsCreateMutationData = components.Announcement;
 export function useClientAnnouncementsCreateMutation(
   options?: MutationHookOptions<
     ClientAnnouncementsCreateMutationData,
-    Error,
+    ClientAnnouncementsCreateMutationError,
     ClientAnnouncementsCreateMutationVariables
   >,
 ): UseMutationResult<
   ClientAnnouncementsCreateMutationData,
-  Error,
+  ClientAnnouncementsCreateMutationError,
   ClientAnnouncementsCreateMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnnouncementsCreateMutation(
   return {
     mutationKey: mutationKeyClientAnnouncementsCreate(),
     mutationFn: function clientAnnouncementsCreateMutationFn({
-      request,
+      createAnnouncementRequest,
+      locale,
       options,
     }): Promise<ClientAnnouncementsCreateMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnnouncementsCreateMutation(
       };
       return unwrapAsync(clientAnnouncementsCreate(
         client$,
-        request,
+        createAnnouncementRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnnouncementsDelete.ts

@@ -12,17 +12,38 @@ import { clientAnnouncementsDelete } from "../funcs/clientAnnouncementsDelete.js
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnnouncementsDeleteMutationVariables = {
-  request: components.DeleteAnnouncementRequest;
+  deleteAnnouncementRequest: components.DeleteAnnouncementRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnnouncementsDeleteMutationData = void;
 
+export type ClientAnnouncementsDeleteMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Delete Announcement
  *
@@ -32,12 +53,12 @@ export type ClientAnnouncementsDeleteMutationData = void;
 export function useClientAnnouncementsDeleteMutation(
   options?: MutationHookOptions<
     ClientAnnouncementsDeleteMutationData,
-    Error,
+    ClientAnnouncementsDeleteMutationError,
     ClientAnnouncementsDeleteMutationVariables
   >,
 ): UseMutationResult<
   ClientAnnouncementsDeleteMutationData,
-  Error,
+  ClientAnnouncementsDeleteMutationError,
   ClientAnnouncementsDeleteMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnnouncementsDeleteMutation(
   return {
     mutationKey: mutationKeyClientAnnouncementsDelete(),
     mutationFn: function clientAnnouncementsDeleteMutationFn({
-      request,
+      deleteAnnouncementRequest,
+      locale,
       options,
     }): Promise<ClientAnnouncementsDeleteMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnnouncementsDeleteMutation(
       };
       return unwrapAsync(clientAnnouncementsDelete(
         client$,
-        request,
+        deleteAnnouncementRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnnouncementsUpdate.ts

@@ -12,17 +12,38 @@ import { clientAnnouncementsUpdate } from "../funcs/clientAnnouncementsUpdate.js
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnnouncementsUpdateMutationVariables = {
-  request: components.UpdateAnnouncementRequest;
+  updateAnnouncementRequest: components.UpdateAnnouncementRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnnouncementsUpdateMutationData = components.Announcement;
 
+export type ClientAnnouncementsUpdateMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Update Announcement
  *
@@ -32,12 +53,12 @@ export type ClientAnnouncementsUpdateMutationData = components.Announcement;
 export function useClientAnnouncementsUpdateMutation(
   options?: MutationHookOptions<
     ClientAnnouncementsUpdateMutationData,
-    Error,
+    ClientAnnouncementsUpdateMutationError,
     ClientAnnouncementsUpdateMutationVariables
   >,
 ): UseMutationResult<
   ClientAnnouncementsUpdateMutationData,
-  Error,
+  ClientAnnouncementsUpdateMutationError,
   ClientAnnouncementsUpdateMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnnouncementsUpdateMutation(
   return {
     mutationKey: mutationKeyClientAnnouncementsUpdate(),
     mutationFn: function clientAnnouncementsUpdateMutationFn({
-      request,
+      updateAnnouncementRequest,
+      locale,
       options,
     }): Promise<ClientAnnouncementsUpdateMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnnouncementsUpdateMutation(
       };
       return unwrapAsync(clientAnnouncementsUpdate(
         client$,
-        request,
+        updateAnnouncementRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnswersCreate.ts

@@ -12,17 +12,38 @@ import { clientAnswersCreate } from "../funcs/clientAnswersCreate.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnswersCreateMutationVariables = {
-  request: components.CreateAnswerRequest;
+  createAnswerRequest: components.CreateAnswerRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnswersCreateMutationData = components.Answer;
 
+export type ClientAnswersCreateMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Create Answer
  *
@@ -32,12 +53,12 @@ export type ClientAnswersCreateMutationData = components.Answer;
 export function useClientAnswersCreateMutation(
   options?: MutationHookOptions<
     ClientAnswersCreateMutationData,
-    Error,
+    ClientAnswersCreateMutationError,
     ClientAnswersCreateMutationVariables
   >,
 ): UseMutationResult<
   ClientAnswersCreateMutationData,
-  Error,
+  ClientAnswersCreateMutationError,
   ClientAnswersCreateMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnswersCreateMutation(
   return {
     mutationKey: mutationKeyClientAnswersCreate(),
     mutationFn: function clientAnswersCreateMutationFn({
-      request,
+      createAnswerRequest,
+      locale,
       options,
     }): Promise<ClientAnswersCreateMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnswersCreateMutation(
       };
       return unwrapAsync(clientAnswersCreate(
         client$,
-        request,
+        createAnswerRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnswersDelete.ts

@@ -12,17 +12,38 @@ import { clientAnswersDelete } from "../funcs/clientAnswersDelete.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnswersDeleteMutationVariables = {
-  request: components.DeleteAnswerRequest;
+  deleteAnswerRequest: components.DeleteAnswerRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnswersDeleteMutationData = void;
 
+export type ClientAnswersDeleteMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Delete Answer
  *
@@ -32,12 +53,12 @@ export type ClientAnswersDeleteMutationData = void;
 export function useClientAnswersDeleteMutation(
   options?: MutationHookOptions<
     ClientAnswersDeleteMutationData,
-    Error,
+    ClientAnswersDeleteMutationError,
     ClientAnswersDeleteMutationVariables
   >,
 ): UseMutationResult<
   ClientAnswersDeleteMutationData,
-  Error,
+  ClientAnswersDeleteMutationError,
   ClientAnswersDeleteMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnswersDeleteMutation(
   return {
     mutationKey: mutationKeyClientAnswersDelete(),
     mutationFn: function clientAnswersDeleteMutationFn({
-      request,
+      deleteAnswerRequest,
+      locale,
       options,
     }): Promise<ClientAnswersDeleteMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnswersDeleteMutation(
       };
       return unwrapAsync(clientAnswersDelete(
         client$,
-        request,
+        deleteAnswerRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnswersList.ts

@@ -12,34 +12,55 @@ import { clientAnswersList } from "../funcs/clientAnswersList.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnswersListMutationVariables = {
-  request: components.ListAnswersRequest;
+  listAnswersRequest: components.ListAnswersRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnswersListMutationData = components.ListAnswersResponse;
 
+export type ClientAnswersListMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * List Answers
  *
  * @remarks
  * List Answers created by the current user.
  *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ * @deprecated method: Deprecated on 2026-01-21, removal scheduled for 2026-10-15: Answer boards have been removed and this endpoint no longer serves a purpose.
  */
 export function useClientAnswersListMutation(
   options?: MutationHookOptions<
     ClientAnswersListMutationData,
-    Error,
+    ClientAnswersListMutationError,
     ClientAnswersListMutationVariables
   >,
 ): UseMutationResult<
   ClientAnswersListMutationData,
-  Error,
+  ClientAnswersListMutationError,
   ClientAnswersListMutationVariables
 > {
   const client = useGleanContext();
@@ -65,7 +86,8 @@ export function buildClientAnswersListMutation(
   return {
     mutationKey: mutationKeyClientAnswersList(),
     mutationFn: function clientAnswersListMutationFn({
-      request,
+      listAnswersRequest,
+      locale,
       options,
     }): Promise<ClientAnswersListMutationData> {
       const mergedOptions = {
@@ -82,7 +104,8 @@ export function buildClientAnswersListMutation(
       };
       return unwrapAsync(clientAnswersList(
         client$,
-        request,
+        listAnswersRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnswersRetrieve.ts

@@ -12,17 +12,38 @@ import { clientAnswersRetrieve } from "../funcs/clientAnswersRetrieve.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnswersRetrieveMutationVariables = {
-  request: components.GetAnswerRequest;
+  getAnswerRequest: components.GetAnswerRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnswersRetrieveMutationData = components.GetAnswerResponse;
 
+export type ClientAnswersRetrieveMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Read Answer
  *
@@ -32,12 +53,12 @@ export type ClientAnswersRetrieveMutationData = components.GetAnswerResponse;
 export function useClientAnswersRetrieveMutation(
   options?: MutationHookOptions<
     ClientAnswersRetrieveMutationData,
-    Error,
+    ClientAnswersRetrieveMutationError,
     ClientAnswersRetrieveMutationVariables
   >,
 ): UseMutationResult<
   ClientAnswersRetrieveMutationData,
-  Error,
+  ClientAnswersRetrieveMutationError,
   ClientAnswersRetrieveMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnswersRetrieveMutation(
   return {
     mutationKey: mutationKeyClientAnswersRetrieve(),
     mutationFn: function clientAnswersRetrieveMutationFn({
-      request,
+      getAnswerRequest,
+      locale,
       options,
     }): Promise<ClientAnswersRetrieveMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnswersRetrieveMutation(
       };
       return unwrapAsync(clientAnswersRetrieve(
         client$,
-        request,
+        getAnswerRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAnswersUpdate.ts

@@ -12,17 +12,38 @@ import { clientAnswersUpdate } from "../funcs/clientAnswersUpdate.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientAnswersUpdateMutationVariables = {
-  request: components.EditAnswerRequest;
+  editAnswerRequest: components.EditAnswerRequest;
+  locale?: string | undefined;
   options?: RequestOptions;
 };
 
 export type ClientAnswersUpdateMutationData = components.Answer;
 
+export type ClientAnswersUpdateMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Update Answer
  *
@@ -32,12 +53,12 @@ export type ClientAnswersUpdateMutationData = components.Answer;
 export function useClientAnswersUpdateMutation(
   options?: MutationHookOptions<
     ClientAnswersUpdateMutationData,
-    Error,
+    ClientAnswersUpdateMutationError,
     ClientAnswersUpdateMutationVariables
   >,
 ): UseMutationResult<
   ClientAnswersUpdateMutationData,
-  Error,
+  ClientAnswersUpdateMutationError,
   ClientAnswersUpdateMutationVariables
 > {
   const client = useGleanContext();
@@ -63,7 +84,8 @@ export function buildClientAnswersUpdateMutation(
   return {
     mutationKey: mutationKeyClientAnswersUpdate(),
     mutationFn: function clientAnswersUpdateMutationFn({
-      request,
+      editAnswerRequest,
+      locale,
       options,
     }): Promise<ClientAnswersUpdateMutationData> {
       const mergedOptions = {
@@ -80,7 +102,8 @@ export function buildClientAnswersUpdateMutation(
       };
       return unwrapAsync(clientAnswersUpdate(
         client$,
-        request,
+        editAnswerRequest,
+        locale,
         mergedOptions,
       ));
     },

package/src/react-query/clientAuthenticationCreateToken.ts

@@ -12,6 +12,16 @@ import { clientAuthenticationCreateToken } from "../funcs/clientAuthenticationCr
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
@@ -23,6 +33,16 @@ export type ClientAuthenticationCreateTokenMutationVariables = {
 export type ClientAuthenticationCreateTokenMutationData =
   components.CreateAuthTokenResponse;
 
+export type ClientAuthenticationCreateTokenMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
 /**
  * Create authentication token
  *
@@ -36,12 +56,12 @@ export type ClientAuthenticationCreateTokenMutationData =
 export function useClientAuthenticationCreateTokenMutation(
   options?: MutationHookOptions<
     ClientAuthenticationCreateTokenMutationData,
-    Error,
+    ClientAuthenticationCreateTokenMutationError,
     ClientAuthenticationCreateTokenMutationVariables
   >,
 ): UseMutationResult<
   ClientAuthenticationCreateTokenMutationData,
-  Error,
+  ClientAuthenticationCreateTokenMutationError,
   ClientAuthenticationCreateTokenMutationVariables
 > {
   const client = useGleanContext();