@greensecurity/javascript-sdk 0.43.1-beta.9 → 0.43.1-beta.92

package/src/__tests__/users.test.ts

@@ -47,3 +47,27 @@ test("Users Rotate Api Key", async () => {
     success: true,
   });
 });
+
+test("Users Get Linked Users", async () => {
+  const testHttpClient = createTestHTTPClient("getLinkedUsers");
+
+  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.users.getLinkedUsers({});
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    linkedUsers: [
+      {
+        id: 24197,
+        email: "Jeffrey.Witting25@gmail.com",
+        userType: "<value>",
+      },
+    ],
+  });
+});

package/src/__tests__/vendors.test.ts

@@ -998,3 +998,38 @@ it.skip("Vendors Update Vendor Credential Invoice", async () => {
     "incomplete test found please make sure to address the following errors: [`workflow step updateVendorCredentialInvoice.test referencing operation updateVendorCredentialInvoice not found in document`]",
   );
 });
+
+test("Vendors List Vendor Custom Fields", async () => {
+  const testHttpClient = createTestHTTPClient("listVendorCustomFields");
+
+  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.listVendorCustomFields({
+    sort: "job",
+    desc: true,
+    itemsPerPage: 25,
+    vendorIdOrMe: "<value>",
+  });
+  expect(result).toBeDefined();
+  expect(result.result).toBeDefined();
+  expect(result.result).toEqual({
+    items: [
+      {},
+    ],
+    pager: {
+      baseUrl: "api/vendors/job_titles",
+      sort: "job,title",
+      desc: 0,
+      itemCount: 228,
+      itemsPerPage: 425443,
+      page: 1,
+      useUrlParams: true,
+    },
+  });
+});

package/src/__tests__/vendorscans.test.ts

@@ -25,3 +25,45 @@ test("Vendor Scans Vendor Scan Out", async () => {
     success: true,
   });
 });
+
+test("Vendor Scans Get Next Screening Question", async () => {
+  const testHttpClient = createTestHTTPClient("getNextScreeningQuestion");
+
+  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.vendorScans.getNextScreeningQuestion({
+    id: 115257,
+    expand: [
+      "facility.system",
+    ],
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Vendor Scans Submit Screening Response", async () => {
+  const testHttpClient = createTestHTTPClient("submitScreeningResponse");
+
+  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.vendorScans.submitScreeningResponse({
+    id: 623781,
+    requestBody: {
+      screeningQuestionId: 840432,
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

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: true,
+      desc: 0,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();

package/src/admin-funcs/handoffStayAlive.ts

@@ -0,0 +1,8 @@
+import { APIPromise } from "../types/async.js";
+import { $doPost, internalApiResult } from "./doAdmin.js";
+
+export function handoffStayAlive(id: number): internalApiResult {
+  return new APIPromise(
+    $doPost(`/handoffs/${id}/stay-alive`, {})
+  );
+}

package/src/funcs/alertsListAlerts.ts

@@ -4,7 +4,7 @@
 
 import { GreenSecurityCore } from "../core.js";
 import { dlv } from "../lib/dlv.js";
-import { encodeFormQuery } from "../lib/encodings.js";
+import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -103,12 +103,17 @@ async function $do(
 
   const path = pathToFunc("/alerts")();
 
-  const query = encodeFormQuery({
-    "desc": payload.desc,
-    "items_per_page": payload.items_per_page,
-    "page": payload.page,
-    "sort": payload.sort,
-  });
+  const query = queryJoin(
+    encodeFormQuery({
+      "user_id_or_me": payload.user_id_or_me,
+    }, { explode: false }),
+    encodeFormQuery({
+      "desc": payload.desc,
+      "items_per_page": payload.items_per_page,
+      "page": payload.page,
+      "sort": payload.sort,
+    }),
+  );
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -177,9 +182,8 @@ async function $do(
   >(
     M.json(200, operations.ListAlertsResponse$inboundSchema, { key: "Result" }),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [haltIterator(result), {

package/src/funcs/alertsUpdateUserAlerts.ts

@@ -158,9 +158,8 @@ async function $do(
   >(
     M.json(200, operations.UpdateUserAlertsUpdateUserAlertsOk$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/companiesGetCompany.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.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 * as components from "../models/components/index.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";
+
+/**
+ * Get company
+ *
+ * @remarks
+ * Get company details.
+ *
+ * Available `expand` scopes are:
+ *
+ * company.location
+ * company.vendor_type_restrictions
+ */
+export function companiesGetCompany(
+  client: GreenSecurityCore,
+  request: operations.GetCompanyRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.Company,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetCompanyRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Company,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetCompanyRequest$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("/companies/{id}")(pathParams);
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+  }, { explode: false });
+
+  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: "getCompany",
+    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,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "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<
+    components.Company,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.Company$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

@@ -0,0 +1,254 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List or search company managers
+ *
+ * @remarks
+ * List or search company managers.
+ */
+export function companiesListCompanyManagers(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListCompanyManagersResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyManagersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListCompanyManagersResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListCompanyManagersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/companies/{id}/managers")(pathParams);
+
+  const query = encodeFormQuery({
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "sort": payload.sort,
+  });
+
+  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: "listCompanyManagers",
+    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 [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListCompanyManagersResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListCompanyManagersResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListCompanyManagersResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      companiesListCompanyManagers(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/companiesListOrSearchCompanies.ts

@@ -187,9 +187,8 @@ async function $do(
       key: "Result",
     }),
     M.jsonErr([400, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [haltIterator(result), {

package/src/funcs/dataRequestsAddDataRequestFile.ts

@@ -165,9 +165,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/dataRequestsDeleteDataRequestFile.ts

@@ -165,9 +165,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/dataRequestsUpdateDataRequest.ts

@@ -165,9 +165,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/eventsAcceptInvitation.ts

@@ -170,9 +170,8 @@ async function $do(
   >(
     M.json(200, operations.AcceptInvitationAcceptInvitationOk$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];