@greensecurity/javascript-sdk 0.45.0-beta.7 → 0.45.0-beta.8

package/src/models/operations/createinvoice.ts

@@ -33,10 +33,27 @@ export type CreateInvoiceRequestBodyInvoicesRequestLines = {
   paymentHandlerData?: string | undefined;
 };
 
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export const CreateInvoiceRequestBodyInvoicesRequestInvoiceType = {
+  Quote: "quote",
+} as const;
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export type CreateInvoiceRequestBodyInvoicesRequestInvoiceType = ClosedEnum<
+  typeof CreateInvoiceRequestBodyInvoicesRequestInvoiceType
+>;
+
 export type Five = {
   vendorCredentialId: number;
   lines?: Array<CreateInvoiceRequestBodyInvoicesRequestLines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
+  /**
+   * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+   */
+  invoiceType?: CreateInvoiceRequestBodyInvoicesRequestInvoiceType | undefined;
 };
 
 export const CreateInvoiceRequestBodyInvoicesPaymentHandler = {
@@ -59,10 +76,27 @@ export type CreateInvoiceRequestBodyInvoicesLines = {
   paymentHandlerData?: string | undefined;
 };
 
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export const CreateInvoiceRequestBodyInvoicesInvoiceType = {
+  Quote: "quote",
+} as const;
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export type CreateInvoiceRequestBodyInvoicesInvoiceType = ClosedEnum<
+  typeof CreateInvoiceRequestBodyInvoicesInvoiceType
+>;
+
 export type Four = {
   systemId: number;
   lines?: Array<CreateInvoiceRequestBodyInvoicesLines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
+  /**
+   * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+   */
+  invoiceType?: CreateInvoiceRequestBodyInvoicesInvoiceType | undefined;
 };
 
 export const CreateInvoiceRequestBodyPaymentHandler = {
@@ -85,10 +119,27 @@ export type CreateInvoiceRequestBodyLines = {
   paymentHandlerData?: string | undefined;
 };
 
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export const CreateInvoiceRequestBodyInvoiceType = {
+  Quote: "quote",
+} as const;
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export type CreateInvoiceRequestBodyInvoiceType = ClosedEnum<
+  typeof CreateInvoiceRequestBodyInvoiceType
+>;
+
 export type Three = {
   facilityId: number;
   lines?: Array<CreateInvoiceRequestBodyLines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
+  /**
+   * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+   */
+  invoiceType?: CreateInvoiceRequestBodyInvoiceType | undefined;
 };
 
 export const RequestBodyPaymentHandler = {
@@ -111,10 +162,25 @@ export type RequestBodyLines = {
   paymentHandlerData?: string | undefined;
 };
 
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export const RequestBodyInvoiceType = {
+  Quote: "quote",
+} as const;
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export type RequestBodyInvoiceType = ClosedEnum<typeof RequestBodyInvoiceType>;
+
 export type CreateInvoiceRequestBody2 = {
   companyId: number;
   lines?: Array<RequestBodyLines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
+  /**
+   * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+   */
+  invoiceType?: RequestBodyInvoiceType | undefined;
 };
 
 export const PaymentHandler = {
@@ -135,10 +201,25 @@ export type Lines = {
   paymentHandlerData?: string | undefined;
 };
 
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export const InvoiceType = {
+  Quote: "quote",
+} as const;
+/**
+ * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+ */
+export type InvoiceType = ClosedEnum<typeof InvoiceType>;
+
 export type RequestBody1 = {
   vendorId: number;
   lines?: Array<Lines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
+  /**
+   * Set to `quote` to create a non-chargeable quote, used to preview an invoice's calculated totals before committing to it. Convert the quote into the real invoice with `POST /invoices/{id}/convert`. Omit this field to create a chargeable invoice directly.
+   */
+  invoiceType?: InvoiceType | undefined;
 };
 
 export type CreateInvoiceRequestBody =
@@ -218,6 +299,11 @@ export function createInvoiceRequestBodyInvoicesRequestLinesToJSON(
   );
 }
 
+/** @internal */
+export const CreateInvoiceRequestBodyInvoicesRequestInvoiceType$outboundSchema:
+  z.ZodNativeEnum<typeof CreateInvoiceRequestBodyInvoicesRequestInvoiceType> = z
+    .nativeEnum(CreateInvoiceRequestBodyInvoicesRequestInvoiceType);
+
 /** @internal */
 export type Five$Outbound = {
   vendor_credential_id: number;
@@ -225,6 +311,7 @@ export type Five$Outbound = {
     | Array<CreateInvoiceRequestBodyInvoicesRequestLines$Outbound>
     | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
+  invoice_type?: string | undefined;
 };
 
 /** @internal */
@@ -235,10 +322,14 @@ export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
       z.lazy(() => CreateInvoiceRequestBodyInvoicesRequestLines$outboundSchema),
     ).optional(),
     credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
+    invoiceType:
+      CreateInvoiceRequestBodyInvoicesRequestInvoiceType$outboundSchema
+        .optional(),
   }).transform((v) => {
     return remap$(v, {
       vendorCredentialId: "vendor_credential_id",
       credentialPricingIds: "credential_pricing_ids",
+      invoiceType: "invoice_type",
     });
   });
 
@@ -304,11 +395,17 @@ export function createInvoiceRequestBodyInvoicesLinesToJSON(
   );
 }
 
