@unified-api/typescript-sdk 2.86.7 → 2.86.9

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

@@ -0,0 +1,86 @@
+/*
+ * 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";
+
+export type PropertyAttachment = {
+  /**
+   * the attachment MIME type
+   */
+  contentType?: string | undefined;
+  /**
+   * URL to download the attachment
+   */
+  downloadUrl?: string | undefined;
+  /**
+   * unique identifier for the attachment
+   */
+  id?: string | undefined;
+  /**
+   * the attachment file name
+   */
+  name?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAttachment$inboundSchema: z.ZodType<
+  PropertyAttachment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content_type: z.string().optional(),
+  download_url: z.string().optional(),
+  id: z.string().optional(),
+  name: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "content_type": "contentType",
+    "download_url": "downloadUrl",
+  });
+});
+/** @internal */
+export type PropertyAttachment$Outbound = {
+  content_type?: string | undefined;
+  download_url?: string | undefined;
+  id?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAttachment$outboundSchema: z.ZodType<
+  PropertyAttachment$Outbound,
+  z.ZodTypeDef,
+  PropertyAttachment
+> = z.object({
+  contentType: z.string().optional(),
+  downloadUrl: z.string().optional(),
+  id: z.string().optional(),
+  name: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    contentType: "content_type",
+    downloadUrl: "download_url",
+  });
+});
+
+export function propertyAttachmentToJSON(
+  propertyAttachment: PropertyAttachment,
+): string {
+  return JSON.stringify(
+    PropertyAttachment$outboundSchema.parse(propertyAttachment),
+  );
+}
+export function propertyAttachmentFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAttachment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAttachment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAttachment' from JSON`,
+  );
+}

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

@@ -0,0 +1,128 @@
+/*
+ * 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";
+
+/**
+ * whether the period is available, booked or blocked
+ */
+export const PropertyAvailabilityStatus = {
+  Available: "AVAILABLE",
+  Unavailable: "UNAVAILABLE",
+  Blocked: "BLOCKED",
+} as const;
+/**
+ * whether the period is available, booked or blocked
+ */
+export type PropertyAvailabilityStatus = OpenEnum<
+  typeof PropertyAvailabilityStatus
+>;
+
+export type PropertyAvailability = {
+  /**
+   * ISO 4217 currency code
+   */
+  currency?: string | undefined;
+  /**
+   * the end of the availability period (exclusive) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  endAt?: Date | undefined;
+  /**
+   * pointer to the Property Listing
+   */
+  listingId?: string | undefined;
+  /**
+   * maximum length of stay, in nights, for arrivals in this period
+   */
+  maxNights?: number | undefined;
+  /**
+   * minimum length of stay, in nights, for arrivals in this period
+   */
+  minNights?: number | undefined;
+  /**
+   * the nightly price
+   */
+  priceAmount?: number | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * Property Reservations that occupy this period
+   */
+  reservationIds?: Array<string> | undefined;
+  /**
+   * the start of the availability period (inclusive) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  startAt?: Date | undefined;
+  /**
+   * whether the period is available, booked or blocked
+   */
+  status?: PropertyAvailabilityStatus | undefined;
+  /**
+   * number of units available
+   */
+  unitsAvailable?: number | undefined;
+  /**
+   * pointer to the Property Unittype (room type)
+   */
+  unittypeId?: string | undefined;
+};
+
+/** @internal */
+export const PropertyAvailabilityStatus$inboundSchema: z.ZodType<
+  PropertyAvailabilityStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyAvailabilityStatus);
+
+/** @internal */
+export const PropertyAvailability$inboundSchema: z.ZodType<
+  PropertyAvailability,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string().optional(),
+  end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  listing_id: z.string().optional(),
+  max_nights: z.number().optional(),
+  min_nights: z.number().optional(),
+  price_amount: z.number().optional(),
+  raw: z.record(z.any()).optional(),
+  reservation_ids: z.array(z.string()).optional(),
+  start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: PropertyAvailabilityStatus$inboundSchema.optional(),
+  units_available: z.number().optional(),
+  unittype_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "end_at": "endAt",
+    "listing_id": "listingId",
+    "max_nights": "maxNights",
+    "min_nights": "minNights",
+    "price_amount": "priceAmount",
+    "reservation_ids": "reservationIds",
+    "start_at": "startAt",
+    "units_available": "unitsAvailable",
+    "unittype_id": "unittypeId",
+  });
+});
+
+export function propertyAvailabilityFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAvailability, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAvailability$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAvailability' from JSON`,
+  );
+}

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

