@unified-api/typescript-sdk 2.73.17 → 2.73.18

package/src/sdk/models/operations/listverificationrequests.ts

@@ -0,0 +1,144 @@
+/*
+ * 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 ListVerificationRequestsRequest = {
+  /**
+   * The candidate ID to filter by
+   */
+  candidateId?: string | undefined;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  /**
+   * The package ID to filter by
+   */
+  packageId?: string | undefined;
+  /**
+   * Query string to search. eg. email address or name
+   */
+  query?: string | undefined;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+  sort?: string | undefined;
+  /**
+   * Return only results whose updated date is equal or greater to this value
+   */
+  updatedGte?: string | undefined;
+};
+
+/** @internal */
+export const ListVerificationRequestsRequest$inboundSchema: z.ZodType<
+  ListVerificationRequestsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  candidate_id: z.string().optional(),
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  package_id: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updated_gte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "candidate_id": "candidateId",
+    "connection_id": "connectionId",
+    "package_id": "packageId",
+    "updated_gte": "updatedGte",
+  });
+});
+
+/** @internal */
+export type ListVerificationRequestsRequest$Outbound = {
+  candidate_id?: string | undefined;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  package_id?: string | undefined;
+  query?: string | undefined;
+  raw?: string | undefined;
+  sort?: string | undefined;
+  updated_gte?: string | undefined;
+};
+
+/** @internal */
+export const ListVerificationRequestsRequest$outboundSchema: z.ZodType<
+  ListVerificationRequestsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVerificationRequestsRequest
+> = z.object({
+  candidateId: z.string().optional(),
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  order: z.string().optional(),
+  packageId: z.string().optional(),
+  query: z.string().optional(),
+  raw: z.string().optional(),
+  sort: z.string().optional(),
+  updatedGte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    candidateId: "candidate_id",
+    connectionId: "connection_id",
+    packageId: "package_id",
+    updatedGte: "updated_gte",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListVerificationRequestsRequest$ {
+  /** @deprecated use `ListVerificationRequestsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListVerificationRequestsRequest$inboundSchema;
+  /** @deprecated use `ListVerificationRequestsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListVerificationRequestsRequest$outboundSchema;
+  /** @deprecated use `ListVerificationRequestsRequest$Outbound` instead. */
+  export type Outbound = ListVerificationRequestsRequest$Outbound;
+}
+
+export function listVerificationRequestsRequestToJSON(
+  listVerificationRequestsRequest: ListVerificationRequestsRequest,
+): string {
+  return JSON.stringify(
+    ListVerificationRequestsRequest$outboundSchema.parse(
+      listVerificationRequestsRequest,
+    ),
+  );
+}
+
+export function listVerificationRequestsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVerificationRequestsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVerificationRequestsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVerificationRequestsRequest' from JSON`,
+  );
+}

package/src/sdk/models/operations/patchverificationrequest.ts

