@greensecurity/javascript-sdk 0.45.0-beta.2 → 0.45.0-beta.20

package/src/__tests__/vendors.test.ts

@@ -121,7 +121,7 @@ test("Vendors List Vendor Credits", async () => {
       page: 1,
       useUrlParams: false,
     },
-    creditBalance: 3532.73,
+    creditBalance: 5361.49,
   });
 });
 
@@ -1339,3 +1339,34 @@ test("Vendors Get Vendor Target Facilities", async () => {
     items: [],
   });
 });
+
+test("Vendors Get Vendor Screening Questions", async () => {
+  const testHttpClient = createTestHTTPClient("getVendorScreeningQuestions");
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.vendors.getVendorScreeningQuestions({
+    vendorIdOrMe: "<value>",
+    facilityId: 657279,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 860787,
+      page: 1,
+      useUrlParams: true,
+    },
+    items: [],
+    facilityName: "<value>",
+  });
+});

package/src/__tests__/zones.test.ts

@@ -35,37 +35,40 @@ test("Zones List Or Search Security Zones", async () => {
       useUrlParams: false,
     },
     items: [
-      {
-        facility: {},
-      },
       {
         facility: {
           contacts: {
             contact: {
-              status: "Inactive",
+              status: "Active",
               department: 123,
             },
             adminContact: {
-              status: "Deleted",
+              status: "Active",
               department: 123,
             },
             techContact: {
+              status: "Inactive",
+              department: 123,
+            },
+            greenSecurityCsm: {
               status: "Deleted",
               department: 123,
             },
-            greenSecurityCsm: null,
             accountManager: {
-              status: "Deleted",
+              status: "Inactive",
               department: 123,
             },
           },
           vendorGuestPolicy: {
-            enabled: false,
+            enabled: true,
             vendorGuestLimitAndOr: "and",
             vendorGuestRequireEmail: false,
           },
         },
       },
+      {
+        facility: {},
+      },
     ],
   });
 });
@@ -82,9 +85,9 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: 8873.74,
-    latitude: 3624.26,
-    zoneId: 95913,
+    longitude: 8706.45,
+    latitude: 7315.87,
+    zoneId: 944641,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/dismissCommunication.ts

@@ -0,0 +1,20 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Records that the caller dismissed a communication (GSSD-7336).
+//
+// Internal for the same reason as listCommunications: it only means anything to our own portal.
+//
+// The durable half of a two-layer dismissal — the client suppresses locally straight away so a
+// banner does not flash back while this is in flight, and this row is what makes the timed
+// rules ("after a week", "after a month") hold on a second device. Whether a past dismissal
+// still suppresses anything is decided server-side on the next list call.
+//
+// The server re-checks the caller's audience before writing, so dismissing a communication that
+// was never aimed at you answers 404 rather than creating a row.
+export function dismissCommunication(communicationId: number): internalApiResult {
+  return new APIPromise($doPost(
+    `/communications/${communicationId}/dismiss`,
+    {},
+  ));
+}

package/src/admin-funcs/doAdmin.ts

@@ -308,6 +308,113 @@ export async function $doPost<T extends object>(
   return [result, { status: "complete", request: req, response }];
 }
 
