@greensecurity/javascript-sdk 0.44.0-beta.11 → 0.44.0-beta.12

package/src/__tests__/organizations.test.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { expect, test } from "vitest";
+import { assert, expect, it, test } from "vitest";
 import { GreenSecurity } from "../index.js";
 import { createTestHTTPClient } from "./testclient.js";
 
@@ -84,8 +84,26 @@ test("Organizations List Or Search Department Contacts", async () => {
   });
 });
 
-test("Organizations List Company Target Facilities", async () => {
-  const testHttpClient = createTestHTTPClient("listCompanyTargetFacilities");
+it.skip("Organizations List Company Target Facilities", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step listCompanyTargetFacilities.test referencing operation listCompanyTargetFacilities not found in document`]",
+  );
+});
+
+it.skip("Organizations Create Company Target Facility", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step createCompanyTargetFacility.test referencing operation createCompanyTargetFacility not found in document`]",
+  );
+});
+
+it.skip("Organizations Delete Company Target Facility", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step deleteCompanyTargetFacility.test referencing operation deleteCompanyTargetFacility not found in document`]",
+  );
+});
+
+test("Organizations Export Company Target Facilities", async () => {
+  const testHttpClient = createTestHTTPClient("exportCompanyTargetFacilities");
 
   const greenSecurity = new GreenSecurity({
     serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
@@ -95,32 +113,22 @@ test("Organizations List Company Target Facilities", async () => {
     },
   });
 
-  const result = await greenSecurity.organizations.listCompanyTargetFacilities({
-    companyId: 864839,
-    expand: [
-      "facility.system",
-    ],
-    desc: true,
-    itemsPerPage: 25,
-  });
+  const result = await greenSecurity.organizations
+    .exportCompanyTargetFacilities({
+      companyId: 927960,
+    });
   expect(result).toBeDefined();
-  expect(result!.result).toBeDefined();
-  expect(result!.result).toEqual({
-    pager: {
-      baseUrl: "api/vendors/job_titles",
-      sort: "job,title",
-      desc: 0,
-      itemCount: 228,
-      itemsPerPage: 112555,
-      page: 1,
-      useUrlParams: true,
-    },
-    items: [],
+  expect(result).toEqual({
+    statusUrl: "https://important-edge.name",
+    downloadUrl: "https://vengeful-coliseum.com",
+    statusId: "<id>",
   });
 });
 
-test("Organizations Create Company Target Facility", async () => {
-  const testHttpClient = createTestHTTPClient("createCompanyTargetFacility");
+test("Organizations Get Company Target Facilities Export Status", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "getCompanyTargetFacilitiesExportStatus",
+  );
 
   const greenSecurity = new GreenSecurity({
     serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
@@ -130,27 +138,22 @@ test("Organizations Create Company Target Facility", async () => {
     },
   });
 
-  const result = await greenSecurity.organizations.createCompanyTargetFacility({
-    companyId: 846108,
-    expand: [
-      "facility.system",
-    ],
-    requestBody: {
-      facilityId: 253646,
-    },
-  });
+  const result = await greenSecurity.organizations
+    .getCompanyTargetFacilitiesExportStatus({
+      companyId: 157147,
+      id: "<id>",
+    });
   expect(result).toBeDefined();
   expect(result).toEqual({
-    companyTargetFacility: {
-      id: 335466,
-      facility: 582706,
-      status: "<value>",
-    },
+    ready: false,
+    statusId: "<id>",
   });
 });
 
-test("Organizations Delete Company Target Facility", async () => {
-  const testHttpClient = createTestHTTPClient("deleteCompanyTargetFacility");
+test("Organizations Download Company Target Facilities Export", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "downloadCompanyTargetFacilitiesExport",
+  );
 
   const greenSecurity = new GreenSecurity({
     serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
@@ -160,10 +163,12 @@ test("Organizations Delete Company Target Facility", async () => {
     },
   });
 
-  const result = await greenSecurity.organizations.deleteCompanyTargetFacility({
-    companyId: 56711,
-    id: 304723,
-  });
+  const result = await greenSecurity.organizations
+    .downloadCompanyTargetFacilitiesExport({
+      companyId: 673655,
+      id: "<id>",
+    });
   expect(result).toBeDefined();
-  expect(result).toEqual(true);
+  expect(result!.result).toBeDefined();
+  expect(result!.result).toEqual({});
 });

package/src/__tests__/vendors.test.ts

@@ -1215,7 +1215,9 @@ test("Vendors Vendors Export", async () => {
     },
   });
 
-  const result = await greenSecurity.vendors.vendorsExport({});
+  const result = await greenSecurity.vendors.vendorsExport({
+    desc: true,
+  });
   expect(result).toBeDefined();
   expect(result).toEqual({
     statusUrl: "https://plump-lava.info/",

package/src/__tests__/vendorscans.test.ts

@@ -4,6 +4,8 @@
 
 import { expect, test } from "vitest";
 import { GreenSecurity } from "../index.js";
+import { DownloadVendorScansExportAcceptEnum } from "../sdk/vendorscans.js";
+import { filesToByteArray, streamToByteArray } from "./files.js";
 import { createTestHTTPClient } from "./testclient.js";
 
 test("Vendor Scans Vendor Scan Out", async () => {
@@ -128,3 +130,71 @@ test("Vendor Scans Get Vendor Scan", async () => {
     zone: 997496,
   });
 });
+
+test("Vendor Scans Export Vendor Scans", async () => {
+  const testHttpClient = createTestHTTPClient("exportVendorScans");
+
+  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.exportVendorScans({
+    desc: true,
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    statusUrl: "https://good-decision.com",
+    downloadUrl: "https://slight-typeface.name",
+    statusId: "<id>",
+  });
+});
+
+test("Vendor Scans Get Vendor Scans Export Status", async () => {
+  const testHttpClient = createTestHTTPClient("getVendorScansExportStatus");
+
+  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.getVendorScansExportStatus({
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    ready: false,
+    statusId: "<id>",
+  });
+});
+
+test("Vendor Scans Download Vendor Scans Export", async () => {
+  const testHttpClient = createTestHTTPClient("downloadVendorScansExport");
+
+  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.downloadVendorScansExport({
+    id: "<id>",
+  }, {
+    acceptHeaderOverride: DownloadVendorScansExportAcceptEnum.textCsv,
+  });
+  expect(result).toBeDefined();
+  expect(result!.result).toBeDefined();
+  expect(
+    new Uint8Array(
+      await streamToByteArray(result!.result as ReadableStream<Uint8Array>),
+    ),
+  ).toEqual(await filesToByteArray(".speakeasy/testfiles/example.file"));
+});

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/__tests__/zones.test.ts

@@ -39,32 +39,7 @@ test("Zones List Or Search Security Zones", async () => {
         facility: {},
       },
       {
-        facility: {
-          contacts: {
-            contact: {
-              status: "Inactive",
-              department: 123,
-            },
-            adminContact: {
-              status: "Deleted",
-              department: 123,
-            },
-            techContact: {
-              status: "Deleted",
-              department: 123,
-            },
-            greenSecurityCsm: null,
-            accountManager: {
-              status: "Deleted",
-              department: 123,
-            },
-          },
-          vendorGuestPolicy: {
-            enabled: false,
-            vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: false,
-          },
-        },
+        facility: {},
       },
     ],
   });
@@ -82,9 +57,8 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: 8873.74,
-    latitude: 3624.26,
-    zoneId: 95913,
+    qrCode: "<value>",
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/invoicesInvoicesExport.ts

@@ -11,6 +11,7 @@ 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,
@@ -41,7 +42,7 @@ export function invoicesInvoicesExport(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.InvoicesExportResponseBody,
+    components.CsvExportEnqueuedResponse,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -67,7 +68,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.InvoicesExportResponseBody,
+      components.CsvExportEnqueuedResponse,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -163,7 +164,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.InvoicesExportResponseBody,
+    components.CsvExportEnqueuedResponse,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -174,7 +175,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.InvoicesExportResponseBody$inboundSchema),
+    M.json(200, components.CsvExportEnqueuedResponse$inboundSchema),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),

package/src/funcs/organizationsDownloadCompanyTargetFacilitiesExport.ts

@@ -0,0 +1,200 @@
+/*
+ * 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";
+import * as types$ from "../types/primitives.js";
+
+/**
+ * Download company target facilities CSV
+ *
+ * @remarks
+ * Returns the exported company target facilities CSV via a 302 redirect to a short-lived presigned S3 URL.
+ * If the export is still being generated, returns 202 with a JSON `{ ready: false }` payload.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function organizationsDownloadCompanyTargetFacilitiesExport(
+  client: GreenSecurityCore,
+  request: operations.DownloadCompanyTargetFacilitiesExportRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DownloadCompanyTargetFacilitiesExportResponse | undefined,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.DownloadCompanyTargetFacilitiesExportRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.DownloadCompanyTargetFacilitiesExportResponse | undefined,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.DownloadCompanyTargetFacilitiesExportRequest$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",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/companies/{company_id}/target-facilities/export/{id}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "downloadCompanyTargetFacilitiesExport",
+    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.DownloadCompanyTargetFacilitiesExportResponse | undefined,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      202,
+      types$.optional(
+        operations.DownloadCompanyTargetFacilitiesExportResponse$inboundSchema,
+      ),
+      { key: "Result" },
+    ),
+    M.nil(
+      302,
+      types$.optional(
+        operations.DownloadCompanyTargetFacilitiesExportResponse$inboundSchema,
+      ),
+      { hdrs: true },
+    ),
+    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/{organizationsCreateCompanyTargetFacility.ts → organizationsExportCompanyTargetFacilities.ts}

@@ -3,7 +3,7 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -27,34 +27,27 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Add a company target facility
+ * Export company target facilities to CSV (async)
  *
  * @remarks
- * Links the URL's company to an existing facility. The link is created with
- * status `Pending`. Only the link row is created — the Facility entity
- * itself is never created or modified by this endpoint.
+ * Enqueues an asynchronous job to generate a CSV export of a company's CompanyTargetFacility rows,
+ * applying the same access scope and filter parameters as the list endpoint. The CSV contains:
+ * Facility Name, Address, City, State, and Active Individuals.
  *
- * Access control: the URL's `company_id` must be in the caller's update
- * scope for Company, AND the `facility_id` must be in the caller's create
- * scope for Facility (a facility on the company's site, or a facility
- * reachable via the API user's site/system/facility-scoped activation).
- * Either being out of scope returns `404 Company not found` /
- * `404 Facility not found` respectively. Deleted facilities also return
- * `404 Facility not found`.
+ * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
  *
- * Available `expand` scopes are:
- *
- * - company_target_facility.facility
+ * Access control: the URL's `company_id` must be in the caller's read scope for Company. Callers
+ * outside that scope receive `404 Company not found`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
-export function organizationsCreateCompanyTargetFacility(
+export function organizationsExportCompanyTargetFacilities(
   client: GreenSecurityCore,
-  request: operations.CreateCompanyTargetFacilityRequest,
+  request: operations.ExportCompanyTargetFacilitiesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+    operations.ExportCompanyTargetFacilitiesResponseBody,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -75,12 +68,12 @@ export function organizationsCreateCompanyTargetFacility(
 
 async function $do(
   client: GreenSecurityCore,
-  request: operations.CreateCompanyTargetFacilityRequest,
+  request: operations.ExportCompanyTargetFacilitiesRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+      operations.ExportCompanyTargetFacilitiesResponseBody,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -97,14 +90,16 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.CreateCompanyTargetFacilityRequest$outboundSchema.parse(value),
+      operations.ExportCompanyTargetFacilitiesRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+  const body = null;
 
   const pathParams = {
     company_id: encodeSimple("company_id", payload.company_id, {
@@ -112,16 +107,21 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/companies/{company_id}/target-facilities")(
+  const path = pathToFunc("/companies/{company_id}/target-facilities/export")(
     pathParams,
   );
 
   const query = encodeFormQuery({
-    "expand": payload.expand,
-  }, { explode: false });
+    "desc": payload.desc,
+    "facility_name_like": payload.facility_name_like,
+    "has_active_individual": payload.has_active_individual,
+    "has_individual": payload.has_individual,
+    "items_per_page": payload.items_per_page,
+    "sort": payload.sort,
+    "status": payload.status,
+  });
 
   const headers = new Headers(compactMap({
-    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 
@@ -131,7 +131,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "createCompanyTargetFacility",
+    operationID: "exportCompanyTargetFacilities",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -145,7 +145,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "POST",
+    method: "GET",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -176,7 +176,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+    operations.ExportCompanyTargetFacilitiesResponseBody,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -188,11 +188,10 @@ async function $do(
     | SDKValidationError
   >(
     M.json(
-      201,
-      operations
-        .CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk$inboundSchema,
+      200,
+      operations.ExportCompanyTargetFacilitiesResponseBody$inboundSchema,
     ),
-    M.jsonErr([400, 401, 403, 404, 422], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });