@novu/api 0.3.0 → 2.6.6

package/src/react-query/workflowsGetStepData.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsGetStepData } from "../funcs/workflowsGetStepData.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type WorkflowsGetStepDataQueryData =
+  operations.WorkflowControllerGetWorkflowStepDataResponse;
+
+export function useWorkflowsGetStepData(
+  workflowId: string,
+  stepId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<WorkflowsGetStepDataQueryData>,
+): UseQueryResult<WorkflowsGetStepDataQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildWorkflowsGetStepDataQuery(
+      client,
+      workflowId,
+      stepId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function useWorkflowsGetStepDataSuspense(
+  workflowId: string,
+  stepId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<WorkflowsGetStepDataQueryData>,
+): UseSuspenseQueryResult<WorkflowsGetStepDataQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildWorkflowsGetStepDataQuery(
+      client,
+      workflowId,
+      stepId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchWorkflowsGetStepData(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  workflowId: string,
+  stepId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildWorkflowsGetStepDataQuery(
+      client$,
+      workflowId,
+      stepId,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setWorkflowsGetStepDataData(
+  client: QueryClient,
+  queryKeyBase: [
+    workflowId: string,
+    stepId: string,
+    parameters: { idempotencyKey?: string | undefined },
+  ],
+  data: WorkflowsGetStepDataQueryData,
+): WorkflowsGetStepDataQueryData | undefined {
+  const key = queryKeyWorkflowsGetStepData(...queryKeyBase);
+
+  return client.setQueryData<WorkflowsGetStepDataQueryData>(key, data);
+}
+
+export function invalidateWorkflowsGetStepData(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      workflowId: string,
+      stepId: string,
+      parameters: { idempotencyKey?: string | undefined },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Workflows", "getStepData", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllWorkflowsGetStepData(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Workflows", "getStepData"],
+  });
+}
+
+export function buildWorkflowsGetStepDataQuery(
+  client$: NovuCore,
+  workflowId: string,
+  stepId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<WorkflowsGetStepDataQueryData>;
+} {
+  return {
+    queryKey: queryKeyWorkflowsGetStepData(workflowId, stepId, {
+      idempotencyKey,
+    }),
+    queryFn: async function workflowsGetStepDataQueryFn(
+      ctx,
+    ): Promise<WorkflowsGetStepDataQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(workflowsGetStepData(
+        client$,
+        workflowId,
+        stepId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyWorkflowsGetStepData(
+  workflowId: string,
+  stepId: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return [
+    "@novu/api",
+    "Workflows",
+    "getStepData",
+    workflowId,
+    stepId,
+    parameters,
+  ];
+}

package/src/react-query/workflowsGetWorkflowTestData.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsGetWorkflowTestData } from "../funcs/workflowsGetWorkflowTestData.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type WorkflowsGetWorkflowTestDataQueryData =
+  operations.WorkflowControllerGetWorkflowTestDataResponse;
+
+export function useWorkflowsGetWorkflowTestData(
+  workflowId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<WorkflowsGetWorkflowTestDataQueryData>,
+): UseQueryResult<WorkflowsGetWorkflowTestDataQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildWorkflowsGetWorkflowTestDataQuery(
+      client,
+      workflowId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function useWorkflowsGetWorkflowTestDataSuspense(
+  workflowId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<WorkflowsGetWorkflowTestDataQueryData>,
+): UseSuspenseQueryResult<WorkflowsGetWorkflowTestDataQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildWorkflowsGetWorkflowTestDataQuery(
+      client,
+      workflowId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchWorkflowsGetWorkflowTestData(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  workflowId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildWorkflowsGetWorkflowTestDataQuery(
+      client$,
+      workflowId,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setWorkflowsGetWorkflowTestDataData(
+  client: QueryClient,
+  queryKeyBase: [
+    workflowId: string,
+    parameters: { idempotencyKey?: string | undefined },
+  ],
+  data: WorkflowsGetWorkflowTestDataQueryData,
+): WorkflowsGetWorkflowTestDataQueryData | undefined {
+  const key = queryKeyWorkflowsGetWorkflowTestData(...queryKeyBase);
+
+  return client.setQueryData<WorkflowsGetWorkflowTestDataQueryData>(key, data);
+}
+
+export function invalidateWorkflowsGetWorkflowTestData(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [workflowId: string, parameters: { idempotencyKey?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@novu/api",
+      "Workflows",
+      "getWorkflowTestData",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllWorkflowsGetWorkflowTestData(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Workflows", "getWorkflowTestData"],
+  });
+}
+
+export function buildWorkflowsGetWorkflowTestDataQuery(
+  client$: NovuCore,
+  workflowId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<WorkflowsGetWorkflowTestDataQueryData>;
+} {
+  return {
+    queryKey: queryKeyWorkflowsGetWorkflowTestData(workflowId, {
+      idempotencyKey,
+    }),
+    queryFn: async function workflowsGetWorkflowTestDataQueryFn(
+      ctx,
+    ): Promise<WorkflowsGetWorkflowTestDataQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(workflowsGetWorkflowTestData(
+        client$,
+        workflowId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyWorkflowsGetWorkflowTestData(
+  workflowId: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return [
+    "@novu/api",
+    "Workflows",
+    "getWorkflowTestData",
+    workflowId,
+    parameters,
+  ];
+}

package/src/react-query/workflowsRetrieve.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsRetrieve } from "../funcs/workflowsRetrieve.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type WorkflowsRetrieveQueryData =
+  operations.WorkflowControllerGetWorkflowResponse;
+
+export function useWorkflowsRetrieve(
+  workflowId: string,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<WorkflowsRetrieveQueryData>,
+): UseQueryResult<WorkflowsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildWorkflowsRetrieveQuery(
+      client,
+      workflowId,
+      environmentId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function useWorkflowsRetrieveSuspense(
+  workflowId: string,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<WorkflowsRetrieveQueryData>,
+): UseSuspenseQueryResult<WorkflowsRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildWorkflowsRetrieveQuery(
+      client,
+      workflowId,
+      environmentId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchWorkflowsRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  workflowId: string,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildWorkflowsRetrieveQuery(
+      client$,
+      workflowId,
+      environmentId,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setWorkflowsRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [
+    workflowId: string,
+    parameters: { environmentId: string; idempotencyKey?: string | undefined },
+  ],
+  data: WorkflowsRetrieveQueryData,
+): WorkflowsRetrieveQueryData | undefined {
+  const key = queryKeyWorkflowsRetrieve(...queryKeyBase);
+
+  return client.setQueryData<WorkflowsRetrieveQueryData>(key, data);
+}
+
+export function invalidateWorkflowsRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      workflowId: string,
+      parameters: {
+        environmentId: string;
+        idempotencyKey?: string | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Workflows", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllWorkflowsRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Workflows", "retrieve"],
+  });
+}
+
+export function buildWorkflowsRetrieveQuery(
+  client$: NovuCore,
+  workflowId: string,
+  environmentId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<WorkflowsRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyWorkflowsRetrieve(workflowId, {
+      environmentId,
+      idempotencyKey,
+    }),
+    queryFn: async function workflowsRetrieveQueryFn(
+      ctx,
+    ): Promise<WorkflowsRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(workflowsRetrieve(
+        client$,
+        workflowId,
+        environmentId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyWorkflowsRetrieve(
+  workflowId: string,
+  parameters: { environmentId: string; idempotencyKey?: string | undefined },
+): QueryKey {
+  return ["@novu/api", "Workflows", "retrieve", workflowId, parameters];
+}

package/src/react-query/workflowsUpdate.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsUpdate } from "../funcs/workflowsUpdate.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 WorkflowsUpdateMutationVariables = {
+  workflowId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type WorkflowsUpdateMutationData =
+  operations.WorkflowControllerUpdateResponse;
+
+export function useWorkflowsUpdateMutation(
+  options?: MutationHookOptions<
+    WorkflowsUpdateMutationData,
+    Error,
+    WorkflowsUpdateMutationVariables
+  >,
+): UseMutationResult<
+  WorkflowsUpdateMutationData,
+  Error,
+  WorkflowsUpdateMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildWorkflowsUpdateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyWorkflowsUpdate(): MutationKey {
+  return ["@novu/api", "Workflows", "update"];
+}
+
+export function buildWorkflowsUpdateMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: WorkflowsUpdateMutationVariables,
+  ) => Promise<WorkflowsUpdateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyWorkflowsUpdate(),
+    mutationFn: function workflowsUpdateMutationFn({
+      workflowId,
+      idempotencyKey,
+      options,
+    }): Promise<WorkflowsUpdateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(workflowsUpdate(
+        client$,
+        workflowId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/workflowsWorkflowControllerGeneratePreview.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { workflowsWorkflowControllerGeneratePreview } from "../funcs/workflowsWorkflowControllerGeneratePreview.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 WorkflowsWorkflowControllerGeneratePreviewMutationVariables = {
+  workflowId: string;
+  stepId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type WorkflowsWorkflowControllerGeneratePreviewMutationData =
+  operations.WorkflowControllerGeneratePreviewResponse;
+
+export function useWorkflowsWorkflowControllerGeneratePreviewMutation(
+  options?: MutationHookOptions<
+    WorkflowsWorkflowControllerGeneratePreviewMutationData,
+    Error,
+    WorkflowsWorkflowControllerGeneratePreviewMutationVariables
+  >,
+): UseMutationResult<
+  WorkflowsWorkflowControllerGeneratePreviewMutationData,
+  Error,
+  WorkflowsWorkflowControllerGeneratePreviewMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildWorkflowsWorkflowControllerGeneratePreviewMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyWorkflowsWorkflowControllerGeneratePreview(): MutationKey {
+  return ["@novu/api", "Workflows", "workflowControllerGeneratePreview"];
+}
+
+export function buildWorkflowsWorkflowControllerGeneratePreviewMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: WorkflowsWorkflowControllerGeneratePreviewMutationVariables,
+  ) => Promise<WorkflowsWorkflowControllerGeneratePreviewMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyWorkflowsWorkflowControllerGeneratePreview(),
+    mutationFn: function workflowsWorkflowControllerGeneratePreviewMutationFn({
+      workflowId,
+      stepId,
+      idempotencyKey,
+      options,
+    }): Promise<WorkflowsWorkflowControllerGeneratePreviewMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(workflowsWorkflowControllerGeneratePreview(
+        client$,
+        workflowId,
+        stepId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}