+export async function $doPut<T extends object>(
+  route: string,
+  putData: T,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Json,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const client = getInternalCore();
+  if (!client) {
+    throw new Error("GreenSecurityCore client is not initialized.");
+  }
+
+  const body = encodeJSON("body", putData, { explode: true });
+
+  // Extract the path parameters from the request object
+  const pathParams = {}; //extractRouteParameters(route, request);
+
+  const path = pathToFunc(route)(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "internalApiRoutes",
+    oAuth2Scopes: [],
+
+    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: "PUT",
+    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, {
+    ...buildDoOptions(context, context.retryConfig, 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<
+    Json,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, jsonSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}
+
 export function hashToQueryString(hash: Record<string, any>): string {
   const params = [];
   for (const key in hash) {

package/src/admin-funcs/kioskCreateEvent.ts

@@ -0,0 +1,18 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Logs a kiosk event (print jobs, printer errors, vending requests, phone
+// home profiles, ...). `value` may be any JSON value or null.
+export function kioskCreateEvent(
+  kioskDeviceId: number,
+  securityToken: string,
+  name: string,
+  value: unknown,
+): internalApiResult {
+  return new APIPromise(
+    $doPost(
+      `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/events`,
+      { name, value: value ?? null },
+    )
+  );
+}

package/src/admin-funcs/kioskCreateKioskDevice.ts

@@ -0,0 +1,17 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export type KioskCreateKioskDeviceRequest = {
+  apns_token?: string;
+  sandbox?: boolean;
+};
+
+// Registers a new kiosk device. Unauthenticated; the response contains the
+// device id and security token used by all subsequent kiosk-api calls.
+export function kioskCreateKioskDevice(
+  request: KioskCreateKioskDeviceRequest,
+): internalApiResult {
+  return new APIPromise(
+    $doPost(`/kiosk-api/kiosk-devices`, request)
+  );
+}

package/src/admin-funcs/kioskCreateZoneDevice.ts

@@ -0,0 +1,17 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+// Registers a zone device for the kiosk's zone. The response includes the
+// zone device id and a base64 PKCS#12 AWS IoT client certificate.
+export function kioskCreateZoneDevice(
+  kioskDeviceId: number,
+  securityToken: string,
+  zoneId: number,
+): internalApiResult {
+  return new APIPromise(
+    $doPost(
+      `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/zone-devices`,
+      { zone_id: zoneId },
+    )
+  );
+}

package/src/admin-funcs/kioskGetKioskDevice.ts

@@ -0,0 +1,16 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+// Fetches the kiosk device (including its kiosk/zone assignment).
+// Kiosk-api routes authenticate via the device id + security token in the path.
+export function kioskGetKioskDevice(
+  kioskDeviceId: number,
+  securityToken: string,
+): internalApiResult {
+  return new APIPromise(
+    $doGetSingle(
+      `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/kiosk-devices/${kioskDeviceId}`,
+      {},
+    )
+  );
+}

package/src/admin-funcs/kioskHeartbeat.ts

@@ -0,0 +1,23 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+export type KioskHeartbeatQuery = {
+  printer_status: string;
+  ip: string;
+  date_received_notification: string;
+};
+
+// 60-second keep-alive ping carrying printer status, local IP and the last
+// APNS heartbeat timestamp.
+export function kioskHeartbeat(
+  kioskDeviceId: number,
+  securityToken: string,
+  query: KioskHeartbeatQuery,
+): internalApiResult {
+  return new APIPromise(
+    $doGetSingle(
+      `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/ping`,
+      query,
+    )
+  );
+}

package/src/admin-funcs/kioskPing2.ts

@@ -0,0 +1,10 @@
+import { APIPromise } from "../types/async.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+
+// Unauthenticated server liveness probe used by the kiosk before setup.
+export function kioskPing2(options?: RequestOptions): internalApiResult {
+  return new APIPromise(
+    $doGetSingle(`/kiosks/ping2`, {}, options)
+  );
+}

package/src/admin-funcs/kioskUpdateKioskDevice.ts

@@ -0,0 +1,23 @@
+import { APIPromise } from "../types/async.js";
+import { $doPut, internalApiResult } from "./doAdmin.js";
+
+export type KioskUpdateKioskDeviceRequest = {
+  apns_token?: string;
+  kiosk_id?: number;
+  user_id?: number;
+  sandbox?: boolean;
+} & Record<string, unknown>;
+
+// Updates kiosk device fields (e.g. the APNS push token after registration).
+export function kioskUpdateKioskDevice(
+  kioskDeviceId: number,
+  securityToken: string,
+  request: KioskUpdateKioskDeviceRequest,
+): internalApiResult {
+  return new APIPromise(
+    $doPut(
+      `/kiosk-api/${kioskDeviceId}/${encodeURIComponent(securityToken)}/kiosk-devices/${kioskDeviceId}`,
+      request,
+    )
+  );
+}

package/src/admin-funcs/listCommunications.ts

@@ -0,0 +1,29 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, hashToQueryString, internalApiResult } from "./doAdmin.js";
+
+// The banners, pop-ups and in-app notifications aimed at the signed-in user (GSSD-7336).
+//
+// Internal rather than part of the public spec: "the adverts for whoever is holding this token"
+// is only meaningful to our own portal, and a third-party SDK consumer has no use for it. See
+// the public/app-only split in AGENTS.md.
+//
+// The response is already filtered and ordered by the server — audience matched per caller,
+// page matched, anything still suppressed by a dismissal removed, and sorted by priority — so a
+// caller renders the list as it arrives.
+//
+// pageKey narrows to the communications configured for one page. Omitting it returns every
+// communication for the user, which is what a caller that does its own page matching wants.
+export function listCommunications(
+  pageKey?: string | null,
+  itemsPerPage: number = 100,
+): internalApiResult {
+  const query: Record<string, string | number> = { items_per_page: itemsPerPage };
+  if (pageKey) {
+    query["page_key"] = pageKey;
+  }
+
+  return new APIPromise($doGetSingle(
+    `/communications?${hashToQueryString(query)}`,
+    {},
+  ));
+}

package/src/funcs/companiesListCompanyManagerContacts.ts

@@ -0,0 +1,182 @@
+/*
+ * 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";
+
+/**
+ * List the contact details of a company's managers
+ *
+ * @remarks
+ * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{company_id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+ */
+export function companiesListCompanyManagerContacts(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListCompanyManagerContactsListCompanyManagerContactsOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListCompanyManagerContactsListCompanyManagerContactsOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListCompanyManagerContactsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    company_id: encodeSimple("company_id", payload.company_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/companies/{company_id}/manager-contacts")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listCompanyManagerContacts",
+    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: "GET",
+    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.ListCompanyManagerContactsListCompanyManagerContactsOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations
+        .ListCompanyManagerContactsListCompanyManagerContactsOk$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/funcs/companiesListCompanyManagers.ts

@@ -117,6 +117,7 @@ async function $do(
     "items_per_page": payload.items_per_page,
     "page": payload.page,
     "sort": payload.sort,
+    "status": payload.status,
   });
 
   const headers = new Headers(compactMap({