@@ -0,0 +1,108 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export type PatchVerificationRequestRequest = {
+  verificationRequest: shared.VerificationRequest;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Request
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchVerificationRequestRequest$inboundSchema: z.ZodType<
+  PatchVerificationRequestRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  VerificationRequest: shared.VerificationRequest$inboundSchema,
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "VerificationRequest": "verificationRequest",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type PatchVerificationRequestRequest$Outbound = {
+  VerificationRequest: shared.VerificationRequest$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const PatchVerificationRequestRequest$outboundSchema: z.ZodType<
+  PatchVerificationRequestRequest$Outbound,
+  z.ZodTypeDef,
+  PatchVerificationRequestRequest
+> = z.object({
+  verificationRequest: shared.VerificationRequest$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    verificationRequest: "VerificationRequest",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PatchVerificationRequestRequest$ {
+  /** @deprecated use `PatchVerificationRequestRequest$inboundSchema` instead. */
+  export const inboundSchema = PatchVerificationRequestRequest$inboundSchema;
+  /** @deprecated use `PatchVerificationRequestRequest$outboundSchema` instead. */
+  export const outboundSchema = PatchVerificationRequestRequest$outboundSchema;
+  /** @deprecated use `PatchVerificationRequestRequest$Outbound` instead. */
+  export type Outbound = PatchVerificationRequestRequest$Outbound;
+}
+
+export function patchVerificationRequestRequestToJSON(
+  patchVerificationRequestRequest: PatchVerificationRequestRequest,
+): string {
+  return JSON.stringify(
+    PatchVerificationRequestRequest$outboundSchema.parse(
+      patchVerificationRequestRequest,
+    ),
+  );
+}
+
+export function patchVerificationRequestRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PatchVerificationRequestRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PatchVerificationRequestRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PatchVerificationRequestRequest' from JSON`,
+  );
+}

package/src/sdk/models/operations/removeverificationrequest.ts

@@ -0,0 +1,156 @@
+/*
+ * 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 RemoveVerificationRequestRequest = {
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * ID of the Request
+   */
+  id: string;
+};
+
+export type RemoveVerificationRequestResponse = {
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const RemoveVerificationRequestRequest$inboundSchema: z.ZodType<
+  RemoveVerificationRequestRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connection_id: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type RemoveVerificationRequestRequest$Outbound = {
+  connection_id: string;
+  id: string;
+};
+
+/** @internal */
+export const RemoveVerificationRequestRequest$outboundSchema: z.ZodType<
+  RemoveVerificationRequestRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveVerificationRequestRequest
+> = z.object({
+  connectionId: z.string(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RemoveVerificationRequestRequest$ {
+  /** @deprecated use `RemoveVerificationRequestRequest$inboundSchema` instead. */
+  export const inboundSchema = RemoveVerificationRequestRequest$inboundSchema;
+  /** @deprecated use `RemoveVerificationRequestRequest$outboundSchema` instead. */
+  export const outboundSchema = RemoveVerificationRequestRequest$outboundSchema;
+  /** @deprecated use `RemoveVerificationRequestRequest$Outbound` instead. */
+  export type Outbound = RemoveVerificationRequestRequest$Outbound;
+}
+
+export function removeVerificationRequestRequestToJSON(
+  removeVerificationRequestRequest: RemoveVerificationRequestRequest,
+): string {
+  return JSON.stringify(
+    RemoveVerificationRequestRequest$outboundSchema.parse(
+      removeVerificationRequestRequest,
+    ),
+  );
+}
+
+export function removeVerificationRequestRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveVerificationRequestRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveVerificationRequestRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveVerificationRequestRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const RemoveVerificationRequestResponse$inboundSchema: z.ZodType<
+  RemoveVerificationRequestResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+  });
+});
+
+/** @internal */
+export type RemoveVerificationRequestResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export const RemoveVerificationRequestResponse$outboundSchema: z.ZodType<
+  RemoveVerificationRequestResponse$Outbound,
+  z.ZodTypeDef,
+  RemoveVerificationRequestResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RemoveVerificationRequestResponse$ {
+  /** @deprecated use `RemoveVerificationRequestResponse$inboundSchema` instead. */
+  export const inboundSchema = RemoveVerificationRequestResponse$inboundSchema;
+  /** @deprecated use `RemoveVerificationRequestResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    RemoveVerificationRequestResponse$outboundSchema;
+  /** @deprecated use `RemoveVerificationRequestResponse$Outbound` instead. */
+  export type Outbound = RemoveVerificationRequestResponse$Outbound;
+}
+
+export function removeVerificationRequestResponseToJSON(
+  removeVerificationRequestResponse: RemoveVerificationRequestResponse,
+): string {
+  return JSON.stringify(
+    RemoveVerificationRequestResponse$outboundSchema.parse(
+      removeVerificationRequestResponse,
+    ),
+  );
+}
+
+export function removeVerificationRequestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RemoveVerificationRequestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RemoveVerificationRequestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RemoveVerificationRequestResponse' from JSON`,
+  );
+}

package/src/sdk/models/operations/updateverificationrequest.ts

@@ -0,0 +1,108 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export type UpdateVerificationRequestRequest = {
+  verificationRequest: shared.VerificationRequest;
+  /**
+   * ID of the connection
+   */
+  connectionId: string;
+  /**
+   * Comma-delimited fields to return
+   */
+  fields?: Array<string> | undefined;
+  /**
+   * ID of the Request
+   */
+  id: string;
+  /**
+   * Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
+   */
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const UpdateVerificationRequestRequest$inboundSchema: z.ZodType<
+  UpdateVerificationRequestRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  VerificationRequest: shared.VerificationRequest$inboundSchema,
+  connection_id: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "VerificationRequest": "verificationRequest",
+    "connection_id": "connectionId",
+  });
+});
+
+/** @internal */
+export type UpdateVerificationRequestRequest$Outbound = {
+  VerificationRequest: shared.VerificationRequest$Outbound;
+  connection_id: string;
+  fields?: Array<string> | undefined;
+  id: string;
+  raw?: string | undefined;
+};
+
+/** @internal */
+export const UpdateVerificationRequestRequest$outboundSchema: z.ZodType<
+  UpdateVerificationRequestRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateVerificationRequestRequest
+> = z.object({
+  verificationRequest: shared.VerificationRequest$outboundSchema,
+  connectionId: z.string(),
+  fields: z.array(z.string()).optional(),
+  id: z.string(),
+  raw: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    verificationRequest: "VerificationRequest",
+    connectionId: "connection_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateVerificationRequestRequest$ {
+  /** @deprecated use `UpdateVerificationRequestRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateVerificationRequestRequest$inboundSchema;
+  /** @deprecated use `UpdateVerificationRequestRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateVerificationRequestRequest$outboundSchema;
+  /** @deprecated use `UpdateVerificationRequestRequest$Outbound` instead. */
+  export type Outbound = UpdateVerificationRequestRequest$Outbound;
+}
+
+export function updateVerificationRequestRequestToJSON(
+  updateVerificationRequestRequest: UpdateVerificationRequestRequest,
+): string {
+  return JSON.stringify(
+    UpdateVerificationRequestRequest$outboundSchema.parse(
+      updateVerificationRequestRequest,
+    ),
+  );
+}
+
+export function updateVerificationRequestRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateVerificationRequestRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateVerificationRequestRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateVerificationRequestRequest' from JSON`,
+  );
+}

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

