@cohostvip/cohost-node 0.0.9 → 0.0.10

package/dist/index.d.mts

@@ -1,46 +1,3 @@
-/**
- * Supported HTTP methods.
- */
-type RequestMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-/**
- * A function that performs a request to the Cohost API.
- * The generic <T> allows you to specify the expected response type.
- */
-type RequestFn = <T = any>(path: string, options?: {
-    method?: RequestMethod;
-    data?: any;
-    query?: Record<string, string | number | boolean | undefined>;
-    headers?: Record<string, string>;
-}) => Promise<T>;
-
-/**
- * Optional settings for customizing the behavior of the CohostClient.
- */
-interface CohostClientSettings {
-    /** Enable verbose debug output for all API requests. */
-    debug?: boolean;
-    /** Override the default API base URL (defaults to apiBaseUrl). */
-    apiUrl?: string;
-}
-
-/**
- * Base class for all API endpoint groups within the Cohost SDK.
- * Provides shared access to the configured request function and settings.
- */
-declare class CohostEndpoint {
-    /** Shared request function injected from the client */
-    protected request: RequestFn;
-    /** Client settings passed during instantiation */
-    protected settings: CohostClientSettings;
-    /**
-     * Constructs a new endpoint group.
-     *
-     * @param request - The shared request function for performing API calls
-     * @param settings - The client-wide settings passed from the parent client
-     */
-    constructor(request: RequestFn, settings: CohostClientSettings);
-}
-
 /**
  * A namespaced identifier representing the entity an order is associated with.
  *
@@ -110,6 +67,27 @@ interface Schedule {
     /** Specific dates to include in "YYYY-MM-DD" format. */
     includeDates?: string[];
 }
