@greensecurity/javascript-sdk 0.30.42 → 0.30.46

package/src/mcp-server/tools/{usersLogsUserIntoTheSystem.ts → usersPostAuthenticate.ts}

@@ -2,16 +2,16 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { usersLogsUserIntoTheSystem } from "../../funcs/usersLogsUserIntoTheSystem.js";
+import { usersPostAuthenticate } from "../../funcs/usersPostAuthenticate.js";
 import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.LogsUserIntoTheSystemRequestBody$inboundSchema,
+  request: operations.PostAuthenticateRequestBody$inboundSchema,
 };
 
-export const tool$usersLogsUserIntoTheSystem: ToolDefinition<typeof args> = {
-  name: "users-logs-user-into-the-system",
+export const tool$usersPostAuthenticate: ToolDefinition<typeof args> = {
+  name: "users-post-authenticate",
   description: `Logs user into the system
 
 This endpoint allows a user to authenticate themselves and retrieve a permanent token for access.
@@ -47,7 +47,7 @@ Requires: \`saml_login\`
 5. Fetch the user object from \`/users/me\` using the token`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await usersLogsUserIntoTheSystem(
+    const [result, apiCall] = await usersPostAuthenticate(
       client,
       args.request,
       { fetchOptions: { signal: ctx.signal } },

package/src/mcp-server/tools/vendorsGetVendorCredentialDetails.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { vendorsGetVendorCredentialDetails } from "../../funcs/vendorsGetVendorCredentialDetails.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetVendorCredentialDetailsRequest$inboundSchema,
+};
+
+export const tool$vendorsGetVendorCredentialDetails: ToolDefinition<
+  typeof args
+> = {
+  name: "vendors-get-vendor-credential-details",
+  description: `Get Vendor Credential details
+
+Get Vendor Credential details
+
+Available \`expand\` scopes are:
+  - vendor_credential.credential
+  - vendor_credential.vendor
+  - vendor_credential.invoice
+  - vendor_credential.vendor_credential_files
+  - vendor_credential.latest_vendor_credential_id
+  - vendor_credential.previously_approved
+  - vendor_credential.unsatisfied_dependencies
+  - vendor_credential.allow_expediting
+  - vendor_credential.unpaid_expedited_invoice_id
+  - vendor_credential.expedited_offers
+  - vendor_credential.background_check_results
+  - vendor_credential.vendor_credential_default_status
+  - vendor_credential.vendor_credential_data_requests
+  - vendor_credential.credential_variants
+  - vendor_credential.targets_chop`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await vendorsGetVendorCredentialDetails(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/webhooksUpdatesTheWebhookEndpointWithTheGivenId.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { webhooksUpdatesTheWebhookEndpointWithTheGivenId } from "../../funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.UpdatesTheWebhookEndpointWithTheGivenIdRequest$inboundSchema,
+};
+
+export const tool$webhooksUpdatesTheWebhookEndpointWithTheGivenId:
+  ToolDefinition<typeof args> = {
+    name: "webhooks-updates-the-webhook-endpoint-with-the-given-id",
+    description: `Updates the webhook endpoint with the given ID.
+
+Updates the webhook endpoint with the given ID.`,
+    args,
+    tool: async (client, args, ctx) => {
+      const [result, apiCall] =
+        await webhooksUpdatesTheWebhookEndpointWithTheGivenId(
+          client,
+          args.request,
+          { fetchOptions: { signal: ctx.signal } },
+        ).$inspect();
+
+      if (!result.ok) {
+        return {
+          content: [{ type: "text", text: result.error.message }],
+          isError: true,
+        };
+      }
+
+      const value = result.value;
+
+      return formatResult(value, apiCall);
+    },
+  };

package/src/mcp-server/tools/zonesSecurityZoneCheckin.ts

@@ -14,7 +14,7 @@ export const tool$zonesSecurityZoneCheckin: ToolDefinition<typeof args> = {
   name: "zones-security-zone-checkin",
   description: `Security zone checkin request
 
-It will create a handoff record in the db for security zone check in request`,
+Security zone checkin request`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await zonesSecurityZoneCheckin(

package/src/models/components/backgroundcheckresult.ts

@@ -0,0 +1,378 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Invoice,
+  Invoice$inboundSchema,
+  Invoice$Outbound,
+  Invoice$outboundSchema,
+} from "./invoice.js";
+
+export const BackgroundCheckResultStatus = {
+  Pending: "Pending",
+  Requested: "Requested",
+  Available: "Available",
+} as const;
+export type BackgroundCheckResultStatus = ClosedEnum<
+  typeof BackgroundCheckResultStatus
+>;
+
+export const DeliveryMethod = {
+  Email: "email",
+  Mail: "mail",
+} as const;
+export type DeliveryMethod = ClosedEnum<typeof DeliveryMethod>;
+
+export type BackgroundCheckResultInvoice = Invoice | number;
+
+export type Bcp = {
+  orderId?: number | null | undefined;
+  orderStatus?: string | null | undefined;
+  notes?: string | null | undefined;
+  dateSent?: string | null | undefined;
+  dateReceived?: string | null | undefined;
+};
+
+export type BackgroundCheckResultLocation = {
+  address1?: string | null | undefined;
+  address2?: string | null | undefined;
+  city?: string | null | undefined;
+  state?: string | null | undefined;
+  zip?: string | null | undefined;
+};
+
+/**
+ * Reduced list of attributes of Background Check Result record
+ */
+export type BackgroundCheckResult = {
+  id?: number | undefined;
+  status?: BackgroundCheckResultStatus | undefined;
+  deliveryMethod?: DeliveryMethod | null | undefined;
+  invoice?: Invoice | number | null | undefined;
+  email?: string | null | undefined;
+  bcp?: Bcp | undefined;
+  location?: BackgroundCheckResultLocation | null | undefined;
+};
+
+/** @internal */
+export const BackgroundCheckResultStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BackgroundCheckResultStatus
+> = z.nativeEnum(BackgroundCheckResultStatus);
+
+/** @internal */
+export const BackgroundCheckResultStatus$outboundSchema: z.ZodNativeEnum<
+  typeof BackgroundCheckResultStatus
+> = BackgroundCheckResultStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BackgroundCheckResultStatus$ {
+  /** @deprecated use `BackgroundCheckResultStatus$inboundSchema` instead. */
+  export const inboundSchema = BackgroundCheckResultStatus$inboundSchema;
+  /** @deprecated use `BackgroundCheckResultStatus$outboundSchema` instead. */
+  export const outboundSchema = BackgroundCheckResultStatus$outboundSchema;
+}
+
+/** @internal */
+export const DeliveryMethod$inboundSchema: z.ZodNativeEnum<
+  typeof DeliveryMethod
+> = z.nativeEnum(DeliveryMethod);
+
+/** @internal */
+export const DeliveryMethod$outboundSchema: z.ZodNativeEnum<
+  typeof DeliveryMethod
+> = DeliveryMethod$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DeliveryMethod$ {
+  /** @deprecated use `DeliveryMethod$inboundSchema` instead. */
+  export const inboundSchema = DeliveryMethod$inboundSchema;
+  /** @deprecated use `DeliveryMethod$outboundSchema` instead. */
+  export const outboundSchema = DeliveryMethod$outboundSchema;
+}
+
+/** @internal */
+export const BackgroundCheckResultInvoice$inboundSchema: z.ZodType<
+  BackgroundCheckResultInvoice,
+  z.ZodTypeDef,
+  unknown
+> = z.union([Invoice$inboundSchema, z.number().int()]);
+
+/** @internal */
+export type BackgroundCheckResultInvoice$Outbound = Invoice$Outbound | number;
+
+/** @internal */
+export const BackgroundCheckResultInvoice$outboundSchema: z.ZodType<
+  BackgroundCheckResultInvoice$Outbound,
+  z.ZodTypeDef,
+  BackgroundCheckResultInvoice
+> = z.union([Invoice$outboundSchema, z.number().int()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BackgroundCheckResultInvoice$ {
+  /** @deprecated use `BackgroundCheckResultInvoice$inboundSchema` instead. */
+  export const inboundSchema = BackgroundCheckResultInvoice$inboundSchema;
+  /** @deprecated use `BackgroundCheckResultInvoice$outboundSchema` instead. */
+  export const outboundSchema = BackgroundCheckResultInvoice$outboundSchema;
+  /** @deprecated use `BackgroundCheckResultInvoice$Outbound` instead. */
+  export type Outbound = BackgroundCheckResultInvoice$Outbound;
+}
+
+export function backgroundCheckResultInvoiceToJSON(
+  backgroundCheckResultInvoice: BackgroundCheckResultInvoice,
+): string {
+  return JSON.stringify(
+    BackgroundCheckResultInvoice$outboundSchema.parse(
+      backgroundCheckResultInvoice,
+    ),
+  );
+}
+
+export function backgroundCheckResultInvoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<BackgroundCheckResultInvoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BackgroundCheckResultInvoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BackgroundCheckResultInvoice' from JSON`,
+  );
+}
+
+/** @internal */
+export const Bcp$inboundSchema: z.ZodType<Bcp, z.ZodTypeDef, unknown> = z
+  .object({
+    order_id: z.nullable(z.number().int()).optional(),
+    order_status: z.nullable(z.string()).optional(),
+    notes: z.nullable(z.string()).optional(),
+    date_sent: z.nullable(z.string()).optional(),
+    date_received: z.nullable(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "order_id": "orderId",
+      "order_status": "orderStatus",
+      "date_sent": "dateSent",
+      "date_received": "dateReceived",
+    });
+  });
+
+/** @internal */
+export type Bcp$Outbound = {
+  order_id?: number | null | undefined;
+  order_status?: string | null | undefined;
+  notes?: string | null | undefined;
+  date_sent?: string | null | undefined;
+  date_received?: string | null | undefined;
+};
+
+/** @internal */
+export const Bcp$outboundSchema: z.ZodType<Bcp$Outbound, z.ZodTypeDef, Bcp> = z
+  .object({
+    orderId: z.nullable(z.number().int()).optional(),
+    orderStatus: z.nullable(z.string()).optional(),
+    notes: z.nullable(z.string()).optional(),
+    dateSent: z.nullable(z.string()).optional(),
+    dateReceived: z.nullable(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      orderId: "order_id",
+      orderStatus: "order_status",
+      dateSent: "date_sent",
+      dateReceived: "date_received",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Bcp$ {
+  /** @deprecated use `Bcp$inboundSchema` instead. */
+  export const inboundSchema = Bcp$inboundSchema;
+  /** @deprecated use `Bcp$outboundSchema` instead. */
+  export const outboundSchema = Bcp$outboundSchema;
+  /** @deprecated use `Bcp$Outbound` instead. */
+  export type Outbound = Bcp$Outbound;
+}
+
+export function bcpToJSON(bcp: Bcp): string {
+  return JSON.stringify(Bcp$outboundSchema.parse(bcp));
+}
+
+export function bcpFromJSON(
+  jsonString: string,
+): SafeParseResult<Bcp, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Bcp$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Bcp' from JSON`,
+  );
+}
+
+/** @internal */
+export const BackgroundCheckResultLocation$inboundSchema: z.ZodType<
+  BackgroundCheckResultLocation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address1: z.nullable(z.string()).optional(),
+  address2: z.nullable(z.string()).optional(),
+  city: z.nullable(z.string()).optional(),
+  state: z.nullable(z.string()).optional(),
+  zip: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type BackgroundCheckResultLocation$Outbound = {
+  address1?: string | null | undefined;
+  address2?: string | null | undefined;
+  city?: string | null | undefined;
+  state?: string | null | undefined;
+  zip?: string | null | undefined;
+};
+
+/** @internal */
+export const BackgroundCheckResultLocation$outboundSchema: z.ZodType<
+  BackgroundCheckResultLocation$Outbound,
+  z.ZodTypeDef,
+  BackgroundCheckResultLocation
+> = z.object({
+  address1: z.nullable(z.string()).optional(),
+  address2: z.nullable(z.string()).optional(),
+  city: z.nullable(z.string()).optional(),
+  state: z.nullable(z.string()).optional(),
+  zip: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BackgroundCheckResultLocation$ {
+  /** @deprecated use `BackgroundCheckResultLocation$inboundSchema` instead. */
+  export const inboundSchema = BackgroundCheckResultLocation$inboundSchema;
+  /** @deprecated use `BackgroundCheckResultLocation$outboundSchema` instead. */
+  export const outboundSchema = BackgroundCheckResultLocation$outboundSchema;
+  /** @deprecated use `BackgroundCheckResultLocation$Outbound` instead. */
+  export type Outbound = BackgroundCheckResultLocation$Outbound;
+}
+
+export function backgroundCheckResultLocationToJSON(
+  backgroundCheckResultLocation: BackgroundCheckResultLocation,
+): string {
+  return JSON.stringify(
+    BackgroundCheckResultLocation$outboundSchema.parse(
+      backgroundCheckResultLocation,
+    ),
+  );
+}
+
+export function backgroundCheckResultLocationFromJSON(
+  jsonString: string,
+): SafeParseResult<BackgroundCheckResultLocation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BackgroundCheckResultLocation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BackgroundCheckResultLocation' from JSON`,
+  );
+}
+
+/** @internal */
+export const BackgroundCheckResult$inboundSchema: z.ZodType<
+  BackgroundCheckResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int().optional(),
+  status: BackgroundCheckResultStatus$inboundSchema.optional(),
+  delivery_method: z.nullable(DeliveryMethod$inboundSchema).optional(),
+  invoice: z.nullable(z.union([Invoice$inboundSchema, z.number().int()]))
+    .optional(),
+  email: z.nullable(z.string()).optional(),
+  bcp: z.lazy(() => Bcp$inboundSchema).optional(),
+  location: z.nullable(
+    z.lazy(() => BackgroundCheckResultLocation$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "delivery_method": "deliveryMethod",
+  });
+});
+
+/** @internal */
+export type BackgroundCheckResult$Outbound = {
+  id?: number | undefined;
+  status?: string | undefined;
+  delivery_method?: string | null | undefined;
+  invoice?: Invoice$Outbound | number | null | undefined;
+  email?: string | null | undefined;
+  bcp?: Bcp$Outbound | undefined;
+  location?: BackgroundCheckResultLocation$Outbound | null | undefined;
+};
+
+/** @internal */
+export const BackgroundCheckResult$outboundSchema: z.ZodType<
+  BackgroundCheckResult$Outbound,
+  z.ZodTypeDef,
+  BackgroundCheckResult
+> = z.object({
+  id: z.number().int().optional(),
+  status: BackgroundCheckResultStatus$outboundSchema.optional(),
+  deliveryMethod: z.nullable(DeliveryMethod$outboundSchema).optional(),
+  invoice: z.nullable(z.union([Invoice$outboundSchema, z.number().int()]))
+    .optional(),
+  email: z.nullable(z.string()).optional(),
+  bcp: z.lazy(() => Bcp$outboundSchema).optional(),
+  location: z.nullable(
+    z.lazy(() => BackgroundCheckResultLocation$outboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    deliveryMethod: "delivery_method",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BackgroundCheckResult$ {
+  /** @deprecated use `BackgroundCheckResult$inboundSchema` instead. */
+  export const inboundSchema = BackgroundCheckResult$inboundSchema;
+  /** @deprecated use `BackgroundCheckResult$outboundSchema` instead. */
+  export const outboundSchema = BackgroundCheckResult$outboundSchema;
+  /** @deprecated use `BackgroundCheckResult$Outbound` instead. */
+  export type Outbound = BackgroundCheckResult$Outbound;
+}
+
+export function backgroundCheckResultToJSON(
+  backgroundCheckResult: BackgroundCheckResult,
+): string {
+  return JSON.stringify(
+    BackgroundCheckResult$outboundSchema.parse(backgroundCheckResult),
+  );
+}
+
+export function backgroundCheckResultFromJSON(
+  jsonString: string,
+): SafeParseResult<BackgroundCheckResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BackgroundCheckResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BackgroundCheckResult' from JSON`,
+  );
+}