@unified-api/typescript-sdk 2.82.25 → 2.83.3

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

@@ -0,0 +1,132 @@
+/*
+ * 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 AssessmentAttributeStatus = {
+  Open: "OPEN",
+  InProgress: "IN_PROGRESS",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Rejected: "REJECTED",
+} as const;
+export type AssessmentAttributeStatus = OpenEnum<
+  typeof AssessmentAttributeStatus
+>;
+
+export const AssessmentAttributeType = {
+  Text: "TEXT",
+  Number: "NUMBER",
+  SubResult: "SUB_RESULT",
+} as const;
+export type AssessmentAttributeType = OpenEnum<typeof AssessmentAttributeType>;
+
+export type AssessmentAttribute = {
+  label: string;
+  reference?: string | undefined;
+  scoreMax?: number | undefined;
+  scoreValue?: number | undefined;
+  status?: AssessmentAttributeStatus | undefined;
+  type: AssessmentAttributeType;
+  value?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentAttributeStatus$inboundSchema: z.ZodType<
+  AssessmentAttributeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AssessmentAttributeStatus);
+/** @internal */
+export const AssessmentAttributeStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AssessmentAttributeStatus
+> = openEnums.outboundSchema(AssessmentAttributeStatus);
+
+/** @internal */
+export const AssessmentAttributeType$inboundSchema: z.ZodType<
+  AssessmentAttributeType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AssessmentAttributeType);
+/** @internal */
+export const AssessmentAttributeType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AssessmentAttributeType
+> = openEnums.outboundSchema(AssessmentAttributeType);
+
+/** @internal */
+export const AssessmentAttribute$inboundSchema: z.ZodType<
+  AssessmentAttribute,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  label: z.string(),
+  reference: z.string().optional(),
+  score_max: z.number().optional(),
+  score_value: z.number().optional(),
+  status: AssessmentAttributeStatus$inboundSchema.optional(),
+  type: AssessmentAttributeType$inboundSchema,
+  value: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "score_max": "scoreMax",
+    "score_value": "scoreValue",
+  });
+});
+/** @internal */
+export type AssessmentAttribute$Outbound = {
+  label: string;
+  reference?: string | undefined;
+  score_max?: number | undefined;
+  score_value?: number | undefined;
+  status?: string | undefined;
+  type: string;
+  value?: string | undefined;
+};
+
+/** @internal */
+export const AssessmentAttribute$outboundSchema: z.ZodType<
+  AssessmentAttribute$Outbound,
+  z.ZodTypeDef,
+  AssessmentAttribute
+> = z.object({
+  label: z.string(),
+  reference: z.string().optional(),
+  scoreMax: z.number().optional(),
+  scoreValue: z.number().optional(),
+  status: AssessmentAttributeStatus$outboundSchema.optional(),
+  type: AssessmentAttributeType$outboundSchema,
+  value: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    scoreMax: "score_max",
+    scoreValue: "score_value",
+  });
+});
+
+export function assessmentAttributeToJSON(
+  assessmentAttribute: AssessmentAttribute,
+): string {
+  return JSON.stringify(
+    AssessmentAttribute$outboundSchema.parse(assessmentAttribute),
+  );
+}
+export function assessmentAttributeFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentAttribute, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentAttribute$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentAttribute' from JSON`,
+  );
+}

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

