@greensecurity/javascript-sdk 0.44.0-beta.4 → 0.44.0-beta.41

package/src/funcs/organizationsListFacilityVendors.ts

@@ -0,0 +1,278 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.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";
+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 vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function organizationsListFacilityVendors(
+  client: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListFacilityVendorsResponse,
+      | 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.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListFacilityVendorsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListFacilityVendorsRequest$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("/facilities/{id}/vendors")(pathParams);
+
+  const query = encodeFormQuery({
+    "company_id": payload.company_id,
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "search": payload.search,
+    "sort": payload.sort,
+    "status": payload.status,
+  });
+
+  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: "listFacilityVendors",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "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.ListFacilityVendorsResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListFacilityVendorsResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404, 422], 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.ListFacilityVendorsResponse,
+        | 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 = (responseData as { items: unknown }).items;
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      organizationsListFacilityVendors(
+        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/organizationsListOrSearchDepartmentContacts.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -241,7 +240,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/organizationsListOrSearchDepartments.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -227,7 +226,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/organizationsListOrSearchFacilities.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -245,7 +244,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/supportArticlesListOrSearchSupportArticles.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -222,7 +221,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/systemsListSystems.ts

@@ -3,7 +3,6 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -231,7 +230,7 @@ async function $do(
     if (!responseData) {
       return { next: () => null };
     }
-    const results = dlv(responseData, "items");
+    const results = (responseData as { items: unknown }).items;
     if (!Array.isArray(results) || !results.length) {
       return { next: () => null };
     }

package/src/funcs/usersGetCurrentUser.ts

@@ -38,7 +38,7 @@ import { Result } from "../types/fp.js";
  *
  * Supported `expand` values:
  * - `user` — return the full user record, including all profile fields stored against the user (sensitive columns such as passwords, MFA codes, and payment-provider IDs are always omitted)
- * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients, weekly email flags, and — for company managers — `receive_vendor_emails`)
  * - `user.payment_profile` — include the user's `payment_profile` block (card type, last four digits, validity flags) when expanded; if no payment profile is associated with the user, the response returns `payment_profile: null`
  * - `company.location`, `company.vendor_type_restrictions`, `company.vendor_fields` — only valid for Company Manager users; embed extra fields on the user's company
  *

package/src/funcs/usersGetLinkedUsers.ts

@@ -30,12 +30,14 @@ import { Result } from "../types/fp.js";
  * Get linked users
  *
  * @remarks
- * Returns a list of users linked to the authenticated user.
+ * Returns a list of users linked to the requested user.
  *
- * For regular users, returns their own linked users.
+ * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+ * is allowed for any authenticated user type.
  *
- * For API users, the `user_id` parameter is required. The API user must
- * have an active app activation for the requested user.
+ * API users may additionally pass a numeric `user_id` to fetch another user's
+ * linked users, provided they have an active app activation for that user.
+ * Non-API users may only pass `me`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/usersGetUserById.ts

@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
  *
  * Supported `expand` values:
  * - `user` — return the full user record (sensitive columns such as passwords and payment-provider IDs are always omitted)
- * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients, weekly email flags, and — for company managers — `receive_vendor_emails`)
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/vendorScansDownloadVendorScansExport.ts

@@ -0,0 +1,210 @@
+/*
+ * 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";
+
+export enum DownloadVendorScansExportAcceptEnum {
+  applicationJson = "application/json",
+  textCsv = "text/csv",
+}
+
+/**
+ * Download vendor scans CSV
+ *
+ * @remarks
+ * Returns the exported vendor scans 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 vendorScansDownloadVendorScansExport(
+  client: GreenSecurityCore,
+  request: operations.DownloadVendorScansExportRequest,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: DownloadVendorScansExportAcceptEnum;
+  },
+): APIPromise<
+  Result<
+    operations.DownloadVendorScansExportResponse | 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.DownloadVendorScansExportRequest,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: DownloadVendorScansExportAcceptEnum;
+  },
+): Promise<
+  [
+    Result<
+      operations.DownloadVendorScansExportResponse | undefined,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.DownloadVendorScansExportRequest$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("/vendor-scans/export/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride
+      || "application/json;q=1, text/csv;q=0",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "downloadVendorScansExport",
+    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.DownloadVendorScansExportResponse | undefined,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.stream(
+      200,
+      types$.optional(
+        operations.DownloadVendorScansExportResponse$inboundSchema,
+      ),
+      { ctype: "text/csv", hdrs: true, key: "Result" },
+    ),
+    M.json(
+      202,
+      types$.optional(
+        operations.DownloadVendorScansExportResponse$inboundSchema,
+      ),
+      { key: "Result" },
+    ),
+    M.nil(
+      302,
+      types$.optional(
+        operations.DownloadVendorScansExportResponse$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 }];
+}