+/** @internal */
+export const CreateInvoiceRequestBodyInvoicesInvoiceType$outboundSchema:
+  z.ZodNativeEnum<typeof CreateInvoiceRequestBodyInvoicesInvoiceType> = z
+    .nativeEnum(CreateInvoiceRequestBodyInvoicesInvoiceType);
+
 /** @internal */
 export type Four$Outbound = {
   system_id: number;
   lines?: Array<CreateInvoiceRequestBodyInvoicesLines$Outbound> | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
+  invoice_type?: string | undefined;
 };
 
 /** @internal */
@@ -319,10 +416,13 @@ export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
       z.lazy(() => CreateInvoiceRequestBodyInvoicesLines$outboundSchema),
     ).optional(),
     credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
+    invoiceType: CreateInvoiceRequestBodyInvoicesInvoiceType$outboundSchema
+      .optional(),
   }).transform((v) => {
     return remap$(v, {
       systemId: "system_id",
       credentialPricingIds: "credential_pricing_ids",
+      invoiceType: "invoice_type",
     });
   });
 
@@ -389,11 +489,18 @@ export function createInvoiceRequestBodyLinesToJSON(
   );
 }
 
+/** @internal */
+export const CreateInvoiceRequestBodyInvoiceType$outboundSchema:
+  z.ZodNativeEnum<typeof CreateInvoiceRequestBodyInvoiceType> = z.nativeEnum(
+    CreateInvoiceRequestBodyInvoiceType,
+  );
+
 /** @internal */
 export type Three$Outbound = {
   facility_id: number;
   lines?: Array<CreateInvoiceRequestBodyLines$Outbound> | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
+  invoice_type?: string | undefined;
 };
 
 /** @internal */
@@ -406,10 +513,12 @@ export const Three$outboundSchema: z.ZodType<
   lines: z.array(z.lazy(() => CreateInvoiceRequestBodyLines$outboundSchema))
     .optional(),
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
+  invoiceType: CreateInvoiceRequestBodyInvoiceType$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     facilityId: "facility_id",
     credentialPricingIds: "credential_pricing_ids",
+    invoiceType: "invoice_type",
   });
 });
 
@@ -472,11 +581,17 @@ export function requestBodyLinesToJSON(
   );
 }
 
+/** @internal */
+export const RequestBodyInvoiceType$outboundSchema: z.ZodNativeEnum<
+  typeof RequestBodyInvoiceType
+> = z.nativeEnum(RequestBodyInvoiceType);
+
 /** @internal */
 export type CreateInvoiceRequestBody2$Outbound = {
   company_id: number;
   lines?: Array<RequestBodyLines$Outbound> | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
+  invoice_type?: string | undefined;
 };
 
 /** @internal */
@@ -488,10 +603,12 @@ export const CreateInvoiceRequestBody2$outboundSchema: z.ZodType<
   companyId: z.number().int(),
   lines: z.array(z.lazy(() => RequestBodyLines$outboundSchema)).optional(),
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
+  invoiceType: RequestBodyInvoiceType$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     companyId: "company_id",
     credentialPricingIds: "credential_pricing_ids",
+    invoiceType: "invoice_type",
   });
 });
 
@@ -554,11 +671,16 @@ export function linesToJSON(lines: Lines): string {
   return JSON.stringify(Lines$outboundSchema.parse(lines));
 }
 
+/** @internal */
+export const InvoiceType$outboundSchema: z.ZodNativeEnum<typeof InvoiceType> = z
+  .nativeEnum(InvoiceType);
+
 /** @internal */
 export type RequestBody1$Outbound = {
   vendor_id: number;
   lines?: Array<Lines$Outbound> | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
+  invoice_type?: string | undefined;
 };
 
 /** @internal */
@@ -570,10 +692,12 @@ export const RequestBody1$outboundSchema: z.ZodType<
   vendorId: z.number().int(),
   lines: z.array(z.lazy(() => Lines$outboundSchema)).optional(),
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
+  invoiceType: InvoiceType$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     vendorId: "vendor_id",
     credentialPricingIds: "credential_pricing_ids",
+    invoiceType: "invoice_type",
   });
 });
 

package/src/models/operations/index.ts

@@ -15,6 +15,7 @@ export * from "./cancelhandoff.js";
 export * from "./changepassword.js";
 export * from "./changesubscription.js";
 export * from "./checkdownloadcode.js";
+export * from "./convertquote.js";
 export * from "./createcompanytargetfacility.js";
 export * from "./createevent.js";
 export * from "./createinvoice.js";

package/src/react-query/index.ts

@@ -33,6 +33,7 @@ export * from "./fhirConfigsDeleteFhirConfigById.js";
 export * from "./fhirConfigsGetFhirConfig.js";
 export * from "./fhirConfigsListOfFhirConfigurations.js";
 export * from "./fhirConfigsUpdateFhirConfigById.js";
+export * from "./invoicesConvertQuote.js";
 export * from "./invoicesCreateInvoice.js";
 export * from "./invoicesDownloadInvoicesExport.js";
 export * from "./invoicesGetInvoice.js";

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/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)
    *