@@ -0,0 +1,102 @@
+/*
+ * 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 rated category
+ */
+export const PropertyCategoryratingCategory = {
+  Cleanliness: "CLEANLINESS",
+  Accuracy: "ACCURACY",
+  Communication: "COMMUNICATION",
+  Checkin: "CHECKIN",
+  Location: "LOCATION",
+  Value: "VALUE",
+  Other: "OTHER",
+} as const;
+/**
+ * the rated category
+ */
+export type PropertyCategoryratingCategory = OpenEnum<
+  typeof PropertyCategoryratingCategory
+>;
+
+export type PropertyCategoryrating = {
+  /**
+   * the rated category
+   */
+  category?: PropertyCategoryratingCategory | undefined;
+  /**
+   * the guest comment for this category
+   */
+  comment?: string | undefined;
+  /**
+   * the category rating
+   */
+  rating?: number | undefined;
+};
+
+/** @internal */
+export const PropertyCategoryratingCategory$inboundSchema: z.ZodType<
+  PropertyCategoryratingCategory,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyCategoryratingCategory);
+/** @internal */
+export const PropertyCategoryratingCategory$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyCategoryratingCategory
+> = openEnums.outboundSchema(PropertyCategoryratingCategory);
+
+/** @internal */
+export const PropertyCategoryrating$inboundSchema: z.ZodType<
+  PropertyCategoryrating,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: PropertyCategoryratingCategory$inboundSchema.optional(),
+  comment: z.string().optional(),
+  rating: z.number().optional(),
+});
+/** @internal */
+export type PropertyCategoryrating$Outbound = {
+  category?: string | undefined;
+  comment?: string | undefined;
+  rating?: number | undefined;
+};
+
+/** @internal */
+export const PropertyCategoryrating$outboundSchema: z.ZodType<
+  PropertyCategoryrating$Outbound,
+  z.ZodTypeDef,
+  PropertyCategoryrating
+> = z.object({
+  category: PropertyCategoryratingCategory$outboundSchema.optional(),
+  comment: z.string().optional(),
+  rating: z.number().optional(),
+});
+
+export function propertyCategoryratingToJSON(
+  propertyCategoryrating: PropertyCategoryrating,
+): string {
+  return JSON.stringify(
+    PropertyCategoryrating$outboundSchema.parse(propertyCategoryrating),
+  );
+}
+export function propertyCategoryratingFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyCategoryrating, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyCategoryrating$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyCategoryrating' from JSON`,
+  );
+}

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

@@ -0,0 +1,68 @@
+/*
+ * 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";
+
+export type PropertyChannel = {
+  /**
+   * the distribution channel name, eg. Airbnb or Booking.com
+   */
+  name?: string | undefined;
+  /**
+   * the listing URL on that channel
+   */
+  webUrl?: string | undefined;
+};
+
+/** @internal */
+export const PropertyChannel$inboundSchema: z.ZodType<
+  PropertyChannel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  web_url: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "web_url": "webUrl",
+  });
+});
+/** @internal */
+export type PropertyChannel$Outbound = {
+  name?: string | undefined;
+  web_url?: string | undefined;
+};
+
+/** @internal */
+export const PropertyChannel$outboundSchema: z.ZodType<
+  PropertyChannel$Outbound,
+  z.ZodTypeDef,
+  PropertyChannel
+> = z.object({
+  name: z.string().optional(),
+  webUrl: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    webUrl: "web_url",
+  });
+});
+
+export function propertyChannelToJSON(
+  propertyChannel: PropertyChannel,
+): string {
+  return JSON.stringify(PropertyChannel$outboundSchema.parse(propertyChannel));
+}
+export function propertyChannelFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyChannel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyChannel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyChannel' from JSON`,
+  );
+}

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

