@greensecurity/javascript-sdk 0.46.0-beta.9 → 0.46.0

package/src/react-query/appsHeartbeatAppDevSession.ts

@@ -1,123 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  MutationKey,
-  useMutation,
-  UseMutationResult,
-} from "@tanstack/react-query";
-import { GreenSecurityCore } from "../core.js";
-import { appsHeartbeatAppDevSession } from "../funcs/appsHeartbeatAppDevSession.js";
-import { combineSignals } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.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 { useGreenSecurityContext } from "./_context.js";
-import { MutationHookOptions } from "./_types.js";
-
-export type AppsHeartbeatAppDevSessionMutationVariables = {
-  request: operations.HeartbeatAppDevSessionRequest;
-  options?: RequestOptions;
-};
-
-export type AppsHeartbeatAppDevSessionMutationData =
-  operations.HeartbeatAppDevSessionHeartbeatAppDevSessionOk;
-
-export type AppsHeartbeatAppDevSessionMutationError =
-  | errors.ApiErrorResponse
-  | errors.UnprocessableEntityOrValidationError
-  | GreenSecurityError
-  | ResponseValidationError
-  | ConnectionError
-  | RequestAbortedError
-  | RequestTimeoutError
-  | InvalidRequestError
-  | UnexpectedClientError
-  | SDKValidationError;
-
-/**
- * Keep a dev session alive
- *
- * @remarks
- * Marks a dev session as still running. Call it every 30 seconds; a session with no
- * heartbeat for 2 minutes is treated as inactive and the host stops using it until the next
- * heartbeat. A heartbeat does not extend the 12-hour lifetime.
- *
- * Access is checked again on every heartbeat. A `404` means the session was closed,
- * expired or replaced by a newer one, or you are no longer a developer of the app; a `403`
- * means dev preview has been switched off for the app. Either way the session is closed:
- * start a new one with `POST /apps/{app_id}/dev-sessions` once the cause is resolved.
- *
- * **Permissions.** Requires the developer CLI token (`gsd_`) of the developer who started
- * the session, as `Authorization: Bearer`. Another developer's session is reported as not
- * found.
- */
-export function useAppsHeartbeatAppDevSessionMutation(
-  options?: MutationHookOptions<
-    AppsHeartbeatAppDevSessionMutationData,
-    AppsHeartbeatAppDevSessionMutationError,
-    AppsHeartbeatAppDevSessionMutationVariables
-  >,
-): UseMutationResult<
-  AppsHeartbeatAppDevSessionMutationData,
-  AppsHeartbeatAppDevSessionMutationError,
-  AppsHeartbeatAppDevSessionMutationVariables
-> {
-  const client = useGreenSecurityContext();
-  return useMutation({
-    ...buildAppsHeartbeatAppDevSessionMutation(client, options),
-    ...options,
-  });
-}
-
-export function mutationKeyAppsHeartbeatAppDevSession(): MutationKey {
-  return ["@greensecurity/javascript-sdk", "apps", "heartbeatAppDevSession"];
-}
-
-export function buildAppsHeartbeatAppDevSessionMutation(
-  client$: GreenSecurityCore,
-  hookOptions?: RequestOptions,
-): {
-  mutationKey: MutationKey;
-  mutationFn: (
-    variables: AppsHeartbeatAppDevSessionMutationVariables,
-  ) => Promise<AppsHeartbeatAppDevSessionMutationData>;
-} {
-  return {
-    mutationKey: mutationKeyAppsHeartbeatAppDevSession(),
-    mutationFn: function appsHeartbeatAppDevSessionMutationFn({
-      request,
-      options,
-    }): Promise<AppsHeartbeatAppDevSessionMutationData> {
-      const mergedOptions = {
-        ...hookOptions,
-        ...options,
-        fetchOptions: {
-          ...hookOptions?.fetchOptions,
-          ...options?.fetchOptions,
-          signal: combineSignals(
-            hookOptions?.fetchOptions?.signal,
-            options?.fetchOptions?.signal,
-          ),
-        },
-      };
-      return unwrapAsync(appsHeartbeatAppDevSession(
-        client$,
-        request,
-        mergedOptions,
-      ));
-    },
-  };
-}

