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

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,184 @@
+/*
+ * 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
+ * Deprecated in favor of `/lookups/company_managers`, which returns the same list. Kept so app builds released before the move keep working.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+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/lookupsLookupCompanyManagers.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } 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 managers of a company for addressing a message
+ *
+ * @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/{id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
+ */
+export function lookupsLookupCompanyManagers(
+  client: GreenSecurityCore,
+  request: operations.LookupCompanyManagersRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.LookupCompanyManagersLookupCompanyManagersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.LookupCompanyManagersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.LookupCompanyManagersLookupCompanyManagersOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.LookupCompanyManagersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/lookups/company_managers")();
+
+  const query = encodeFormQuery({
+    "company_id": payload.company_id,
+  });
+
+  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: "lookupCompanyManagers",
+    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,
+    query: query,
+    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.LookupCompanyManagersLookupCompanyManagersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.LookupCompanyManagersLookupCompanyManagersOk$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 }];
+}