@greensecurity/javascript-sdk 0.9.1

package/src/react-query/userGetUserById.ts

@@ -0,0 +1,152 @@
+/*
+ * 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 { userGetUserById } from "../funcs/userGetUserById.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 UserGetUserByIdQueryData = components.User;
+
+/**
+ * Get user by id
+ *
+ * @remarks
+ * Returns a user object for the user represented by the identifier in the path.
+ */
+export function useUserGetUserById(
+  request: operations.GetUserByIdRequest,
+  options?: QueryHookOptions<UserGetUserByIdQueryData>,
+): UseQueryResult<UserGetUserByIdQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildUserGetUserByIdQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get user by id
+ *
+ * @remarks
+ * Returns a user object for the user represented by the identifier in the path.
+ */
+export function useUserGetUserByIdSuspense(
+  request: operations.GetUserByIdRequest,
+  options?: SuspenseQueryHookOptions<UserGetUserByIdQueryData>,
+): UseSuspenseQueryResult<UserGetUserByIdQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildUserGetUserByIdQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchUserGetUserById(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetUserByIdRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildUserGetUserByIdQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setUserGetUserByIdData(
+  client: QueryClient,
+  queryKeyBase: [id: number],
+  data: UserGetUserByIdQueryData,
+): UserGetUserByIdQueryData | undefined {
+  const key = queryKeyUserGetUserById(...queryKeyBase);
+
+  return client.setQueryData<UserGetUserByIdQueryData>(key, data);
+}
+
+export function invalidateUserGetUserById(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "user",
+      "getUserById",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllUserGetUserById(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "user", "getUserById"],
+  });
+}
+
+export function buildUserGetUserByIdQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetUserByIdRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<UserGetUserByIdQueryData>;
+} {
+  return {
+    queryKey: queryKeyUserGetUserById(request.id),
+    queryFn: async function userGetUserByIdQueryFn(
+      ctx,
+    ): Promise<UserGetUserByIdQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(userGetUserById(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyUserGetUserById(id: number): QueryKey {
+  return ["@greensecurity/javascript-sdk", "user", "getUserById", id];
+}

package/src/react-query/userLogsUserIntoTheSystem.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { userLogsUserIntoTheSystem } from "../funcs/userLogsUserIntoTheSystem.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 { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type UserLogsUserIntoTheSystemMutationVariables = {
+  request: operations.LogsUserIntoTheSystemRequestBody;
+  options?: RequestOptions;
+};
+
+export type UserLogsUserIntoTheSystemMutationData =
+  operations.LogsUserIntoTheSystemResponse;
+
+/**
+ * Logs user into the system
+ *
+ * @remarks
+ * This endpoint allows a user to authenticate themselves and retrieve a permanent token for access.
+ *
+ * Permanent tokens should only ever be stored in an encrypted storage because they represent a fully logged in user.
+ *
+ * Users may log in with `email/password`, `SAML`, `magic link` or `mfa`. The application should handle all of the above as equally valid login methods.
+ *
+ * The most common way to authenticate a user is to log in with an email and password. If the user provides valid credentials, the server will either respond with a full user object including the token.
+ *
+ * When the user's account is protected via MFA, the server will send a 6 digit code to the user via their default MFA provider. You should collect that code and resend the email, password and mfa_code together to get a successful authentication.
+ *
+ * The ideal flow for a login sequence is the following:
+ *
+ * 1. Present an email address field only and allow the user to submit
+ * 2. Send `email` and `return_url` payload to this endpoint
+ * 3. Follow the flow based on the response `requires` field
+ *
+ * Requires: `password`
+ *
+ * 1. Show a password field for the user to fill out
+ * 2. Submit the `email` and `password` to this endpoint
+ * 3. If the response is `200`, the login is done. If the response is `201`, then check if `requires: mfa_code` is returned and show MFA flow
+ * 4. Submit `email`, `password`, `mfa_code` to this endpoint
+ * 5. If the response is `200`, the login is done. Otherwise, show the appropriate error to the user and go back to step 1 or 3 depending on the error.
+ *
+ * Requires: `saml_login`
+ *
+ * 1. [Open a browser](https://docs.expo.dev/versions/latest/sdk/webbrowser/#webbrowseropenauthsessionasyncurl-redirecturl-options) to the url returned in `sso_url`
+ * 2. User completes sign-in using their configured SAML IdP
+ * 3. Site redirects to your selected `return_url`
+ * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
+ * 5. Fetch the user object from `/users/me` using the token
+ */
+export function useUserLogsUserIntoTheSystemMutation(
+  options?: MutationHookOptions<
+    UserLogsUserIntoTheSystemMutationData,
+    Error,
+    UserLogsUserIntoTheSystemMutationVariables
+  >,
+): UseMutationResult<
+  UserLogsUserIntoTheSystemMutationData,
+  Error,
+  UserLogsUserIntoTheSystemMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUserLogsUserIntoTheSystemMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUserLogsUserIntoTheSystem(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "user", "logsUserIntoTheSystem"];
+}
+
+export function buildUserLogsUserIntoTheSystemMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UserLogsUserIntoTheSystemMutationVariables,
+  ) => Promise<UserLogsUserIntoTheSystemMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUserLogsUserIntoTheSystem(),
+    mutationFn: function userLogsUserIntoTheSystemMutationFn({
+      request,
+      options,
+    }): Promise<UserLogsUserIntoTheSystemMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(userLogsUserIntoTheSystem(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsCreateVendorRegistration.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsCreateVendorRegistration } from "../funcs/vendorsCreateVendorRegistration.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 { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsCreateVendorRegistrationMutationVariables = {
+  request: operations.CreateVendorRegistrationRequestBody;
+  options?: RequestOptions;
+};
+
+export type VendorsCreateVendorRegistrationMutationData =
+  operations.CreateVendorRegistrationResponseBody;
+
+/**
+ * Create vendor registration
+ *
+ * @remarks
+ * Create an initial vendor registration. Once successful, the vendor will be able to continue to filling out the rest of their onboarding profile.
+ */
+export function useVendorsCreateVendorRegistrationMutation(
+  options?: MutationHookOptions<
+    VendorsCreateVendorRegistrationMutationData,
+    Error,
+    VendorsCreateVendorRegistrationMutationVariables
+  >,
+): UseMutationResult<
+  VendorsCreateVendorRegistrationMutationData,
+  Error,
+  VendorsCreateVendorRegistrationMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsCreateVendorRegistrationMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsCreateVendorRegistration(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "createVendorRegistration",
+  ];
+}
+
+export function buildVendorsCreateVendorRegistrationMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsCreateVendorRegistrationMutationVariables,
+  ) => Promise<VendorsCreateVendorRegistrationMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsCreateVendorRegistration(),
+    mutationFn: function vendorsCreateVendorRegistrationMutationFn({
+      request,
+      options,
+    }): Promise<VendorsCreateVendorRegistrationMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsCreateVendorRegistration(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsListVendorJobTitles.ts

@@ -0,0 +1,194 @@
+/*
+ * 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 { vendorsListVendorJobTitles } from "../funcs/vendorsListVendorJobTitles.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 VendorsListVendorJobTitlesQueryData =
+  operations.ListVendorJobTitlesResponseBody;
+
+/**
+ * List vendor job titles
+ *
+ * @remarks
+ * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ */
+export function useVendorsListVendorJobTitles(
+  request: operations.ListVendorJobTitlesRequest,
+  options?: QueryHookOptions<VendorsListVendorJobTitlesQueryData>,
+): UseQueryResult<VendorsListVendorJobTitlesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorJobTitlesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor job titles
+ *
+ * @remarks
+ * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ */
+export function useVendorsListVendorJobTitlesSuspense(
+  request: operations.ListVendorJobTitlesRequest,
+  options?: SuspenseQueryHookOptions<VendorsListVendorJobTitlesQueryData>,
+): UseSuspenseQueryResult<VendorsListVendorJobTitlesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorJobTitlesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsListVendorJobTitles(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorJobTitlesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorJobTitlesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsListVendorJobTitlesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      jobLike?: string | undefined;
+    },
+  ],
+  data: VendorsListVendorJobTitlesQueryData,
+): VendorsListVendorJobTitlesQueryData | undefined {
+  const key = queryKeyVendorsListVendorJobTitles(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorJobTitlesQueryData>(key, data);
+}
+
+export function invalidateVendorsListVendorJobTitles(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      jobLike?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorJobTitles",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendorJobTitles(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorJobTitles",
+    ],
+  });
+}
+
+export function buildVendorsListVendorJobTitlesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorJobTitlesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorJobTitlesQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorJobTitles({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      jobLike: request.jobLike,
+    }),
+    queryFn: async function vendorsListVendorJobTitlesQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorJobTitlesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsListVendorJobTitles(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsListVendorJobTitles(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    jobLike?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorJobTitles",
+    parameters,
+  ];
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/organizations.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { organizationsGetFacility } from "../funcs/organizationsGetFacility.js";
+import { organizationsListOrSearchFacilities } from "../funcs/organizationsListOrSearchFacilities.js";
+import { ClientSDK, 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";
+
+export class Organizations extends ClientSDK {
+  /**
+   * List or search facilities
+   *
+   * @remarks
+   * List or search facilities.
+   *
+   * Available `expand` scopes are:
+   *
+   * - facility.appointment_policy
+   * - facility.contacts
+   * - facility.vendor_counts
+   * - facility.flu_credential
+   * - facility.scrubs_policy
+   * - facility.system
+   * - facility.vendor_guest_policy
+   * - facility.vendor_policy
+   * - facility.visitor_policy
+   * - facility.workflow
+   */
+  async listOrSearchFacilities(
+    request: operations.ListOrSearchFacilitiesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListOrSearchFacilitiesResponseBody> {
+    return unwrapAsync(organizationsListOrSearchFacilities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get facility
+   *
+   * @remarks
+   * Retrieve an individual facility.
+   */
+  async getFacility(
+    request: operations.GetFacilityRequest,
+    options?: RequestOptions,
+  ): Promise<components.Facility> {
+    return unwrapAsync(organizationsGetFacility(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Organizations } from "./organizations.js";
+import { User } from "./user.js";
+import { Vendors } from "./vendors.js";
+
+export class GreenSecurity extends ClientSDK {
+  private _vendors?: Vendors;
+  get vendors(): Vendors {
+    return (this._vendors ??= new Vendors(this._options));
+  }
+
+  private _user?: User;
+  get user(): User {
+    return (this._user ??= new User(this._options));
+  }
+
+  private _organizations?: Organizations;
+  get organizations(): Organizations {
+    return (this._organizations ??= new Organizations(this._options));
+  }
+}