libs/internal-sdk/src/react-query/subscribersNotificationsArchive.ts - next - githubmirror/novu

libs/internal-sdk/src/react-query/subscribersNotificationsArchive.ts
112 строк3 KB
Dima Grossman
chore(root): sdk gen version update for latest internal sdk changes (#10651)
10 апр 2026, 16:36
10 апр 2026, 16:36b5e0674
/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { NovuCore } from "../core.js";
import { subscribersNotificationsArchive } from "../funcs/subscribersNotificationsArchive.js";
import { combineSignals } from "../lib/primitives.js";
import { RequestOptions } from "../lib/sdks.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { NovuError } from "../models/errors/novuerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { unwrapAsync } from "../types/fp.js";
import { useNovuContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type SubscribersNotificationsArchiveMutationVariables = {
  request: operations.SubscribersControllerArchiveNotificationRequest;
  options?: RequestOptions;
};

export type SubscribersNotificationsArchiveMutationData =
  operations.SubscribersControllerArchiveNotificationResponse;

export type SubscribersNotificationsArchiveMutationError =
  | errors.ErrorDto
  | errors.ValidationErrorDto
  | NovuError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Archive a notification
 *
 * @remarks
 * Archive a specific in-app (inbox) notification by its unique identifier **notificationId**.
 */
export function useSubscribersNotificationsArchiveMutation(
  options?: MutationHookOptions<
    SubscribersNotificationsArchiveMutationData,
    SubscribersNotificationsArchiveMutationError,
    SubscribersNotificationsArchiveMutationVariables
  >,
): UseMutationResult<
  SubscribersNotificationsArchiveMutationData,
  SubscribersNotificationsArchiveMutationError,
  SubscribersNotificationsArchiveMutationVariables
> {
  const client = useNovuContext();
  return useMutation({
    ...buildSubscribersNotificationsArchiveMutation(client, options),
    ...options,
  });
}

export function mutationKeySubscribersNotificationsArchive(): MutationKey {
  return ["@novu/api", "Notifications", "archive"];
}

export function buildSubscribersNotificationsArchiveMutation(
  client$: NovuCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: SubscribersNotificationsArchiveMutationVariables,
  ) => Promise<SubscribersNotificationsArchiveMutationData>;
} {
  return {
    mutationKey: mutationKeySubscribersNotificationsArchive(),
    mutationFn: function subscribersNotificationsArchiveMutationFn({
      request,
      options,
    }): Promise<SubscribersNotificationsArchiveMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(subscribersNotificationsArchive(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}