@cohostvip/cohost-node 0.0.5 → 0.0.9

package/dist/index.d.mts

@@ -41,707 +41,1138 @@ declare class CohostEndpoint {
     constructor(request: RequestFn, settings: CohostClientSettings);
 }
 
-type Address = {
-    address_1: string;
-    address_2?: string;
-    city: string;
-    country: string;
-    formattedAddress?: string;
-    localized_address_display?: string;
-    localized_area_display?: string;
-    localized_multi_line_address_display?: Array<string>;
-    postal_code: string;
-    premise?: string;
-    region: string;
-};
-
-type BuzzBuilder = {
-    countLabel: string;
-    profiles: Array<{
-        id: string;
-        name: string;
-        photoURL: string;
-    }>;
-};
-
-declare enum CostBucket {
-    DELIVERY = "delivery",
-    FEE = "fee",
-    ITEM = "item",
-    TAX = "tax"
+/**
+ * A namespaced identifier representing the entity an order is associated with.
+ *
+ * Must begin with one of the following prefixes:
+ * - "evt_" for events
+ * - "ven_" for venues
+ * - "org_" for organizers
+ *
+ * @example "evt_abc123"
+ * @example "org_def456"
+ *
+ * @schema string()
+ * @pattern ^((evt|ven|org)_[a-zA-Z0-9]+)$
+ */
+type ContextId = string;
+type ApiVersion = "2025-04-15";
+/**
+ * A rich content object that supports multiple representations of text.
+ */
+interface MultipartText {
+    /** HTML version of the content. */
+    html?: string;
+    /** Plain text version of the content. */
+    text?: string;
+    /** Markdown version of the content. */
+    md?: string;
+    /** Optional rich editor blocks (if structured editing is supported). */
+    blocks?: any[] | null;
 }
-
-type CalculatedCostComponent = {
-    base: string;
-    bucket: CostBucket;
+/**
+ * A photo object with resolution options and optional metadata.
+ */
+interface Photo {
+    /** High-resolution (2x) image URL. */
+    "2x"?: string;
+    /** Internal photo ID, if stored in a media system. */
+    id?: string;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * Primary image URL.
+     * This is the default image URL to be used when no other resolution is specified.
+     *
+     * @example "https://picsum.photos/500"
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     *
+     * @x-faker image.imageUrl
      */
-    cost: string;
-    discount: null;
-    id: string;
-    name: string;
-    payer: CalculatedCostComponent.payer;
-    recipient: string;
-    value: number;
-    version: string;
-};
-declare namespace CalculatedCostComponent {
-    enum payer {
-        ATTENDEE = "attendee",
-        ORGANIZER = "organizer"
-    }
+    url: string;
+    /** Width of the image in pixels. */
+    width?: number;
+    /** Height of the image in pixels. */
+    height?: number;
+    /** Optional caption for the image. */
+    caption?: string;
 }
-
-type CouponSummary = {
-    /**
-     * Fixed amount to deduct from the order total.
-     * This is a currency-less value that matches the event or order currency.
-     * Example: `10.00` = $10.00 off.
-     */
-    amountOff: number;
-    /**
-     * The code used to redeem this coupon during checkout.
-     * For public or coded discounts.
-     */
-    code: string;
+/**
+ * A repeating or structured date schedule for an event or item.
+ */
+interface Schedule {
+    /** Days of the week (0 = Sunday, 6 = Saturday). */
+    daysOfWeek?: number[];
+    /** ISO-formatted UTC start datetime. */
+    start: string;
+    /** ISO-formatted UTC end datetime. */
+    end: string;
+    /** Specific dates to exclude in "YYYY-MM-DD" format. */
+    excludeDates?: string[];
+    /** Specific dates to include in "YYYY-MM-DD" format. */
+    includeDates?: string[];
+}
+/**
+ * Base metadata for any record stored in the system.
+ * Includes an ID and timestamps for creation and optional updates.
+ *
+ * @export
+ */
+interface DataRecord {
     /**
      * Unique identifier for the record.
+     * @example "rec_123abc"
      */
     id: string;
     /**
-     * List of offering IDs (e.g., ticket classes) this coupon applies to.
-     * If empty, the coupon applies to all eligible offerings in its context.
+     * ISO 8601 timestamp indicating when the record was created.
+     * @example "2025-04-16T10:15:00Z"
      */
-    offeringIds: Array<string>;
+    created: string;
     /**
-     * Percentage to deduct from the item or order total.
-     * Range is 0–100. Use 0 for no percentage-based discount.
+     * ISO 8601 timestamp indicating when the record was last updated, if applicable.
+     * @example "2025-04-18T08:00:00Z"
      */
-    percentOff: number;
-};
-
-type Partial_Customer_ = {
-    age?: number;
-    birthdate?: string;
-    displayName?: string;
-    email?: string;
-    first?: string;
-    gender?: string;
-    last?: string;
-    name?: string;
-    phone?: string;
-    photoURL?: string;
-    uid?: string;
-};
-
-type Partial_OrderContext_ = {
+    changed?: string;
+}
+/**
+ * Extension of `DataRecord` for resources returned from RESTful APIs.
+ * Includes a schema version to ensure compatibility with evolving formats.
+ *
+ * @export
+ */
+interface VersionedDataRecord extends DataRecord {
     /**
-     * The unique cart session ID assigned at the time the cart was created.
-     * Helps track cart attribution across systems.
+     * Schema version identifier for this record.
+     * Helps manage compatibility across client-server contracts.
+     * @example "2025-01-10"
      */
-    cartSessionId?: string;
+    version: ApiVersion;
+}
+interface VCDataRecord extends VersionedDataRecord {
+    companyId: string;
+}
+/**
+ * Represents either an absolute or a relative time constraint.
+ *
+ * - If using `date`, `secondsBefore` must not be present.
+ * - If using `secondsBefore`, `date` must not be present.
+ *
+ * @export
+ */
+type TimeOrOffset = {
     /**
-     * IP addresses associated with the user request.
-     * Typically includes forwarded IPs and direct client IP.
+     * Absolute time in ISO 8601 format.
+     * @example "2025-06-30T23:59:59"
      */
-    ipAddresses?: Array<string>;
+    date: string;
+    secondsBefore?: never;
+} | {
     /**
-     * (Optional) Origin domain name if embedded or white-labeled.
-     * Can help identify partner portals or iframe referrers.
+     * Relative time before an anchor point (e.g. event start), in seconds.
+     * @example 3600
      */
-    originDomain?: string;
+    secondsBefore: number;
+    date?: never;
+};
+/**
+ * @description A string representing a currency amount in the format `"USD,1000"` where:
+ * - `"USD"` is the 3-letter ISO currency code.
+ * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+ *
+ * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+ *
+ * @example "USD,0"
+ * @example "USD,100"
+ * @example "USD,1000"
+ *
+ * @pattern ^\w{3},\d+$
+ * @zod .string()
+ */
+type CurrencyAmount = string;
+interface CostBase {
     /**
-     * The referring URL from which the cart or checkout was initiated.
-     * May be a partner site, marketing page, or event listing.
+     * The base value of the cost. This is the value before any operations are applied.
+     * in OrderItem this is the cost of a single item.
+     *
+     * @example "USD,1000"
      */
-    referrer?: string;
+    cost: CurrencyAmount;
     /**
-     * (Optional) Campaign ID, UTM source, or tracking label.
-     * Useful for affiliate and analytics systems.
+     * Delivery fee for a single item.
+     *
+     * @example "USD,1000"
      */
-    trackingId?: string;
+    delivery: CurrencyAmount;
     /**
-     * Authenticated user ID, or null for anonymous guests.
+     * Fee per item.
+     * @example "USD,1000"
      */
-    uid?: string;
+    fee: CurrencyAmount;
     /**
-     * Raw User-Agent header from the client request.
+     * Total discount amount applied to this item.
+     * @example "USD,1000"
      */
-    userAgent?: string;
-};
-
-declare enum OfferingType {
-    ADMISSION = "admission",
-    DONATION = "donation",
-    DRINK = "drink",
-    MEMBERSHIP = "membership",
-    MERCH = "merch",
-    OTHER = "other",
-    PACKAGE = "package",
-    SERVICE = "service",
-    SKIP = "skip",
-    TC_TICKET = "tc-ticket",
-    TICKET = "ticket",
-    VOUCHER = "voucher"
+    tax: CurrencyAmount;
+}
+interface CostComponentCap {
+    op: "cap";
+    type: "percentage" | "absolute";
+    /**
+     * The value of the cap. If type is percentage, it is a percentage of the base value.
+     * If type is absolute, it is an absolute value.
+     *
+     * Absolute value is represented in the same denomination as the cost.
+     * i.e. if the cost is in cents, the absolute value should be in cents.
+     *
+     * percentage value is represented as a decimal.
+     * For example, 10% is represented as 0.1.
+     */
+    value: number;
 }
-
 /**
- * Cost breakdown for a specific item in the order.
- * Extends the standard `OfferingCosts` with totals calculated for quantity and discounts.
+ * Represents a cost operation to be applied in a pricing formula.
+ *
+ * @example
+ * { op: '*', value: 0.9 }
  */
-type OrderItemCosts = {
+interface CostOp {
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * The operation to apply to the cost value.
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * Allowed values:
+     * - "+" (addition)
+     * - "-" (subtraction)
+     * - "*" (multiplication)
+     * - "/" (division)
+     * @ignore
+     * @enum {string}
      */
-    cost: string;
+    op: "+" | "-" | "*" | "/";
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * The operand value used in the cost operation.
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * The unit should match the denomination of the cost.
+     * For example, if cost is expressed in cents, this value should also be in cents.
+     *
+     * @example 100
      */
-    delivery: string;
+    value: number;
+}
+/**
+ * A set of comparison operators used for evaluating conditional expressions.
+ *
+ * Supported operators:
+ * - '==' (equal to)
+ * - '!=' (not equal to)
+ * - '<' (less than)
+ * - '<=' (less than or equal to)
+ * - '>' (greater than)
+ * - '>=' (greater than or equal to)
+ * @enum {string}
+ * @ignore
+ */
+type EqualOperator = "==" | "!=" | "<" | "<=" | ">" | ">=";
+interface CostComponentRuleCondition {
     /**
-     * Total discount amount applied to this item.
+     * The field to evaluate the condition against.
+     * For example, "item.price" or "order.total".
+     * The field should be a valid path to the field in the cost component base.
      */
-    discount: string;
+    field: string;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
      */
-    fee: string;
+    operator: EqualOperator;
     /**
-     * cost + fee - discount , not including tax
+     * Can be a value such as number, currencyAmount, an ISO date string, etc...
      */
-    gross: string;
+    value: string | number | any;
     /**
-     * Total price before discounts.
-     * Equal to subtotal + fee, before subtracting discount.
+     * evaluator, will define a function or endpoint to evaluate the condition.
      */
-    preDiscount: string;
+    eval?: string;
+}
+interface CostComponentRule {
     /**
-     * Total cost of tickets before taxes, fees, and discounts.
+     * Friendly name of the rule.
      */
-    subtotal: string;
+    name: string;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * The rule will be applied to the cost component if the conditions are met.
+     */
+    conditions: CostComponentRuleCondition[];
+}
+/**
+ * Represents the costs associated with an offering.
+ *
+ * @property {CurrencyAmount} delivery - The delivery cost.
+ * @property {CurrencyAmount} cost - The cost amount. In an order item, this is the cost of a single item.
+ * @property {CurrencyAmount} fee - The fee amount. In an order item, this is the fee of a single item.
+ * @property {CurrencyAmount} tax - The tax amount. In an order item, this is the tax per a single item.
+ * @property {CurrencyAmount} gross - The gross amount, which is the cost plus fee minus discount, not including tax.
+ * @property {CurrencyAmount} total - The total cost including tax.
+ */
+interface OfferingCosts extends CostBase {
+    /**
+     * cost + fee - discount , not including tax
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * In an order item, this is the gross cost of a single item.
+     *
+     * @x-faker {"random.arrayElement": ["\"USD,100000\"", "\"USD,25000\""]}
      */
-    tax: string;
+    gross: CurrencyAmount;
     /**
      * total cost including tax
+     *
+     * In an order item, this is the total cost * Quantity.
      */
-    total: string;
-};
-
+    total: CurrencyAmount;
+}
+type CostBucket = "item" | "fee" | "tax" | "delivery";
+interface CostComponent {
+    id: string;
+    name: string;
+    details?: any;
+    currency: string | "*";
+    base: "order" | "item" | string;
+    bucket: CostBucket;
+    recipient: "organizer" | "platform" | "tax" | string;
+    payer: "attendee" | "organizer";
+    /**
+     * @ignore
+     */
+    ops: CostOp[];
+    cap?: CostComponentCap;
+    rules: CostComponentRule[];
+    version: "2025-03-25";
+}
+interface CalculatedCostComponent extends Omit<CostComponent, "ops" | "cap" | "rules" | "details" | "currency"> {
+    cost: CurrencyAmount;
+    value: number;
+    discount: null;
+}
 /**
- * Represents the costs associated with an offering.
+ * @zod .string()
  */
-type OfferingCosts = {
+type OfferingType = "admission" | "package" | "skip" | "drink" | "ticket" | "tc-ticket" | "merch" | "donation" | "membership" | "voucher" | "service" | "other";
+type ActiveOfferingStatus = "live" | "hidden" | "sold-out";
+type OfferingStatus = ActiveOfferingStatus | "draft" | "deleted" | "unavailable";
+type PriceCategory = "donation" | "free" | "paid" | "other";
+interface Offering extends DataRecord {
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * Offering name, can be ticket name, vaucher name, etc...
+     * @example "General Admission" (ticket) | "T-shirt" (merch) | "Donation" (donation) | "Membership" (membership) | "Gift Card" (voucher) | "Service Fee" (service) | "Other" (other)
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * @x-faker commerce.productName
      */
-    cost: string;
+    name: string;
+    type: OfferingType;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * @description The maximum number of tickets that can be sold for this offering.
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * @example 100
+     *
+     * @x-faker {"datatype.number": { "min": 10, "max": 100 }}
      */
-    delivery: string;
+    capacity: number;
+    quantitySold: number;
+    status: OfferingStatus;
+    priceCategory: PriceCategory;
+    sorting: number;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * @ignore
+     */
+    schedule?: Schedule;
+    description?: string;
+    instructions?: string;
+    /**
+     * @description Maximum number of tickets that can be purchased in a single order.
+     *
+     * @example 10
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * @x-faker {"datatype.number": { "min": 4, "max": 15 }}
      */
-    fee: string;
+    maximumQuantity: number;
     /**
-     * cost + fee - discount , not including tax
+     * @description Minimum number of tickets that can be purchased in a single order.
+     *
+     * @example 1
+     *
+     * @x-faker {"datatype.number": { "min": 1, "max": 4 }}
      */
-    gross: string;
+    minimumQuantity: number;
+    package?: boolean;
     /**
-     * A string representing a currency amount in the format `"USD,1000"` where:
-     * - `"USD"` is the 3-letter ISO currency code.
-     * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
+     * @description Items, products ,and vouchers included in this offering.
+     *
      *
-     * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
+     * @x-faker {"array.length": 0}
      */
-    tax: string;
+    included?: PackageInclude[];
     /**
-     * total cost including tax
+     * Any constraints that apply to this offering.
+     * it can be time limit, quantity limit, etc...
      */
-    total: string;
-};
-
-type OrderItemOffering = {
+    constraints?: any;
+    hidden: boolean;
+    order_confirmation_message?: string | null;
     costs: OfferingCosts;
     /**
-     * doc assicated with this offering in the DB.
+     * Describe fees and other costs associated with purchasing tickets
+     * to this offering
+     *
+     * @ignore
      */
-    docPath: string;
+    costComponents?: CostComponent[];
+}
+interface PackageInclude {
+    id: string;
+    quantity: number;
+    type: OfferingType;
+    description: string;
+    ref?: any;
+}
+interface Ticket extends Omit<Offering, "hidden" | "constraints" | "type"> {
+    category: string;
+    type: "admission" | "package" | "admission.tableCommitment";
+    source: string;
+    display_name?: string;
+    description?: string;
+    ticketParentId?: string;
+    salesEnd: string;
+    salesStart: string;
+    parentId?: string;
+    refId?: string;
+}
+interface BuzzBuilder {
+    countLabel: string;
+    profiles: {
+        id: string;
+        name: string;
+        photoURL: string;
+    }[];
+}
+interface EventFeature {
+    id: string;
+    title: string;
+    enabled: boolean;
+    order: number;
+    widgetUri: string;
+    iconName?: string;
+    logoUri?: string;
+    description: string;
+    type: string;
+    version?: string;
+    key: string;
+    meta?: any;
+    data: any;
+}
+interface Address {
+    address_1: string;
+    address_2?: string;
+    city: string;
+    country: string;
+    premise?: string;
+    formattedAddress?: string;
+    localized_address_display?: string;
+    localized_area_display?: string;
+    localized_multi_line_address_display?: string[];
+    postal_code: string;
+    region: string;
+}
+/**
+ * A simple point geometry consisting of latitude and longitude.
+ *
+ * @typedef {Object} GeometryPoint
+ * @property {number} lat - Latitude of the point.
+ * @property {number} lng - Longitude of the point.
+ *
+ * @example
+ * {
+ *   lat: 40.7128,
+ *   lng: -74.0060
+ * }
+ */
+interface GeometryPoint {
+    lat: number;
+    lng: number;
+}
+/**
+ * Represents the geometry of a location, including optional viewport and zoom level.
+ *
+ * @typedef {Object} LocationGeometry
+ * @property {number} lat - Latitude of the location.
+ * @property {number} lng - Longitude of the location.
+ * @property {number} [zoom] - Optional zoom level representing map detail.
+ * @property {{ northeast: GeometryPoint, southwest: GeometryPoint }} [viewport] - Optional viewport rectangle surrounding the location.
+ * @property {string} [vicinity] - Optional vicinity description.
+ * @property {string} [region] - Optional region.
+ * @property {string} [locality] - Optional locality.
+ * @property {string} [geoHash] - Optional geohash for spatial indexing.
+ *
+ * @example
+ * {
+ *   lat: 37.7749,
+ *   lng: -122.4194,
+ *   zoom: 15,
+ *   viewport: {
+ *     northeast: { lat: 37.785, lng: -122.41 },
+ *     southwest: { lat: 37.765, lng: -122.43 }
+ *   },
+ *   vicinity: "Near Mission District",
+ *   region: "California",
+ *   locality: "San Francisco",
+ *   geoHash: "9q8yy"
+ * }
+ */
+interface LocationGeometry extends GeometryPoint {
+    zoom?: number;
+    viewport?: {
+        northeast: GeometryPoint;
+        southwest: GeometryPoint;
+    };
+    vicinity?: string;
+    region?: string;
+    locality?: string;
+    geoHash?: string;
+}
+/**
+ * A structured representation of a physical location, including address and coordinates.
+ *
+ * @typedef {Object} Location
+ * @property {string | null} venueId - The ID of the venue associated with this location.
+ * @property {string | null} placeId - The Google Place ID associated with this location.
+ * @property {string} name - Name of the location (e.g., venue or custom name).
+ * @property {LocationGeometry | null} geometry - Geospatial data including lat/lng, zoom, and viewport.
+ * @property {Address | null} address - Structured postal address.
+ * @property {string} [timezone] - IANA time zone (e.g., "America/New_York").
+ *
+ * @example
+ * {
+ *   venueId: "abc123",
+ *   placeId: "ChIJVXealLU_xkcRja_At0z9AGY",
+ *   name: "The Fillmore",
+ *   geometry: {
+ *     lat: 37.784,
+ *     lng: -122.433,
+ *     zoom: 14,
+ *     viewport: {
+ *       northeast: { lat: 37.788, lng: -122.429 },
+ *       southwest: { lat: 37.780, lng: -122.437 }
+ *     }
+ *   },
+ *   address: {
+ *     address_1: "1805 Geary Blvd",
+ *     city: "San Francisco",
+ *     state: "CA",
+ *     postalCode: "94115",
+ *     country: "USA"
+ *   },
+ *   timezone: "America/Los_Angeles"
+ * }
+ */
+interface Location {
+    venueId: string | null;
+    placeId: string | null;
+    name: string;
+    geometry: LocationGeometry | null;
+    address: Address | null;
+    timezone?: string;
+}
+interface VenueBase {
+    id: string;
+    name: string;
+    formattedAddress: string;
+    placeId?: string | null;
+    tz: string;
+    logo: Photo | null;
+    public: boolean;
+    address: Address | null;
+    slug: string | null;
+}
+/**
+ * @description Status of the event lifecycle.
+ *
+ * - `archived`: The event is archived and no longer visible in listings.
+ * - `draft`: The event is still being edited and not yet published.
+ * - `live`: The event is published and accepting actions (e.g., ticket sales).
+ * - `started`: The event has begun.
+ * - `ended`: The event has ended.
+ * - `completed`: The event has concluded successfully and is finalized.
+ * - `canceled`: The event was canceled and is no longer active.
+ */
+type EventStatus = "archived" | "draft" | "live" | "started" | "ended" | "completed" | "canceled";
+interface EventBase {
+    id: string;
     /**
-     * Offering name, can be ticket name, vaucher name, etc...
+     * @example "Spring Concert"
+     * @faker name.firstName
+     * @x-faker name.firstName
      */
     name: string;
-    type: OfferingType;
-};
-
-type Partial_OrderItem_ = {
+    summary: string;
+    companyId: string;
     /**
-     * Breakdown of cost components (e.g., base, service fee, delivery).
+     * @description The timezone in which the event is taking place.
+     * @example "America/New_York"
+     * @example "Europe/London"
+     * @example "Asia/Tokyo"
      */
-    costComponents?: Array<CalculatedCostComponent>;
-    costs?: OrderItemCosts;
+    tz: string;
     /**
-     * Unique ID for this order item.
+     * @description The start date and time of the event in ISO 8601 format.
+     * @example "2023-10-01T12:00:00Z"
      */
-    id?: string;
+    start: string;
     /**
-     * If this item is included as part of a package, this is the ID of the parent item.
-     * Otherwise, null.
+     * @description The end date and time of the event in ISO 8601 format.
+     * @example "2023-10-01T14:00:00Z"
      */
-    includedWithItemId?: string;
+    end: string;
+    isSeries?: boolean;
     /**
-     * Any relevant metadata associated with this item.
-     * This can include custom fields or additional information.
+     * @description The status of the event in its lifecycle.
+     * @example "draft"
+     * @example "live"
+     * @example "ended"
      */
-    meta?: any;
-    offering?: OrderItemOffering;
+    status: EventStatus;
     /**
-     * ID of the offering purchased.
+     * @x-faker { url: faker.image.imageUrl() }
      */
-    offeringId?: string;
-    offeringType?: OfferingType;
+    flyer?: Photo | null;
+    venue?: VenueBase | null;
     /**
-     * Quantity purchased of this item.
+     * @description Curerncy used for the event.
+     * @example "USD"
      */
-    quantity?: number;
-};
-
+    currency: string;
+    /**
+     * @description Is the event public?
+     * @example true
+     */
+    public: boolean;
+    location?: Location;
+}
 /**
- * Represents a temporary or persisted cart before order placement.
- * Focuses on user intent and checkout prep, not post-purchase records.
+ * @openapi
+ * @description EventProfile respresent a public view of an event
+ */
+interface EventProfile extends EventBase {
+    meta?: any;
+    organizer: any;
+    url?: string;
+    slug: string;
+    channels: string[];
+    description: MultipartText;
+    widgets: EventFeature[];
+    ticketPrices: string[];
+    buzzBuilder?: BuzzBuilder | null;
+    venue?: VenueBase | null;
+    tags: string[];
+    searchTags: string[];
+    sections: string[];
+    priceRange?: {
+        min?: string;
+        max?: string;
+    };
+}
+/**
+ * Represents a discount coupon that can be applied to one or more offerings in an event platform.
+ *
+ * @export
  */
-type CartSession = {
+interface Coupon extends VersionedDataRecord {
     /**
-     * ISO 8601 timestamp indicating when the record was last updated, if applicable.
+     * ID of the company that issued this coupon.
+     * @example "company_123abc"
      */
-    changed?: string;
-    context: Partial_OrderContext_;
+    companyId: string;
     /**
-     * Namespaced identifier indicating what the order is associated with.
-     * Format: "{type}_{id}", where type is "evt", "ven", or "org".
+     * Internal description for the coupon.
+     * This is not necessarily visible to users.
+     * @example "Early bird discount for spring events"
      */
-    contextId: string;
+    description: string;
     /**
-     * Estimated totals based on current cart state.
-     * These values are subject to recalculation before checkout.
+     * The code used to redeem this coupon during checkout.
+     * For public or coded discounts.
+     * @example "SPRING2025"
      */
-    costs?: {
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        delivery: string;
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        discount: string;
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        fee: string;
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        subtotal: string;
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        tax: string;
-        /**
-         * A string representing a currency amount in the format `"USD,1000"` where:
-         * - `"USD"` is the 3-letter ISO currency code.
-         * - The number after the comma represents the value in **minor units** (e.g., cents for USD).
-         *
-         * For example, `"USD,1000"` equals $10.00 (i.e., 1000 cents).
-         */
-        total: string;
+    code: string;
+    /**
+     * Type of coupon — determines how it's distributed or applied.
+     * @example "coded"
+     */
+    type: "access" | "coded" | "public" | "hold";
+    /**
+     * Fixed amount to deduct from the order total.
+     * This is a currency-less value that matches the event or order currency.
+     * Example: `10.00` = $10.00 off.
+     * @minimum 0
+     * @maximum 99999
+     * @example 10.0
+     */
+    amountOff: number;
+    /**
+     * Percentage to deduct from the item or order total.
+     * Range is 0–100. Use 0 for no percentage-based discount.
+     * @minimum 0
+     * @maximum 100
+     * @example 20.0
+     */
+    percentOff: number;
+    /**
+     * Total number of times this coupon can be used.
+     * A value of `0` means unlimited usage.
+     * @example 100
+     */
+    limit: number;
+    /**
+     * Number of times this coupon has been redeemed.
+     * Read-only field.
+     * @readonly
+     * @example 42
+     */
+    quantitySold: number;
+    /**
+     * List of offering IDs (e.g., ticket classes) this coupon applies to.
+     * If empty, the coupon applies to all eligible offerings in its context.
+     * @example ["off_123abc", "off_456def"]
+     */
+    offeringIds: string[];
+    /**
+     * List of context IDs (e.g., event, venue, or organizer) this coupon is valid for.
+     * Follows the format: "evt_xxx", "org_xxx", etc.
+     * @example ["evt_abc123", "org_def456"]
+     */
+    contextIds: ContextId[];
+    /**
+     * Time-based constraints that control when the coupon is active and when it expires.
+     * Supports absolute dates or relative time offsets (in seconds) from event start.
+     *
+     * - If `start` is omitted, the coupon is valid immediately.
+     * - If `end` is omitted, the coupon remains valid until the event ends.
+     *
+     * @example {
+     *   start: { date: "2025-04-01T00:00:00" },
+     *   end: { secondsBefore: 3600 }
+     * }
+     */
+    constraints: {
+        start?: TimeOrOffset;
+        end?: TimeOrOffset;
     };
     /**
-     * List of applied coupons used in the order.
-     * Supports multiple entries based on organizer preferences.
+     * Current status of the coupon for administrative purposes.
+     * Determines whether it can be redeemed at checkout.
+     * @example "active"
+     */
+    status: "active" | "expired" | "disabled" | "sold_out";
+    /**
+     * Schema version identifier.
+     * Used to ensure compatibility between coupon formats.
+     * @example "2025-01-10"
+     */
+    version: ApiVersion;
+}
+/**
+ * Captures metadata and request/session context at the time the cart is created.
+ * Supports fraud detection, attribution, analytics, and partner session tracking.
+ *
+ * This interface is extensible — additional custom fields may be included as needed.
+ *
+ * @export
+ */
+interface OrderContext {
+    /**
+     * IP addresses associated with the user request.
+     * Typically includes forwarded IPs and direct client IP.
+     * @example ["203.0.113.1", "10.0.0.1"]
+     */
+    ipAddresses: string[];
+    /**
+     * Raw User-Agent header from the client request.
+     * @example "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
+     */
+    userAgent: string;
+    /**
+     * The referring URL from which the cart or checkout was initiated.
+     * May be a partner site, marketing page, or event listing.
+     * @example "https://partner.example.com/tickets/event123"
+     */
+    referrer: string;
+    /**
+     * Authenticated user ID, or null for anonymous guests.
+     * @example "uid_456def"
+     */
+    uid: string | null;
+    /**
+     * The unique cart session ID assigned at the time the cart was created.
+     * Helps track cart attribution across systems.
+     * @example "cart_sess_abc123"
+     */
+    cartSessionId: string;
+    /**
+     * (Optional) Origin domain name if embedded or white-labeled.
+     * Can help identify partner portals or iframe referrers.
+     * @example "examplepartner.com"
+     */
+    originDomain?: string;
+    /**
+     * (Optional) Campaign ID, UTM source, or tracking label.
+     * Useful for affiliate and analytics systems.
+     * @example "utm_campaign=spring_launch"
+     */
+    trackingId?: string;
+    /**
+     * Allows custom fields for analytics, partners, or experiment data.
+     */
+    [custom: string]: unknown;
+}
+/**
+ * Cost breakdown for a specific item in the order.
+ * Extends the standard `OfferingCosts` with totals calculated for quantity and discounts.
+ *
+ * @export
+ */
+interface OrderItemCosts extends OfferingCosts {
+    /**
+     * Total cost of tickets before taxes, fees, and discounts.
+     * @example { amount: 5000, currency: "USD" }
      */
-    coupons?: Array<CouponSummary>;
+    subtotal: CurrencyAmount;
     /**
-     * ISO 8601 timestamp indicating when the record was created.
+     * Total discount amount applied to this item.
+     * @example { amount: 1000, currency: "USD" }
      */
-    created: string;
+    discount: CurrencyAmount;
     /**
-     * The currency code used for this order in ISO 4217 format.
+     * Total price before discounts.
+     * Equal to subtotal + fee, before subtracting discount.
+     * @example { amount: 6000, currency: "USD" }
      */
-    currency: string;
-    customer?: Partial_Customer_;
+    preDiscount: CurrencyAmount;
+}
+/**
+ * Represents an individual item within an order.
+ *
+ * @export
+ */
+interface OrderItem {
     /**
-     * Partner-forwarded data (e.g. utm, session metadata).
+     * Unique ID for this order item.
+     * @example "item_abc123"
      */
-    forwarded?: any;
+    id: string;
     /**
-     * Unique identifier for the record.
+     * Type of offering (e.g., ticket, package, merch).
+     * @example "ticket"
      */
-    id: string;
+    offeringType: OfferingType;
     /**
-     * Items the user has added to their cart.
+     * ID of the offering purchased.
+     * @example "evt_abc123_off_001"
      */
-    items: Array<Partial_OrderItem_>;
+    offeringId: string;
     /**
-     * Internal metadata, flags, debug hints, or experimental context.
+     * Quantity purchased of this item.
+     * @example 2
      */
-    meta: Record<string, any>;
+    quantity: number;
     /**
-     * Stripe PaymentIntent client secret, used by frontend (e.g. Stripe.js).
-     * Required for completing the payment flow.
+     * Full cost breakdown for this item.
      */
-    paymentIntentClientSecret?: string;
+    costs: OrderItemCosts;
     /**
-     * Stripe PaymentIntent ID linked to this cart, if created.
-     * Used for confirming payment on the backend.
+     * If this item is included as part of a package, this is the ID of the parent item.
+     * Otherwise, null.
+     * @example null
      */
-    paymentIntentId?: string;
-    status: CartSession.status;
+    includedWithItemId: string | null;
     /**
-     * Authenticated user ID, if available.
+     * Breakdown of cost components (e.g., base, service fee, delivery).
      */
-    uid: string;
+    costComponents: CalculatedCostComponent[];
     /**
-     * Schema version identifier for this record.
-     * Helps manage compatibility across client-server contracts.
+     * Any relevant metadata associated with this item.
+     * This can include custom fields or additional information.
+     * @example { "customField": "value" }
      */
-    version: string;
-};
-declare namespace CartSession {
-    enum status {
-        ABANDONED = "abandoned",
-        CANCELLED = "cancelled",
-        COMPLETED = "completed",
-        STARTED = "started"
-    }
+    meta: any;
+    offering: OrderItemOffering;
+}
+interface OrderItemOffering extends Pick<Offering, "name" | "costs" | "type"> {
+    /**
+     * doc assicated with this offering in the DB.
+     *
+     * @example "events/1234567890/tickets/0987654321"
+     */
+    docPath: string;
 }
-
 /**
- * Status of the event lifecycle.
- *
- * - `archived`: The event is archived and no longer visible in listings.
- * - `draft`: The event is still being edited and not yet published.
- * - `live`: The event is published and accepting actions (e.g., ticket sales).
- * - `started`: The event has begun.
- * - `ended`: The event has ended.
- * - `completed`: The event has concluded successfully and is finalized.
- * - `canceled`: The event was canceled and is no longer active.
+ * Person interface
  */
-declare enum EventStatus {
-    ARCHIVED = "archived",
-    CANCELED = "canceled",
-    COMPLETED = "completed",
-    DRAFT = "draft",
-    ENDED = "ended",
-    LIVE = "live",
-    STARTED = "started"
-}
-
-type GeometryPoint = {
-    lat: number;
-    lng: number;
-};
-
-type LocationGeometry = {
-    geoHash?: string;
-    lat: number;
-    lng: number;
-    locality?: string;
-    region?: string;
-    vicinity?: string;
-    viewport?: {
-        northeast: GeometryPoint;
-        southwest: GeometryPoint;
-    };
-    zoom?: number;
-};
-
-type Location = {
-    address: Address;
-    geometry: LocationGeometry;
+interface Person {
     name: string;
-    placeId: string;
-    timezone?: string;
-    venueId: string;
+    photoURL?: string | null;
+    displayName: string;
+    first: string;
+    last: string;
+    gender: null | string | "male" | "female" | "other";
+    birthdate?: string | null;
+    age?: number;
+}
+interface PersonContact {
+    email: string | null;
+    phone: string | null;
+}
+type Customer = Person & PersonContact & {
+    uid: string | null;
 };
-
+type CouponSummary = Pick<Coupon, "id" | "code" | "amountOff" | "percentOff" | "offeringIds">;
+type OrderStatus = "placed" | "completed" | "attending" | "cancelled" | "refunded" | "started" | "pending" | "abandoned";
+interface OrderCosts {
+    subtotal: CurrencyAmount;
+    fee: CurrencyAmount;
+    tax: CurrencyAmount;
+    discount: CurrencyAmount;
+    delivery: CurrencyAmount;
+    gross: CurrencyAmount;
+    preDiscount: CurrencyAmount;
+    total: CurrencyAmount;
+}
 /**
- * A photo object with resolution options and optional metadata.
+ * Represents an order in the system.
+ *
+ * @export
  */
-type Photo = {
+interface Order extends VCDataRecord {
     /**
-     * High-resolution (2x) image URL.
+     * Human-readable order number for customer reference.
+     * Often used in emails and receipts.
+     * @example "GW-12345679"
      */
-    '2x'?: string;
+    orderNumber: string;
     /**
-     * Optional caption for the image.
+     * @description The currency code used for this order in ISO 4217 format.
+     * @example "USD"
+     *
+     * @pattern ^[A-Z]{3}$
      */
-    caption?: string;
+    currency: string;
     /**
-     * Height of the image in pixels.
+     * List of applied coupons used in the order.
+     * Supports multiple entries based on organizer preferences.
      */
-    height?: number;
+    coupons?: CouponSummary[];
     /**
-     * Internal photo ID, if stored in a media system.
+     * Namespaced identifier indicating what the order is associated with.
+     * Format: "{type}_{id}", where type is "evt", "ven", or "org".
+     * @example "evt_56k2cf348"
+     * @example "org_9912ff8"
      */
-    id?: string;
+    contextId: ContextId;
     /**
-     * Primary image URL.
-     * This is the default image URL to be used when no other resolution is specified.
+     * Detailed cost breakdown for this order.
      */
-    url: string;
+    costs: OrderCosts;
     /**
-     * Width of the image in pixels.
+     * Customer information related to this order.
      */
-    width?: number;
-};
-
-type VenueBase = {
-    address: Address;
-    formattedAddress: string;
-    id: string;
-    logo: Photo;
-    name: string;
-    placeId?: string;
-    public: boolean;
-    slug: string;
-    tz: string;
-};
-
-type EventFeature = {
-    data: any;
-    description: string;
-    enabled: boolean;
-    iconName?: string;
-    id: string;
-    key: string;
-    logoUri?: string;
-    meta?: any;
-    order: number;
-    title: string;
-    type: string;
-    version?: string;
-    widgetUri: string;
-};
-
-/**
- * A rich content object that supports multiple representations of text.
- */
-type MultipartText = {
+    customer: Customer;
     /**
-     * Optional rich editor blocks (if structured editing is supported).
+     * The current status of the order.
+     * @example "paid"
      */
-    blocks?: Array<any>;
+    status: OrderStatus;
     /**
-     * HTML version of the content.
+     * A list of individual items included in the order.
      */
-    html?: string;
+    items: OrderItem[];
     /**
-     * Markdown version of the content.
+     * Agreement flags for terms and marketing opt-ins.
      */
-    md?: string;
+    agreements: {
+        /**
+         * Whether the customer accepted the organizer’s custom terms.
+         * @example true
+         */
+        agreedToOrganizerTerms?: boolean;
+        /**
+         * Whether the customer accepted the platform-wide terms of service.
+         * @example true
+         */
+        agreedToTerms?: boolean;
+        /**
+         * Whether the customer opted in to receive marketing emails.
+         * @example false
+         */
+        emailOptIn?: boolean;
+        /**
+         * Whether the customer opted in to receive marketing SMS messages.
+         * @example false
+         */
+        textOptIn?: boolean;
+    };
     /**
-     * Plain text version of the content.
+     * Responses to dynamic questions during checkout (e.g. survey or registration).
+     * @example { "tshirtSize": "M", "vipNewsletter": true }
      */
-    text?: string;
-};
-
+    answers: {
+        [questionId: string]: string | boolean;
+    };
+    /**
+     * Freeform object containing metadata forwarded from the partner site
+     * or embedding context. Can include UTM tags, user traits, campaign IDs, etc.
+     * @example { utm_campaign: "spring_launch", partner: "venue_123" }
+     */
+    forwarded: any;
+    /**
+     * Internal or computed metadata associated with the order.
+     * May include fulfillment flags, debugging info, or derived calculations.
+     * @example { preview: true, manuallyAdjusted: true }
+     */
+    meta: any;
+    /**
+     * Session and request context captured at the time of order creation.
+     * Includes IPs, referrer, user agent, cart session ID, and tracking info.
+     */
+    context: OrderContext;
+    version: ApiVersion;
+}
 /**
- * EventProfile respresent a public view of an event
+ * Represents the resolved context associated with a cart session.
+ * This may be an event, venue, or organizer, and is used to enrich the cart with metadata
+ * needed for UI rendering and pricing logic without requiring repeated DB lookups.
+ *
+ * Typically stored in `cart.meta.resolvedContext`.
+ *
+ * @export
  */
-type EventProfile = {
-    buzzBuilder?: BuzzBuilder;
-    channels: Array<string>;
-    companyId: string;
+interface ResolvedCartContext {
     /**
-     * Curerncy used for the event.
+     * Unique identifier of the context entity.
+     * Typically matches the cart's `contextId` (e.g., "evt_abc123").
+     * @example "evt_abc123"
      */
-    currency: string;
-    description: MultipartText;
+    id: string;
     /**
-     * The end date and time of the event in ISO 8601 format.
+     * Human-readable title or name of the context entity.
+     * Used for display in headers, summaries, and confirmations.
+     * @example "Downtown Comedy Night"
      */
-    end: string;
-    flyer?: Photo;
-    id: string;
-    isSeries?: boolean;
-    location?: Location;
-    meta?: any;
-    name: string;
-    organizer: any;
-    priceRange?: {
-        max?: string;
-        min?: string;
-    };
+    title: string;
     /**
-     * Is the event public?
+     * Optional physical or virtual location of the event or venue.
+     * Can include address, coordinates, or virtual link.
      */
-    public: boolean;
-    searchTags: Array<string>;
-    sections: Array<string>;
-    slug: string;
+    location?: Location;
     /**
-     * The start date and time of the event in ISO 8601 format.
+     * Optional logo, banner, or primary image representing the context.
+     * Used in UI to visually identify the entity during checkout.
      */
-    start: string;
-    status: EventStatus;
-    summary: string;
-    tags: Array<string>;
-    ticketPrices: Array<string>;
+    logo?: Photo;
     /**
-     * The timezone in which the event is taking place.
+     * A map of offerings relevant to this context (e.g., ticket types, merch).
+     * Stored as a record keyed by offering ID to allow fast lookup.
+     * Each value is a partial offering object, intended for display, validation, or pricing.
+     * @example {
+     *   "off_123abc": { path: "events/ev_1234/tickets/tkt_567", offering: { name: "VIP Ticket", price: 3000 }),
+     *   "off_456def": { path: "events/ev_1234/tickets/tkt_567", offering: { name: "T-Shirt", price: 2000 }}
+     * }
      */
-    tz: string;
-    url?: string;
-    venue?: VenueBase;
-    widgets: Array<EventFeature>;
-};
-
-declare enum OfferingStatus {
-    DELETED = "deleted",
-    DRAFT = "draft",
-    HIDDEN = "hidden",
-    LIVE = "live",
-    SOLD_OUT = "sold-out",
-    UNAVAILABLE = "unavailable"
+    offerings?: Record<string, ResolvedCartContextOffering>;
 }
-
-type PackageInclude = {
-    description: string;
-    id: string;
-    quantity: number;
-    ref?: any;
-    type: OfferingType;
-};
-
-declare enum PriceCategory {
-    DONATION = "donation",
-    FREE = "free",
-    OTHER = "other",
-    PAID = "paid"
+interface ResolvedCartContextOffering {
+    path: string;
+    offering: Offering;
 }
-
-type Ticket = {
+/**
+ * Represents a temporary or persisted cart before order placement.
+ * Focuses on user intent and checkout prep, not post-purchase records.
+ *
+ * @export
+ */
+interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" | "version" | "coupons"> {
     /**
-     * The maximum number of tickets that can be sold for this offering.
+     * Authenticated user ID, if available.
+     * @example "uid_123abc"
      */
-    capacity: number;
-    category: string;
+    uid: string | null;
     /**
-     * ISO 8601 timestamp indicating when the record was last updated, if applicable.
+     * Optional snapshot of customer info entered during cart fill.
+     * Not required and not final.
+     *
+     * @schema lazy(() => customerSchema).optional()
      */
-    changed?: string;
-    costs: OfferingCosts;
+    customer?: Partial<Customer>;
     /**
-     * ISO 8601 timestamp indicating when the record was created.
+     * @schema lazy(() => orderContextSchema).optional()
      */
-    created: string;
-    description?: string;
-    display_name?: string;
+    context: Partial<OrderContext>;
     /**
-     * Unique identifier for the record.
+     * Items the user has added to their cart.
      */
-    id: string;
+    items: Partial<OrderItem>[];
     /**
-     * Items, products ,and vouchers included in this offering.
+     * Estimated totals based on current cart state.
+     * These values are subject to recalculation before checkout.
      */
-    included?: Array<PackageInclude>;
-    instructions?: string;
+    costs?: {
+        subtotal: CurrencyAmount;
+        discount: CurrencyAmount;
+        tax: CurrencyAmount;
+        fee: CurrencyAmount;
+        delivery: CurrencyAmount;
+        total: CurrencyAmount;
+    };
     /**
-     * Maximum number of tickets that can be purchased in a single order.
+     * Stripe PaymentIntent ID linked to this cart, if created.
+     * Used for confirming payment on the backend.
+     * @example "pi_1ABCXYZ..."
      */
-    maximumQuantity: number;
+    paymentIntentId?: string;
     /**
-     * Minimum number of tickets that can be purchased in a single order.
+     * Stripe PaymentIntent client secret, used by frontend (e.g. Stripe.js).
+     * Required for completing the payment flow.
+     * @example "pi_1ABCXYZ..._secret_456"
      */
-    minimumQuantity: number;
+    paymentIntentClientSecret?: string;
     /**
-     * Offering name, can be ticket name, vaucher name, etc...
+     * Partner-forwarded data (e.g. utm, session metadata).
      */
-    name: string;
-    order_confirmation_message?: string;
-    package?: boolean;
-    parentId?: string;
-    priceCategory: PriceCategory;
-    quantitySold: number;
-    refId?: string;
-    salesEnd: string;
-    salesStart: string;
-    sorting: number;
-    source: string;
-    status: OfferingStatus;
-    ticketParentId?: string;
-    type: Ticket.type;
-};
-declare namespace Ticket {
-    enum type {
-        ADMISSION = "admission",
-        ADMISSION_TABLE_COMMITMENT = "admission.tableCommitment",
-        PACKAGE = "package"
-    }
-}
-
-type UpdatableCartSession = {
-    customer?: Partial_Customer_;
+    forwarded?: any;
     /**
-     * Items the user has added to their cart.
+     * Internal metadata, flags, debug hints, or experimental context.
      */
-    items: Array<Partial_OrderItem_>;
-};
+    meta: {
+        /**
+         * Display context (event, venue, organizer) for rendering and logic.
+         */
+        resolvedContext?: ResolvedCartContext;
+        /**
+         * Cost components to calculate the cart costs.
+         *
+         * @ignore
+         */
+        costComponents?: CostComponent[];
+        /**
+         * Snapshot of when pricing was calculated and locked.
+         * Useful for honoring totals during a grace window.
+         */
+        priceLock?: {
+            lockedAt: string;
+            ttl?: number;
+        };
+        /**
+         * Any additional internal system flags, A/B test conditions, or
+         * non-critical partner payloads.
+         */
+        [key: string]: any;
+    };
+    status: "started" | "completed" | "abandoned" | "cancelled";
+}
+type UpdatableCartSession = Pick<CartSession, "customer" | "items">;
 
 /**
  * Provides methods to interact with the Cohost Events API.
@@ -847,7 +1278,7 @@ declare class SessionsAPI extends CohostEndpoint {
      *
      * @throws Will throw an error if the update fails
      */
-    update(id: string, input: UpdatableCartSession): Promise<CartSession>;
+    update(id: string, input: Partial<UpdatableCartSession>): Promise<CartSession>;
     /**
      * Cancel (soft delete) a cart session.
      *
@@ -869,6 +1300,21 @@ declare class SessionsAPI extends CohostEndpoint {
         offeringId: string;
         quantity: number;
     }): Promise<CartSession>;
+    /**
+     * Pre-validate and prepare the cart session for checkout.
+     * @param sessionId
+     */
+    preValidate(sessionId: string, data: any): Promise<CartSession>;
+    /**
+     * Close the cart session, and place the order.
+     *
+     * @param sessionId - The ID of the session
+     * @param data - Data to place the order
+     * @returns {CartSession} The latest cart session
+     *
+     * @throws Will throw an error if the order placement fails
+     */
+    placeOrder(sessionId: string, data: any): Promise<CartSession>;
     /**
      * Remove an item from the cart session.
      * The same as setting the quantity to 0.