@unified-api/typescript-sdk 2.86.6 → 2.86.8

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

@@ -0,0 +1,212 @@
+/*
+ * 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";
+import {
+  PropertyCategoryrating,
+  PropertyCategoryrating$inboundSchema,
+  PropertyCategoryrating$Outbound,
+  PropertyCategoryrating$outboundSchema,
+} from "./propertycategoryrating.js";
+import {
+  PropertyMetadata,
+  PropertyMetadata$inboundSchema,
+  PropertyMetadata$Outbound,
+  PropertyMetadata$outboundSchema,
+} from "./propertymetadata.js";
+
+export type PropertyReview = {
+  /**
+   * the reviewer name
+   */
+  authorName?: string | undefined;
+  /**
+   * ratings per category
+   */
+  categoryRatings?: Array<PropertyCategoryrating> | undefined;
+  /**
+   * the review text
+   */
+  content?: string | undefined;
+  /**
+   * when the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * pointer to the Property Guest who wrote the review
+   */
+  guestId?: string | undefined;
+  /**
+   * unique identifier for the review
+   */
+  id?: string | undefined;
+  /**
+   * whether the review is publicly visible
+   */
+  isPublic?: boolean | undefined;
+  /**
+   * pointer to the Property Listing that was reviewed
+   */
+  listingId?: string | undefined;
+  /**
+   * custom field values
+   */
+  metadata?: Array<PropertyMetadata> | undefined;
+  /**
+   * private feedback for the host
+   */
+  privateFeedback?: string | undefined;
+  /**
+   * the overall rating
+   */
+  rating?: number | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * pointer to the Property Reservation that was reviewed
+   */
+  reservationId?: string | undefined;
+  /**
+   * when the host replied (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  respondedAt?: Date | undefined;
+  /**
+   * the host public reply
+   */
+  response?: string | undefined;
+  /**
+   * the channel the review was posted on, eg. Airbnb
+   */
+  source?: string | undefined;
+  /**
+   * the review title
+   */
+  title?: string | undefined;
+  /**
+   * when the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PropertyReview$inboundSchema: z.ZodType<
+  PropertyReview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  author_name: z.string().optional(),
+  category_ratings: z.array(PropertyCategoryrating$inboundSchema).optional(),
+  content: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  guest_id: z.string().optional(),
+  id: z.string().optional(),
+  is_public: z.boolean().optional(),
+  listing_id: z.string().optional(),
+  metadata: z.array(PropertyMetadata$inboundSchema).optional(),
+  private_feedback: z.string().optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  reservation_id: z.string().optional(),
+  responded_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  response: z.string().optional(),
+  source: z.string().optional(),
+  title: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "author_name": "authorName",
+    "category_ratings": "categoryRatings",
+    "created_at": "createdAt",
+    "guest_id": "guestId",
+    "is_public": "isPublic",
+    "listing_id": "listingId",
+    "private_feedback": "privateFeedback",
+    "reservation_id": "reservationId",
+    "responded_at": "respondedAt",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type PropertyReview$Outbound = {
+  author_name?: string | undefined;
+  category_ratings?: Array<PropertyCategoryrating$Outbound> | undefined;
+  content?: string | undefined;
+  created_at?: string | undefined;
+  guest_id?: string | undefined;
+  id?: string | undefined;
+  is_public?: boolean | undefined;
+  listing_id?: string | undefined;
+  metadata?: Array<PropertyMetadata$Outbound> | undefined;
+  private_feedback?: string | undefined;
+  rating?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reservation_id?: string | undefined;
+  responded_at?: string | undefined;
+  response?: string | undefined;
+  source?: string | undefined;
+  title?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const PropertyReview$outboundSchema: z.ZodType<
+  PropertyReview$Outbound,
+  z.ZodTypeDef,
+  PropertyReview
+> = z.object({
+  authorName: z.string().optional(),
+  categoryRatings: z.array(PropertyCategoryrating$outboundSchema).optional(),
+  content: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  guestId: z.string().optional(),
+  id: z.string().optional(),
+  isPublic: z.boolean().optional(),
+  listingId: z.string().optional(),
+  metadata: z.array(PropertyMetadata$outboundSchema).optional(),
+  privateFeedback: z.string().optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  reservationId: z.string().optional(),
+  respondedAt: z.date().transform(v => v.toISOString()).optional(),
+  response: z.string().optional(),
+  source: z.string().optional(),
+  title: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    authorName: "author_name",
+    categoryRatings: "category_ratings",
+    createdAt: "created_at",
+    guestId: "guest_id",
+    isPublic: "is_public",
+    listingId: "listing_id",
+    privateFeedback: "private_feedback",
+    reservationId: "reservation_id",
+    respondedAt: "responded_at",
+    updatedAt: "updated_at",
+  });
+});
+
+export function propertyReviewToJSON(propertyReview: PropertyReview): string {
+  return JSON.stringify(PropertyReview$outboundSchema.parse(propertyReview));
+}
+export function propertyReviewFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyReview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyReview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyReview' from JSON`,
+  );
+}

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

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * the kind of telephone number
+ */
+export const PropertyTelephoneType = {
+  Work: "WORK",
+  Home: "HOME",
+  Mobile: "MOBILE",
+  Fax: "FAX",
+  Other: "OTHER",
+} as const;
+/**
+ * the kind of telephone number
+ */
+export type PropertyTelephoneType = OpenEnum<typeof PropertyTelephoneType>;
+
+export type PropertyTelephone = {
+  /**
+   * the telephone number
+   */
+  telephone: string;
+  /**
+   * the kind of telephone number
+   */
+  type?: PropertyTelephoneType | undefined;
+};
+
+/** @internal */
+export const PropertyTelephoneType$inboundSchema: z.ZodType<
+  PropertyTelephoneType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyTelephoneType);
+/** @internal */
+export const PropertyTelephoneType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyTelephoneType
+> = openEnums.outboundSchema(PropertyTelephoneType);
+
+/** @internal */
+export const PropertyTelephone$inboundSchema: z.ZodType<
+  PropertyTelephone,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  telephone: z.string(),
+  type: PropertyTelephoneType$inboundSchema.optional(),
+});
+/** @internal */
+export type PropertyTelephone$Outbound = {
+  telephone: string;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const PropertyTelephone$outboundSchema: z.ZodType<
+  PropertyTelephone$Outbound,
+  z.ZodTypeDef,
+  PropertyTelephone
+> = z.object({
+  telephone: z.string(),
+  type: PropertyTelephoneType$outboundSchema.optional(),
+});
+
+export function propertyTelephoneToJSON(
+  propertyTelephone: PropertyTelephone,
+): string {
+  return JSON.stringify(
+    PropertyTelephone$outboundSchema.parse(propertyTelephone),
+  );
+}
+export function propertyTelephoneFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyTelephone, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyTelephone$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyTelephone' from JSON`,
+  );
+}

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

