@greensecurity/javascript-sdk 0.43.1-beta.7 → 0.43.1-beta.70

package/src/react-query/invoicesListInvoices.ts

@@ -0,0 +1,288 @@
+/*
+ * 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 * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildInvoicesListInvoicesInfiniteQuery,
+  buildInvoicesListInvoicesQuery,
+  InvoicesListInvoicesInfiniteQueryData,
+  InvoicesListInvoicesPageParams,
+  InvoicesListInvoicesQueryData,
+  prefetchInvoicesListInvoices,
+  prefetchInvoicesListInvoicesInfinite,
+  queryKeyInvoicesListInvoices,
+  queryKeyInvoicesListInvoicesInfinite,
+} from "./invoicesListInvoices.core.js";
+export {
+  buildInvoicesListInvoicesInfiniteQuery,
+  buildInvoicesListInvoicesQuery,
+  type InvoicesListInvoicesInfiniteQueryData,
+  type InvoicesListInvoicesPageParams,
+  type InvoicesListInvoicesQueryData,
+  prefetchInvoicesListInvoices,
+  prefetchInvoicesListInvoicesInfinite,
+  queryKeyInvoicesListInvoices,
+  queryKeyInvoicesListInvoicesInfinite,
+};
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ * - invoice.invoice_type
+ */
+export function useInvoicesListInvoices(
+  request: operations.ListInvoicesRequest,
+  options?: QueryHookOptions<InvoicesListInvoicesQueryData>,
+): UseQueryResult<InvoicesListInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildInvoicesListInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ * - invoice.invoice_type
+ */
+export function useInvoicesListInvoicesSuspense(
+  request: operations.ListInvoicesRequest,
+  options?: SuspenseQueryHookOptions<InvoicesListInvoicesQueryData>,
+): UseSuspenseQueryResult<InvoicesListInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildInvoicesListInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ * - invoice.invoice_type
+ */
+export function useInvoicesListInvoicesInfinite(
+  request: operations.ListInvoicesRequest,
+  options?: InfiniteQueryHookOptions<InvoicesListInvoicesInfiniteQueryData>,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    InvoicesListInvoicesInfiniteQueryData,
+    InvoicesListInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    InvoicesListInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      InvoicesListInvoicesInfiniteQueryData,
+      InvoicesListInvoicesPageParams
+    >,
+    QueryKey,
+    InvoicesListInvoicesPageParams
+  >({
+    ...buildInvoicesListInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ * - invoice.invoice_type
+ */
+export function useInvoicesListInvoicesInfiniteSuspense(
+  request: operations.ListInvoicesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    InvoicesListInvoicesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    InvoicesListInvoicesInfiniteQueryData,
+    InvoicesListInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    InvoicesListInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      InvoicesListInvoicesInfiniteQueryData,
+      InvoicesListInvoicesPageParams
+    >,
+    QueryKey,
+    InvoicesListInvoicesPageParams
+  >({
+    ...buildInvoicesListInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setInvoicesListInvoicesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      invoiceNumber?: string | undefined;
+      invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
+      representative?: string | undefined;
+      vendorId?: number | undefined;
+      companyId?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+    },
+  ],
+  data: InvoicesListInvoicesQueryData,
+): InvoicesListInvoicesQueryData | undefined {
+  const key = queryKeyInvoicesListInvoices(...queryKeyBase);
+
+  return client.setQueryData<InvoicesListInvoicesQueryData>(key, data);
+}
+
+export function invalidateInvoicesListInvoices(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      invoiceNumber?: string | undefined;
+      invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
+      representative?: string | undefined;
+      vendorId?: number | undefined;
+      companyId?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "invoices",
+      "listInvoices",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllInvoicesListInvoices(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "invoices", "listInvoices"],
+  });
+}

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

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansGetNextScreeningQuestion } from "../funcs/vendorScansGetNextScreeningQuestion.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";
+export type VendorScansGetNextScreeningQuestionQueryData =
+  operations.GetNextScreeningQuestionResponseBody;
+
+export function prefetchVendorScansGetNextScreeningQuestion(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansGetNextScreeningQuestionQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansGetNextScreeningQuestionQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansGetNextScreeningQuestionQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansGetNextScreeningQuestion(request.id, {
+      expand: request.expand,
+      vendorId: request.vendorId,
+    }),
+    queryFn: async function vendorScansGetNextScreeningQuestionQueryFn(
+      ctx,
+    ): Promise<VendorScansGetNextScreeningQuestionQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansGetNextScreeningQuestion(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansGetNextScreeningQuestion(
+  id: number,
+  parameters: {
+    expand?: Array<components.Expand> | undefined;
+    vendorId?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "getNextScreeningQuestion",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/vendorScansGetNextScreeningQuestion.ts

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorScansGetNextScreeningQuestionQuery,
+  prefetchVendorScansGetNextScreeningQuestion,
+  queryKeyVendorScansGetNextScreeningQuestion,
+  VendorScansGetNextScreeningQuestionQueryData,
+} from "./vendorScansGetNextScreeningQuestion.core.js";
+export {
+  buildVendorScansGetNextScreeningQuestionQuery,
+  prefetchVendorScansGetNextScreeningQuestion,
+  queryKeyVendorScansGetNextScreeningQuestion,
+  type VendorScansGetNextScreeningQuestionQueryData,
+};
+
+/**
+ * Get the next unanswered screening questions for a vendor scan
+ *
+ * @remarks
+ * Retrieve the next unanswered screening question for the specified vendor scan.
+ * If a question exists, the endpoint returns the question and its available answers.
+ *
+ * Available `expand` scopes are:
+ *
+ * screening_question.screening_answers
+ */
+export function useVendorScansGetNextScreeningQuestion(
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: QueryHookOptions<VendorScansGetNextScreeningQuestionQueryData>,
+): UseQueryResult<VendorScansGetNextScreeningQuestionQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansGetNextScreeningQuestionQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get the next unanswered screening questions for a vendor scan
+ *
+ * @remarks
+ * Retrieve the next unanswered screening question for the specified vendor scan.
+ * If a question exists, the endpoint returns the question and its available answers.
+ *
+ * Available `expand` scopes are:
+ *
+ * screening_question.screening_answers
+ */
+export function useVendorScansGetNextScreeningQuestionSuspense(
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansGetNextScreeningQuestionQueryData
+  >,
+): UseSuspenseQueryResult<VendorScansGetNextScreeningQuestionQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansGetNextScreeningQuestionQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansGetNextScreeningQuestionData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      expand?: Array<components.Expand> | undefined;
+      vendorId?: number | undefined;
+    },
+  ],
+  data: VendorScansGetNextScreeningQuestionQueryData,
+): VendorScansGetNextScreeningQuestionQueryData | undefined {
+  const key = queryKeyVendorScansGetNextScreeningQuestion(...queryKeyBase);
+
+  return client.setQueryData<VendorScansGetNextScreeningQuestionQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorScansGetNextScreeningQuestion(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        expand?: Array<components.Expand> | undefined;
+        vendorId?: number | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getNextScreeningQuestion",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansGetNextScreeningQuestion(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getNextScreeningQuestion",
+    ],
+  });
+}

