@unified-api/typescript-sdk 2.73.17 → 2.73.19

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

@@ -0,0 +1,330 @@
+/*
+ * 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 {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VerificationAddress,
+  VerificationAddress$inboundSchema,
+  VerificationAddress$Outbound,
+  VerificationAddress$outboundSchema,
+} from "./verificationaddress.js";
+import {
+  VerificationParameterInput,
+  VerificationParameterInput$inboundSchema,
+  VerificationParameterInput$Outbound,
+  VerificationParameterInput$outboundSchema,
+} from "./verificationparameterinput.js";
+import {
+  VerificationResponseDetail,
+  VerificationResponseDetail$inboundSchema,
+  VerificationResponseDetail$Outbound,
+  VerificationResponseDetail$outboundSchema,
+} from "./verificationresponsedetail.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 = {
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Passed: "PASSED",
+  Pending: "PENDING",
+} as const;
+export type ResponseStatus = OpenEnum<typeof ResponseStatus>;
+
+export type VerificationRequest = {
+  candidateId?: string | undefined;
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  packageId?: string | undefined;
+  parameters?: Array<VerificationParameterInput> | undefined;
+  profileAddresses?: Array<VerificationAddress> | undefined;
+  profileDateOfBirth?: string | undefined;
+  profileEmails?: Array<string> | undefined;
+  profileGender?: ProfileGender | undefined;
+  profileIpAddress?: string | undefined;
+  profileName?: string | undefined;
+  profileNationalIdentifier?: string | undefined;
+  profileTelephones?: Array<string> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  responseCompletedAt?: Date | undefined;
+  responseDetails?: Array<VerificationResponseDetail> | undefined;
+  /**
+   * report download
+   */
+  responseDownloadUrls?: Array<string> | undefined;
+  responseExpiresAt?: Date | undefined;
+  responseIssuedAt?: Date | undefined;
+  responseRedirectUrl?: string | undefined;
+  responseScore?: number | undefined;
+  responseSource?: string | undefined;
+  responseStatus?: ResponseStatus | undefined;
+  targetUrl?: string | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const ProfileGender$inboundSchema: z.ZodType<
+  ProfileGender,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(ProfileGender),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const ProfileGender$outboundSchema: z.ZodType<
+  ProfileGender,
+  z.ZodTypeDef,
+  ProfileGender
+> = z.union([
+  z.nativeEnum(ProfileGender),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProfileGender$ {
+  /** @deprecated use `ProfileGender$inboundSchema` instead. */
+  export const inboundSchema = ProfileGender$inboundSchema;
+  /** @deprecated use `ProfileGender$outboundSchema` instead. */
+  export const outboundSchema = ProfileGender$outboundSchema;
+}
+
+/** @internal */
+export const ResponseStatus$inboundSchema: z.ZodType<
+  ResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(ResponseStatus),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const ResponseStatus$outboundSchema: z.ZodType<
+  ResponseStatus,
+  z.ZodTypeDef,
+  ResponseStatus
+> = z.union([
+  z.nativeEnum(ResponseStatus),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ResponseStatus$ {
+  /** @deprecated use `ResponseStatus$inboundSchema` instead. */
+  export const inboundSchema = ResponseStatus$inboundSchema;
+  /** @deprecated use `ResponseStatus$outboundSchema` instead. */
+  export const outboundSchema = ResponseStatus$outboundSchema;
+}
+
+/** @internal */
+export const VerificationRequest$inboundSchema: z.ZodType<
+  VerificationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  candidate_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  package_id: z.string().optional(),
+  parameters: z.array(VerificationParameterInput$inboundSchema).optional(),
+  profile_addresses: z.array(VerificationAddress$inboundSchema).optional(),
+  profile_date_of_birth: z.string().optional(),
+  profile_emails: z.array(z.string()).optional(),
+  profile_gender: ProfileGender$inboundSchema.optional(),
+  profile_ip_address: z.string().optional(),
+  profile_name: z.string().optional(),
+  profile_national_identifier: z.string().optional(),
+  profile_telephones: z.array(z.string()).optional(),
+  raw: z.record(z.any()).optional(),
+  response_completed_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  response_details: z.array(VerificationResponseDetail$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_redirect_url: z.string().optional(),
+  response_score: z.number().optional(),
+  response_source: z.string().optional(),
+  response_status: ResponseStatus$inboundSchema.optional(),
+  target_url: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "candidate_id": "candidateId",
+    "created_at": "createdAt",
+    "package_id": "packageId",
+    "profile_addresses": "profileAddresses",
+    "profile_date_of_birth": "profileDateOfBirth",
+    "profile_emails": "profileEmails",
+    "profile_gender": "profileGender",
+    "profile_ip_address": "profileIpAddress",
+    "profile_name": "profileName",
+    "profile_national_identifier": "profileNationalIdentifier",
+    "profile_telephones": "profileTelephones",
+    "response_completed_at": "responseCompletedAt",
+    "response_details": "responseDetails",
+    "response_download_urls": "responseDownloadUrls",
+    "response_expires_at": "responseExpiresAt",
+    "response_issued_at": "responseIssuedAt",
+    "response_redirect_url": "responseRedirectUrl",
+    "response_score": "responseScore",
+    "response_source": "responseSource",
+    "response_status": "responseStatus",
+    "target_url": "targetUrl",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type VerificationRequest$Outbound = {
+  candidate_id?: string | undefined;
+  created_at?: string | undefined;
+  id?: string | undefined;
+  package_id?: string | undefined;
+  parameters?: Array<VerificationParameterInput$Outbound> | undefined;
+  profile_addresses?: Array<VerificationAddress$Outbound> | undefined;
+  profile_date_of_birth?: string | undefined;
+  profile_emails?: Array<string> | undefined;
+  profile_gender?: string | undefined;
+  profile_ip_address?: string | undefined;
+  profile_name?: string | undefined;
+  profile_national_identifier?: string | undefined;
+  profile_telephones?: Array<string> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  response_completed_at?: string | undefined;
+  response_details?: Array<VerificationResponseDetail$Outbound> | undefined;
+  response_download_urls?: Array<string> | undefined;
+  response_expires_at?: string | undefined;
+  response_issued_at?: string | undefined;
+  response_redirect_url?: string | undefined;
+  response_score?: number | undefined;
+  response_source?: string | undefined;
+  response_status?: string | undefined;
+  target_url?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const VerificationRequest$outboundSchema: z.ZodType<
+  VerificationRequest$Outbound,
+  z.ZodTypeDef,
+  VerificationRequest
+> = z.object({
+  candidateId: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  packageId: z.string().optional(),
+  parameters: z.array(VerificationParameterInput$outboundSchema).optional(),
+  profileAddresses: z.array(VerificationAddress$outboundSchema).optional(),
+  profileDateOfBirth: z.string().optional(),
+  profileEmails: z.array(z.string()).optional(),
+  profileGender: ProfileGender$outboundSchema.optional(),
+  profileIpAddress: z.string().optional(),
+  profileName: z.string().optional(),
+  profileNationalIdentifier: z.string().optional(),
+  profileTelephones: z.array(z.string()).optional(),
+  raw: z.record(z.any()).optional(),
+  responseCompletedAt: z.date().transform(v => v.toISOString()).optional(),
+  responseDetails: z.array(VerificationResponseDetail$outboundSchema)
+    .optional(),
+  responseDownloadUrls: z.array(z.string()).optional(),
+  responseExpiresAt: z.date().transform(v => v.toISOString()).optional(),
+  responseIssuedAt: z.date().transform(v => v.toISOString()).optional(),
+  responseRedirectUrl: z.string().optional(),
+  responseScore: z.number().optional(),
+  responseSource: z.string().optional(),
+  responseStatus: ResponseStatus$outboundSchema.optional(),
+  targetUrl: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    candidateId: "candidate_id",
+    createdAt: "created_at",
+    packageId: "package_id",
+    profileAddresses: "profile_addresses",
+    profileDateOfBirth: "profile_date_of_birth",
+    profileEmails: "profile_emails",
+    profileGender: "profile_gender",
+    profileIpAddress: "profile_ip_address",
+    profileName: "profile_name",
+    profileNationalIdentifier: "profile_national_identifier",
+    profileTelephones: "profile_telephones",
+    responseCompletedAt: "response_completed_at",
+    responseDetails: "response_details",
+    responseDownloadUrls: "response_download_urls",
+    responseExpiresAt: "response_expires_at",
+    responseIssuedAt: "response_issued_at",
+    responseRedirectUrl: "response_redirect_url",
+    responseScore: "response_score",
+    responseSource: "response_source",
+    responseStatus: "response_status",
+    targetUrl: "target_url",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationRequest$ {
+  /** @deprecated use `VerificationRequest$inboundSchema` instead. */
+  export const inboundSchema = VerificationRequest$inboundSchema;
+  /** @deprecated use `VerificationRequest$outboundSchema` instead. */
+  export const outboundSchema = VerificationRequest$outboundSchema;
+  /** @deprecated use `VerificationRequest$Outbound` instead. */
+  export type Outbound = VerificationRequest$Outbound;
+}
+
+export function verificationRequestToJSON(
+  verificationRequest: VerificationRequest,
+): string {
+  return JSON.stringify(
+    VerificationRequest$outboundSchema.parse(verificationRequest),
+  );
+}
+
+export function verificationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,101 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VerificationResponseDetail = {
+  downloadUrl?: string | undefined;
+  isFailedReason?: boolean | undefined;
+  isPrivate?: boolean | undefined;
+  parameterId?: string | undefined;
+  text?: string | undefined;
+  title?: string | undefined;
+};
+
+/** @internal */
+export const VerificationResponseDetail$inboundSchema: z.ZodType<
+  VerificationResponseDetail,
+  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 VerificationResponseDetail$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 VerificationResponseDetail$outboundSchema: z.ZodType<
+  VerificationResponseDetail$Outbound,
+  z.ZodTypeDef,
+  VerificationResponseDetail
+> = 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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationResponseDetail$ {
+  /** @deprecated use `VerificationResponseDetail$inboundSchema` instead. */
+  export const inboundSchema = VerificationResponseDetail$inboundSchema;
+  /** @deprecated use `VerificationResponseDetail$outboundSchema` instead. */
+  export const outboundSchema = VerificationResponseDetail$outboundSchema;
+  /** @deprecated use `VerificationResponseDetail$Outbound` instead. */
+  export type Outbound = VerificationResponseDetail$Outbound;
+}
+
+export function verificationResponseDetailToJSON(
+  verificationResponseDetail: VerificationResponseDetail,
+): string {
+  return JSON.stringify(
+    VerificationResponseDetail$outboundSchema.parse(verificationResponseDetail),
+  );
+}
+
+export function verificationResponseDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationResponseDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationResponseDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationResponseDetail' from JSON`,
+  );
+}

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

@@ -0,0 +1,82 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VerificationTime = {
+  milliseconds?: number | undefined;
+  /**
+   * {country}-{stateprovince/territory} or just {country} 2-digit ISO codes
+   */
+  validRegions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const VerificationTime$inboundSchema: z.ZodType<
+  VerificationTime,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  milliseconds: z.number().optional(),
+  valid_regions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "valid_regions": "validRegions",
+  });
+});
+
+/** @internal */
+export type VerificationTime$Outbound = {
+  milliseconds?: number | undefined;
+  valid_regions?: Array<string> | undefined;
+};
+
+/** @internal */
+export const VerificationTime$outboundSchema: z.ZodType<
+  VerificationTime$Outbound,
+  z.ZodTypeDef,
+  VerificationTime
+> = z.object({
+  milliseconds: z.number().optional(),
+  validRegions: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    validRegions: "valid_regions",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationTime$ {
+  /** @deprecated use `VerificationTime$inboundSchema` instead. */
+  export const inboundSchema = VerificationTime$inboundSchema;
+  /** @deprecated use `VerificationTime$outboundSchema` instead. */
+  export const outboundSchema = VerificationTime$outboundSchema;
+  /** @deprecated use `VerificationTime$Outbound` instead. */
+  export type Outbound = VerificationTime$Outbound;
+}
+
+export function verificationTimeToJSON(
+  verificationTime: VerificationTime,
+): string {
+  return JSON.stringify(
+    VerificationTime$outboundSchema.parse(verificationTime),
+  );
+}
+
+export function verificationTimeFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationTime, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationTime$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationTime' from JSON`,
+  );
+}

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

@@ -57,6 +57,8 @@ export const ObjectType = {
   CommerceInventory: "commerce_inventory",
   CommerceLocation: "commerce_location",
   CommerceReview: "commerce_review",
+  VerificationPackage: "verification_package",
+  VerificationRequest: "verification_request",
   AtsActivity: "ats_activity",
   AtsApplication: "ats_application",
   AtsApplicationstatus: "ats_applicationstatus",

package/src/sdk/package.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { verificationGetVerificationPackage } from "../funcs/verificationGetVerificationPackage.js";
+import { verificationListVerificationPackages } from "../funcs/verificationListVerificationPackages.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Package extends ClientSDK {
+  /**
+   * Retrieve a package
+   */
+  async getVerificationPackage(
+    request: operations.GetVerificationPackageRequest,
+    options?: RequestOptions,
+  ): Promise<shared.VerificationPackage> {
+    return unwrapAsync(verificationGetVerificationPackage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all packages
+   */
+  async listVerificationPackages(
+    request: operations.ListVerificationPackagesRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.VerificationPackage>> {
+    return unwrapAsync(verificationListVerificationPackages(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/request.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { verificationCreateVerificationRequest } from "../funcs/verificationCreateVerificationRequest.js";
+import { verificationGetVerificationRequest } from "../funcs/verificationGetVerificationRequest.js";
+import { verificationListVerificationRequests } from "../funcs/verificationListVerificationRequests.js";
+import { verificationPatchVerificationRequest } from "../funcs/verificationPatchVerificationRequest.js";
+import { verificationRemoveVerificationRequest } from "../funcs/verificationRemoveVerificationRequest.js";
+import { verificationUpdateVerificationRequest } from "../funcs/verificationUpdateVerificationRequest.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class RequestT extends ClientSDK {
+  /**
+   * Create a request
+   */
+  async createVerificationRequest(
+    request: operations.CreateVerificationRequestRequest,
+    options?: RequestOptions,
+  ): Promise<shared.VerificationRequest> {
+    return unwrapAsync(verificationCreateVerificationRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a request
+   */
+  async getVerificationRequest(
+    request: operations.GetVerificationRequestRequest,
+    options?: RequestOptions,
+  ): Promise<shared.VerificationRequest> {
+    return unwrapAsync(verificationGetVerificationRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all requests
+   */
+  async listVerificationRequests(
+    request: operations.ListVerificationRequestsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.VerificationRequest>> {
+    return unwrapAsync(verificationListVerificationRequests(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a request
+   */
+  async patchVerificationRequest(
+    request: operations.PatchVerificationRequestRequest,
+    options?: RequestOptions,
+  ): Promise<shared.VerificationRequest> {
+    return unwrapAsync(verificationPatchVerificationRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a request
+   */
+  async removeVerificationRequest(
+    request: operations.RemoveVerificationRequestRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveVerificationRequestResponse | undefined> {
+    return unwrapAsync(verificationRemoveVerificationRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a request
+   */
+  async updateVerificationRequest(
+    request: operations.UpdateVerificationRequestRequest,
+    options?: RequestOptions,
+  ): Promise<shared.VerificationRequest> {
+    return unwrapAsync(verificationUpdateVerificationRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+}