package/src/react-query/appsListAppActivations.core.ts

@@ -1,183 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  QueryClient,
-  QueryFunctionContext,
-  QueryKey,
-} from "@tanstack/react-query";
-import { GreenSecurityCore } from "../core.js";
-import { appsListAppActivations } from "../funcs/appsListAppActivations.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 { pageIteratorToJSON } from "./_types.js";
-export type AppsListAppActivationsQueryData =
-  operations.ListAppActivationsResponse;
-
-export type AppsListAppActivationsInfiniteQueryData = PageIterator<
-  operations.ListAppActivationsResponse,
-  { page: number }
->;
-
-export type AppsListAppActivationsPageParams = PageIterator<
-  operations.ListAppActivationsResponse,
-  { page: number }
->["~next"];
-
-export function prefetchAppsListAppActivations(
-  queryClient: QueryClient,
-  client$: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): Promise<void> {
-  return queryClient.prefetchQuery({
-    ...buildAppsListAppActivationsQuery(
-      client$,
-      request,
-      options,
-    ),
-  });
-}
-
-export function prefetchAppsListAppActivationsInfinite(
-  queryClient: QueryClient,
-  client$: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): Promise<void> {
-  return queryClient.prefetchInfiniteQuery({
-    ...buildAppsListAppActivationsInfiniteQuery(
-      client$,
-      request,
-      options,
-    ),
-    initialPageParam: undefined as AppsListAppActivationsPageParams,
-    getNextPageParam: (previousPage: AppsListAppActivationsInfiniteQueryData) =>
-      previousPage["~next"],
-  });
-}
-
-export function buildAppsListAppActivationsQuery(
-  client$: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext,
-  ) => Promise<AppsListAppActivationsQueryData>;
-} {
-  return {
-    queryKey: queryKeyAppsListAppActivations({
-      page: request.page,
-      itemsPerPage: request.itemsPerPage,
-      desc: request.desc,
-      sort: request.sort,
-    }),
-    queryFn: async function appsListAppActivationsQueryFn(
-      ctx,
-    ): Promise<AppsListAppActivationsQueryData> {
-      const sig = combineSignals(
-        ctx.signal,
-        options?.signal,
-        options?.fetchOptions?.signal,
-      );
-      const mergedOptions = {
-        ...options?.fetchOptions,
-        ...options,
-        signal: sig,
-      };
-
-      return unwrapAsync(appsListAppActivations(
-        client$,
-        request,
-        mergedOptions,
-      ));
-    },
-  };
-}
-
-export function buildAppsListAppActivationsInfiniteQuery(
-  client$: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext<QueryKey, AppsListAppActivationsPageParams>,
-  ) => Promise<AppsListAppActivationsInfiniteQueryData>;
-} {
-  return {
-    queryKey: queryKeyAppsListAppActivationsInfinite({
-      page: request.page,
-      itemsPerPage: request.itemsPerPage,
-      desc: request.desc,
-      sort: request.sort,
-    }),
-    queryFn: async function appsListAppActivationsQuery(
-      ctx,
-    ): Promise<AppsListAppActivationsInfiniteQueryData> {
-      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
-      const mergedOptions = {
-        ...options,
-        fetchOptions: { ...options?.fetchOptions, signal: sig },
-      };
-
-      if (!ctx.pageParam) {
-        const pageResult = await unwrapResultIterator(appsListAppActivations(
-          client$,
-          request,
-          mergedOptions,
-        ));
-        return pageIteratorToJSON(pageResult);
-      }
-      const pageResult = await unwrapResultIterator(appsListAppActivations(
-        client$,
-        {
-          ...request,
-          page: ctx.pageParam.page,
-        },
-        mergedOptions,
-      ));
-      return pageIteratorToJSON(pageResult);
-    },
-  };
-}
-
-export function queryKeyAppsListAppActivations(
-  parameters: {
-    page?: number | undefined;
-    itemsPerPage?: number | undefined;
-    desc?: components.Desc | undefined;
-    sort?: operations.ListAppActivationsQueryParamSort | undefined;
-  },
-): QueryKey {
-  return [
-    "@greensecurity/javascript-sdk",
-    "apps",
-    "listAppActivations",
-    parameters,
-  ];
-}
-
-export function queryKeyAppsListAppActivationsInfinite(
-  parameters: {
-    page?: number | undefined;
-    itemsPerPage?: number | undefined;
-    desc?: components.Desc | undefined;
-    sort?: operations.ListAppActivationsQueryParamSort | undefined;
-  },
-): QueryKey {
-  return [
-    "@greensecurity/javascript-sdk",
-    "apps",
-    "listAppActivations",
-    "infinite",
-    parameters,
-  ];
-}