@@ -237,4 +237,11 @@ export * from "./ucrecording.js";
 export * from "./ucrecordingmedia.js";
 export * from "./ucrecordingtranscript.js";
 export * from "./uctelephone.js";
+export * from "./verificationaddress.js";
+export * from "./verificationpackage.js";
+export * from "./verificationparameter.js";
+export * from "./verificationparameterinput.js";
+export * from "./verificationrequest.js";
+export * from "./verificationresponsedetail.js";
+export * from "./verificationtime.js";
 export * from "./webhook.js";

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

@@ -32,6 +32,7 @@ export const PropertyConnectionCategories = {
   Repo: "repo",
   Metadata: "metadata",
   Calendar: "calendar",
+  Verification: "verification",
 } as const;
 export type PropertyConnectionCategories = OpenEnum<
   typeof PropertyConnectionCategories

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

@@ -61,6 +61,9 @@ export const PropertyConnectionPermissions = {
   CommerceLocationWrite: "commerce_location_write",
   CommerceReviewRead: "commerce_review_read",
   CommerceReviewWrite: "commerce_review_write",
+  VerificationPackageRead: "verification_package_read",
+  VerificationRequestRead: "verification_request_read",
+  VerificationRequestWrite: "verification_request_write",
   AtsActivityRead: "ats_activity_read",
   AtsActivityWrite: "ats_activity_write",
   AtsApplicationRead: "ats_application_read",

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

@@ -32,6 +32,7 @@ export const PropertyIntegrationCategories = {
   Repo: "repo",
   Metadata: "metadata",
   Calendar: "calendar",
+  Verification: "verification",
 } as const;
 export type PropertyIntegrationCategories = OpenEnum<
   typeof PropertyIntegrationCategories

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

@@ -0,0 +1,107 @@
+/*
+ * 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 VerificationAddress = {
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  country?: string | undefined;
+  countryCode?: string | undefined;
+  postalCode?: string | undefined;
+  region?: string | undefined;
+  regionCode?: string | undefined;
+};
+
+/** @internal */
+export const VerificationAddress$inboundSchema: z.ZodType<
+  VerificationAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  country: z.string().optional(),
+  country_code: z.string().optional(),
+  postal_code: z.string().optional(),
+  region: z.string().optional(),
+  region_code: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "country_code": "countryCode",
+    "postal_code": "postalCode",
+    "region_code": "regionCode",
+  });
+});
+
+/** @internal */
+export type VerificationAddress$Outbound = {
+  address1?: string | undefined;
+  address2?: string | undefined;
+  city?: string | undefined;
+  country?: string | undefined;
+  country_code?: string | undefined;
+  postal_code?: string | undefined;
+  region?: string | undefined;
+  region_code?: string | undefined;
+};
+
+/** @internal */
+export const VerificationAddress$outboundSchema: z.ZodType<
+  VerificationAddress$Outbound,
+  z.ZodTypeDef,
+  VerificationAddress
+> = z.object({
+  address1: z.string().optional(),
+  address2: z.string().optional(),
+  city: z.string().optional(),
+  country: z.string().optional(),
+  countryCode: z.string().optional(),
+  postalCode: z.string().optional(),
+  region: z.string().optional(),
+  regionCode: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    countryCode: "country_code",
+    postalCode: "postal_code",
+    regionCode: "region_code",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VerificationAddress$ {
+  /** @deprecated use `VerificationAddress$inboundSchema` instead. */
+  export const inboundSchema = VerificationAddress$inboundSchema;
+  /** @deprecated use `VerificationAddress$outboundSchema` instead. */
+  export const outboundSchema = VerificationAddress$outboundSchema;
+  /** @deprecated use `VerificationAddress$Outbound` instead. */
+  export type Outbound = VerificationAddress$Outbound;
+}
+
+export function verificationAddressToJSON(
+  verificationAddress: VerificationAddress,
+): string {
+  return JSON.stringify(
+    VerificationAddress$outboundSchema.parse(verificationAddress),
+  );
+}
+
+export function verificationAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationAddress' from JSON`,
+  );
+}