@@ -0,0 +1,155 @@
+/*
+ * 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";
+import {
+  PropertyMetadata,
+  PropertyMetadata$inboundSchema,
+} from "./propertymetadata.js";
+
+export type PropertyUnittype = {
+  /**
+   * the amenity names
+   */
+  amenities?: Array<string> | undefined;
+  /**
+   * number of bathrooms
+   */
+  bathrooms?: number | undefined;
+  /**
+   * number of bedrooms
+   */
+  bedrooms?: number | undefined;
+  /**
+   * number of beds
+   */
+  beds?: number | undefined;
+  /**
+   * the cleaning fee
+   */
+  cleaningFeeAmount?: number | undefined;
+  /**
+   * when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * ISO 4217 currency code
+   */
+  currency?: string | undefined;
+  /**
+   * free-text description of the unit type
+   */
+  description?: string | undefined;
+  /**
+   * the fee per extra guest
+   */
+  extraPersonFeeAmount?: number | undefined;
+  /**
+   * unique identifier for the unit type
+   */
+  id?: string | undefined;
+  /**
+   * URLs of the unit type pictures
+   */
+  imageUrls?: Array<string> | undefined;
+  /**
+   * pointer to the Property Listing this unit type belongs to
+   */
+  listingId?: string | undefined;
+  /**
+   * maximum length of stay, in nights
+   */
+  maxNights?: number | undefined;
+  /**
+   * maximum number of guests
+   */
+  maxOccupancy?: number | undefined;
+  /**
+   * custom field values
+   */
+  metadata?: Array<PropertyMetadata> | undefined;
+  /**
+   * minimum length of stay, in nights
+   */
+  minNights?: number | undefined;
+  /**
+   * the unit type (room type) name
+   */
+  name?: string | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * the lowest nightly price
+   */
+  startPriceAmount?: number | undefined;
+  /**
+   * number of bookable units of this type
+   */
+  unitCount?: number | undefined;
+  /**
+   * when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PropertyUnittype$inboundSchema: z.ZodType<
+  PropertyUnittype,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amenities: z.array(z.string()).optional(),
+  bathrooms: z.number().optional(),
+  bedrooms: z.number().optional(),
+  beds: z.number().optional(),
+  cleaning_fee_amount: z.number().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  extra_person_fee_amount: z.number().optional(),
+  id: z.string().optional(),
+  image_urls: z.array(z.string()).optional(),
+  listing_id: z.string().optional(),
+  max_nights: z.number().optional(),
+  max_occupancy: z.number().optional(),
+  metadata: z.array(PropertyMetadata$inboundSchema).optional(),
+  min_nights: z.number().optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  start_price_amount: z.number().optional(),
+  unit_count: z.number().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "cleaning_fee_amount": "cleaningFeeAmount",
+    "created_at": "createdAt",
+    "extra_person_fee_amount": "extraPersonFeeAmount",
+    "image_urls": "imageUrls",
+    "listing_id": "listingId",
+    "max_nights": "maxNights",
+    "max_occupancy": "maxOccupancy",
+    "min_nights": "minNights",
+    "start_price_amount": "startPriceAmount",
+    "unit_count": "unitCount",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function propertyUnittypeFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyUnittype, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyUnittype$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyUnittype' from JSON`,
+  );
+}

package/src/sdk/models/shared/{virtualwebhookcarrierid.ts → virtualwebhookcalendarid.ts}

@@ -286,6 +286,13 @@ export const ListGroupId = {
 } as const;
 export type ListGroupId = OpenEnum<typeof ListGroupId>;
 
+export const ListGuestId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListGuestId = OpenEnum<typeof ListGuestId>;
+
 export const ListInstanceId = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -377,6 +384,13 @@ export const ListListId = {
 } as const;
 export type ListListId = OpenEnum<typeof ListListId>;
 
+export const ListListingId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListListingId = OpenEnum<typeof ListListingId>;
+
 export const ListLocationId = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -559,6 +573,13 @@ export const ListRepoId = {
 } as const;
 export type ListRepoId = OpenEnum<typeof ListRepoId>;
 
+export const ListReservationId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListReservationId = OpenEnum<typeof ListReservationId>;
+
 export const ListRoleId = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -720,6 +741,13 @@ export const ListType = {
 } as const;
 export type ListType = OpenEnum<typeof ListType>;
 
+export const ListUnittypeId = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type ListUnittypeId = OpenEnum<typeof ListUnittypeId>;
+
 export const ListUpdatedGte = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -1038,38 +1066,6 @@ export type VirtualWebhookCalendarId = OpenEnum<
   typeof VirtualWebhookCalendarId
 >;
 
-export const VirtualWebhookCallId = {
-  SupportedRequired: "supported-required",
-  Supported: "supported",
-  NotSupported: "not-supported",
-} as const;
-export type VirtualWebhookCallId = OpenEnum<typeof VirtualWebhookCallId>;
-
-export const VirtualWebhookCampaignId = {
-  SupportedRequired: "supported-required",
-  Supported: "supported",
-  NotSupported: "not-supported",
-} as const;
-export type VirtualWebhookCampaignId = OpenEnum<
-  typeof VirtualWebhookCampaignId
->;
-
-export const VirtualWebhookCandidateId = {
-  SupportedRequired: "supported-required",
-  Supported: "supported",
-  NotSupported: "not-supported",
-} as const;
-export type VirtualWebhookCandidateId = OpenEnum<
-  typeof VirtualWebhookCandidateId
->;
-
-export const VirtualWebhookCarrierId = {
-  SupportedRequired: "supported-required",
-  Supported: "supported",
-  NotSupported: "not-supported",
-} as const;
-export type VirtualWebhookCarrierId = OpenEnum<typeof VirtualWebhookCarrierId>;
-
 /** @internal */
 export const FromWebhook$inboundSchema: z.ZodType<
   FromWebhook,