package/src/react-query/appsListAppActivations.ts

@@ -1,335 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import {
-  InfiniteData,
-  InvalidateQueryFilters,
-  QueryClient,
-  QueryKey,
-  useInfiniteQuery,
-  UseInfiniteQueryResult,
-  useQuery,
-  UseQueryResult,
-  useSuspenseInfiniteQuery,
-  UseSuspenseInfiniteQueryResult,
-  useSuspenseQuery,
-  UseSuspenseQueryResult,
-} from "@tanstack/react-query";
-import * as components from "../models/components/index.js";
-import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
-import { useGreenSecurityContext } from "./_context.js";
-import {
-  InfiniteQueryHookOptions,
-  QueryHookOptions,
-  SuspenseInfiniteQueryHookOptions,
-  SuspenseQueryHookOptions,
-  TupleToPrefixes,
-} from "./_types.js";
-import {
-  AppsListAppActivationsInfiniteQueryData,
-  AppsListAppActivationsPageParams,
-  AppsListAppActivationsQueryData,
-  buildAppsListAppActivationsInfiniteQuery,
-  buildAppsListAppActivationsQuery,
-  prefetchAppsListAppActivations,
-  prefetchAppsListAppActivationsInfinite,
-  queryKeyAppsListAppActivations,
-  queryKeyAppsListAppActivationsInfinite,
-} from "./appsListAppActivations.core.js";
-export {
-  type AppsListAppActivationsInfiniteQueryData,
-  type AppsListAppActivationsPageParams,
-  type AppsListAppActivationsQueryData,
-  buildAppsListAppActivationsInfiniteQuery,
-  buildAppsListAppActivationsQuery,
-  prefetchAppsListAppActivations,
-  prefetchAppsListAppActivationsInfinite,
-  queryKeyAppsListAppActivations,
-  queryKeyAppsListAppActivationsInfinite,
-};
-
-export type AppsListAppActivationsQueryError =
-  | errors.ApiErrorResponse
-  | errors.UnprocessableEntityOrValidationError
-  | GreenSecurityError
-  | ResponseValidationError
-  | ConnectionError
-  | RequestAbortedError
-  | RequestTimeoutError
-  | InvalidRequestError
-  | UnexpectedClientError
-  | SDKValidationError;
-
-/**
- * List your app's activations
- *
- * @remarks
- * Lists the activations (installations) of the apps your service account belongs to: which
- * app, what each installation covers, and when it was made. A back-end-only app has no UI to
- * be handed an activation id, so this is where its backend finds the `activation_id` it passes
- * to `POST /oauth/token` with `grant_type=client_credentials` to get an installation token for
- * one installation.
- *
- * To hear about installs as they happen, declare `webhooks` in your app's manifest: your app's
- * own endpoint then receives `MarketplaceAppActivation.created`, `.updated` and `.destroyed`
- * for every installation, the first one included. Use this list to reconcile, on start-up and
- * after any delivery you could not process.
- *
- * Sorted by `id` unless `sort` says otherwise, ascending unless `desc` is set.
- *
- * **Permissions.** Accepts only the app service account's own unscoped token, as
- * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
- * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
- * `gsdr_` refresh token) are refused with `403` — an installation token acts as the same service
- * account but is narrowed to one installation — and so is a token narrowed with `scope`. A
- * `token` query parameter is refused with `401`, even alongside the header. A user that is not
- * the service account of any app gets `403`.
- */
-export function useAppsListAppActivations(
-  request: operations.ListAppActivationsRequest,
-  options?: QueryHookOptions<
-    AppsListAppActivationsQueryData,
-    AppsListAppActivationsQueryError
-  >,
-): UseQueryResult<
-  AppsListAppActivationsQueryData,
-  AppsListAppActivationsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useQuery({
-    ...buildAppsListAppActivationsQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * List your app's activations
- *
- * @remarks
- * Lists the activations (installations) of the apps your service account belongs to: which
- * app, what each installation covers, and when it was made. A back-end-only app has no UI to
- * be handed an activation id, so this is where its backend finds the `activation_id` it passes
- * to `POST /oauth/token` with `grant_type=client_credentials` to get an installation token for
- * one installation.
- *
- * To hear about installs as they happen, declare `webhooks` in your app's manifest: your app's
- * own endpoint then receives `MarketplaceAppActivation.created`, `.updated` and `.destroyed`
- * for every installation, the first one included. Use this list to reconcile, on start-up and
- * after any delivery you could not process.
- *
- * Sorted by `id` unless `sort` says otherwise, ascending unless `desc` is set.
- *
- * **Permissions.** Accepts only the app service account's own unscoped token, as
- * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
- * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
- * `gsdr_` refresh token) are refused with `403` — an installation token acts as the same service
- * account but is narrowed to one installation — and so is a token narrowed with `scope`. A
- * `token` query parameter is refused with `401`, even alongside the header. A user that is not
- * the service account of any app gets `403`.
- */
-export function useAppsListAppActivationsSuspense(
-  request: operations.ListAppActivationsRequest,
-  options?: SuspenseQueryHookOptions<
-    AppsListAppActivationsQueryData,
-    AppsListAppActivationsQueryError
-  >,
-): UseSuspenseQueryResult<
-  AppsListAppActivationsQueryData,
-  AppsListAppActivationsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useSuspenseQuery({
-    ...buildAppsListAppActivationsQuery(
-      client,
-      request,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * List your app's activations
- *
- * @remarks
- * Lists the activations (installations) of the apps your service account belongs to: which
- * app, what each installation covers, and when it was made. A back-end-only app has no UI to
- * be handed an activation id, so this is where its backend finds the `activation_id` it passes
- * to `POST /oauth/token` with `grant_type=client_credentials` to get an installation token for
- * one installation.
- *
- * To hear about installs as they happen, declare `webhooks` in your app's manifest: your app's
- * own endpoint then receives `MarketplaceAppActivation.created`, `.updated` and `.destroyed`
- * for every installation, the first one included. Use this list to reconcile, on start-up and
- * after any delivery you could not process.
- *
- * Sorted by `id` unless `sort` says otherwise, ascending unless `desc` is set.
- *
- * **Permissions.** Accepts only the app service account's own unscoped token, as
- * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
- * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
- * `gsdr_` refresh token) are refused with `403` — an installation token acts as the same service
- * account but is narrowed to one installation — and so is a token narrowed with `scope`. A
- * `token` query parameter is refused with `401`, even alongside the header. A user that is not
- * the service account of any app gets `403`.
- */
-export function useAppsListAppActivationsInfinite(
-  request: operations.ListAppActivationsRequest,
-  options?: InfiniteQueryHookOptions<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsQueryError
-  >,
-): UseInfiniteQueryResult<
-  InfiniteData<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsPageParams
-  >,
-  AppsListAppActivationsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useInfiniteQuery<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsQueryError,
-    InfiniteData<
-      AppsListAppActivationsInfiniteQueryData,
-      AppsListAppActivationsPageParams
-    >,
-    QueryKey,
-    AppsListAppActivationsPageParams
-  >({
-    ...buildAppsListAppActivationsInfiniteQuery(
-      client,
-      request,
-      options,
-    ),
-    initialPageParam: options?.initialPageParam,
-    getNextPageParam: (previousPage) => previousPage["~next"],
-    ...options,
-  });
-}
-
-/**
- * List your app's activations
- *
- * @remarks
- * Lists the activations (installations) of the apps your service account belongs to: which
- * app, what each installation covers, and when it was made. A back-end-only app has no UI to
- * be handed an activation id, so this is where its backend finds the `activation_id` it passes
- * to `POST /oauth/token` with `grant_type=client_credentials` to get an installation token for
- * one installation.
- *
- * To hear about installs as they happen, declare `webhooks` in your app's manifest: your app's
- * own endpoint then receives `MarketplaceAppActivation.created`, `.updated` and `.destroyed`
- * for every installation, the first one included. Use this list to reconcile, on start-up and
- * after any delivery you could not process.
- *
- * Sorted by `id` unless `sort` says otherwise, ascending unless `desc` is set.
- *
- * **Permissions.** Accepts only the app service account's own unscoped token, as
- * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
- * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
- * `gsdr_` refresh token) are refused with `403` — an installation token acts as the same service
- * account but is narrowed to one installation — and so is a token narrowed with `scope`. A
- * `token` query parameter is refused with `401`, even alongside the header. A user that is not
- * the service account of any app gets `403`.
- */
-export function useAppsListAppActivationsInfiniteSuspense(
-  request: operations.ListAppActivationsRequest,
-  options?: SuspenseInfiniteQueryHookOptions<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsQueryError
-  >,
-): UseSuspenseInfiniteQueryResult<
-  InfiniteData<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsPageParams
-  >,
-  AppsListAppActivationsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useSuspenseInfiniteQuery<
-    AppsListAppActivationsInfiniteQueryData,
-    AppsListAppActivationsQueryError,
-    InfiniteData<
-      AppsListAppActivationsInfiniteQueryData,
-      AppsListAppActivationsPageParams
-    >,
-    QueryKey,
-    AppsListAppActivationsPageParams
-  >({
-    ...buildAppsListAppActivationsInfiniteQuery(
-      client,
-      request,
-      options,
-    ),
-    initialPageParam: options?.initialPageParam,
-    getNextPageParam: (previousPage) => previousPage["~next"],
-    ...options,
-  });
-}
-
-export function setAppsListAppActivationsData(
-  client: QueryClient,
-  queryKeyBase: [
-    parameters: {
-      page?: number | undefined;
-      itemsPerPage?: number | undefined;
-      desc?: components.Desc | undefined;
-      sort?: operations.ListAppActivationsQueryParamSort | undefined;
-    },
-  ],
-  data: AppsListAppActivationsQueryData,
-): AppsListAppActivationsQueryData | undefined {
-  const key = queryKeyAppsListAppActivations(...queryKeyBase);
-
-  return client.setQueryData<AppsListAppActivationsQueryData>(key, data);
-}
-
-export function invalidateAppsListAppActivations(
-  client: QueryClient,
-  queryKeyBase: TupleToPrefixes<
-    [parameters: {
-      page?: number | undefined;
-      itemsPerPage?: number | undefined;
-      desc?: components.Desc | undefined;
-      sort?: operations.ListAppActivationsQueryParamSort | undefined;
-    }]
-  >,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: [
-      "@greensecurity/javascript-sdk",
-      "apps",
-      "listAppActivations",
-      ...queryKeyBase,
-    ],
-  });
-}
-
-export function invalidateAllAppsListAppActivations(
-  client: QueryClient,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: ["@greensecurity/javascript-sdk", "apps", "listAppActivations"],
-  });
-}