@greensecurity/javascript-sdk 0.43.1-beta.136 → 0.43.1-beta.137

package/src/funcs/vendorsAddVendorCredentialFileForAutoClassification.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d99fb25efd2a
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON, 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 * 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 a one-time URL for uploading a credential file for automatic classification (Emerald vendors only)
+ *
+ * @remarks
+ * This endpoint allows vendors on the Emerald plan to upload a series of
+ * documents and have them automatically ingested and routed to the proper
+ * credential. The endpoint will return a one-time-use URL where the file
+ * must be uploaded. Green Security will process the file asynchronously.
+ *
+ * Non-Emerald vendors must use `addVendorCredentialFile` instead.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function vendorsAddVendorCredentialFileForAutoClassification(
+  client: GreenSecurityCore,
+  request: operations.AddVendorCredentialFileForAutoClassificationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.VendorCredentialFileForAutoClassificationOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.AddVendorCredentialFileForAutoClassificationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.VendorCredentialFileForAutoClassificationOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .AddVendorCredentialFileForAutoClassificationRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON(
+    "body",
+    payload.VendorCredentialFileForAutoClassificationRequest,
+    { explode: true },
+  );
+
+  const pathParams = {
+    vendor_id_or_me: encodeSimple("vendor_id_or_me", payload.vendor_id_or_me, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/vendors/{vendor_id_or_me}/credentials/files")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "addVendorCredentialFileForAutoClassification",
+    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,
+    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<
+    components.VendorCredentialFileForAutoClassificationOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.VendorCredentialFileForAutoClassificationOk$inboundSchema,
+    ),
+    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 [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/index.extras.ts

@@ -32,6 +32,8 @@ import { submitCompany } from "./admin-funcs/registerCompanies.js";
 import {smartBadgePairBadge} from "./admin-funcs/smartBadgePairBadge.js";
 import {smartBadgeUnpairBadge} from "./admin-funcs/smartBadgeUnpairBadge.js";
 
+import { notifyVendorCredentialFileUploaded } from "./admin-funcs/notifyVendorCredentialFileUploaded.js";
+
 export const __internal = {
   getInternalCore,
   initializeInternalCore,
@@ -76,5 +78,9 @@ export const __internal = {
   smartBadge: {
     pairBadge: smartBadgePairBadge,
     unpairBadge: smartBadgeUnpairBadge
+  },
+
+  vendorCredentialFile: {
+    notifyUploaded: notifyVendorCredentialFileUploaded
   }
 };

package/src/lib/config.ts

@@ -81,8 +81,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.11",
-  sdkVersion: "0.43.1-beta.136",
+  sdkVersion: "0.43.1-beta.137",
   genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.43.1-beta.136 2.882.0 0.0.11 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.43.1-beta.137 2.882.0 0.0.11 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/index.ts

@@ -73,6 +73,8 @@ export * from "./usersummary.js";
 export * from "./vendor.js";
 export * from "./vendorcredentialdatarequest.js";
 export * from "./vendorcredentialfile.js";
+export * from "./vendorcredentialfileforautoclassificationok.js";
+export * from "./vendorcredentialfileforautoclassificationrequest.js";
 export * from "./vendorcredentialscontainer.js";
 export * from "./vendorcredentialsummary.js";
 export * from "./vendorcustomfields.js";

package/src/models/components/vendorcredentialfileforautoclassificationok.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f91cc5a07bf0
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VendorCredentialFileForAutoClassificationOk = {
+  success: boolean;
+  /**
+   * ID of the placeholder VendorCredential row.
+   */
+  vendorCredentialId: number;
+  /**
+   * ID of the paired VendorCredentialFile row.
+   */
+  vendorCredentialFileId: number;
+  /**
+   * Short-lived presigned PUT URL. Client uploads file body here.
+   */
+  presignedUrl: string;
+};
+
+/** @internal */
+export const VendorCredentialFileForAutoClassificationOk$inboundSchema:
+  z.ZodType<
+    VendorCredentialFileForAutoClassificationOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    success: types.boolean(),
+    vendor_credential_id: types.number(),
+    vendor_credential_file_id: types.number(),
+    presigned_url: types.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "vendor_credential_id": "vendorCredentialId",
+      "vendor_credential_file_id": "vendorCredentialFileId",
+      "presigned_url": "presignedUrl",
+    });
+  });
+
+export function vendorCredentialFileForAutoClassificationOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  VendorCredentialFileForAutoClassificationOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VendorCredentialFileForAutoClassificationOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'VendorCredentialFileForAutoClassificationOk' from JSON`,
+  );
+}

package/src/models/components/vendorcredentialfileforautoclassificationrequest.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6d6bc55fb921
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type VendorCredentialFileForAutoClassificationRequest = {
+  /**
+   * Original filename of the file the user is uploading.
+   */
+  filename: string;
+  /**
+   * MIME type. Defaults server-side to application/octet-stream.
+   */
+  contentType?: string | undefined;
+};
+
+/** @internal */
+export type VendorCredentialFileForAutoClassificationRequest$Outbound = {
+  filename: string;
+  content_type?: string | undefined;
+};
+
+/** @internal */
+export const VendorCredentialFileForAutoClassificationRequest$outboundSchema:
+  z.ZodType<
+    VendorCredentialFileForAutoClassificationRequest$Outbound,
+    z.ZodTypeDef,
+    VendorCredentialFileForAutoClassificationRequest
+  > = z.object({
+    filename: z.string(),
+    contentType: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      contentType: "content_type",
+    });
+  });
+
+export function vendorCredentialFileForAutoClassificationRequestToJSON(
+  vendorCredentialFileForAutoClassificationRequest:
+    VendorCredentialFileForAutoClassificationRequest,
+): string {
+  return JSON.stringify(
+    VendorCredentialFileForAutoClassificationRequest$outboundSchema.parse(
+      vendorCredentialFileForAutoClassificationRequest,
+    ),
+  );
+}

package/src/models/operations/addvendorcredentialfileforautoclassification.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 56f8c3748c86
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type AddVendorCredentialFileForAutoClassificationRequest = {
+  /**
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
+   */
+  vendorIdOrMe: string;
+  vendorCredentialFileForAutoClassificationRequest:
+    components.VendorCredentialFileForAutoClassificationRequest;
+};
+
+/** @internal */
+export type AddVendorCredentialFileForAutoClassificationRequest$Outbound = {
+  vendor_id_or_me: string;
+  VendorCredentialFileForAutoClassificationRequest:
+    components.VendorCredentialFileForAutoClassificationRequest$Outbound;
+};
+
+/** @internal */
+export const AddVendorCredentialFileForAutoClassificationRequest$outboundSchema:
+  z.ZodType<
+    AddVendorCredentialFileForAutoClassificationRequest$Outbound,
+    z.ZodTypeDef,
+    AddVendorCredentialFileForAutoClassificationRequest
+  > = z.object({
+    vendorIdOrMe: z.string(),
+    vendorCredentialFileForAutoClassificationRequest:
+      components
+        .VendorCredentialFileForAutoClassificationRequest$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      vendorIdOrMe: "vendor_id_or_me",
+      vendorCredentialFileForAutoClassificationRequest:
+        "VendorCredentialFileForAutoClassificationRequest",
+    });
+  });
+
+export function addVendorCredentialFileForAutoClassificationRequestToJSON(
+  addVendorCredentialFileForAutoClassificationRequest:
+    AddVendorCredentialFileForAutoClassificationRequest,
+): string {
+  return JSON.stringify(
+    AddVendorCredentialFileForAutoClassificationRequest$outboundSchema.parse(
+      addVendorCredentialFileForAutoClassificationRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -9,6 +9,7 @@ export * from "./addcompanymanager.js";
 export * from "./adddatarequestfile.js";
 export * from "./addmobiledevice.js";
 export * from "./addvendorcredentialfile.js";
+export * from "./addvendorcredentialfileforautoclassification.js";
 export * from "./addvendormanagedbycompany.js";
 export * from "./calculatesubscriptionprice.js";
 export * from "./cancelhandoff.js";

package/src/react-query/index.ts

@@ -67,6 +67,7 @@ export * from "./vendorFieldsCreateVendorField.js";
 export * from "./vendorFieldsUpdateVendorField.js";
 export * from "./vendorsAcceptVendorCredential.js";
 export * from "./vendorsAddVendorCredentialFile.js";
+export * from "./vendorsAddVendorCredentialFileForAutoClassification.js";
 export * from "./vendorsAddVendorManagedByCompany.js";
 export * from "./vendorsCalculateSubscriptionPrice.js";
 export * from "./vendorsCancelHandoff.js";

package/src/react-query/vendorsAddVendorCredentialFileForAutoClassification.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d4372147bc16
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsAddVendorCredentialFileForAutoClassification } from "../funcs/vendorsAddVendorCredentialFileForAutoClassification.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsAddVendorCredentialFileForAutoClassificationMutationVariables =
+  {
+    request: operations.AddVendorCredentialFileForAutoClassificationRequest;
+    options?: RequestOptions;
+  };
+
+export type VendorsAddVendorCredentialFileForAutoClassificationMutationData =
+  components.VendorCredentialFileForAutoClassificationOk;
+
+export type VendorsAddVendorCredentialFileForAutoClassificationMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get a one-time URL for uploading a credential file for automatic classification (Emerald vendors only)
+ *
+ * @remarks
+ * This endpoint allows vendors on the Emerald plan to upload a series of
+ * documents and have them automatically ingested and routed to the proper
+ * credential. The endpoint will return a one-time-use URL where the file
+ * must be uploaded. Green Security will process the file asynchronously.
+ *
+ * Non-Emerald vendors must use `addVendorCredentialFile` instead.
+ */
+export function useVendorsAddVendorCredentialFileForAutoClassificationMutation(
+  options?: MutationHookOptions<
+    VendorsAddVendorCredentialFileForAutoClassificationMutationData,
+    VendorsAddVendorCredentialFileForAutoClassificationMutationError,
+    VendorsAddVendorCredentialFileForAutoClassificationMutationVariables
+  >,
+): UseMutationResult<
+  VendorsAddVendorCredentialFileForAutoClassificationMutationData,
+  VendorsAddVendorCredentialFileForAutoClassificationMutationError,
+  VendorsAddVendorCredentialFileForAutoClassificationMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsAddVendorCredentialFileForAutoClassificationMutation(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsAddVendorCredentialFileForAutoClassification(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "addVendorCredentialFileForAutoClassification",
+  ];
+}
+
+export function buildVendorsAddVendorCredentialFileForAutoClassificationMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables:
+      VendorsAddVendorCredentialFileForAutoClassificationMutationVariables,
+  ) => Promise<VendorsAddVendorCredentialFileForAutoClassificationMutationData>;
+} {
+  return {
+    mutationKey:
+      mutationKeyVendorsAddVendorCredentialFileForAutoClassification(),
+    mutationFn:
+      function vendorsAddVendorCredentialFileForAutoClassificationMutationFn({
+        request,
+        options,
+      }): Promise<
+        VendorsAddVendorCredentialFileForAutoClassificationMutationData
+      > {
+        const mergedOptions = {
+          ...hookOptions,
+          ...options,
+          fetchOptions: {
+            ...hookOptions?.fetchOptions,
+            ...options?.fetchOptions,
+            signal: combineSignals(
+              hookOptions?.fetchOptions?.signal,
+              options?.fetchOptions?.signal,
+            ),
+          },
+        };
+        return unwrapAsync(vendorsAddVendorCredentialFileForAutoClassification(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      },
+  };
+}

package/src/sdk/vendors.ts

@@ -5,6 +5,7 @@
 
 import { vendorsAcceptVendorCredential } from "../funcs/vendorsAcceptVendorCredential.js";
 import { vendorsAddVendorCredentialFile } from "../funcs/vendorsAddVendorCredentialFile.js";
+import { vendorsAddVendorCredentialFileForAutoClassification } from "../funcs/vendorsAddVendorCredentialFileForAutoClassification.js";
 import { vendorsAddVendorManagedByCompany } from "../funcs/vendorsAddVendorManagedByCompany.js";
 import { vendorsCalculateSubscriptionPrice } from "../funcs/vendorsCalculateSubscriptionPrice.js";
 import { vendorsCancelHandoff } from "../funcs/vendorsCancelHandoff.js";
@@ -1084,4 +1085,26 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get a one-time URL for uploading a credential file for automatic classification (Emerald vendors only)
+   *
+   * @remarks
+   * This endpoint allows vendors on the Emerald plan to upload a series of
+   * documents and have them automatically ingested and routed to the proper
+   * credential. The endpoint will return a one-time-use URL where the file
+   * must be uploaded. Green Security will process the file asynchronously.
+   *
+   * Non-Emerald vendors must use `addVendorCredentialFile` instead.
+   */
+  async addVendorCredentialFileForAutoClassification(
+    request: operations.AddVendorCredentialFileForAutoClassificationRequest,
+    options?: RequestOptions,
+  ): Promise<components.VendorCredentialFileForAutoClassificationOk> {
+    return unwrapAsync(vendorsAddVendorCredentialFileForAutoClassification(
+      this,
+      request,
+      options,
+    ));
+  }
 }