@@ -0,0 +1,397 @@
+/*
+ * 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 {
+  AssessmentAddress,
+  AssessmentAddress$inboundSchema,
+  AssessmentAddress$Outbound,
+  AssessmentAddress$outboundSchema,
+} from "./assessmentaddress.js";
+import {
+  AssessmentAttribute,
+  AssessmentAttribute$inboundSchema,
+  AssessmentAttribute$Outbound,
+  AssessmentAttribute$outboundSchema,
+} from "./assessmentattribute.js";
+import {
+  AssessmentParameterInput,
+  AssessmentParameterInput$inboundSchema,
+  AssessmentParameterInput$Outbound,
+  AssessmentParameterInput$outboundSchema,
+} from "./assessmentparameterinput.js";
+import {
+  AssessmentResponseDetail,
+  AssessmentResponseDetail$inboundSchema,
+  AssessmentResponseDetail$Outbound,
+  AssessmentResponseDetail$outboundSchema,
+} from "./assessmentresponsedetail.js";
+
+export const ProfileGender = {
+  Male: "MALE",
+  Female: "FEMALE",
+  Intersex: "INTERSEX",
+  Trans: "TRANS",
+  NonBinary: "NON_BINARY",
+} as const;
+export type ProfileGender = OpenEnum<typeof ProfileGender>;
+
+export const ResponseStatus = {
+  Open: "OPEN",
+  InProgress: "IN_PROGRESS",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Rejected: "REJECTED",
+} as const;
+export type ResponseStatus = OpenEnum<typeof ResponseStatus>;
+
+export const AssessmentOrderStatus = {
+  Open: "OPEN",
+  InProgress: "IN_PROGRESS",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Rejected: "REJECTED",
+} as const;
+export type AssessmentOrderStatus = OpenEnum<typeof AssessmentOrderStatus>;
+
+export type AssessmentOrder = {
+  applicationId?: string | undefined;
+  candidateId?: string | undefined;
+  companyId?: string | undefined;
+  connectionId: string;
+  createdAt?: Date | undefined;
+  employeeId?: string | undefined;
+  id?: string | undefined;
+  jobId?: string | undefined;
+  packageId?: string | undefined;
+  /**
+   * Filled-in answers to the package's parameter questions
+   */
+  parameters?: Array<AssessmentParameterInput> | undefined;
+  profileAddresses?: Array<AssessmentAddress> | undefined;
+  profileDateOfBirth?: string | undefined;
+  profileEmails?: Array<string> | undefined;
+  profileFirstName?: string | undefined;
+  profileGender?: ProfileGender | undefined;
+  profileIpAddress?: string | undefined;
+  profileLastName?: string | undefined;
+  profileName?: string | undefined;
+  profileNationalIdentifier?: string | undefined;
+  profileResumeUrl?: string | undefined;
+  profileSocialMediaUrls?: Array<string> | undefined;
+  profileTelephones?: Array<string> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reference?: string | undefined;
+  /**
+   * Additional result attributes
+   */
+  responseAttributes?: Array<AssessmentAttribute> | undefined;
+  responseCompletedAt?: Date | undefined;
+  responseDetails?: Array<AssessmentResponseDetail> | undefined;
+  /**
+   * Report download URLs
+   */
+  responseDownloadUrls?: Array<string> | undefined;
+  responseExpiresAt?: Date | undefined;
+  responseIssuedAt?: Date | undefined;
+  responseMaxScore?: number | undefined;
+  responseRedirectUrl?: string | undefined;
+  responseScore?: number | undefined;
+  responseSource?: string | undefined;
+  responseStatus?: ResponseStatus | undefined;
+  responseUrl?: string | undefined;
+  status?: AssessmentOrderStatus | undefined;
+  targetUrl?: string | undefined;
+  updatedAt?: Date | undefined;
+  webhookId?: string | undefined;
+  workspaceId: string;
+};
+
+/** @internal */
+export const ProfileGender$inboundSchema: z.ZodType<
+  ProfileGender,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ProfileGender);
+/** @internal */
+export const ProfileGender$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ProfileGender
+> = openEnums.outboundSchema(ProfileGender);
+
+/** @internal */
+export const ResponseStatus$inboundSchema: z.ZodType<
+  ResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ResponseStatus);
+/** @internal */
+export const ResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ResponseStatus
+> = openEnums.outboundSchema(ResponseStatus);
+
+/** @internal */
+export const AssessmentOrderStatus$inboundSchema: z.ZodType<
+  AssessmentOrderStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AssessmentOrderStatus);
+/** @internal */
+export const AssessmentOrderStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AssessmentOrderStatus
+> = openEnums.outboundSchema(AssessmentOrderStatus);
+
+/** @internal */
+export const AssessmentOrder$inboundSchema: z.ZodType<
+  AssessmentOrder,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  application_id: z.string().optional(),
+  candidate_id: z.string().optional(),
+  company_id: z.string().optional(),
+  connection_id: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  employee_id: z.string().optional(),
+  id: z.string().optional(),
+  job_id: z.string().optional(),
+  package_id: z.string().optional(),
+  parameters: z.array(AssessmentParameterInput$inboundSchema).optional(),
+  profile_addresses: z.array(AssessmentAddress$inboundSchema).optional(),
+  profile_date_of_birth: z.string().optional(),
+  profile_emails: z.array(z.string()).optional(),
+  profile_first_name: z.string().optional(),
+  profile_gender: ProfileGender$inboundSchema.optional(),
+  profile_ip_address: z.string().optional(),
+  profile_last_name: z.string().optional(),
+  profile_name: z.string().optional(),
+  profile_national_identifier: z.string().optional(),
+  profile_resume_url: z.string().optional(),
+  profile_social_media_urls: z.array(z.string()).optional(),
+  profile_telephones: z.array(z.string()).optional(),
+  raw: z.record(z.any()).optional(),
+  reference: z.string().optional(),
+  response_attributes: z.array(AssessmentAttribute$inboundSchema).optional(),
+  response_completed_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  response_details: z.array(AssessmentResponseDetail$inboundSchema).optional(),
+  response_download_urls: z.array(z.string()).optional(),
+  response_expires_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  response_issued_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  response_max_score: z.number().optional(),
+  response_redirect_url: z.string().optional(),
+  response_score: z.number().optional(),
+  response_source: z.string().optional(),
+  response_status: ResponseStatus$inboundSchema.optional(),
+  response_url: z.string().optional(),
+  status: AssessmentOrderStatus$inboundSchema.optional(),
+  target_url: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  webhook_id: z.string().optional(),
+  workspace_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "application_id": "applicationId",
+    "candidate_id": "candidateId",
+    "company_id": "companyId",
+    "connection_id": "connectionId",
+    "created_at": "createdAt",
+    "employee_id": "employeeId",
+    "job_id": "jobId",
+    "package_id": "packageId",
+    "profile_addresses": "profileAddresses",
+    "profile_date_of_birth": "profileDateOfBirth",
+    "profile_emails": "profileEmails",
+    "profile_first_name": "profileFirstName",
+    "profile_gender": "profileGender",
+    "profile_ip_address": "profileIpAddress",
+    "profile_last_name": "profileLastName",
+    "profile_name": "profileName",
+    "profile_national_identifier": "profileNationalIdentifier",
+    "profile_resume_url": "profileResumeUrl",
+    "profile_social_media_urls": "profileSocialMediaUrls",
+    "profile_telephones": "profileTelephones",
+    "response_attributes": "responseAttributes",
+    "response_completed_at": "responseCompletedAt",
+    "response_details": "responseDetails",
+    "response_download_urls": "responseDownloadUrls",
+    "response_expires_at": "responseExpiresAt",
+    "response_issued_at": "responseIssuedAt",
+    "response_max_score": "responseMaxScore",
+    "response_redirect_url": "responseRedirectUrl",
+    "response_score": "responseScore",
+    "response_source": "responseSource",
+    "response_status": "responseStatus",
+    "response_url": "responseUrl",
+    "target_url": "targetUrl",
+    "updated_at": "updatedAt",
+    "webhook_id": "webhookId",
+    "workspace_id": "workspaceId",
+  });
+});
+/** @internal */
+export type AssessmentOrder$Outbound = {
+  application_id?: string | undefined;
+  candidate_id?: string | undefined;
+  company_id?: string | undefined;
+  connection_id: string;
+  created_at?: string | undefined;
+  employee_id?: string | undefined;
+  id?: string | undefined;
+  job_id?: string | undefined;
+  package_id?: string | undefined;
+  parameters?: Array<AssessmentParameterInput$Outbound> | undefined;
+  profile_addresses?: Array<AssessmentAddress$Outbound> | undefined;
+  profile_date_of_birth?: string | undefined;
+  profile_emails?: Array<string> | undefined;
+  profile_first_name?: string | undefined;
+  profile_gender?: string | undefined;
+  profile_ip_address?: string | undefined;
+  profile_last_name?: string | undefined;
+  profile_name?: string | undefined;
+  profile_national_identifier?: string | undefined;
+  profile_resume_url?: string | undefined;
+  profile_social_media_urls?: Array<string> | undefined;
+  profile_telephones?: Array<string> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reference?: string | undefined;
+  response_attributes?: Array<AssessmentAttribute$Outbound> | undefined;
+  response_completed_at?: string | undefined;
+  response_details?: Array<AssessmentResponseDetail$Outbound> | undefined;
+  response_download_urls?: Array<string> | undefined;
+  response_expires_at?: string | undefined;
+  response_issued_at?: string | undefined;
+  response_max_score?: number | undefined;
+  response_redirect_url?: string | undefined;
+  response_score?: number | undefined;
+  response_source?: string | undefined;
+  response_status?: string | undefined;
+  response_url?: string | undefined;
+  status?: string | undefined;
+  target_url?: string | undefined;
+  updated_at?: string | undefined;
+  webhook_id?: string | undefined;
+  workspace_id: string;
+};
+
+/** @internal */
+export const AssessmentOrder$outboundSchema: z.ZodType<
+  AssessmentOrder$Outbound,
+  z.ZodTypeDef,
+  AssessmentOrder
+> = z.object({
+  applicationId: z.string().optional(),
+  candidateId: z.string().optional(),
+  companyId: z.string().optional(),
+  connectionId: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  employeeId: z.string().optional(),
+  id: z.string().optional(),
+  jobId: z.string().optional(),
+  packageId: z.string().optional(),
+  parameters: z.array(AssessmentParameterInput$outboundSchema).optional(),
+  profileAddresses: z.array(AssessmentAddress$outboundSchema).optional(),
+  profileDateOfBirth: z.string().optional(),
+  profileEmails: z.array(z.string()).optional(),
+  profileFirstName: z.string().optional(),
+  profileGender: ProfileGender$outboundSchema.optional(),
+  profileIpAddress: z.string().optional(),
+  profileLastName: z.string().optional(),
+  profileName: z.string().optional(),
+  profileNationalIdentifier: z.string().optional(),
+  profileResumeUrl: z.string().optional(),
+  profileSocialMediaUrls: z.array(z.string()).optional(),
+  profileTelephones: z.array(z.string()).optional(),
+  raw: z.record(z.any()).optional(),
+  reference: z.string().optional(),
+  responseAttributes: z.array(AssessmentAttribute$outboundSchema).optional(),
+  responseCompletedAt: z.date().transform(v => v.toISOString()).optional(),
+  responseDetails: z.array(AssessmentResponseDetail$outboundSchema).optional(),
+  responseDownloadUrls: z.array(z.string()).optional(),
+  responseExpiresAt: z.date().transform(v => v.toISOString()).optional(),
+  responseIssuedAt: z.date().transform(v => v.toISOString()).optional(),
+  responseMaxScore: z.number().optional(),
+  responseRedirectUrl: z.string().optional(),
+  responseScore: z.number().optional(),
+  responseSource: z.string().optional(),
+  responseStatus: ResponseStatus$outboundSchema.optional(),
+  responseUrl: z.string().optional(),
+  status: AssessmentOrderStatus$outboundSchema.optional(),
+  targetUrl: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  webhookId: z.string().optional(),
+  workspaceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    applicationId: "application_id",
+    candidateId: "candidate_id",
+    companyId: "company_id",
+    connectionId: "connection_id",
+    createdAt: "created_at",
+    employeeId: "employee_id",
+    jobId: "job_id",
+    packageId: "package_id",
+    profileAddresses: "profile_addresses",
+    profileDateOfBirth: "profile_date_of_birth",
+    profileEmails: "profile_emails",
+    profileFirstName: "profile_first_name",
+    profileGender: "profile_gender",
+    profileIpAddress: "profile_ip_address",
+    profileLastName: "profile_last_name",
+    profileName: "profile_name",
+    profileNationalIdentifier: "profile_national_identifier",
+    profileResumeUrl: "profile_resume_url",
+    profileSocialMediaUrls: "profile_social_media_urls",
+    profileTelephones: "profile_telephones",
+    responseAttributes: "response_attributes",
+    responseCompletedAt: "response_completed_at",
+    responseDetails: "response_details",
+    responseDownloadUrls: "response_download_urls",
+    responseExpiresAt: "response_expires_at",
+    responseIssuedAt: "response_issued_at",
+    responseMaxScore: "response_max_score",
+    responseRedirectUrl: "response_redirect_url",
+    responseScore: "response_score",
+    responseSource: "response_source",
+    responseStatus: "response_status",
+    responseUrl: "response_url",
+    targetUrl: "target_url",
+    updatedAt: "updated_at",
+    webhookId: "webhook_id",
+    workspaceId: "workspace_id",
+  });
+});
+
+export function assessmentOrderToJSON(
+  assessmentOrder: AssessmentOrder,
+): string {
+  return JSON.stringify(AssessmentOrder$outboundSchema.parse(assessmentOrder));
+}
+export function assessmentOrderFromJSON(
+  jsonString: string,
+): SafeParseResult<AssessmentOrder, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssessmentOrder$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssessmentOrder' from JSON`,
+  );
+}