@greensecurity/javascript-sdk 0.15.1 → 0.17.0

package/src/react-query/supportArticlesGetSupportArticle.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { supportArticlesGetSupportArticle } from "../funcs/supportArticlesGetSupportArticle.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type SupportArticlesGetSupportArticleQueryData =
+  components.SupportArticle;
+
+/**
+ * Get support article
+ *
+ * @remarks
+ * Retrieve an individual support article.
+ *
+ * Available `expand` scopes are:
+ *
+ * - support_article.description
+ * - support_article.published
+ * - support_article.notes
+ * - support_article.support_category
+ */
+export function useSupportArticlesGetSupportArticle(
+  request: operations.GetSupportArticleRequest,
+  options?: QueryHookOptions<SupportArticlesGetSupportArticleQueryData>,
+): UseQueryResult<SupportArticlesGetSupportArticleQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildSupportArticlesGetSupportArticleQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get support article
+ *
+ * @remarks
+ * Retrieve an individual support article.
+ *
+ * Available `expand` scopes are:
+ *
+ * - support_article.description
+ * - support_article.published
+ * - support_article.notes
+ * - support_article.support_category
+ */
+export function useSupportArticlesGetSupportArticleSuspense(
+  request: operations.GetSupportArticleRequest,
+  options?: SuspenseQueryHookOptions<SupportArticlesGetSupportArticleQueryData>,
+): UseSuspenseQueryResult<SupportArticlesGetSupportArticleQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildSupportArticlesGetSupportArticleQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchSupportArticlesGetSupportArticle(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetSupportArticleRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSupportArticlesGetSupportArticleQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setSupportArticlesGetSupportArticleData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: SupportArticlesGetSupportArticleQueryData,
+): SupportArticlesGetSupportArticleQueryData | undefined {
+  const key = queryKeySupportArticlesGetSupportArticle(...queryKeyBase);
+
+  return client.setQueryData<SupportArticlesGetSupportArticleQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateSupportArticlesGetSupportArticle(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "support_articles",
+      "getSupportArticle",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSupportArticlesGetSupportArticle(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "support_articles",
+      "getSupportArticle",
+    ],
+  });
+}
+
+export function buildSupportArticlesGetSupportArticleQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetSupportArticleRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SupportArticlesGetSupportArticleQueryData>;
+} {
+  return {
+    queryKey: queryKeySupportArticlesGetSupportArticle(request.id, {
+      expand: request.expand,
+    }),
+    queryFn: async function supportArticlesGetSupportArticleQueryFn(
+      ctx,
+    ): Promise<SupportArticlesGetSupportArticleQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(supportArticlesGetSupportArticle(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySupportArticlesGetSupportArticle(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "support_articles",
+    "getSupportArticle",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/supportArticlesListOrSearchSupportArticles.ts

@@ -0,0 +1,349 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { supportArticlesListOrSearchSupportArticles } from "../funcs/supportArticlesListOrSearchSupportArticles.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type SupportArticlesListOrSearchSupportArticlesQueryData =
+  operations.ListOrSearchSupportArticlesResponse;
+
+export type SupportArticlesListOrSearchSupportArticlesInfiniteQueryData =
+  PageIterator<
+    operations.ListOrSearchSupportArticlesResponse,
+    { page: number }
+  >;
+
+export type SupportArticlesListOrSearchSupportArticlesPageParams = PageIterator<
+  operations.ListOrSearchSupportArticlesResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List or search support articles
+ *
+ * @remarks
+ * List or search support articles for FAQ.
+ */
+export function useSupportArticlesListOrSearchSupportArticles(
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: QueryHookOptions<
+    SupportArticlesListOrSearchSupportArticlesQueryData
+  >,
+): UseQueryResult<SupportArticlesListOrSearchSupportArticlesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildSupportArticlesListOrSearchSupportArticlesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search support articles
+ *
+ * @remarks
+ * List or search support articles for FAQ.
+ */
+export function useSupportArticlesListOrSearchSupportArticlesSuspense(
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: SuspenseQueryHookOptions<
+    SupportArticlesListOrSearchSupportArticlesQueryData
+  >,
+): UseSuspenseQueryResult<
+  SupportArticlesListOrSearchSupportArticlesQueryData,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildSupportArticlesListOrSearchSupportArticlesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search support articles
+ *
+ * @remarks
+ * List or search support articles for FAQ.
+ */
+export function useSupportArticlesListOrSearchSupportArticlesInfinite(
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: InfiniteQueryHookOptions<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+    SupportArticlesListOrSearchSupportArticlesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+      SupportArticlesListOrSearchSupportArticlesPageParams
+    >,
+    QueryKey,
+    SupportArticlesListOrSearchSupportArticlesPageParams
+  >({
+    ...buildSupportArticlesListOrSearchSupportArticlesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search support articles
+ *
+ * @remarks
+ * List or search support articles for FAQ.
+ */
+export function useSupportArticlesListOrSearchSupportArticlesInfiniteSuspense(
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+    SupportArticlesListOrSearchSupportArticlesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      SupportArticlesListOrSearchSupportArticlesInfiniteQueryData,
+      SupportArticlesListOrSearchSupportArticlesPageParams
+    >,
+    QueryKey,
+    SupportArticlesListOrSearchSupportArticlesPageParams
+  >({
+    ...buildSupportArticlesListOrSearchSupportArticlesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchSupportArticlesListOrSearchSupportArticles(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSupportArticlesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSupportArticlesListOrSearchSupportArticlesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setSupportArticlesListOrSearchSupportArticlesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: SupportArticlesListOrSearchSupportArticlesQueryData,
+): SupportArticlesListOrSearchSupportArticlesQueryData | undefined {
+  const key = queryKeySupportArticlesListOrSearchSupportArticles(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    SupportArticlesListOrSearchSupportArticlesQueryData
+  >(key, data);
+}
+
+export function invalidateSupportArticlesListOrSearchSupportArticles(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "support_articles",
+      "listOrSearchSupportArticles",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSupportArticlesListOrSearchSupportArticles(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "support_articles",
+      "listOrSearchSupportArticles",
+    ],
+  });
+}
+
+export function buildSupportArticlesListOrSearchSupportArticlesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SupportArticlesListOrSearchSupportArticlesQueryData>;
+} {
+  return {
+    queryKey: queryKeySupportArticlesListOrSearchSupportArticles({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function supportArticlesListOrSearchSupportArticlesQueryFn(
+      ctx,
+    ): Promise<SupportArticlesListOrSearchSupportArticlesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(supportArticlesListOrSearchSupportArticles(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildSupportArticlesListOrSearchSupportArticlesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      SupportArticlesListOrSearchSupportArticlesPageParams
+    >,
+  ) => Promise<SupportArticlesListOrSearchSupportArticlesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeySupportArticlesListOrSearchSupportArticles({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function supportArticlesListOrSearchSupportArticlesQuery(
+      ctx,
+    ): Promise<SupportArticlesListOrSearchSupportArticlesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(supportArticlesListOrSearchSupportArticles(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(supportArticlesListOrSearchSupportArticles(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySupportArticlesListOrSearchSupportArticles(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "support_articles",
+    "listOrSearchSupportArticles",
+    parameters,
+  ];
+}

package/src/react-query/{userGetCurrentUser.ts → usersGetCurrentUser.ts}

@@ -13,7 +13,7 @@ import {
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
 import { GreenSecurityCore } from "../core.js";
-import { userGetCurrentUser } from "../funcs/userGetCurrentUser.js";
+import { usersGetCurrentUser } from "../funcs/usersGetCurrentUser.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -21,7 +21,7 @@ import { unwrapAsync } from "../types/fp.js";
 import { useGreenSecurityContext } from "./_context.js";
 import { QueryHookOptions, SuspenseQueryHookOptions } from "./_types.js";
 
-export type UserGetCurrentUserQueryData = components.User;
+export type UsersGetCurrentUserQueryData = components.User;
 
 /**
  * Get current user
@@ -29,12 +29,12 @@ export type UserGetCurrentUserQueryData = components.User;
  * @remarks
  * Returns a user object for the user represented by the authorization token
  */
-export function useUserGetCurrentUser(
-  options?: QueryHookOptions<UserGetCurrentUserQueryData>,
-): UseQueryResult<UserGetCurrentUserQueryData, Error> {
+export function useUsersGetCurrentUser(
+  options?: QueryHookOptions<UsersGetCurrentUserQueryData>,
+): UseQueryResult<UsersGetCurrentUserQueryData, Error> {
   const client = useGreenSecurityContext();
   return useQuery({
-    ...buildUserGetCurrentUserQuery(
+    ...buildUsersGetCurrentUserQuery(
       client,
       options,
     ),
@@ -48,12 +48,12 @@ export function useUserGetCurrentUser(
  * @remarks
  * Returns a user object for the user represented by the authorization token
  */
-export function useUserGetCurrentUserSuspense(
-  options?: SuspenseQueryHookOptions<UserGetCurrentUserQueryData>,
-): UseSuspenseQueryResult<UserGetCurrentUserQueryData, Error> {
+export function useUsersGetCurrentUserSuspense(
+  options?: SuspenseQueryHookOptions<UsersGetCurrentUserQueryData>,
+): UseSuspenseQueryResult<UsersGetCurrentUserQueryData, Error> {
   const client = useGreenSecurityContext();
   return useSuspenseQuery({
-    ...buildUserGetCurrentUserQuery(
+    ...buildUsersGetCurrentUserQuery(
       client,
       options,
     ),
@@ -61,57 +61,57 @@ export function useUserGetCurrentUserSuspense(
   });
 }
 
-export function prefetchUserGetCurrentUser(
+export function prefetchUsersGetCurrentUser(
   queryClient: QueryClient,
   client$: GreenSecurityCore,
 ): Promise<void> {
   return queryClient.prefetchQuery({
-    ...buildUserGetCurrentUserQuery(
+    ...buildUsersGetCurrentUserQuery(
       client$,
     ),
   });
 }
 
-export function setUserGetCurrentUserData(
+export function setUsersGetCurrentUserData(
   client: QueryClient,
-  data: UserGetCurrentUserQueryData,
-): UserGetCurrentUserQueryData | undefined {
-  const key = queryKeyUserGetCurrentUser();
+  data: UsersGetCurrentUserQueryData,
+): UsersGetCurrentUserQueryData | undefined {
+  const key = queryKeyUsersGetCurrentUser();
 
-  return client.setQueryData<UserGetCurrentUserQueryData>(key, data);
+  return client.setQueryData<UsersGetCurrentUserQueryData>(key, data);
 }
 
-export function invalidateAllUserGetCurrentUser(
+export function invalidateAllUsersGetCurrentUser(
   client: QueryClient,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({
     ...filters,
-    queryKey: ["@greensecurity/javascript-sdk", "user", "getCurrentUser"],
+    queryKey: ["@greensecurity/javascript-sdk", "users", "getCurrentUser"],
   });
 }
 
-export function buildUserGetCurrentUserQuery(
+export function buildUsersGetCurrentUserQuery(
   client$: GreenSecurityCore,
   options?: RequestOptions,
 ): {
   queryKey: QueryKey;
   queryFn: (
     context: QueryFunctionContext,
-  ) => Promise<UserGetCurrentUserQueryData>;
+  ) => Promise<UsersGetCurrentUserQueryData>;
 } {
   return {
-    queryKey: queryKeyUserGetCurrentUser(),
-    queryFn: async function userGetCurrentUserQueryFn(
+    queryKey: queryKeyUsersGetCurrentUser(),
+    queryFn: async function usersGetCurrentUserQueryFn(
       ctx,
-    ): Promise<UserGetCurrentUserQueryData> {
+    ): Promise<UsersGetCurrentUserQueryData> {
       const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
       const mergedOptions = {
         ...options,
         fetchOptions: { ...options?.fetchOptions, signal: sig },
       };
 
-      return unwrapAsync(userGetCurrentUser(
+      return unwrapAsync(usersGetCurrentUser(
         client$,
         mergedOptions,
       ));
@@ -119,6 +119,6 @@ export function buildUserGetCurrentUserQuery(
   };
 }
 
-export function queryKeyUserGetCurrentUser(): QueryKey {
-  return ["@greensecurity/javascript-sdk", "user", "getCurrentUser"];
+export function queryKeyUsersGetCurrentUser(): QueryKey {
+  return ["@greensecurity/javascript-sdk", "users", "getCurrentUser"];
 }