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

package/src/__tests__/zoneDevicesCreate.test.ts

@@ -1,7 +1,8 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 // Typed parameters so mock.calls is the argument tuple; see smartBadgeGetPsks.test.ts.
-const { doPostMock, doGetSingleMock, doPutMock } = vi.hoisted(() => ({
+const { doPostMock, doGetSingleMock, doPutMock, doDeleteMock } = vi.hoisted(() => ({
+  doDeleteMock: vi.fn((_route: string) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doPutMock: vi.fn((_route: string, _body: unknown) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doPostMock: vi.fn((_route: string, _body: unknown) => Promise.resolve([{ ok: true }, { status: "complete" }])),
   doGetSingleMock: vi.fn((_route: string, _query: unknown) =>
@@ -13,6 +14,7 @@ vi.mock("../admin-funcs/doAdmin.js", () => ({
   $doPost: doPostMock,
   $doGetSingle: doGetSingleMock,
   $doPut: doPutMock,
+  $doDelete: doDeleteMock,
 }));
 
 import { __internal } from "../index.extras.js";
@@ -22,6 +24,7 @@ describe("__internal.zoneDevices", () => {
     doPostMock.mockClear();
     doGetSingleMock.mockClear();
     doPutMock.mockClear();
+    doDeleteMock.mockClear();
   });
 
   it("puts only the changed fields to /zone-devices/:id", () => {
@@ -30,6 +33,18 @@ describe("__internal.zoneDevices", () => {
     expect(doPutMock).toHaveBeenCalledWith("/zone-devices/42", { zone_id: 7, connection_type: "wifi" });
   });
 
+  it("deletes /zone-devices/:id", () => {
+    __internal.zoneDevices.delete(42);
+
+    expect(doDeleteMock).toHaveBeenCalledWith("/zone-devices/42");
+  });
+
+  it("posts to /zone-devices/:id/provisioning", () => {
+    __internal.zoneDevices.provisioning(42);
+
+    expect(doPostMock).toHaveBeenCalledWith("/zone-devices/42/provisioning", {});
+  });
+
   it("posts the gateway body verbatim to /zone-devices", () => {
     const body = {
       zone_id: 7,

package/src/__tests__/zoneDevicesList.test.ts

@@ -28,10 +28,24 @@ describe("zoneDevicesList", () => {
     expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices", { zone_id: 7, items_per_page: 1 });
   });
 
+  it("sends the network filter as network_id", () => {
+    zoneDevicesList({ networkId: 3 });
+
+    expect(doGetSingleMock).toHaveBeenCalledWith("/zone-devices", { network_id: 3 });
+  });
+
   // Gatekeeper's Networks and Devices tabs call these; dropping them from `__internal` once
   // broke both without failing a build here.
   it("keeps the gatekeeper funcs on __internal", () => {
-    expect(__internal.zoneDevices).toEqual({ list: zoneDevicesList, get: zoneDevicesGet });
+    expect(__internal.zoneDevices).toEqual({
+      list: zoneDevicesList,
+      get: zoneDevicesGet,
+      create: expect.any(Function),
+      update: expect.any(Function),
+      macAvailability: expect.any(Function),
+      provisioning: expect.any(Function),
+      delete: expect.any(Function),
+    });
     expect(__internal.networks).toEqual({ list: networksList, get: networksGet, create: networksCreate });
   });
 });

package/src/__tests__/zones.test.ts

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

package/src/admin-funcs/doAdmin.ts

@@ -341,10 +341,27 @@ export async function $doPostForm(
   return $doPostBody(route, form, {}, options);
 }
 
-export async function $doPut<T extends object>(
+export function $doPut<T extends object>(
   route: string,
   putData: T,
   options?: RequestOptions,
+): ReturnType<typeof $doJsonRequest> {
+  return $doJsonRequest("PUT", route, putData, options);
+}
+
+export function $doDelete(
+  route: string,
+  options?: RequestOptions,
+): ReturnType<typeof $doJsonRequest> {
+  return $doJsonRequest("DELETE", route, undefined, options);
+}
+
+// PUT and DELETE share everything but the method; a DELETE sends no body.
+async function $doJsonRequest(
+  method: "PUT" | "DELETE",
+  route: string,
+  data: object | undefined,
+  options?: RequestOptions,
 ): Promise<
   [
     Result<
@@ -367,7 +384,7 @@ export async function $doPut<T extends object>(
     throw new Error("GreenSecurityCore client is not initialized.");
   }
 
-  const body = encodeJSON("body", putData, { explode: true });
+  const body = data === undefined ? undefined : encodeJSON("body", data, { explode: true });
 
   // Extract the path parameters from the request object
   const pathParams = {}; //extractRouteParameters(route, request);
@@ -399,7 +416,7 @@ export async function $doPut<T extends object>(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method,
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

package/src/admin-funcs/vendorCredentialCreateFormQuote.ts

@@ -1,12 +1,31 @@
 import { APIPromise } from "../types/async.js";
+import { RequestOptions } from "../lib/sdks.js";
 import { $doPost, internalApiResult } from "./doAdmin.js";
 
+/**
+ * Quotes the fee the given form answers incur on a credential.
+ *
+ * `useCredits` declares that the payer intends to settle the order from their credit balance
+ * before their payment method is charged. It only affects how the convenience fee is tiered --
+ * the fee pays for card processing, so it is assessed on what the card is left to cover, and an
+ * order the balance covers in full carries none. No credits are debited here, and the balance is
+ * read from the payer's own ledger rather than taken from this call.
+ *
+ * Answers with: `{ id, is_quote, tax, convenience_fee, total, success }`. The three money
+ * fields are in cents, matching what the invoice endpoints report, so the quote prices the
+ * order on its own and no follow-up fetch of the invoice is needed.
+ */
 export function vendorCredentialCreateFormQuote(
   vendorCredentialId: number,
   jsonData: string,
+  useCredits = false,
+  /** Carries the caller's AbortSignal: the form re-prices as it is filled in, so a
+   *  superseded request has to be droppable in flight. */
+  options?: RequestOptions,
 ): internalApiResult {
   return new APIPromise($doPost(
     `/vendors/credentials/${vendorCredentialId}/quote`,
-    { json_data: jsonData },
+    { json_data: jsonData, use_credits: useCredits },
+    options,
   ));
 }

package/src/admin-funcs/vendorCredentialGetFormLineItems.ts

@@ -1,12 +1,17 @@
 import { APIPromise } from "../types/async.js";
+import { RequestOptions } from "../lib/sdks.js";
 import { $doPost, internalApiResult } from "./doAdmin.js";
 
 export function vendorCredentialGetFormLineItems(
   vendorCredentialId: number,
   jsonData: string,
+  /** Carries the caller's AbortSignal: the form re-prices as it is filled in, so a
+   *  superseded request has to be droppable in flight. */
+  options?: RequestOptions,
 ): internalApiResult {
   return new APIPromise($doPost(
     `/vendors/credentials/${vendorCredentialId}/line-items`,
     { json_data: jsonData },
+    options,
   ));
 }

package/src/admin-funcs/zoneDevicesDelete.ts

@@ -0,0 +1,8 @@
+import { APIPromise } from "../types/async.js";
+import { $doDelete, internalApiResult } from "./doAdmin.js";
+
+// Removes a gateway from the Gatekeeper device details screen and revokes its AWS IoT thing.
+// Internal for the same reason as zoneDevicesCreate. 404 covers a gateway outside the caller's scope.
+export function zoneDevicesDelete(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doDelete(`/zone-devices/${zoneDeviceId}`));
+}

package/src/admin-funcs/zoneDevicesList.ts

@@ -6,6 +6,7 @@ export type zoneDevicesListSortField = "id" | "name";
 export type zoneDevicesListRequest = {
   facilityId?: number;
   zoneId?: number;
+  networkId?: number;
   page?: number;
   itemsPerPage?: number;
   sort?: zoneDevicesListSortField;
@@ -36,6 +37,9 @@ export function zoneDevicesList(
   if (request.zoneId !== undefined) {
     query["zone_id"] = request.zoneId;
   }
+  if (request.networkId !== undefined) {
+    query["network_id"] = request.networkId;
+  }
   if (request.page !== undefined) {
     query["page"] = request.page;
   }

package/src/admin-funcs/zoneDevicesProvisioning.ts

@@ -0,0 +1,12 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Everything the Gatekeeper app writes to a gateway when it provisions it over the gateway's own
+// Wi-Fi: the admin password, the AWS IoT certificate and broker, and the settings and
+// secrets of the network it joins. The first call mints the password and certificate, hence POST.
+//
+// Internal for the same reason as zoneDevicesCreate. The response carries secrets: callers keep it
+// in memory for the provisioning run and never persist or log it.
+export function zoneDevicesProvisioning(zoneDeviceId: number): internalApiResult {
+  return new APIPromise($doPost(`/zone-devices/${zoneDeviceId}/provisioning`, {}));
+}

package/src/admin-funcs/zoneDevicesUpdate.ts

@@ -11,8 +11,8 @@ export type zoneDevicesUpdateRequest = {
   name?: string;
 };
 
-// Edits a gateway from the Gatekeeper device details screen (GSSD-7059). Pushing a new network to
-// the hardware is GSSD-7061; this only updates the record.
+// Edits a gateway from the Gatekeeper device details screen. This only updates the record; the
+// app pushes the new network to the hardware using zoneDevicesProvisioning.
 //
 // Internal for the same reason as zoneDevicesCreate. 404 covers a gateway, zone or network outside
 // the caller's scope, and a network not linked to the zone's facility.

package/src/index.extras.ts

@@ -67,6 +67,8 @@ import { zoneDevicesGet } from "./admin-funcs/zoneDevicesGet.js";
 import { zoneDevicesCreate } from "./admin-funcs/zoneDevicesCreate.js";
 import { zoneDevicesMacAvailability } from "./admin-funcs/zoneDevicesMacAvailability.js";
 import { zoneDevicesUpdate } from "./admin-funcs/zoneDevicesUpdate.js";
+import { zoneDevicesProvisioning } from "./admin-funcs/zoneDevicesProvisioning.js";
+import { zoneDevicesDelete } from "./admin-funcs/zoneDevicesDelete.js";
 import { lookupsAddressValidation } from "./admin-funcs/lookupsAddressValidation.js";
 import { lookupsAddressAutocomplete } from "./admin-funcs/lookupsAddressAutocomplete.js";
 import { lookupsAddressPlace } from "./admin-funcs/lookupsAddressPlace.js";
@@ -192,6 +194,8 @@ export const __internal = {
     get: zoneDevicesGet,
     create: zoneDevicesCreate,
     update: zoneDevicesUpdate,
+    provisioning: zoneDevicesProvisioning,
+    delete: zoneDevicesDelete,
     macAvailability: zoneDevicesMacAvailability
   }
 };

package/src/lib/config.ts

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

package/src/models/operations/createinvoice.ts

@@ -58,6 +58,10 @@ export type Five = {
    * A campaign opt-in code, taken from the link that carried the offer Deliberately not an enumeration. The server decides which codes are live, what each one grants, and who qualifies for it. These decisions change as campaigns come and go. The server ignores an unrecognized code, or one the account does not qualify for, and creates the invoice as if the code were absent, never returning an error. The server adds any line item the code earns, and it appears on the quote.
    */
   promo?: string | undefined;
+  /**
+   * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
+   */
+  useCredits?: boolean | undefined;
 };
 
 export const CreateInvoiceRequestBodyInvoicesPaymentHandler = {
@@ -105,6 +109,10 @@ export type Four = {
    * A campaign opt-in code, taken from the link that carried the offer Deliberately not an enumeration. The server decides which codes are live, what each one grants, and who qualifies for it. These decisions change as campaigns come and go. The server ignores an unrecognized code, or one the account does not qualify for, and creates the invoice as if the code were absent, never returning an error. The server adds any line item the code earns, and it appears on the quote.
    */
   promo?: string | undefined;
+  /**
+   * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
+   */
+  useCredits?: boolean | undefined;
 };
 
 export const CreateInvoiceRequestBodyPaymentHandler = {
@@ -152,6 +160,10 @@ export type Three = {
    * A campaign opt-in code, taken from the link that carried the offer Deliberately not an enumeration. The server decides which codes are live, what each one grants, and who qualifies for it. These decisions change as campaigns come and go. The server ignores an unrecognized code, or one the account does not qualify for, and creates the invoice as if the code were absent, never returning an error. The server adds any line item the code earns, and it appears on the quote.
    */
   promo?: string | undefined;
+  /**
+   * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
+   */
+  useCredits?: boolean | undefined;
 };
 
 export const RequestBodyPaymentHandler = {
@@ -197,6 +209,10 @@ export type CreateInvoiceRequestBody2 = {
    * A campaign opt-in code, taken from the link that carried the offer Deliberately not an enumeration. The server decides which codes are live, what each one grants, and who qualifies for it. These decisions change as campaigns come and go. The server ignores an unrecognized code, or one the account does not qualify for, and creates the invoice as if the code were absent, never returning an error. The server adds any line item the code earns, and it appears on the quote.
    */
   promo?: string | undefined;
+  /**
+   * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
+   */
+  useCredits?: boolean | undefined;
 };
 
 export const PaymentHandler = {
@@ -240,6 +256,10 @@ export type RequestBody1 = {
    * A campaign opt-in code, taken from the link that carried the offer Deliberately not an enumeration. The server decides which codes are live, what each one grants, and who qualifies for it. These decisions change as campaigns come and go. The server ignores an unrecognized code, or one the account does not qualify for, and creates the invoice as if the code were absent, never returning an error. The server adds any line item the code earns, and it appears on the quote.
    */
   promo?: string | undefined;
+  /**
+   * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
+   */
+  useCredits?: boolean | undefined;
 };
 
 /**
@@ -336,6 +356,7 @@ export type Five$Outbound = {
   credential_pricing_ids?: Array<number> | null | undefined;
   invoice_type?: string | undefined;
   promo?: string | undefined;
+  use_credits: boolean;
 };
 
 /** @internal */
@@ -350,11 +371,13 @@ export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
       CreateInvoiceRequestBodyInvoicesRequestInvoiceType$outboundSchema
         .optional(),
     promo: z.string().optional(),
+    useCredits: z.boolean().default(false),
   }).transform((v) => {
     return remap$(v, {
       vendorCredentialId: "vendor_credential_id",
       credentialPricingIds: "credential_pricing_ids",
       invoiceType: "invoice_type",
+      useCredits: "use_credits",
     });
   });
 
@@ -432,6 +455,7 @@ export type Four$Outbound = {
   credential_pricing_ids?: Array<number> | null | undefined;
   invoice_type?: string | undefined;
   promo?: string | undefined;
+  use_credits: boolean;
 };
 
 /** @internal */
@@ -445,11 +469,13 @@ export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
     invoiceType: CreateInvoiceRequestBodyInvoicesInvoiceType$outboundSchema
       .optional(),
     promo: z.string().optional(),
+    useCredits: z.boolean().default(false),
   }).transform((v) => {
     return remap$(v, {
       systemId: "system_id",
       credentialPricingIds: "credential_pricing_ids",
       invoiceType: "invoice_type",
+      useCredits: "use_credits",
     });
   });
 
@@ -529,6 +555,7 @@ export type Three$Outbound = {
   credential_pricing_ids?: Array<number> | null | undefined;
   invoice_type?: string | undefined;
   promo?: string | undefined;
+  use_credits: boolean;
 };
 
 /** @internal */
@@ -543,11 +570,13 @@ export const Three$outboundSchema: z.ZodType<
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
   invoiceType: CreateInvoiceRequestBodyInvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
+  useCredits: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     facilityId: "facility_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
+    useCredits: "use_credits",
   });
 });
 
@@ -622,6 +651,7 @@ export type CreateInvoiceRequestBody2$Outbound = {
   credential_pricing_ids?: Array<number> | null | undefined;
   invoice_type?: string | undefined;
   promo?: string | undefined;
+  use_credits: boolean;
 };
 
 /** @internal */
@@ -635,11 +665,13 @@ export const CreateInvoiceRequestBody2$outboundSchema: z.ZodType<
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
   invoiceType: RequestBodyInvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
+  useCredits: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     companyId: "company_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
+    useCredits: "use_credits",
   });
 });
 
@@ -713,6 +745,7 @@ export type RequestBody1$Outbound = {
   credential_pricing_ids?: Array<number> | null | undefined;
   invoice_type?: string | undefined;
   promo?: string | undefined;
+  use_credits: boolean;
 };
 
 /** @internal */
@@ -726,11 +759,13 @@ export const RequestBody1$outboundSchema: z.ZodType<
   credentialPricingIds: z.nullable(z.array(z.number().int())).optional(),
   invoiceType: InvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
+  useCredits: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     vendorId: "vendor_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
+    useCredits: "use_credits",
   });
 });