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

libs/internal-sdk/src/react-query/activityRequestsList.ts
158 строк4 KB
Pawan Jain
refactor(api-service): validate flattened provider IDs fixes NV-8087 (#11611)
23 июн 2026, 07:40
23 июн 2026, 07:40043e6db
/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.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 { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  ActivityRequestsListQueryData,
  buildActivityRequestsListQuery,
  prefetchActivityRequestsList,
  queryKeyActivityRequestsList,
} from "./activityRequestsList.core.js";
export {
  type ActivityRequestsListQueryData,
  buildActivityRequestsListQuery,
  prefetchActivityRequestsList,
  queryKeyActivityRequestsList,
};

export type ActivityRequestsListQueryError =
  | NovuError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * List activity requests
 *
 * @remarks
 * Retrieve a list of activity requests with optional filtering and pagination.
 */
export function useActivityRequestsList(
  request: operations.ActivityControllerGetLogsRequest,
  options?: QueryHookOptions<
    ActivityRequestsListQueryData,
    ActivityRequestsListQueryError
  >,
): UseQueryResult<
  ActivityRequestsListQueryData,
  ActivityRequestsListQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildActivityRequestsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * List activity requests
 *
 * @remarks
 * Retrieve a list of activity requests with optional filtering and pagination.
 */
export function useActivityRequestsListSuspense(
  request: operations.ActivityControllerGetLogsRequest,
  options?: SuspenseQueryHookOptions<
    ActivityRequestsListQueryData,
    ActivityRequestsListQueryError
  >,
): UseSuspenseQueryResult<
  ActivityRequestsListQueryData,
  ActivityRequestsListQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildActivityRequestsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setActivityRequestsListData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      page?: number | undefined;
      limit?: number | undefined;
      statusCodes?: Array<number> | undefined;
      urlPattern?: string | undefined;
      transactionId?: string | undefined;
      createdGte?: number | undefined;
      source?: operations.Source | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: ActivityRequestsListQueryData,
): ActivityRequestsListQueryData | undefined {
  const key = queryKeyActivityRequestsList(...queryKeyBase);

  return client.setQueryData<ActivityRequestsListQueryData>(key, data);
}

export function invalidateActivityRequestsList(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [parameters: {
      page?: number | undefined;
      limit?: number | undefined;
      statusCodes?: Array<number> | undefined;
      urlPattern?: string | undefined;
      transactionId?: string | undefined;
      createdGte?: number | undefined;
      source?: operations.Source | undefined;
      idempotencyKey?: string | undefined;
    }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Requests", "list", ...queryKeyBase],
  });
}

export function invalidateAllActivityRequestsList(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Requests", "list"],
  });
}