@unified-api/typescript-sdk 2.82.24 → 2.83.3

package/src/sdk/models/shared/assessmentpackage.ts

@@ -0,0 +1,204 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AssessmentPackageRegion,
+  AssessmentPackageRegion$inboundSchema,
+  AssessmentPackageRegion$Outbound,
+  AssessmentPackageRegion$outboundSchema,
+} from "./assessmentpackageregion.js";
+import {
+  AssessmentParameter,
+  AssessmentParameter$inboundSchema,
+  AssessmentParameter$Outbound,
+  AssessmentParameter$outboundSchema,
+} from "./assessmentparameter.js";
+
+export const AssessmentPackageType = {
+  SkillsTest: "SKILLS_TEST",
+  BehavioralAssessment: "BEHAVIORAL_ASSESSMENT",
+  VideoInterview: "VIDEO_INTERVIEW",
+  BackgroundCheck: "BACKGROUND_CHECK",
+  ReferenceCheck: "REFERENCE_CHECK",
+  Other: "OTHER",
+} as const;
+export type AssessmentPackageType = OpenEnum<typeof AssessmentPackageType>;
+
+/**
+ * Used by assessment providers to SUBMIT packages to ATS systems
+ */
+export type AssessmentPackage = {
+  /**
+   * Alternative namesidentifiers for this package
+   */
+  aliases?: Array<string> | undefined;
+  connectionId?: string | undefined;
+  createdAt?: Date | undefined;
+  description?: string | undefined;
+  hasRedirectUrl?: boolean | undefined;
+  hasTargetUrl?: boolean | undefined;
+  id: string;
+  infoUrl?: string | undefined;
+  /**
+   * Integration types that support this package
+   */
+  integrationTypes?: Array<string> | undefined;
+  maxScore?: number | undefined;
+  name: string;
+  needsIpAddress?: boolean | undefined;
+  /**
+   * Questionsinputs needed for this assessment (aligned with verification)
+   */
+  parameters?: Array<AssessmentParameter> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  regions?: Array<AssessmentPackageRegion> | undefined;
+  /**
+   * Category tags (e.g., "Assessment", "Background Check")
+   */
+  tags?: Array<string> | undefined;
+  type: AssessmentPackageType;
+  updatedAt?: Date | undefined;
+  workspaceId?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentPackageType$inboundSchema: z.ZodType<
+  AssessmentPackageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AssessmentPackageType);
+/** @internal */
+export const AssessmentPackageType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AssessmentPackageType
+> = openEnums.outboundSchema(AssessmentPackageType);
+
+/** @internal */
+export const AssessmentPackage$inboundSchema: z.ZodType<
+  AssessmentPackage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aliases: z.array(z.string()).optional(),
+  connection_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  description: z.string().optional(),
+  has_redirect_url: z.boolean().optional(),
+  has_target_url: z.boolean().optional(),
+  id: z.string(),
+  info_url: z.string().optional(),
+  integration_types: z.array(z.string()).optional(),
+  max_score: z.number().optional(),
+  name: z.string(),
+  needs_ip_address: z.boolean().optional(),
+  parameters: z.array(AssessmentParameter$inboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  regions: z.array(AssessmentPackageRegion$inboundSchema).optional(),
+  tags: z.array(z.string()).optional(),
+  type: AssessmentPackageType$inboundSchema,
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  workspace_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+    "created_at": "createdAt",
+    "has_redirect_url": "hasRedirectUrl",
+    "has_target_url": "hasTargetUrl",
+    "info_url": "infoUrl",
+    "integration_types": "integrationTypes",
+    "max_score": "maxScore",
+    "needs_ip_address": "needsIpAddress",
+    "updated_at": "updatedAt",
+    "workspace_id": "workspaceId",
+  });
+});
+/** @internal */
+export type AssessmentPackage$Outbound = {
+  aliases?: Array<string> | undefined;
+  connection_id?: string | undefined;
+  created_at?: string | undefined;
+  description?: string | undefined;
+  has_redirect_url?: boolean | undefined;
+  has_target_url?: boolean | undefined;
+  id: string;
+  info_url?: string | undefined;
+  integration_types?: Array<string> | undefined;
+  max_score?: number | undefined;
+  name: string;
+  needs_ip_address?: boolean | undefined;
+  parameters?: Array<AssessmentParameter$Outbound> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  regions?: Array<AssessmentPackageRegion$Outbound> | undefined;
+  tags?: Array<string> | undefined;
+  type: string;
+  updated_at?: string | undefined;
+  workspace_id?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentPackage$outboundSchema: z.ZodType<
+  AssessmentPackage$Outbound,
+  z.ZodTypeDef,
+  AssessmentPackage
+> = z.object({
+  aliases: z.array(z.string()).optional(),
+  connectionId: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  description: z.string().optional(),
+  hasRedirectUrl: z.boolean().optional(),
+  hasTargetUrl: z.boolean().optional(),
+  id: z.string(),
+  infoUrl: z.string().optional(),
+  integrationTypes: z.array(z.string()).optional(),
+  maxScore: z.number().optional(),
+  name: z.string(),
+  needsIpAddress: z.boolean().optional(),
+  parameters: z.array(AssessmentParameter$outboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  regions: z.array(AssessmentPackageRegion$outboundSchema).optional(),
+  tags: z.array(z.string()).optional(),
+  type: AssessmentPackageType$outboundSchema,
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  workspaceId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+    createdAt: "created_at",
+    hasRedirectUrl: "has_redirect_url",
+    hasTargetUrl: "has_target_url",
+    infoUrl: "info_url",
+    integrationTypes: "integration_types",
+    maxScore: "max_score",
+    needsIpAddress: "needs_ip_address",
+    updatedAt: "updated_at",
+    workspaceId: "workspace_id",
+  });
+});
+
+export function assessmentPackageToJSON(
+  assessmentPackage: AssessmentPackage,
+): string {
+  return JSON.stringify(
+    AssessmentPackage$outboundSchema.parse(assessmentPackage),
+  );
+}
+export function assessmentPackageFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentPackage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentPackage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentPackage' from JSON`,
+  );
+}

