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

package/src/funcs/invoicesConvertQuote.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function invoicesConvertQuote(
+  client: GreenSecurityCore,
+  request: operations.ConvertQuoteRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ConvertQuoteConvertQuoteOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ConvertQuoteRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ConvertQuoteConvertQuoteOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ConvertQuoteRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/invoices/{id}/convert")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "convertQuote",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.ConvertQuoteConvertQuoteOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ConvertQuoteConvertQuoteOk$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.44.0",
-  sdkVersion: "0.45.0-beta.7",
+  sdkVersion: "0.45.0-beta.9",
   genVersion: "2.933.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.45.0-beta.7 2.933.0 0.44.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.45.0-beta.9 2.933.0 0.44.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/operations/convertquote.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ConvertQuoteRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+};
+
+/**
+ * The quote was converted, and the server has returned the resulting invoice.
+ */
+export type ConvertQuoteConvertQuoteOk = {
+  /**
+   * Identifier of the invoice the quote was converted into.
+   */
+  id: number;
+  success: boolean;
+  /**
+   * Tax calculated on the new invoice.
+   */
+  tax?: number | null | undefined;
+  /**
+   * Shipping calculated on the new invoice.
+   */
+  shipping?: number | null | undefined;
+  /**
+   * Convenience fee calculated on the new invoice.
+   */
+  convenienceFee?: number | null | undefined;
+  /**
+   * Total amount due on the new invoice, including tax, shipping and the convenience fee.
+   */
+  total?: number | null | undefined;
+};
+
+/** @internal */
+export type ConvertQuoteRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const ConvertQuoteRequest$outboundSchema: z.ZodType<
+  ConvertQuoteRequest$Outbound,
+  z.ZodTypeDef,
+  ConvertQuoteRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+export function convertQuoteRequestToJSON(
+  convertQuoteRequest: ConvertQuoteRequest,
+): string {
+  return JSON.stringify(
+    ConvertQuoteRequest$outboundSchema.parse(convertQuoteRequest),
+  );
+}
+
+/** @internal */
+export const ConvertQuoteConvertQuoteOk$inboundSchema: z.ZodType<
+  ConvertQuoteConvertQuoteOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  success: types.boolean(),
+  tax: z.nullable(types.number()).optional(),
+  shipping: z.nullable(types.number()).optional(),
+  convenience_fee: z.nullable(types.number()).optional(),
+  total: z.nullable(types.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "convenience_fee": "convenienceFee",
+  });
+});
+
+export function convertQuoteConvertQuoteOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ConvertQuoteConvertQuoteOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConvertQuoteConvertQuoteOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConvertQuoteConvertQuoteOk' from JSON`,
+  );
+}

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";