@unified-api/typescript-sdk 2.86.7 → 2.86.9

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

@@ -0,0 +1,121 @@
+/*
+ * 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";
+
+/**
+ * postal address of the listing
+ */
+export type PropertyPropertyListingAddress = {
+  /**
+   * first line of the street address
+   */
+  address1?: string | undefined;
+  /**
+   * second line of the street address
+   */
+  address2?: string | undefined;
+  /**
+   * city or locality
+   */
+  city?: string | undefined;
+  /**
+   * country name
+   */
+  country?: string | undefined;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  countryCode?: string | undefined;
+  /**
+   * postal or ZIP code
+   */
+  postalCode?: string | undefined;
+  /**
+   * state, province or regional area
+   */
+  region?: string | undefined;
+  /**
+   * state, province or regional area code
+   */
+  regionCode?: string | undefined;
+};
+
+/** @internal */
+export const PropertyPropertyListingAddress$inboundSchema: z.ZodType<
+  PropertyPropertyListingAddress,
+  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 PropertyPropertyListingAddress$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 PropertyPropertyListingAddress$outboundSchema: z.ZodType<
+  PropertyPropertyListingAddress$Outbound,
+  z.ZodTypeDef,
+  PropertyPropertyListingAddress
+> = 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",
+  });
+});
+
+export function propertyPropertyListingAddressToJSON(
+  propertyPropertyListingAddress: PropertyPropertyListingAddress,
+): string {
+  return JSON.stringify(
+    PropertyPropertyListingAddress$outboundSchema.parse(
+      propertyPropertyListingAddress,
+    ),
+  );
+}
+export function propertyPropertyListingAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyPropertyListingAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyPropertyListingAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyPropertyListingAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,182 @@
+/*
+ * 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 {
+  PropertyLineitem,
+  PropertyLineitem$inboundSchema,
+  PropertyLineitem$Outbound,
+  PropertyLineitem$outboundSchema,
+} from "./propertylineitem.js";
+
+export type PropertyQuote = {
+  /**
+   * number of adults
+   */
+  adults?: number | undefined;
+  /**
+   * number of children
+   */
+  children?: number | undefined;
+  /**
+   * when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * ISO 4217 currency code
+   */
+  currency?: string | undefined;
+  /**
+   * the deposit due at booking
+   */
+  depositAmount?: number | undefined;
+  /**
+   * the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  endAt?: Date | undefined;
+  /**
+   * total number of guests
+   */
+  guests?: number | undefined;
+  /**
+   * unique identifier for the quote
+   */
+  id?: string | undefined;
+  /**
+   * price breakdown (base price, fees, taxes, discounts)
+   */
+  lineItems?: Array<PropertyLineitem> | undefined;
+  /**
+   * pointer to the Property Listing to price
+   */
+  listingId?: string | undefined;
+  /**
+   * promotion or coupon code to apply
+   */
+  promotionCode?: string | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  startAt?: Date | undefined;
+  /**
+   * the total price of the stay
+   */
+  totalAmount?: number | undefined;
+  /**
+   * pointer to the Property Unittype (room type) to price
+   */
+  unittypeId?: string | undefined;
+};
+
+/** @internal */
+export const PropertyQuote$inboundSchema: z.ZodType<
+  PropertyQuote,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  adults: z.number().optional(),
+  children: z.number().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  currency: z.string().optional(),
+  deposit_amount: z.number().optional(),
+  end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  guests: z.number().optional(),
+  id: z.string().optional(),
+  line_items: z.array(PropertyLineitem$inboundSchema).optional(),
+  listing_id: z.string().optional(),
+  promotion_code: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  total_amount: z.number().optional(),
+  unittype_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "deposit_amount": "depositAmount",
+    "end_at": "endAt",
+    "line_items": "lineItems",
+    "listing_id": "listingId",
+    "promotion_code": "promotionCode",
+    "start_at": "startAt",
+    "total_amount": "totalAmount",
+    "unittype_id": "unittypeId",
+  });
+});
+/** @internal */
+export type PropertyQuote$Outbound = {
+  adults?: number | undefined;
+  children?: number | undefined;
+  created_at?: string | undefined;
+  currency?: string | undefined;
+  deposit_amount?: number | undefined;
+  end_at?: string | undefined;
+  guests?: number | undefined;
+  id?: string | undefined;
+  line_items?: Array<PropertyLineitem$Outbound> | undefined;
+  listing_id?: string | undefined;
+  promotion_code?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  start_at?: string | undefined;
+  total_amount?: number | undefined;
+  unittype_id?: string | undefined;
+};
+
+/** @internal */
+export const PropertyQuote$outboundSchema: z.ZodType<
+  PropertyQuote$Outbound,
+  z.ZodTypeDef,
+  PropertyQuote
+> = z.object({
+  adults: z.number().optional(),
+  children: z.number().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  currency: z.string().optional(),
+  depositAmount: z.number().optional(),
+  endAt: z.date().transform(v => v.toISOString()).optional(),
+  guests: z.number().optional(),
+  id: z.string().optional(),
+  lineItems: z.array(PropertyLineitem$outboundSchema).optional(),
+  listingId: z.string().optional(),
+  promotionCode: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  startAt: z.date().transform(v => v.toISOString()).optional(),
+  totalAmount: z.number().optional(),
+  unittypeId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    depositAmount: "deposit_amount",
+    endAt: "end_at",
+    lineItems: "line_items",
+    listingId: "listing_id",
+    promotionCode: "promotion_code",
+    startAt: "start_at",
+    totalAmount: "total_amount",
+    unittypeId: "unittype_id",
+  });
+});
+
+export function propertyQuoteToJSON(propertyQuote: PropertyQuote): string {
+  return JSON.stringify(PropertyQuote$outboundSchema.parse(propertyQuote));
+}
+export function propertyQuoteFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyQuote, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyQuote$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyQuote' from JSON`,
+  );
+}

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

