bmlt-query-client 1.0.6 → 1.0.7

package/dist/app.d.ts

@@ -22,6 +22,16 @@ export declare class BmltClient {
      * Search for meetings
      */
     searchMeetings(params?: SearchResultsParams): Promise<Meeting[]>;
+    /**
+     * Search for meetings and return both meetings and the formats they reference in a
+     * single request. Uses get_used_formats=true so the server wraps the response as
+     * { meetings: Meeting[], formats: Format[] } instead of a bare Meeting[].
+     *
+     * This replaces the common pattern of Promise.all([getFormats(), searchMeetings()])
+     * with a single round-trip, which matters for large servers where getFormats() can
+     * return hundreds of unused format records.
+     */
+    searchMeetingsWithFormats(params?: Omit<SearchResultsParams, 'get_used_formats' | 'get_formats_only'>): Promise<MeetingsWithFormats>;
     /**
      * Search for meetings by geographic location using geocoding
      */
@@ -722,12 +732,29 @@ export declare class MeetingQueryBuilder {
      * Execute the search and return results
      */
     execute(): Promise<Meeting[]>;
+    /**
+     * Execute the search and return both meetings and the formats they reference
+     * in a single request. Equivalent to execute() but avoids a separate getFormats() call.
+     */
+    executeWithFormats(): Promise<MeetingsWithFormats>;
     /**
      * Execute the search by geocoding an address first
      */
     executeNearAddress(address: string, radiusMiles?: number, radiusKm?: number, sortByDistance?: boolean): Promise<Meeting[]>;
 }
 
+/**
+ * Combined response when get_used_formats=true is passed to GetSearchResults.
+ * The BMLT API wraps the response in an object with separate meetings and formats arrays
+ * instead of returning a bare meetings array.
+ */
+export declare interface MeetingsWithFormats {
+    /** Meetings matching the search criteria */
+    meetings: Meeting[];
+    /** Only the formats actually referenced by the returned meetings */
+    formats: Format[];
+}
+
 /**
  * Convert miles to kilometers
  */