@@ -45,6 +45,7 @@ export const PropertyConnectionCategories = {
   Legal: "legal",
   Compute: "compute",
   Healthcare: "healthcare",
+  Property: "property",
 } as const;
 export type PropertyConnectionCategories = OpenEnum<
   typeof PropertyConnectionCategories

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

@@ -86,6 +86,8 @@ export const PropertyConnectionPermissions = {
   CommerceItemvariantWrite: "commerce_itemvariant_write",
   CommerceReservationRead: "commerce_reservation_read",
   CommerceReservationWrite: "commerce_reservation_write",
+  CommerceReturnRead: "commerce_return_read",
+  CommerceReturnWrite: "commerce_return_write",
   CommerceAvailabilityRead: "commerce_availability_read",
   CommerceAvailabilityWrite: "commerce_availability_write",
   VerificationPackageRead: "verification_package_read",
@@ -418,6 +420,20 @@ export const PropertyConnectionPermissions = {
   HealthcareCareplanWrite: "healthcare_careplan_write",
   HealthcareGoalRead: "healthcare_goal_read",
   HealthcareGoalWrite: "healthcare_goal_write",
+  PropertyListingRead: "property_listing_read",
+  PropertyListingWrite: "property_listing_write",
+  PropertyUnittypeRead: "property_unittype_read",
+  PropertyGuestRead: "property_guest_read",
+  PropertyGuestWrite: "property_guest_write",
+  PropertyReservationRead: "property_reservation_read",
+  PropertyReservationWrite: "property_reservation_write",
+  PropertyAvailabilityRead: "property_availability_read",
+  PropertyQuoteRead: "property_quote_read",
+  PropertyQuoteWrite: "property_quote_write",
+  PropertyReviewRead: "property_review_read",
+  PropertyReviewWrite: "property_review_write",
+  PropertyConversationRead: "property_conversation_read",
+  PropertyConversationWrite: "property_conversation_write",
 } as const;
 export type PropertyConnectionPermissions = OpenEnum<
   typeof PropertyConnectionPermissions

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

@@ -0,0 +1,184 @@
+/*
+ * 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 {
+  PropertyMessage,
+  PropertyMessage$inboundSchema,
+  PropertyMessage$Outbound,
+  PropertyMessage$outboundSchema,
+} from "./propertymessage.js";
+import {
+  PropertyMetadata,
+  PropertyMetadata$inboundSchema,
+  PropertyMetadata$Outbound,
+  PropertyMetadata$outboundSchema,
+} from "./propertymetadata.js";
+
+export type PropertyConversation = {
+  /**
+   * when the conversation was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  createdAt?: Date | undefined;
+  /**
+   * the guest email address
+   */
+  guestEmail?: string | undefined;
+  /**
+   * pointer to the Property Guest in this conversation
+   */
+  guestId?: string | undefined;
+  /**
+   * the guest full name
+   */
+  guestName?: string | undefined;
+  /**
+   * the guest telephone number
+   */
+  guestPhone?: string | undefined;
+  /**
+   * unique identifier for the conversation
+   */
+  id?: string | undefined;
+  /**
+   * whether the conversation has unread messages
+   */
+  isUnread?: boolean | undefined;
+  /**
+   * pointer to the Property Listing this conversation is about
+   */
+  listingId?: string | undefined;
+  /**
+   * the messages in this conversation, oldest first
+   */
+  messages?: Array<PropertyMessage> | undefined;
+  /**
+   * custom field values
+   */
+  metadata?: Array<PropertyMetadata> | undefined;
+  /**
+   * raw data from the integration
+   */
+  raw?: { [k: string]: any } | undefined;
+  /**
+   * pointer to the Property Reservation this conversation is about
+   */
+  reservationId?: string | undefined;
+  /**
+   * the channel the conversation happens on, eg. Airbnb, email or SMS
+   */
+  source?: string | undefined;
+  /**
+   * when the conversation was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PropertyConversation$inboundSchema: z.ZodType<
+  PropertyConversation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  guest_email: z.string().optional(),
+  guest_id: z.string().optional(),
+  guest_name: z.string().optional(),
+  guest_phone: z.string().optional(),
+  id: z.string().optional(),
+  is_unread: z.boolean().optional(),
+  listing_id: z.string().optional(),
+  messages: z.array(PropertyMessage$inboundSchema).optional(),
+  metadata: z.array(PropertyMetadata$inboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  reservation_id: z.string().optional(),
+  source: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "guest_email": "guestEmail",
+    "guest_id": "guestId",
+    "guest_name": "guestName",
+    "guest_phone": "guestPhone",
+    "is_unread": "isUnread",
+    "listing_id": "listingId",
+    "reservation_id": "reservationId",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type PropertyConversation$Outbound = {
+  created_at?: string | undefined;
+  guest_email?: string | undefined;
+  guest_id?: string | undefined;
+  guest_name?: string | undefined;
+  guest_phone?: string | undefined;
+  id?: string | undefined;
+  is_unread?: boolean | undefined;
+  listing_id?: string | undefined;
+  messages?: Array<PropertyMessage$Outbound> | undefined;
+  metadata?: Array<PropertyMetadata$Outbound> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reservation_id?: string | undefined;
+  source?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const PropertyConversation$outboundSchema: z.ZodType<
+  PropertyConversation$Outbound,
+  z.ZodTypeDef,
+  PropertyConversation
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  guestEmail: z.string().optional(),
+  guestId: z.string().optional(),
+  guestName: z.string().optional(),
+  guestPhone: z.string().optional(),
+  id: z.string().optional(),
+  isUnread: z.boolean().optional(),
+  listingId: z.string().optional(),
+  messages: z.array(PropertyMessage$outboundSchema).optional(),
+  metadata: z.array(PropertyMetadata$outboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  reservationId: z.string().optional(),
+  source: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    guestEmail: "guest_email",
+    guestId: "guest_id",
+    guestName: "guest_name",
+    guestPhone: "guest_phone",
+    isUnread: "is_unread",
+    listingId: "listing_id",
+    reservationId: "reservation_id",
+    updatedAt: "updated_at",
+  });
+});
+
+export function propertyConversationToJSON(
+  propertyConversation: PropertyConversation,
+): string {
+  return JSON.stringify(
+    PropertyConversation$outboundSchema.parse(propertyConversation),
+  );
+}
+export function propertyConversationFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyConversation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyConversation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyConversation' from JSON`,
+  );
+}

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

@@ -0,0 +1,85 @@
+/*
+ * 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 email address
+ */
+export const PropertyEmailType = {
+  Work: "WORK",
+  Home: "HOME",
+  Other: "OTHER",
+} as const;
+/**
+ * the kind of email address
+ */
+export type PropertyEmailType = OpenEnum<typeof PropertyEmailType>;
+
+export type PropertyEmail = {
+  /**
+   * the email address
+   */
+  email: string;
+  /**
+   * the kind of email address
+   */
+  type?: PropertyEmailType | undefined;
+};
+
+/** @internal */
+export const PropertyEmailType$inboundSchema: z.ZodType<
+  PropertyEmailType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyEmailType);
+/** @internal */
+export const PropertyEmailType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PropertyEmailType
+> = openEnums.outboundSchema(PropertyEmailType);
+
+/** @internal */
+export const PropertyEmail$inboundSchema: z.ZodType<
+  PropertyEmail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+  type: PropertyEmailType$inboundSchema.optional(),
+});
+/** @internal */
+export type PropertyEmail$Outbound = {
+  email: string;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const PropertyEmail$outboundSchema: z.ZodType<
+  PropertyEmail$Outbound,
+  z.ZodTypeDef,
+  PropertyEmail
+> = z.object({
+  email: z.string(),
+  type: PropertyEmailType$outboundSchema.optional(),
+});
+
+export function propertyEmailToJSON(propertyEmail: PropertyEmail): string {
+  return JSON.stringify(PropertyEmail$outboundSchema.parse(propertyEmail));
+}
+export function propertyEmailFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyEmail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyEmail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyEmail' from JSON`,
+  );
+}