@@ -0,0 +1,369 @@
+/*
+ * 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 {
+  PropertyLineitem,
+  PropertyLineitem$inboundSchema,
+  PropertyLineitem$Outbound,
+  PropertyLineitem$outboundSchema,
+} from "./propertylineitem.js";
+import {
+  PropertyMetadata,
+  PropertyMetadata$inboundSchema,
+  PropertyMetadata$Outbound,
+  PropertyMetadata$outboundSchema,
+} from "./propertymetadata.js";
+
+/**
+ * the reservation status
+ */
+export const PropertyReservationStatus = {
+  Inquiry: "INQUIRY",
+  Pending: "PENDING",
+  Confirmed: "CONFIRMED",
+  Cancelled: "CANCELLED",
+  CheckedIn: "CHECKED_IN",
+  CheckedOut: "CHECKED_OUT",
+  NoShow: "NO_SHOW",
+  Other: "OTHER",
+} as const;
+/**
+ * the reservation status
+ */
+export type PropertyReservationStatus = OpenEnum<
+  typeof PropertyReservationStatus
+>;
+
+export type PropertyReservation = {
+  /**
+   * number of adults
+   */
+  adults?: number | undefined;
+  /**
+   * the remaining balance
+   */
+  balanceAmount?: number | undefined;
+  /**
+   * when the reservation was cancelled (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  cancelledAt?: Date | undefined;
+  /**
+   * number of children
+   */
+  children?: number | undefined;
+  /**
+   * the booking channel confirmation code
+   */
+  confirmationCode?: string | undefined;
+  /**
+   * when the reservation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * ISO 4217 currency code
+   */
+  currency?: string | undefined;
+  /**
+   * the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  endAt?: Date | undefined;
+  /**
+   * the guest estimated arrival time (HH:mm, local time)
+   */
+  estimatedArrivalTime?: string | undefined;
+  /**
+   * the guest estimated departure time (HH:mm, local time)
+   */
+  estimatedDepartureTime?: string | undefined;
+  /**
+   * the primary guest email address
+   */
+  guestEmail?: string | undefined;
+  /**
+   * pointer to the Property Guest who made the reservation
+   */
+  guestId?: string | undefined;
+  /**
+   * the primary guest full name
+   */
+  guestName?: string | undefined;
+  /**
+   * the primary guest telephone number
+   */
+  guestPhone?: string | undefined;
+  /**
+   * total number of guests
+   */
+  guests?: number | undefined;
+  /**
+   * unique identifier for the reservation
+   */
+  id?: string | undefined;
+  /**
+   * number of infants
+   */
+  infants?: number | undefined;
+  /**
+   * price breakdown (base price, fees, taxes, discounts)
+   */
+  lineItems?: Array<PropertyLineitem> | undefined;
+  /**
+   * pointer to the Property Listing that is booked
+   */
+  listingId?: string | undefined;
+  /**
+   * custom field values
+   */
+  metadata?: Array<PropertyMetadata> | undefined;
+  /**
+   * number of nights
+   */
+  nights?: number | undefined;
+  /**
+   * free-text notes about the reservation
+   */
+  notes?: string | undefined;
+  /**
+   * the amount already paid
+   */
+  paidAmount?: number | undefined;
+  /**
+   * number of pets
+   */
+  pets?: number | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * the booking channel, eg. Airbnb, Booking.com or direct
+   */
+  source?: string | undefined;
+  /**
+   * the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  startAt?: Date | undefined;
+  /**
+   * the reservation status
+   */
+  status?: PropertyReservationStatus | undefined;
+  /**
+   * the total price of the reservation
+   */
+  totalAmount?: number | undefined;
+  /**
+   * Property Unittypes (room types) that are booked
+   */
+  unittypeIds?: Array<string> | undefined;
+  /**
+   * when the reservation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+  /**
+   * the reservation URL
+   */
+  webUrl?: string | undefined;
+};
+
+/** @internal */
+export const PropertyReservationStatus$inboundSchema: z.ZodType<
+  PropertyReservationStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyReservationStatus);
+/** @internal */
+export const PropertyReservationStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyReservationStatus
+> = openEnums.outboundSchema(PropertyReservationStatus);
+
+/** @internal */
+export const PropertyReservation$inboundSchema: z.ZodType<
+  PropertyReservation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  adults: z.number().optional(),
+  balance_amount: z.number().optional(),
+  cancelled_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  children: z.number().optional(),
+  confirmation_code: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  currency: z.string().optional(),
+  end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  estimated_arrival_time: z.string().optional(),
+  estimated_departure_time: z.string().optional(),
+  guest_email: z.string().optional(),
+  guest_id: z.string().optional(),
+  guest_name: z.string().optional(),
+  guest_phone: z.string().optional(),
+  guests: z.number().optional(),
+  id: z.string().optional(),
+  infants: z.number().optional(),
+  line_items: z.array(PropertyLineitem$inboundSchema).optional(),
+  listing_id: z.string().optional(),
+  metadata: z.array(PropertyMetadata$inboundSchema).optional(),
+  nights: z.number().optional(),
+  notes: z.string().optional(),
+  paid_amount: z.number().optional(),
+  pets: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  source: z.string().optional(),
+  start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: PropertyReservationStatus$inboundSchema.optional(),
+  total_amount: z.number().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, {
+    "balance_amount": "balanceAmount",
+    "cancelled_at": "cancelledAt",
+    "confirmation_code": "confirmationCode",
+    "created_at": "createdAt",
+    "end_at": "endAt",
+    "estimated_arrival_time": "estimatedArrivalTime",
+    "estimated_departure_time": "estimatedDepartureTime",
+    "guest_email": "guestEmail",
+    "guest_id": "guestId",
+    "guest_name": "guestName",
+    "guest_phone": "guestPhone",
+    "line_items": "lineItems",
+    "listing_id": "listingId",
+    "paid_amount": "paidAmount",
+    "start_at": "startAt",
+    "total_amount": "totalAmount",
+    "unittype_ids": "unittypeIds",
+    "updated_at": "updatedAt",
+    "web_url": "webUrl",
+  });
+});
+/** @internal */
+export type PropertyReservation$Outbound = {
+  adults?: number | undefined;
+  balance_amount?: number | undefined;
+  cancelled_at?: string | undefined;
+  children?: number | undefined;
+  confirmation_code?: string | undefined;
+  created_at?: string | undefined;
+  currency?: string | undefined;
+  end_at?: string | undefined;
+  estimated_arrival_time?: string | undefined;
+  estimated_departure_time?: string | undefined;
+  guest_email?: string | undefined;
+  guest_id?: string | undefined;
+  guest_name?: string | undefined;
+  guest_phone?: string | undefined;
+  guests?: number | undefined;
+  id?: string | undefined;
+  infants?: number | undefined;
+  line_items?: Array<PropertyLineitem$Outbound> | undefined;
+  listing_id?: string | undefined;
+  metadata?: Array<PropertyMetadata$Outbound> | undefined;
+  nights?: number | undefined;
+  notes?: string | undefined;
+  paid_amount?: number | undefined;
+  pets?: number | undefined;
+  raw?: { [k: string]: any } | undefined;
+  source?: string | undefined;
+  start_at?: string | undefined;
+  status?: string | undefined;
+  total_amount?: number | undefined;
+  unittype_ids?: Array<string> | undefined;
+  updated_at?: string | undefined;
+  web_url?: string | undefined;
+};
+
+/** @internal */
+export const PropertyReservation$outboundSchema: z.ZodType<
+  PropertyReservation$Outbound,
+  z.ZodTypeDef,
+  PropertyReservation
+> = z.object({
+  adults: z.number().optional(),
+  balanceAmount: z.number().optional(),
+  cancelledAt: z.date().transform(v => v.toISOString()).optional(),
+  children: z.number().optional(),
+  confirmationCode: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  currency: z.string().optional(),
+  endAt: z.date().transform(v => v.toISOString()).optional(),
+  estimatedArrivalTime: z.string().optional(),
+  estimatedDepartureTime: z.string().optional(),
+  guestEmail: z.string().optional(),
+  guestId: z.string().optional(),
+  guestName: z.string().optional(),
+  guestPhone: z.string().optional(),
+  guests: z.number().optional(),
+  id: z.string().optional(),
+  infants: z.number().optional(),
+  lineItems: z.array(PropertyLineitem$outboundSchema).optional(),
+  listingId: z.string().optional(),
+  metadata: z.array(PropertyMetadata$outboundSchema).optional(),
+  nights: z.number().optional(),
+  notes: z.string().optional(),
+  paidAmount: z.number().optional(),
+  pets: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  source: z.string().optional(),
+  startAt: z.date().transform(v => v.toISOString()).optional(),
+  status: PropertyReservationStatus$outboundSchema.optional(),
+  totalAmount: z.number().optional(),
+  unittypeIds: z.array(z.string()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  webUrl: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    balanceAmount: "balance_amount",
+    cancelledAt: "cancelled_at",
+    confirmationCode: "confirmation_code",
+    createdAt: "created_at",
+    endAt: "end_at",
+    estimatedArrivalTime: "estimated_arrival_time",
+    estimatedDepartureTime: "estimated_departure_time",
+    guestEmail: "guest_email",
+    guestId: "guest_id",
+    guestName: "guest_name",
+    guestPhone: "guest_phone",
+    lineItems: "line_items",
+    listingId: "listing_id",
+    paidAmount: "paid_amount",
+    startAt: "start_at",
+    totalAmount: "total_amount",
+    unittypeIds: "unittype_ids",
+    updatedAt: "updated_at",
+    webUrl: "web_url",
+  });
+});
+
+export function propertyReservationToJSON(
+  propertyReservation: PropertyReservation,
+): string {
+  return JSON.stringify(
+    PropertyReservation$outboundSchema.parse(propertyReservation),
+  );
+}
+export function propertyReservationFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyReservation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyReservation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyReservation' from JSON`,
+  );
+}