package/src/react-query/vendorScansSubmitScreeningResponse.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansSubmitScreeningResponse } from "../funcs/vendorScansSubmitScreeningResponse.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 VendorScansSubmitScreeningResponseMutationVariables = {
+  request: operations.SubmitScreeningResponseRequest;
+  options?: RequestOptions;
+};
+
+export type VendorScansSubmitScreeningResponseMutationData =
+  operations.SubmitScreeningResponseResponseBody;
+
+/**
+ * Create a screening response for a vendor scan
+ *
+ * @remarks
+ * Submits a response to a screening question for the specified vendor scan.
+ * The response may contain a single selected answer, multiple answer IDs
+ * (for multi-select questions), or a custom free-text answer. The endpoint
+ * also executes any triggered actions associated with the response and
+ * indicates whether there is a next screening question.
+ */
+export function useVendorScansSubmitScreeningResponseMutation(
+  options?: MutationHookOptions<
+    VendorScansSubmitScreeningResponseMutationData,
+    Error,
+    VendorScansSubmitScreeningResponseMutationVariables
+  >,
+): UseMutationResult<
+  VendorScansSubmitScreeningResponseMutationData,
+  Error,
+  VendorScansSubmitScreeningResponseMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorScansSubmitScreeningResponseMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorScansSubmitScreeningResponse(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "submitScreeningResponse",
+  ];
+}
+
+export function buildVendorScansSubmitScreeningResponseMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorScansSubmitScreeningResponseMutationVariables,
+  ) => Promise<VendorScansSubmitScreeningResponseMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorScansSubmitScreeningResponse(),
+    mutationFn: function vendorScansSubmitScreeningResponseMutationFn({
+      request,
+      options,
+    }): Promise<VendorScansSubmitScreeningResponseMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorScansSubmitScreeningResponse(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsChangeSubscription.ts

@@ -28,7 +28,10 @@ export type VendorsChangeSubscriptionMutationData =
  * Change subscription
  *
  * @remarks
- * Calculate subscription price
+ * Change a vendor's credentialing subscription by updating the vendor type
+ * and/or target facilities. If the new selection increases the subscription
+ * price, an invoice is created and the payment profile is charged; the
+ * response includes the invoice id.
  */
 export function useVendorsChangeSubscriptionMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsListVendorAdditionalFacilityFields.ts

@@ -53,7 +53,9 @@ export {
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFields(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -76,7 +78,9 @@ export function useVendorsListVendorAdditionalFacilityFields(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -102,7 +106,9 @@ export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,
@@ -142,7 +148,9 @@ export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfiniteSuspense(
   request: operations.ListVendorAdditionalFacilityFieldsRequest,