@unified-api/typescript-sdk 2.86.7 → 2.86.9

package/src/sdk/models/shared/propertylisting.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 {
+  PropertyChannel,
+  PropertyChannel$inboundSchema,
+  PropertyChannel$Outbound,
+  PropertyChannel$outboundSchema,
+} from "./propertychannel.js";
+import {
+  PropertyMetadata,
+  PropertyMetadata$inboundSchema,
+  PropertyMetadata$Outbound,
+  PropertyMetadata$outboundSchema,
+} from "./propertymetadata.js";
+import {
+  PropertyPropertyListingAddress,
+  PropertyPropertyListingAddress$inboundSchema,
+  PropertyPropertyListingAddress$Outbound,
+  PropertyPropertyListingAddress$outboundSchema,
+} from "./propertypropertylistingaddress.js";
+
+/**
+ * the normalized property type
+ */
+export const PropertyListingType = {
+  Apartment: "APARTMENT",
+  House: "HOUSE",
+  Condo: "CONDO",
+  Studio: "STUDIO",
+  Villa: "VILLA",
+  Cabin: "CABIN",
+  Room: "ROOM",
+  Hotel: "HOTEL",
+  BedAndBreakfast: "BED_AND_BREAKFAST",
+  Other: "OTHER",
+} as const;
+/**
+ * the normalized property type
+ */
+export type PropertyListingType = OpenEnum<typeof PropertyListingType>;
+
+export type PropertyListing = {
+  /**
+   * postal address of the listing
+   */
+  address?: PropertyPropertyListingAddress | undefined;
+  /**
+   * 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 cancellation policy
+   */
+  cancellationPolicy?: string | undefined;
+  /**
+   * distribution channels this listing is published on
+   */
+  channels?: Array<PropertyChannel> | undefined;
+  /**
+   * latest check-in time (HH:mm, local time)
+   */
+  checkInEndTime?: string | undefined;
+  /**
+   * earliest check-in time (HH:mm, local time)
+   */
+  checkInStartTime?: string | undefined;
+  /**
+   * check-out time (HH:mm, local time)
+   */
+  checkOutTime?: string | undefined;
+  /**
+   * the cleaning fee
+   */
+  cleaningFeeAmount?: number | undefined;
+  /**
+   * when the listing 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 listing
+   */
+  description?: string | undefined;
+  /**
+   * the house rules
+   */
+  houseRules?: string | undefined;
+  /**
+   * unique identifier for the listing
+   */
+  id?: string | undefined;
+  /**
+   * URLs of the listing pictures
+   */
+  imageUrls?: Array<string> | undefined;
+  /**
+   * the internal (host-facing) listing name
+   */
+  internalName?: string | undefined;
+  /**
+   * whether the listing is active
+   */
+  isActive?: boolean | undefined;
+  /**
+   * latitude of the listing
+   */
+  latitude?: number | undefined;
+  /**
+   * longitude of the listing
+   */
+  longitude?: number | 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 public listing name
+   */
+  name?: string | undefined;
+  /**
+   * HR Employees who own this listing
+   */
+  ownerUserIds?: Array<string> | undefined;
+  /**
+   * the average guest rating
+   */
+  rating?: number | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * the number of guest reviews
+   */
+  reviewCount?: number | undefined;
+  /**
+   * the lowest nightly price
+   */
+  startPriceAmount?: number | undefined;
+  /**
+   * IANA time zone of the listing
+   */
+  timezone?: string | undefined;
+  /**
+   * the normalized property type
+   */
+  type?: PropertyListingType | undefined;
+  /**
+   * Property Unittypes (room types) of this listing
+   */
+  unittypeIds?: Array<string> | undefined;
+  /**
+   * when the listing was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+  /**
+   * the listing URL
+   */
+  webUrl?: string | undefined;
+};
+
+/** @internal */
+export const PropertyListingType$inboundSchema: z.ZodType<
+  PropertyListingType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyListingType);
+/** @internal */
+export const PropertyListingType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyListingType
+> = openEnums.outboundSchema(PropertyListingType);
+
+/** @internal */
+export const PropertyListing$inboundSchema: z.ZodType<
+  PropertyListing,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: PropertyPropertyListingAddress$inboundSchema.optional(),
+  amenities: z.array(z.string()).optional(),
+  bathrooms: z.number().optional(),
+  bedrooms: z.number().optional(),
+  beds: z.number().optional(),
+  cancellation_policy: z.string().optional(),
+  channels: z.array(PropertyChannel$inboundSchema).optional(),
+  check_in_end_time: z.string().optional(),
+  check_in_start_time: z.string().optional(),
+  check_out_time: z.string().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(),
+  house_rules: z.string().optional(),
+  id: z.string().optional(),
+  image_urls: z.array(z.string()).optional(),
+  internal_name: z.string().optional(),
+  is_active: z.boolean().optional(),
+  latitude: z.number().optional(),
+  longitude: z.number().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(),
+  owner_user_ids: z.array(z.string()).optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  review_count: z.number().optional(),
+  start_price_amount: z.number().optional(),
+  timezone: z.string().optional(),
+  type: PropertyListingType$inboundSchema.optional(),
+  unittype_ids: z.array(z.string()).optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  web_url: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "cancellation_policy": "cancellationPolicy",
+    "check_in_end_time": "checkInEndTime",
+    "check_in_start_time": "checkInStartTime",
+    "check_out_time": "checkOutTime",
+    "cleaning_fee_amount": "cleaningFeeAmount",
+    "created_at": "createdAt",
+    "house_rules": "houseRules",
+    "image_urls": "imageUrls",
+    "internal_name": "internalName",
+    "is_active": "isActive",
+    "max_nights": "maxNights",
+    "max_occupancy": "maxOccupancy",
+    "min_nights": "minNights",
+    "owner_user_ids": "ownerUserIds",
+    "review_count": "reviewCount",
+    "start_price_amount": "startPriceAmount",
+    "unittype_ids": "unittypeIds",
+    "updated_at": "updatedAt",
+    "web_url": "webUrl",
+  });
+});
+/** @internal */
+export type PropertyListing$Outbound = {
+  address?: PropertyPropertyListingAddress$Outbound | undefined;
+  amenities?: Array<string> | undefined;
+  bathrooms?: number | undefined;
+  bedrooms?: number | undefined;
+  beds?: number | undefined;
+  cancellation_policy?: string | undefined;
+  channels?: Array<PropertyChannel$Outbound> | undefined;
+  check_in_end_time?: string | undefined;
+  check_in_start_time?: string | undefined;
+  check_out_time?: string | undefined;
+  cleaning_fee_amount?: number | undefined;
+  created_at?: string | undefined;
+  currency?: string | undefined;
+  description?: string | undefined;
+  house_rules?: string | undefined;
+  id?: string | undefined;
+  image_urls?: Array<string> | undefined;
+  internal_name?: string | undefined;
+  is_active?: boolean | undefined;
+  latitude?: number | undefined;
+  longitude?: number | undefined;
+  max_nights?: number | undefined;
+  max_occupancy?: number | undefined;
+  metadata?: Array<PropertyMetadata$Outbound> | undefined;
+  min_nights?: number | undefined;
+  name?: string | undefined;
+  owner_user_ids?: Array<string> | undefined;
+  rating?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  review_count?: number | undefined;
+  start_price_amount?: number | undefined;
+  timezone?: string | undefined;
+  type?: string | undefined;
+  unittype_ids?: Array<string> | undefined;
+  updated_at?: string | undefined;
+  web_url?: string | undefined;
+};
+
+/** @internal */
+export const PropertyListing$outboundSchema: z.ZodType<
+  PropertyListing$Outbound,
+  z.ZodTypeDef,
+  PropertyListing
+> = z.object({
+  address: PropertyPropertyListingAddress$outboundSchema.optional(),
+  amenities: z.array(z.string()).optional(),
+  bathrooms: z.number().optional(),
+  bedrooms: z.number().optional(),
+  beds: z.number().optional(),
+  cancellationPolicy: z.string().optional(),
+  channels: z.array(PropertyChannel$outboundSchema).optional(),
+  checkInEndTime: z.string().optional(),
+  checkInStartTime: z.string().optional(),
+  checkOutTime: z.string().optional(),
+  cleaningFeeAmount: z.number().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  houseRules: z.string().optional(),
+  id: z.string().optional(),
+  imageUrls: z.array(z.string()).optional(),
+  internalName: z.string().optional(),
+  isActive: z.boolean().optional(),
+  latitude: z.number().optional(),
+  longitude: z.number().optional(),
+  maxNights: z.number().optional(),
+  maxOccupancy: z.number().optional(),
+  metadata: z.array(PropertyMetadata$outboundSchema).optional(),
+  minNights: z.number().optional(),
+  name: z.string().optional(),
+  ownerUserIds: z.array(z.string()).optional(),
+  rating: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  reviewCount: z.number().optional(),
+  startPriceAmount: z.number().optional(),
+  timezone: z.string().optional(),
+  type: PropertyListingType$outboundSchema.optional(),
+  unittypeIds: z.array(z.string()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  webUrl: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    cancellationPolicy: "cancellation_policy",
+    checkInEndTime: "check_in_end_time",
+    checkInStartTime: "check_in_start_time",
+    checkOutTime: "check_out_time",
+    cleaningFeeAmount: "cleaning_fee_amount",
+    createdAt: "created_at",
+    houseRules: "house_rules",
+    imageUrls: "image_urls",
+    internalName: "internal_name",
+    isActive: "is_active",
+    maxNights: "max_nights",
+    maxOccupancy: "max_occupancy",
+    minNights: "min_nights",
+    ownerUserIds: "owner_user_ids",
+    reviewCount: "review_count",
+    startPriceAmount: "start_price_amount",
+    unittypeIds: "unittype_ids",
+    updatedAt: "updated_at",
+    webUrl: "web_url",
+  });
+});
+
+export function propertyListingToJSON(
+  propertyListing: PropertyListing,
+): string {
+  return JSON.stringify(PropertyListing$outboundSchema.parse(propertyListing));
+}
+export function propertyListingFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyListing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyListing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyListing' from JSON`,
+  );
+}

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