+/**
+ * Pagination parameters for a paginated API request.
+ */
+interface Pagination$1 {
+    /** Number of results per page. */
+    size: number;
+    /** Page number (starting from 1). */
+    page: number;
+    /** Continuation */
+    continuation?: string;
+}
+interface PaginationResponse extends Pagination$1 {
+    /** Total number of results available. */
+    total: number;
+}
+type PaginatedResponse<T> = {
+    /** Array of results. */
+    results: T[];
+    /** Pagination metadata. */
+    pagination: PaginationResponse;
+};
 /**
  * Base metadata for any record stored in the system.
  * Includes an ID and timestamps for creation and optional updates.
@@ -173,6 +151,15 @@ type TimeOrOffset = {
     secondsBefore: number;
     date?: never;
 };
+/**
+ * A request structure that includes both query parameters and pagination.
+ *
+ * @ignore
+ */
+type PaginatedRequest<T> = T & {
+    /** Pagination settings. */
+    pagination: Pagination$1;
+};
 /**
  * @description A string representing a currency amount in the format `"USD,1000"` where:
  * - `"USD"` is the 3-letter ISO currency code.
@@ -443,6 +430,44 @@ interface Ticket extends Omit<Offering, "hidden" | "constraints" | "type"> {
     parentId?: string;
     refId?: string;
 }
+/**
+ * Person interface
+ */
+interface Person {
+    name: 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 AttendeeStatus = "attending" | "checkedIn" | "cancelled" | "refunded" | "noShow" | "unknown" | string;
+interface Attendee3 extends DataRecord {
+    /**
+     * Order ID, from /orders/:orderId
+     */
+    orderId: string;
+    /**
+     * For event it will be the ticket's id
+     */
+    offeringId: string;
+    offeringSnapshot: Partial<Offering>;
+    profile: Customer | null;
+    checkedIn: boolean;
+    barcodes: string[];
+    version: ApiVersion;
+    status: AttendeeStatus | string;
+    index: number;
+}
 interface BuzzBuilder {
     countLabel: string;
     profiles: {
@@ -589,6 +614,21 @@ interface VenueBase {
     address: Address | null;
     slug: string | null;
 }
+interface Venue extends VenueBase {
+    claimed: boolean;
+    refId?: string;
+    description?: MultipartText;
+    capacity?: number | null;
+    types: string[];
+    photos?: Photo[];
+    hoursOfOperation: string[];
+    phoneNumber?: string | null;
+    priceLevel: number | null;
+    rating: {
+        google: number | null;
+    };
+    [key: string]: any;
+}
 /**
  * @description Status of the event lifecycle.
  *
@@ -601,8 +641,7 @@ interface VenueBase {
  * - `canceled`: The event was canceled and is no longer active.
  */
 type EventStatus = "archived" | "draft" | "live" | "started" | "ended" | "completed" | "canceled";
-interface EventBase {
-    id: string;
+interface EventBase extends DataRecord {
     /**
      * @example "Spring Concert"
      * @faker name.firstName
@@ -652,6 +691,7 @@ interface EventBase {
      */
     public: boolean;
     location?: Location;
+    organizerId: string;
 }
 /**
  * @openapi
@@ -775,60 +815,6 @@ interface Coupon extends VersionedDataRecord {
      */
     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.
@@ -910,25 +896,64 @@ interface OrderItemOffering extends Pick<Offering, "name" | "costs" | "type"> {
     docPath: string;
 }
 /**
- * Person interface
+ * 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
  */
-interface Person {
-    name: string;
-    photoURL?: string | null;
-    displayName: string;
-    first: string;
-    last: string;
-    gender: null | string | "male" | "female" | "other";
-    birthdate?: string | null;
-    age?: number;
+interface ResolvedCartContext {
+    /**
+     * Unique identifier of the context entity.
+     * Typically matches the cart's `contextId` (e.g., "evt_abc123").
+     * @example "evt_abc123"
+     */
+    id: string;
+    /**
+     * Human-readable title or name of the context entity.
+     * Used for display in headers, summaries, and confirmations.
+     * @example "Downtown Comedy Night"
+     */
+    title: string;
+    /**
+     * Optional physical or virtual location of the event or venue.
+     * Can include address, coordinates, or virtual link.
+     */
+    location?: Location;
+    /**
+     * Optional logo, banner, or primary image representing the context.
+     * Used in UI to visually identify the entity during checkout.
+     */
+    logo?: Photo;
+    /**
+     * Optional description or summary of the context entity.
+     * Provides additional information to the customer during checkout.
+     * @example "Join us for a night of laughter with top comedians!"
+     */
+    start: string;
+    /**
+     * Optional end date or time of the event or context entity.
+     * Useful for events with a specific duration or schedule.
+     * @example "2023-10-15T22:00:00Z"
+     */
+    end?: string;
+    /**
+     * 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 }}
+     * }
+     */
+    offerings?: Record<string, ResolvedCartContextOffering>;
 }
-interface PersonContact {
-    email: string | null;
-    phone: string | null;
+interface ResolvedCartContextOffering {
+    path: string;
+    offering: Offering;
 }
-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 {
@@ -965,6 +990,7 @@ interface Order extends VCDataRecord {
      * Supports multiple entries based on organizer preferences.
      */
     coupons?: CouponSummary[];
+    organizerId: string;
     /**
      * Namespaced identifier indicating what the order is associated with.
      * Format: "{type}_{id}", where type is "evt", "ven", or "org".
@@ -1032,7 +1058,31 @@ interface Order extends VCDataRecord {
      * May include fulfillment flags, debugging info, or derived calculations.
      * @example { preview: true, manuallyAdjusted: true }
      */
-    meta: any;
+    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;
+    };
     /**
      * Session and request context captured at the time of order creation.
      * Includes IPs, referrer, user agent, cart session ID, and tracking info.
@@ -1040,52 +1090,60 @@ interface Order extends VCDataRecord {
     context: OrderContext;
     version: ApiVersion;
 }
-/**
- * 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
- */
-interface ResolvedCartContext {
+type OrderContext = {
+    type: "event";
+    event: EventProfile;
+    venue?: Venue;
+} | {
+    type: "venue";
+    event?: EventProfile;
+    venue: Venue;
+};
+interface OrderContext$1 {
     /**
-     * Unique identifier of the context entity.
-     * Typically matches the cart's `contextId` (e.g., "evt_abc123").
-     * @example "evt_abc123"
+     * IP addresses associated with the user request.
+     * Typically includes forwarded IPs and direct client IP.
+     * @example ["203.0.113.1", "10.0.0.1"]
      */
-    id: string;
+    ipAddresses: string[];
     /**
-     * Human-readable title or name of the context entity.
-     * Used for display in headers, summaries, and confirmations.
-     * @example "Downtown Comedy Night"
+     * Raw User-Agent header from the client request.
+     * @example "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
      */
-    title: string;
+    userAgent: string;
     /**
-     * Optional physical or virtual location of the event or venue.
-     * Can include address, coordinates, or virtual link.
+     * 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"
      */
-    location?: Location;
+    referrer: string;
     /**
-     * Optional logo, banner, or primary image representing the context.
-     * Used in UI to visually identify the entity during checkout.
+     * Authenticated user ID, or null for anonymous guests.
+     * @example "uid_456def"
      */
-    logo?: Photo;
+    uid: string | null;
     /**
-     * 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 }}
-     * }
+     * The unique cart session ID assigned at the time the cart was created.
+     * Helps track cart attribution across systems.
+     * @example "cart_sess_abc123"
      */
-    offerings?: Record<string, ResolvedCartContextOffering>;
-}
-interface ResolvedCartContextOffering {
-    path: string;
-    offering: Offering;
+    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;
 }
 /**
  * Represents a temporary or persisted cart before order placement.
@@ -1093,7 +1151,8 @@ interface ResolvedCartContextOffering {
  *
  * @export
  */
-interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" | "version" | "coupons"> {
+interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" | "version" | "coupons" | "companyId" | "organizerId" | "meta"> {
+    orderId?: string;
     /**
      * Authenticated user ID, if available.
      * @example "uid_123abc"
@@ -1109,7 +1168,7 @@ interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" |
     /**
      * @schema lazy(() => orderContextSchema).optional()
      */
-    context: Partial<OrderContext>;
+    context: Partial<OrderContext$1>;
     /**
      * Items the user has added to their cart.
      */
@@ -1126,6 +1185,7 @@ interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" |
         delivery: CurrencyAmount;
         total: CurrencyAmount;
     };
+    paymentStatus: "pending" | "confirmed" | "failed" | "refunded";
     /**
      * Stripe PaymentIntent ID linked to this cart, if created.
      * Used for confirming payment on the backend.
@@ -1142,38 +1202,67 @@ interface CartSession extends DataRecord, Pick<Order, "currency" | "contextId" |
      * Partner-forwarded data (e.g. utm, session metadata).
      */
     forwarded?: any;
-    /**
-     * Internal metadata, flags, debug hints, or experimental context.
-     */
-    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">;
 
+/**
+ * Pagination parameters for a paginated API request.
+ */
+interface Pagination {
+    /** Number of results per page. */
+    size: number;
+    /** Page number (starting from 1). */
+    page: number;
+    /** Continuation */
+    continuation?: string;
+}
+
+/**
+ * Supported HTTP methods.
+ */
+type RequestMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+type RequestOptions = {
+    method?: RequestMethod;
+    data?: any;
+    query?: Record<string, string | number | boolean | undefined>;
+    headers?: Record<string, string>;
+    pagination?: Pagination;
+};
+/**
+ * A function that performs a request to the Cohost API.
+ * The generic <T> allows you to specify the expected response type.
+ */
+type RequestFn = <T = any>(path: string, options?: RequestOptions) => Promise<T>;
+
+/**
+ * Optional settings for customizing the behavior of the CohostClient.
+ */
+interface CohostClientSettings {
+    /** Enable verbose debug output for all API requests. */
+    debug?: boolean;
+    /** Override the default API base URL (defaults to apiBaseUrl). */
+    apiUrl?: string;
+}
+
+/**
+ * Base class for all API endpoint groups within the Cohost SDK.
+ * Provides shared access to the configured request function and settings.
+ */
+declare class CohostEndpoint {
+    /** Shared request function injected from the client */
+    protected request: RequestFn;
+    /** Client settings passed during instantiation */
+    protected settings: CohostClientSettings;
+    /**
+     * Constructs a new endpoint group.
+     *
+     * @param request - The shared request function for performing API calls
+     * @param settings - The client-wide settings passed from the parent client
+     */
+    constructor(request: RequestFn, settings: CohostClientSettings);
+}
+
 /**
  * Provides methods to interact with the Cohost Events API.
  *
@@ -1211,6 +1300,15 @@ declare class EventsAPI extends CohostEndpoint {
      * @throws Will throw an error if the request fails or the event does not exist
      */
     tickets(id: string): Promise<Ticket[]>;
+    /**
+     * List attendees in the event.
+     *
+     * Requires: valid authentication token. This endpoint is not public.
+     *
+     * @param id - The ID of the event.
+     * @returns List of tickets (attendees) for the event.
+     */
+    attendees(id: string, filters?: PaginatedRequest<any>): Promise<PaginatedResponse<Attendee3>>;
 }
 
 /**