package/src/sdk/models/shared/assessmentpackageregion.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssessmentPackageRegion = {
+  costAmount: number;
+  currency?: string | undefined;
+  processingTime?: number | undefined;
+  /**
+   * Countryregion codes where this package is available ({country}-{state} or {country})
+   */
+  regions: Array<string>;
+};
+
+/** @internal */
+export const AssessmentPackageRegion$inboundSchema: z.ZodType<
+  AssessmentPackageRegion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cost_amount: z.number(),
+  currency: z.string().optional(),
+  processing_time: z.number().optional(),
+  regions: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "cost_amount": "costAmount",
+    "processing_time": "processingTime",
+  });
+});
+/** @internal */
+export type AssessmentPackageRegion$Outbound = {
+  cost_amount: number;
+  currency?: string | undefined;
+  processing_time?: number | undefined;
+  regions: Array<string>;
+};
+
+/** @internal */
+export const AssessmentPackageRegion$outboundSchema: z.ZodType<
+  AssessmentPackageRegion$Outbound,
+  z.ZodTypeDef,
+  AssessmentPackageRegion
+> = z.object({
+  costAmount: z.number(),
+  currency: z.string().optional(),
+  processingTime: z.number().optional(),
+  regions: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    costAmount: "cost_amount",
+    processingTime: "processing_time",
+  });
+});
+
+export function assessmentPackageRegionToJSON(
+  assessmentPackageRegion: AssessmentPackageRegion,
+): string {
+  return JSON.stringify(
+    AssessmentPackageRegion$outboundSchema.parse(assessmentPackageRegion),
+  );
+}
+export function assessmentPackageRegionFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentPackageRegion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentPackageRegion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentPackageRegion' from JSON`,
+  );
+}

package/src/sdk/models/shared/assessmentparameter.ts

@@ -0,0 +1,128 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const AssessmentParameterType = {
+  Text: "TEXT",
+  Number: "NUMBER",
+  MultipleChoice: "MULTIPLE_CHOICE",
+  MultipleSelect: "MULTIPLE_SELECT",
+  Date: "DATE",
+  File: "FILE",
+} as const;
+export type AssessmentParameterType = OpenEnum<typeof AssessmentParameterType>;
+
+export type AssessmentParameter = {
+  /**
+   * Valid file MIME types for FILE type
+   */
+  fileTypes?: Array<string> | undefined;
+  id?: string | undefined;
+  isRequired?: boolean | undefined;
+  name: string;
+  /**
+   * Options for MULTIPLE_CHOICE and MULTIPLE_SELECT
+   */
+  options?: Array<string> | undefined;
+  publicQuestion?: string | undefined;
+  type?: AssessmentParameterType | undefined;
+  /**
+   * Regions where this parameter is valid ({country}-{state} or {country})
+   */
+  validRegions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const AssessmentParameterType$inboundSchema: z.ZodType<
+  AssessmentParameterType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AssessmentParameterType);
+/** @internal */
+export const AssessmentParameterType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AssessmentParameterType
+> = openEnums.outboundSchema(AssessmentParameterType);
+
+/** @internal */
+export const AssessmentParameter$inboundSchema: z.ZodType<
+  AssessmentParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  file_types: z.array(z.string()).optional(),
+  id: z.string().optional(),
+  is_required: z.boolean().optional(),
+  name: z.string(),
+  options: z.array(z.string()).optional(),
+  public_question: z.string().optional(),
+  type: AssessmentParameterType$inboundSchema.optional(),
+  valid_regions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "file_types": "fileTypes",
+    "is_required": "isRequired",
+    "public_question": "publicQuestion",
+    "valid_regions": "validRegions",
+  });
+});
+/** @internal */
+export type AssessmentParameter$Outbound = {
+  file_types?: Array<string> | undefined;
+  id?: string | undefined;
+  is_required?: boolean | undefined;
+  name: string;
+  options?: Array<string> | undefined;
+  public_question?: string | undefined;
+  type?: string | undefined;
+  valid_regions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const AssessmentParameter$outboundSchema: z.ZodType<
+  AssessmentParameter$Outbound,
+  z.ZodTypeDef,
+  AssessmentParameter
+> = z.object({
+  fileTypes: z.array(z.string()).optional(),
+  id: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  name: z.string(),
+  options: z.array(z.string()).optional(),
+  publicQuestion: z.string().optional(),
+  type: AssessmentParameterType$outboundSchema.optional(),
+  validRegions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    fileTypes: "file_types",
+    isRequired: "is_required",
+    publicQuestion: "public_question",
+    validRegions: "valid_regions",
+  });
+});
+
+export function assessmentParameterToJSON(
+  assessmentParameter: AssessmentParameter,
+): string {
+  return JSON.stringify(
+    AssessmentParameter$outboundSchema.parse(assessmentParameter),
+  );
+}
+export function assessmentParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentParameter' from JSON`,
+  );
+}