@@ -0,0 +1,170 @@
+/*
+ * 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 {
+  PropertyAttachment,
+  PropertyAttachment$inboundSchema,
+  PropertyAttachment$Outbound,
+  PropertyAttachment$outboundSchema,
+} from "./propertyattachment.js";
+
+/**
+ * whether the guest, host or system sent the message
+ */
+export const SenderType = {
+  Guest: "GUEST",
+  Host: "HOST",
+  System: "SYSTEM",
+} as const;
+/**
+ * whether the guest, host or system sent the message
+ */
+export type SenderType = OpenEnum<typeof SenderType>;
+
+export type PropertyMessage = {
+  /**
+   * files attached to the message
+   */
+  attachments?: Array<PropertyAttachment> | undefined;
+  /**
+   * when the message was sent (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * unique identifier for the message
+   */
+  id?: string | undefined;
+  /**
+   * whether the message was sent automatically
+   */
+  isAutomatic?: boolean | undefined;
+  /**
+   * whether the message has not been read
+   */
+  isUnread?: boolean | undefined;
+  /**
+   * the message body as plain text
+   */
+  message?: string | undefined;
+  /**
+   * the name of the sender
+   */
+  senderName?: string | undefined;
+  /**
+   * whether the guest, host or system sent the message
+   */
+  senderType?: SenderType | undefined;
+  /**
+   * the message subject
+   */
+  subject?: string | undefined;
+  /**
+   * when the message was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const SenderType$inboundSchema: z.ZodType<
+  SenderType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SenderType);
+/** @internal */
+export const SenderType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SenderType
+> = openEnums.outboundSchema(SenderType);
+
+/** @internal */
+export const PropertyMessage$inboundSchema: z.ZodType<
+  PropertyMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attachments: z.array(PropertyAttachment$inboundSchema).optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  is_automatic: z.boolean().optional(),
+  is_unread: z.boolean().optional(),
+  message: z.string().optional(),
+  sender_name: z.string().optional(),
+  sender_type: SenderType$inboundSchema.optional(),
+  subject: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "is_automatic": "isAutomatic",
+    "is_unread": "isUnread",
+    "sender_name": "senderName",
+    "sender_type": "senderType",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type PropertyMessage$Outbound = {
+  attachments?: Array<PropertyAttachment$Outbound> | undefined;
+  created_at?: string | undefined;
+  id?: string | undefined;
+  is_automatic?: boolean | undefined;
+  is_unread?: boolean | undefined;
+  message?: string | undefined;
+  sender_name?: string | undefined;
+  sender_type?: string | undefined;
+  subject?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const PropertyMessage$outboundSchema: z.ZodType<
+  PropertyMessage$Outbound,
+  z.ZodTypeDef,
+  PropertyMessage
+> = z.object({
+  attachments: z.array(PropertyAttachment$outboundSchema).optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  isAutomatic: z.boolean().optional(),
+  isUnread: z.boolean().optional(),
+  message: z.string().optional(),
+  senderName: z.string().optional(),
+  senderType: SenderType$outboundSchema.optional(),
+  subject: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    isAutomatic: "is_automatic",
+    isUnread: "is_unread",
+    senderName: "sender_name",
+    senderType: "sender_type",
+    updatedAt: "updated_at",
+  });
+});
+
+export function propertyMessageToJSON(
+  propertyMessage: PropertyMessage,
+): string {
+  return JSON.stringify(PropertyMessage$outboundSchema.parse(propertyMessage));
+}
+export function propertyMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyMessage' from JSON`,
+  );
+}