@@ -1350,6 +1346,13 @@ export const ListGroupId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListGroupId);
 
+/** @internal */
+export const ListGuestId$inboundSchema: z.ZodType<
+  ListGuestId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListGuestId);
+
 /** @internal */
 export const ListInstanceId$inboundSchema: z.ZodType<
   ListInstanceId,
@@ -1441,6 +1444,13 @@ export const ListListId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListListId);
 
+/** @internal */
+export const ListListingId$inboundSchema: z.ZodType<
+  ListListingId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListListingId);
+
 /** @internal */
 export const ListLocationId$inboundSchema: z.ZodType<
   ListLocationId,
@@ -1623,6 +1633,13 @@ export const ListRepoId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListRepoId);
 
+/** @internal */
+export const ListReservationId$inboundSchema: z.ZodType<
+  ListReservationId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListReservationId);
+
 /** @internal */
 export const ListRoleId$inboundSchema: z.ZodType<
   ListRoleId,
@@ -1784,6 +1801,13 @@ export const ListType$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(ListType);
 
+/** @internal */
+export const ListUnittypeId$inboundSchema: z.ZodType<
+  ListUnittypeId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListUnittypeId);
+
 /** @internal */
 export const ListUpdatedGte$inboundSchema: z.ZodType<
   ListUpdatedGte,
