@greensecurity/javascript-sdk 0.45.0-beta.0 → 0.45.0-beta.10

package/src/react-query/invoicesConvertQuote.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { invoicesConvertQuote } from "../funcs/invoicesConvertQuote.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 InvoicesConvertQuoteMutationVariables = {
+  request: operations.ConvertQuoteRequest;
+  options?: RequestOptions;
+};
+
+export type InvoicesConvertQuoteMutationData =
+  operations.ConvertQuoteConvertQuoteOk;
+
+export type InvoicesConvertQuoteMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Convert a quote into an invoice
+ *
+ * @remarks
+ * Converts a quote into the real invoice its caller will be charged for, and
+ * returns the new invoice with its calculated totals. Any `VendorCredential`
+ * linked to the quote is re-pointed at the new invoice.
+ *
+ * The operation is idempotent: converting a quote that has already been
+ * processed returns the invoice previously created from it rather than
+ * creating a second one, so a retried request is safe.
+ *
+ * The referenced invoice must actually be a quote — a non-quote invoice id
+ * responds `400`. Requires a caller whose access scope permits creating
+ * invoices; a caller allowed to create the invoice but not to update the
+ * linked `VendorCredential` responds `401`.
+ *
+ * Takes no request body.
+ */
+export function useInvoicesConvertQuoteMutation(
+  options?: MutationHookOptions<
+    InvoicesConvertQuoteMutationData,
+    InvoicesConvertQuoteMutationError,
+    InvoicesConvertQuoteMutationVariables
+  >,
+): UseMutationResult<
+  InvoicesConvertQuoteMutationData,
+  InvoicesConvertQuoteMutationError,
+  InvoicesConvertQuoteMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildInvoicesConvertQuoteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyInvoicesConvertQuote(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "invoices", "convertQuote"];
+}
+
+export function buildInvoicesConvertQuoteMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: InvoicesConvertQuoteMutationVariables,
+  ) => Promise<InvoicesConvertQuoteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyInvoicesConvertQuote(),
+    mutationFn: function invoicesConvertQuoteMutationFn({
+      request,
+      options,
+    }): Promise<InvoicesConvertQuoteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(invoicesConvertQuote(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsGetVendorCredentialDetails.ts

@@ -63,6 +63,7 @@ export type VendorsGetVendorCredentialDetailsQueryError =
  *   - vendor_credential.credential
  *   - vendor_credential.vendor
  *   - vendor_credential.invoice
+ *   - vendor_credential.quote
  *   - vendor_credential.vendor_credential_files
  *   - vendor_credential.latest_vendor_credential_id
  *   - vendor_credential.previously_approved
@@ -118,6 +119,7 @@ export function useVendorsGetVendorCredentialDetails(
  *   - vendor_credential.credential
  *   - vendor_credential.vendor
  *   - vendor_credential.invoice
+ *   - vendor_credential.quote
  *   - vendor_credential.vendor_credential_files
  *   - vendor_credential.latest_vendor_credential_id
  *   - vendor_credential.previously_approved

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

@@ -57,6 +57,7 @@ export function buildVendorsVendorsExportQuery(
       zipLike: request.zipLike,
       status: request.status,
       companyId: request.companyId,
+      externallyManagedByCompanyId: request.externallyManagedByCompanyId,
       credentialingSubscriptionIdNull: request.credentialingSubscriptionIdNull,
       scrubsSubscriptionIdNull: request.scrubsSubscriptionIdNull,
       credentialingSubscriptionStatus: request.credentialingSubscriptionStatus,
@@ -110,6 +111,7 @@ export function queryKeyVendorsVendorsExport(
     zipLike?: string | undefined;
     status?: string | undefined;
     companyId?: number | undefined;
+    externallyManagedByCompanyId?: number | undefined;
     credentialingSubscriptionIdNull?: string | undefined;
     scrubsSubscriptionIdNull?: string | undefined;
     credentialingSubscriptionStatus?: string | undefined;

package/src/react-query/vendorsVendorsExport.ts

@@ -58,7 +58,10 @@ export type VendorsVendorsExportQueryError =
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint).
+ * provided filters (the same filters supported by the vendors list endpoint), in the same
+ * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * applicable credential (status, due date, expiration), plus counts and percentage approved,
+ * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
  */
@@ -88,7 +91,10 @@ export function useVendorsVendorsExport(
  *
  * @remarks
  * Enqueues an asynchronous job to generate a CSV export of vendors based on the
- * provided filters (the same filters supported by the vendors list endpoint).
+ * provided filters (the same filters supported by the vendors list endpoint), in the same
+ * credential-inclusive format as the portal's "Download Full Report" button - one column per
+ * applicable credential (status, due date, expiration), plus counts and percentage approved,
+ * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
  */
@@ -130,6 +136,7 @@ export function setVendorsVendorsExportData(
       zipLike?: string | undefined;
       status?: string | undefined;
       companyId?: number | undefined;
+      externallyManagedByCompanyId?: number | undefined;
       credentialingSubscriptionIdNull?: string | undefined;
       scrubsSubscriptionIdNull?: string | undefined;
       credentialingSubscriptionStatus?: string | undefined;
@@ -170,6 +177,7 @@ export function invalidateVendorsVendorsExport(
       zipLike?: string | undefined;
       status?: string | undefined;
       companyId?: number | undefined;
+      externallyManagedByCompanyId?: number | undefined;
       credentialingSubscriptionIdNull?: string | undefined;
       scrubsSubscriptionIdNull?: string | undefined;
       credentialingSubscriptionStatus?: string | undefined;

package/src/sdk/invoices.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { invoicesConvertQuote } from "../funcs/invoicesConvertQuote.js";
 import { invoicesCreateInvoice } from "../funcs/invoicesCreateInvoice.js";
 import {
   DownloadInvoicesExportAcceptEnum,
@@ -152,6 +153,36 @@ export class Invoices extends ClientSDK {
     ));
   }
 
+  /**
+   * Convert a quote into an invoice
+   *
+   * @remarks
+   * Converts a quote into the real invoice its caller will be charged for, and
+   * returns the new invoice with its calculated totals. Any `VendorCredential`
+   * linked to the quote is re-pointed at the new invoice.
+   *
+   * The operation is idempotent: converting a quote that has already been
+   * processed returns the invoice previously created from it rather than
+   * creating a second one, so a retried request is safe.
+   *
+   * The referenced invoice must actually be a quote — a non-quote invoice id
+   * responds `400`. Requires a caller whose access scope permits creating
+   * invoices; a caller allowed to create the invoice but not to update the
+   * linked `VendorCredential` responds `401`.
+   *
+   * Takes no request body.
+   */
+  async convertQuote(
+    request: operations.ConvertQuoteRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ConvertQuoteConvertQuoteOk> {
+    return unwrapAsync(invoicesConvertQuote(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Export invoices to csv (async)
    *

package/src/sdk/vendors.ts

@@ -273,6 +273,7 @@ export class Vendors extends ClientSDK {
    *   - vendor_credential.credential
    *   - vendor_credential.vendor
    *   - vendor_credential.invoice
+   *   - vendor_credential.quote
    *   - vendor_credential.vendor_credential_files
    *   - vendor_credential.latest_vendor_credential_id
    *   - vendor_credential.previously_approved
@@ -1078,7 +1079,10 @@ export class Vendors extends ClientSDK {
    *
    * @remarks
    * Enqueues an asynchronous job to generate a CSV export of vendors based on the
-   * provided filters (the same filters supported by the vendors list endpoint).
+   * provided filters (the same filters supported by the vendors list endpoint), in the same
+   * credential-inclusive format as the portal's "Download Full Report" button - one column per
+   * applicable credential (status, due date, expiration), plus counts and percentage approved,
+   * alongside the vendor's identity, contact, and company details.
    * Returns a `status_url` to poll until the export is ready, plus a
    * `download_url` and `status_id`.
    */