package/src/sdk/models/shared/assessmentparameterinput.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssessmentParameterInput = {
+  inputs?: Array<string> | undefined;
+  name?: string | undefined;
+  parameterId?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentParameterInput$inboundSchema: z.ZodType<
+  AssessmentParameterInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inputs: z.array(z.string()).optional(),
+  name: z.string().optional(),
+  parameter_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "parameter_id": "parameterId",
+  });
+});
+/** @internal */
+export type AssessmentParameterInput$Outbound = {
+  inputs?: Array<string> | undefined;
+  name?: string | undefined;
+  parameter_id?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentParameterInput$outboundSchema: z.ZodType<
+  AssessmentParameterInput$Outbound,
+  z.ZodTypeDef,
+  AssessmentParameterInput
+> = z.object({
+  inputs: z.array(z.string()).optional(),
+  name: z.string().optional(),
+  parameterId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    parameterId: "parameter_id",
+  });
+});
+
+export function assessmentParameterInputToJSON(
+  assessmentParameterInput: AssessmentParameterInput,
+): string {
+  return JSON.stringify(
+    AssessmentParameterInput$outboundSchema.parse(assessmentParameterInput),
+  );
+}
+export function assessmentParameterInputFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentParameterInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentParameterInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentParameterInput' from JSON`,
+  );
+}

package/src/sdk/models/shared/assessmentresponsedetail.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssessmentResponseDetail = {
+  downloadUrl?: string | undefined;
+  isFailedReason?: boolean | undefined;
+  isPrivate?: boolean | undefined;
+  parameterId?: string | undefined;
+  text?: string | undefined;
+  title?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentResponseDetail$inboundSchema: z.ZodType<
+  AssessmentResponseDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  download_url: z.string().optional(),
+  is_failed_reason: z.boolean().optional(),
+  is_private: z.boolean().optional(),
+  parameter_id: z.string().optional(),
+  text: z.string().optional(),
+  title: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "download_url": "downloadUrl",
+    "is_failed_reason": "isFailedReason",
+    "is_private": "isPrivate",
+    "parameter_id": "parameterId",
+  });
+});
+/** @internal */
+export type AssessmentResponseDetail$Outbound = {
+  download_url?: string | undefined;
+  is_failed_reason?: boolean | undefined;
+  is_private?: boolean | undefined;
+  parameter_id?: string | undefined;
+  text?: string | undefined;
+  title?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentResponseDetail$outboundSchema: z.ZodType<
+  AssessmentResponseDetail$Outbound,
+  z.ZodTypeDef,
+  AssessmentResponseDetail
+> = z.object({
+  downloadUrl: z.string().optional(),
+  isFailedReason: z.boolean().optional(),
+  isPrivate: z.boolean().optional(),
+  parameterId: z.string().optional(),
+  text: z.string().optional(),
+  title: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    downloadUrl: "download_url",
+    isFailedReason: "is_failed_reason",
+    isPrivate: "is_private",
+    parameterId: "parameter_id",
+  });
+});
+
+export function assessmentResponseDetailToJSON(
+  assessmentResponseDetail: AssessmentResponseDetail,
+): string {
+  return JSON.stringify(
+    AssessmentResponseDetail$outboundSchema.parse(assessmentResponseDetail),
+  );
+}
+export function assessmentResponseDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentResponseDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentResponseDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentResponseDetail' from JSON`,
+  );
+}