@@ -2091,31 +2115,3 @@ export const VirtualWebhookCalendarId$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = openEnums.inboundSchema(VirtualWebhookCalendarId);
-
-/** @internal */
-export const VirtualWebhookCallId$inboundSchema: z.ZodType<
-  VirtualWebhookCallId,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(VirtualWebhookCallId);
-
-/** @internal */
-export const VirtualWebhookCampaignId$inboundSchema: z.ZodType<
-  VirtualWebhookCampaignId,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(VirtualWebhookCampaignId);
-
-/** @internal */
-export const VirtualWebhookCandidateId$inboundSchema: z.ZodType<
-  VirtualWebhookCandidateId,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(VirtualWebhookCandidateId);
-
-/** @internal */
-export const VirtualWebhookCarrierId$inboundSchema: z.ZodType<
-  VirtualWebhookCarrierId,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(VirtualWebhookCarrierId);

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

@@ -259,6 +259,14 @@ export const WebhookObjectType = {
   HealthcareReport: "healthcare_report",
   HealthcareCareplan: "healthcare_careplan",
   HealthcareGoal: "healthcare_goal",
+  PropertyListing: "property_listing",
+  PropertyUnittype: "property_unittype",
+  PropertyGuest: "property_guest",
+  PropertyReservation: "property_reservation",
+  PropertyAvailability: "property_availability",
+  PropertyQuote: "property_quote",
+  PropertyReview: "property_review",
+  PropertyConversation: "property_conversation",
 } as const;
 /**
  * The object to return (eg. CRM "contact")