@greensecurity/javascript-sdk 0.48.0-beta.8 → 0.48.0

package/src/__tests__/subscriptionPlanSelection.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it, vi } from "vitest";
+
+const { doPostMock } = vi.hoisted(() => ({
+  doPostMock: vi.fn(() => Promise.resolve([{ ok: true }, { status: "complete" }])),
+}));
+
+vi.mock("../admin-funcs/doAdmin.js", () => ({
+  $doPost: doPostMock,
+}));
+
+import { subscriptionFinishScreeningQuestions } from "../admin-funcs/subscriptionFinishScreeningQuestions.js";
+import { subscriptionPlanSelectionResponse$inboundSchema } from "../admin-funcs/subscriptionPlanSelection.js";
+import { subscriptionUpdateVendorType } from "../admin-funcs/subscriptionUpdateVendorType.js";
+
+// GSSD-7289: both steps answer whether the vendor has a plan to choose, and the SDK holds the
+// server to it.
+describe("subscription plan selection responses", () => {
+  it("validates finishing the screening questions against the plan selection schema", () => {
+    subscriptionFinishScreeningQuestions({ vendor_id: 7 });
+
+    expect(doPostMock).toHaveBeenCalledWith(
+      "/subscription/screening-questions",
+      { vendor_id: 7 },
+      undefined,
+      subscriptionPlanSelectionResponse$inboundSchema,
+    );
+  });
+
+  it("validates choosing a vendor type against the plan selection schema", () => {
+    subscriptionUpdateVendorType({ vendor_id: 7, vendor_type_id: [10] });
+
+    expect(doPostMock).toHaveBeenCalledWith(
+      "/subscription/vendor-type",
+      { vendor_id: 7, vendor_type_id: [10] },
+      undefined,
+      subscriptionPlanSelectionResponse$inboundSchema,
+    );
+  });
+
+  it("accepts a response that says whether a plan must be chosen, keeping other fields", () => {
+    const parsed = subscriptionPlanSelectionResponse$inboundSchema.parse({
+      success: true,
+      plan_selection_required: false,
+      extra: 1,
+    });
+
+    expect(parsed).toEqual({ success: true, plan_selection_required: false, extra: 1 });
+  });
+
+  it("rejects a response without plan_selection_required", () => {
+    expect(subscriptionPlanSelectionResponse$inboundSchema.safeParse({ success: true }).success).toBe(false);
+  });
+});

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 3502.49,
+    creditBalance: 5488.14,
   });
 });
 

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: 0,
+      desc: true,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();
@@ -62,10 +62,11 @@ test("Webhooks Updates The Webhook Endpoint With The Given Id", async () => {
       id: 220782,
       webhookEndpointUpdate: {
         webhookUrl: "https://example.com/webhook/incoming",
-        subscriptions: [
-          "Vendor.updated",
-          "Vendor.created",
-        ],
+        subscriptions: {
+          model: "Vendor",
+          action: "updated",
+          expands: "vendor.company,vendor.user",
+        },
         consumers: {
           systemId: 1,
           facilityId: 1,

package/src/__tests__/zones.test.ts

@@ -36,35 +36,7 @@ test("Zones List Or Search Security Zones", async () => {
     },
     items: [
       {
-        facility: {
-          contacts: {
-            contact: {
-              status: "Inactive",
-              department: 123,
-            },
-            adminContact: {
-              status: "Inactive",
-              department: 123,
-            },
-            techContact: {
-              status: "Deleted",
-              department: 123,
-            },
-            greenSecurityCsm: {
-              status: "Inactive",
-              department: 123,
-            },
-            accountManager: {
-              status: "Active",
-              department: 123,
-            },
-          },
-          vendorGuestPolicy: {
-            enabled: true,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
       {
         facility: {},
@@ -86,7 +58,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 64369,
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/doAdmin.ts

@@ -20,9 +20,11 @@ import { Result } from "../types/fp.js";
 import { getInternalCore } from "./initializeCore.js";
 import { encodeJSON } from "../lib/encodings.js";
 
-export type internalApiResult = APIPromise<
+// An internal call whose response is validated against a schema for `T` (see $doPost's
+// responseSchema). internalApiResult is the untyped default.
+export type internalApiResultOf<T> = APIPromise<
   Result<
-    Json,
+    T,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | SDKValidationError
@@ -34,6 +36,8 @@ export type internalApiResult = APIPromise<
   >
 >;
 
+export type internalApiResult = internalApiResultOf<Json>;
+
 // This creates a generic JSON schema that can be used to validate any JSON object
 const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
 type Literal = z.infer<typeof literalSchema>;
@@ -201,10 +205,10 @@ export async function $doGetSingle<T extends object>(
   return [result, { status: "complete", request: req, response }];
 }
 
-type BodyResult = Promise<
+type BodyResult<T = Json> = Promise<
   [
     Result<
-      Json,
+      T,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -222,13 +226,18 @@ type BodyResult = Promise<
 // Shared by the JSON and multipart requests below: everything except the method, how the body
 // is built and whether we name a Content-Type. A multipart body must NOT carry one, because only
 // fetch can append the boundary it generates.
-async function $doBodyRequest(
+async function $doBodyRequest<R = Json>(
   method: "POST" | "PUT",
   route: string,
   body: BodyInit | undefined,
   contentTypeHeader: Record<string, string>,
   options?: RequestOptions,
-): BodyResult {
+  responseSchema?: z.ZodType<R>,
+): BodyResult<R> {
+  // Without a schema the body is only checked to be JSON, which is every caller before typed
+  // responses existed.
+  const schema = (responseSchema ?? jsonSchema) as z.ZodType<R>;
+
   const client = getInternalCore();
   if (!client) {
     throw new Error("GreenSecurityCore client is not initialized.");
@@ -290,7 +299,7 @@ async function $doBodyRequest(
   };
 
   const [result] = await M.match<
-    Json,
+    R,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -301,10 +310,10 @@ async function $doBodyRequest(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, jsonSchema),
+    M.json(200, schema),
     // A REST create answers 201, which matches none of the cases below — an unmatched status is
     // an error, so the caller saw a failure for a request the server had accepted.
-    M.json(201, jsonSchema),
+    M.json(201, schema),
     // 422 is a real answer here, not a surprise: the create returns it for a refused certificate
     // and for a model validation failure. Left out, it fell through to M.fail("4XX"), which
     // yields a generic APIError and hides the server's message from the form.
@@ -319,17 +328,21 @@ async function $doBodyRequest(
   return [result, { status: "complete", request: req, response }];
 }
 
-export async function $doPost<T extends object>(
+// Pass responseSchema to validate and type the 200/201 body; a body that does not match it comes
+// back as a ResponseValidationError instead of being handed to the caller.
+export async function $doPost<T extends object, R = Json>(
   route: string,
   postData: T,
   options?: RequestOptions,
-): BodyResult {
+  responseSchema?: z.ZodType<R>,
+): BodyResult<R> {
   return $doBodyRequest(
     "POST",
     route,
     encodeJSON("body", postData, { explode: true }),
     { "Content-Type": "application/json" },
     options,
+    responseSchema,
   );
 }
 

package/src/admin-funcs/subscriptionFinishScreeningQuestions.ts

@@ -1,13 +1,21 @@
 import { APIPromise } from "../types/async.js";
-import { $doPost, internalApiResult } from "./doAdmin.js";
+import { $doPost, internalApiResultOf } from "./doAdmin.js";
+import {
+  subscriptionPlanSelectionResponse,
+  subscriptionPlanSelectionResponse$inboundSchema,
+} from "./subscriptionPlanSelection.js";
 
 export type subscriptionFinishScreeningQuestionsRequest = {
   vendor_id: number;
 };
 
-export function subscriptionFinishScreeningQuestions(request: subscriptionFinishScreeningQuestionsRequest): internalApiResult  {
+export function subscriptionFinishScreeningQuestions(
+  request: subscriptionFinishScreeningQuestionsRequest,
+): internalApiResultOf<subscriptionPlanSelectionResponse> {
   return new APIPromise($doPost(
     "/subscription/screening-questions",
-    request
+    request,
+    undefined,
+    subscriptionPlanSelectionResponse$inboundSchema,
   ));
 }

package/src/admin-funcs/subscriptionPlanSelection.ts

@@ -0,0 +1,17 @@
+import * as z from "zod/v3";
+
+// What finishing the screening questions or choosing a vendor type answers. GSSD-7289.
+export type subscriptionPlanSelectionResponse = {
+  success: boolean;
+  // false when Standard is the vendor's only plan (e.g. Level 1, which cannot buy Emerald): the
+  // server has already selected it, so the plan step is skipped and the next step is the invoice.
+  plan_selection_required: boolean;
+};
+
+// Unknown fields pass through, so the server can add to the response without breaking callers.
+export const subscriptionPlanSelectionResponse$inboundSchema: z.ZodType<subscriptionPlanSelectionResponse> = z
+  .object({
+    success: z.boolean(),
+    plan_selection_required: z.boolean(),
+  })
+  .passthrough();

package/src/admin-funcs/subscriptionUpdateVendorType.ts

@@ -1,14 +1,22 @@
 import { APIPromise } from "../types/async.js";
-import { $doPost, internalApiResult } from "./doAdmin.js";
+import { $doPost, internalApiResultOf } from "./doAdmin.js";
+import {
+  subscriptionPlanSelectionResponse,
+  subscriptionPlanSelectionResponse$inboundSchema,
+} from "./subscriptionPlanSelection.js";
 
 export type subscriptionUpdateVendorTypeRequest = {
   vendor_id: number;
   vendor_type_id: number[];
 };
 
-export function subscriptionUpdateVendorType(request: subscriptionUpdateVendorTypeRequest): internalApiResult  {
+export function subscriptionUpdateVendorType(
+  request: subscriptionUpdateVendorTypeRequest,
+): internalApiResultOf<subscriptionPlanSelectionResponse> {
   return new APIPromise($doPost(
     "/subscription/vendor-type",
-    request
+    request,
+    undefined,
+    subscriptionPlanSelectionResponse$inboundSchema,
   ));
 }

package/src/admin-funcs/zoneDevicesUpdate.ts

@@ -9,6 +9,10 @@ export type zoneDevicesUpdateRequest = {
   network_id?: number;
   connection_type?: zoneDeviceConnectionType;
   name?: string;
+  // Sent once the app has pushed the network's current settings to the gateway; only a network edit sets it.
+  needs_network_update?: false;
+  // The provisioning response's network_revision for the settings that were pushed; required with the clear.
+  network_revision?: string;
 };
 
 // Edits a gateway from the Gatekeeper device details screen. This only updates the record; the

package/src/funcs/invoicesConvertQuote.ts

@@ -3,7 +3,7 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.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";
@@ -43,10 +43,7 @@ import { Result } from "../types/fp.js";
  * invoices; a caller allowed to create the invoice but not to update the
  * linked `VendorCredential` responds `401`.
  *
- * Optionally takes `send_to_company_manager`, for a quote linked to a
- * `VendorCredential`: send `true` when the vendor is sending the
- * converted invoice to their company managers to pay instead of paying
- * it themselves. It follows the same rules as on `POST /invoices`.
+ * Takes no request body.
  *
  * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission—the caller's role and their relationship to the record decide what it returns.
  *
@@ -107,7 +104,7 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = null;
 
   const pathParams = {
     id: encodeSimple("id", payload.id, {
@@ -118,7 +115,6 @@ async function $do(
   const path = pathToFunc("/invoices/{id}/convert")(pathParams);
 
   const headers = new Headers(compactMap({
-    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 

package/src/funcs/vendorsCreateVendorCompany.ts

@@ -50,6 +50,7 @@ export function vendorsCreateVendorCompany(
   Result<
     operations.CreateVendorCompanyCreateVendorCompanyOk,
     | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -76,6 +77,7 @@ async function $do(
     Result<
       operations.CreateVendorCompanyCreateVendorCompanyOk,
       | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
       | GreenSecurityError
       | ResponseValidationError
       | ConnectionError
@@ -165,6 +167,7 @@ async function $do(
   const [result] = await M.match<
     operations.CreateVendorCompanyCreateVendorCompanyOk,
     | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -179,6 +182,7 @@ async function $do(
       operations.CreateVendorCompanyCreateVendorCompanyOk$inboundSchema,
     ),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableEntityOrValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });

package/src/lib/config.ts

@@ -79,9 +79,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.47.0",
-  sdkVersion: "0.48.0-beta.8",
-  genVersion: "2.950.2",
+  openapiDocVersion: "0.48.0",
+  sdkVersion: "0.48.0",
+  genVersion: "2.952.5",
   userAgent:
-    "speakeasy-sdk/typescript 0.48.0-beta.8 2.950.2 0.47.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.48.0 2.952.5 0.48.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/fhirconfig.ts

@@ -47,6 +47,10 @@ export type ProductionProfile = {
    * The private key used to sign token requests to the production FHIR instance.
    */
   privateKey?: string | undefined;
+  /**
+   * Extra HTTP headers to send with the token request and with every FHIR request to the production instance, as a map of header name to value. Merged over the headers the client sets itself, so an entry named `Authorization`, `Content-Type` or `Accept` replaces the default. Empty when the facility's gateway needs none, which is the usual case. A value may be a credential, so this field is only served to callers allowed to see this configuration's secrets.
+   */
+  customHeaders?: { [k: string]: string } | undefined;
   /**
    * Relative path of the self-hosted JSON Web Key (JWK) Set URL (JKU) serving this configuration's production public signing keys.
    */
@@ -97,6 +101,10 @@ export type NonProductionProfile = {
    * The private key used to sign token requests to the non-production FHIR instance.
    */
   privateKeyNp?: string | undefined;
+  /**
+   * Extra HTTP headers to send with the token request and with every FHIR request to the non-production instance, as a map of header name to value. Merged over the headers the client sets itself, so an entry named `Authorization`, `Content-Type` or `Accept` replaces the default. Empty when the facility's gateway needs none, which is the usual case. A value may be a credential, so this field is only served to callers allowed to see this configuration's secrets.
+   */
+  customHeadersNp?: { [k: string]: string } | undefined;
   /**
    * Relative path of the self-hosted JWK Set URL (JKU) serving this configuration's non-production public signing keys.
    */
@@ -221,6 +229,7 @@ export const ProductionProfile$inboundSchema: z.ZodType<
   patient_list_url: types.optional(types.string()),
   patient_list_id: types.optional(types.string()),
   private_key: types.optional(types.string()),
+  custom_headers: types.optional(z.record(types.string())),
   jku_path: types.optional(types.string()),
   jku_url: z.nullable(types.string()).optional(),
   signing_kid: z.nullable(types.string()).optional(),
@@ -234,6 +243,7 @@ export const ProductionProfile$inboundSchema: z.ZodType<
     "patient_list_url": "patientListUrl",
     "patient_list_id": "patientListId",
     "private_key": "privateKey",
+    "custom_headers": "customHeaders",
     "jku_path": "jkuPath",
     "jku_url": "jkuUrl",
     "signing_kid": "signingKid",
@@ -264,6 +274,7 @@ export const NonProductionProfile$inboundSchema: z.ZodType<
   patient_list_url_np: types.optional(types.string()),
   patient_list_id_np: types.optional(types.string()),
   private_key_np: types.optional(types.string()),
+  custom_headers_np: types.optional(z.record(types.string())),
   jku_path_np: types.optional(types.string()),
   jku_url_np: z.nullable(types.string()).optional(),
   signing_kid_np: z.nullable(types.string()).optional(),
@@ -277,6 +288,7 @@ export const NonProductionProfile$inboundSchema: z.ZodType<
     "patient_list_url_np": "patientListUrlNp",
     "patient_list_id_np": "patientListIdNp",
     "private_key_np": "privateKeyNp",
+    "custom_headers_np": "customHeadersNp",
     "jku_path_np": "jkuPathNp",
     "jku_url_np": "jkuUrlNp",
     "signing_kid_np": "signingKidNp",

package/src/models/components/invoice.ts

@@ -141,10 +141,6 @@ export type Invoice = {
    * When the invoice was created.
    */
   dateCreated?: string | null | undefined;
-  /**
-   * When the vendor sent this invoice to their company managers to pay instead of paying it themselves (`send_to_company_manager` on `POST /invoices` or `POST /invoices/{id}/convert`). `null` if it was never sent, or if the vendor took it back or settled it themselves. It is kept on an invoice the managers paid, and on one that was later voided.
-   */
-  dateSentToCompanyManager?: string | null | undefined;
   /**
    * The date the invoice payment is due. `null` if no due date is set.
    */
@@ -397,7 +393,6 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     date_processed: z.nullable(types.string()).optional(),
     date_paid: z.nullable(types.string()).optional(),
     date_created: z.nullable(types.string()).optional(),
-    date_sent_to_company_manager: z.nullable(types.string()).optional(),
     date_due: z.nullable(types.string()).optional(),
     amount: z.nullable(types.number()).optional(),
     status: z.nullable(types.string()).optional(),
@@ -426,7 +421,6 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
       "date_processed": "dateProcessed",
       "date_paid": "datePaid",
       "date_created": "dateCreated",
-      "date_sent_to_company_manager": "dateSentToCompanyManager",
       "date_due": "dateDue",
       "financial_status": "financialStatus",
       "amount_not_paid": "amountNotPaid",
@@ -445,7 +439,6 @@ export type Invoice$Outbound = {
   date_processed?: string | null | undefined;
   date_paid?: string | null | undefined;
   date_created?: string | null | undefined;
-  date_sent_to_company_manager?: string | null | undefined;
   date_due?: string | null | undefined;
   amount?: number | null | undefined;
   status?: string | null | undefined;
@@ -478,7 +471,6 @@ export const Invoice$outboundSchema: z.ZodType<
   dateProcessed: z.nullable(z.string()).optional(),
   datePaid: z.nullable(z.string()).optional(),
   dateCreated: z.nullable(z.string()).optional(),
-  dateSentToCompanyManager: z.nullable(z.string()).optional(),
   dateDue: z.nullable(z.string()).optional(),
   amount: z.nullable(z.number().int()).optional(),
   status: z.nullable(z.string()).optional(),
@@ -506,7 +498,6 @@ export const Invoice$outboundSchema: z.ZodType<
     dateProcessed: "date_processed",
     datePaid: "date_paid",
     dateCreated: "date_created",
-    dateSentToCompanyManager: "date_sent_to_company_manager",
     dateDue: "date_due",
     financialStatus: "financial_status",
     amountNotPaid: "amount_not_paid",

package/src/models/operations/convertquote.ts

@@ -9,25 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Whether the vendor is sending the converted invoice to their company managers.
- */
-export type ConvertQuoteRequestBody = {
-  /**
-   * Set to `true` when the vendor is sending the converted invoice to their company managers to pay instead of paying it themselves, and `false` to take it back. Recorded on the invoice as `date_sent_to_company_manager`; the managers are asked to pay once the credential is submitted. Omit the field to leave the invoice as it is. Ignored when no `VendorCredential` is linked to the quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` and the quote is not converted.
-   */
-  sendToCompanyManager?: boolean | undefined;
-};
-
 export type ConvertQuoteRequest = {
   /**
    * The identifier of the object.
    */
   id: number;
-  /**
-   * Whether the vendor is sending the converted invoice to their company managers.
-   */
-  requestBody?: ConvertQuoteRequestBody | undefined;
 };
 
 /**
@@ -57,36 +43,9 @@ export type ConvertQuoteConvertQuoteOk = {
   total?: number | null | undefined;
 };
 
-/** @internal */
-export type ConvertQuoteRequestBody$Outbound = {
-  send_to_company_manager?: boolean | undefined;
-};
-
-/** @internal */
-export const ConvertQuoteRequestBody$outboundSchema: z.ZodType<
-  ConvertQuoteRequestBody$Outbound,
-  z.ZodTypeDef,
-  ConvertQuoteRequestBody
-> = z.object({
-  sendToCompanyManager: z.boolean().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    sendToCompanyManager: "send_to_company_manager",
-  });
-});
-
-export function convertQuoteRequestBodyToJSON(
-  convertQuoteRequestBody: ConvertQuoteRequestBody,
-): string {
-  return JSON.stringify(
-    ConvertQuoteRequestBody$outboundSchema.parse(convertQuoteRequestBody),
-  );
-}
-
 /** @internal */
 export type ConvertQuoteRequest$Outbound = {
   id: number;
-  RequestBody?: ConvertQuoteRequestBody$Outbound | undefined;
 };
 
 /** @internal */
@@ -96,11 +55,6 @@ export const ConvertQuoteRequest$outboundSchema: z.ZodType<
   ConvertQuoteRequest
 > = z.object({
   id: z.number().int(),
-  requestBody: z.lazy(() => ConvertQuoteRequestBody$outboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    requestBody: "RequestBody",
-  });
 });
 
 export function convertQuoteRequestToJSON(