@greensecurity/javascript-sdk 0.43.1-beta.7 → 0.43.1-beta.72

package/src/funcs/vendorScansSubmitScreeningResponse.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON, 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";
+
+/**
+ * Create a screening response for a vendor scan
+ *
+ * @remarks
+ * Submits a response to a screening question for the specified vendor scan.
+ * The response may contain a single selected answer, multiple answer IDs
+ * (for multi-select questions), or a custom free-text answer. The endpoint
+ * also executes any triggered actions associated with the response and
+ * indicates whether there is a next screening question.
+ */
+export function vendorScansSubmitScreeningResponse(
+  client: GreenSecurityCore,
+  request: operations.SubmitScreeningResponseRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SubmitScreeningResponseResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.SubmitScreeningResponseRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubmitScreeningResponseResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SubmitScreeningResponseRequest$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 pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/vendor-scans/{id}/screening-response")(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: "submitScreeningResponse",
+    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: "POST",
+    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,
+    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<
+    operations.SubmitScreeningResponseResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.SubmitScreeningResponseResponseBody$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/vendorScansVendorScanOut.ts

@@ -163,9 +163,8 @@ async function $do(
   >(
     M.json(200, operations.VendorScanOutVendorScanOutOk$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/vendorsAcceptVendorCredential.ts

@@ -168,9 +168,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     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/vendorsAddVendorCredentialFile.ts

@@ -171,9 +171,8 @@ async function $do(
       operations.AddVendorCredentialFileAddVendorCredentialFileOk$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/vendorsAddVendorManagedByCompany.ts

@@ -171,9 +171,8 @@ async function $do(
         .AddVendorManagedByCompanyAddVendorManagedByCompanyOk$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/vendorsCalculateSubscriptionPrice.ts

@@ -171,9 +171,8 @@ async function $do(
         .CalculateSubscriptionPriceCalculateSubscriptionPriceOk$inboundSchema,
     ),
     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/vendorsChangeSubscription.ts

@@ -29,7 +29,10 @@ import { Result } from "../types/fp.js";
  * Change subscription
  *
  * @remarks
- * Calculate subscription price
+ * Change a vendor's credentialing subscription by updating the vendor type
+ * and/or target facilities. If the new selection increases the subscription
+ * price, an invoice is created and the payment profile is charged; the
+ * response includes the invoice id.
  */
 export function vendorsChangeSubscription(
   client: GreenSecurityCore,
@@ -169,9 +172,8 @@ async function $do(
       operations.ChangeSubscriptionChangeSubscriptionOk$inboundSchema,
     ),
     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/vendorsCheckDownloadCode.ts

@@ -171,9 +171,8 @@ async function $do(
   >(
     M.json(200, operations.CheckDownloadCodeCheckDownloadCodeOk$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/vendorsCreateNewVendorCredentialVersion.ts

@@ -163,9 +163,8 @@ async function $do(
         .CreateNewVendorCredentialVersionCreateNewVendorCredentialVersionOk$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/vendorsCreateOrUpdateBcr.ts

@@ -168,9 +168,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     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/vendorsCreateVendorCompany.ts

@@ -168,9 +168,8 @@ async function $do(
       operations.CreateVendorCompanyCreateVendorCompanyOk$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/vendorsCreateVendorRegistration.ts

@@ -156,9 +156,8 @@ async function $do(
   >(
     M.json(201, components.User$inboundSchema),
     M.jsonErr([400, 401, 403, 409], 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/vendorsDeclineVendorCredential.ts

@@ -168,9 +168,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     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/vendorsDeleteVendorCredentialFile.ts

@@ -172,9 +172,8 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     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/vendorsDeleteVendorManagedByCompany.ts

@@ -170,9 +170,8 @@ async function $do(
   >(
     M.json(200, components.DeleteApiResponse$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/vendorsExpediteTimeRemaining.ts

@@ -169,9 +169,8 @@ async function $do(
       operations.ExpediteTimeRemainingGetExpediteTimeRemainingOk$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/vendorsGetNextUnansweredScreeningQuestion.ts

@@ -177,9 +177,8 @@ async function $do(
         .GetNextUnansweredScreeningQuestionGetNextUnansweredScreeningQuestionOk$inboundSchema,
     ),
     M.jsonErr([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/vendorsGetSubscription.ts

@@ -174,9 +174,8 @@ async function $do(
   >(
     M.json(200, operations.GetSubscriptionGetSubscriptionOk$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/vendorsGetVendorCredentialDetails.ts

@@ -200,9 +200,8 @@ async function $do(
         .GetVendorCredentialDetailsGetVendorCredentialDetailsOk$inboundSchema,
     ),
     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/vendorsGetVendorCredentialFile.ts

@@ -182,9 +182,8 @@ async function $do(
   >(
     M.json(200, components.VendorCredentialFile$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/vendorsGetVendorInvoiceDetails.ts

@@ -175,9 +175,8 @@ async function $do(
   >(
     M.json(200, components.Invoice$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/vendorsGetVendorInvoiceReceipt.ts

@@ -167,9 +167,8 @@ async function $do(
       operations.GetVendorInvoiceReceiptGetVendorInvoiceReceiptOk$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/vendorsGetVendorLegalName.ts

@@ -166,9 +166,8 @@ async function $do(
       operations.GetVendorLegalNameGetVendorLegalNameOk$inboundSchema,
     ),
     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/vendorsGetVendorsDetails.ts

@@ -193,9 +193,8 @@ async function $do(
   >(
     M.json(200, components.Vendor$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/vendorsListVendorAdditionalFacilityFields.ts

@@ -36,7 +36,9 @@ import {
  * List of vendor's additional facility fields
  *
  * @remarks
- * List of vendor's additional facility fields
+ * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function vendorsListVendorAdditionalFacilityFields(
   client: GreenSecurityCore,
@@ -193,9 +195,8 @@ async function $do(
       { key: "Result" },
     ),
     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 [haltIterator(result), {

package/src/funcs/vendorsListVendorCredentialDataRequests.ts

@@ -195,9 +195,8 @@ async function $do(
       ),
     ),
     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/vendorsListVendorCredentialFiles.ts

@@ -191,9 +191,8 @@ async function $do(
       z.array(types$.nullable(components.VendorCredentialFile$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/vendorsListVendorCredentialHistory.ts

@@ -194,9 +194,8 @@ async function $do(
       key: "Result",
     }),
     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 [haltIterator(result), {

package/src/funcs/vendorsListVendorCredentials.ts

@@ -193,9 +193,8 @@ async function $do(
       key: "Result",
     }),
     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 [haltIterator(result), {

package/src/funcs/vendorsListVendorCredits.ts

@@ -186,9 +186,8 @@ async function $do(
       key: "Result",
     }),
     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 [haltIterator(result), {