@jphil/bookwhen-client 0.3.1 → 0.4.0

package/dist/index.d.ts

@@ -105,6 +105,9 @@ declare interface EventImage {
 
 export declare type EventResource = 'location' | 'attachments' | 'tickets' | 'tickets.events' | 'tickets.class_passes';
 
+declare interface EventResponse extends JsonApiResponse<BookwhenEvent> {
+}
+
 /**
  * Service class for managing events in the Bookwhen API.
  */
@@ -123,14 +126,17 @@ declare class EventService implements IEventService {
      * @param {string} [param.include] - Optional parameter to include additional data.
      * @returns {Promise<BookwhenEvent>} A Promise that resolves to the BookwhenEvent object.
      */
-    getById(params: z.infer<typeof GetEventByIdParamsSchema>): Promise<BookwhenEvent>;
+    getById(params: z.infer<typeof GetEventByIdParamsSchema>): Promise<EventResponse>;
     /**
      * Retrieves multiple events based on filtering and pagination parameters.
      *
      * @param {GetMultipleEventsParams} params - Optional parameters for filtering and pagination.
-     * @return {Promise<BookwhenEvent[]>} A Promise that resolves to an array of BookwhenEvent objects.
+     * @return {Promise<EventsResponse>} A Promise that resolves to the full JSON:API response object.
      */
-    getMultiple(params?: GetMultipleEventsParams): Promise<BookwhenEvent[]>;
+    getMultiple(params?: GetMultipleEventsParams): Promise<EventsResponse>;
+}
+
+declare interface EventsResponse extends JsonApiResponse<BookwhenEvent[]> {
 }
 
 export declare interface Filters {
@@ -181,15 +187,34 @@ export declare interface IEventService {
      * Retrieves a single event by its ID.
      * @param eventId The unique identifier of the event.
      * @param include Optional parameter to include additional data.
-     * @returns A Promise that resolves to an Event object, as defined by the Bookwhen API data structure.
+     * @returns A Promise that resolves to the full JSON:API response object.
      */
-    getById(params: GetEventByIdParams): Promise<BookwhenEvent>;
+    getById(params: GetEventByIdParams): Promise<EventResponse>;
     /**
      * Retrieves multiple events based on specified parameters.
      * @param params Optional parameters to filter and control the list of returned events, according to what the Bookwhen API supports.
-     * @returns A Promise that resolves to an array of Event objects.
+     * @returns A Promise that resolves to the full JSON:API response object.
      */
-    getMultiple?(params?: GetMultipleEventsParams): Promise<BookwhenEvent[]>;
+    getMultiple?(params?: GetMultipleEventsParams): Promise<EventsResponse>;
+}
+
+declare interface JsonApiResponse<T> {
+    data: T;
+    included?: any[];
+    links?: {
+        self?: string;
+        first?: string;
+        last?: string;
+        prev?: string;
+        next?: string;
+    };
+    meta?: {
+        page?: {
+            current?: number;
+            total?: number;
+            size?: number;
+        };
+    };
 }
 
 export declare type Resource = string;

package/dist/index.js

@@ -6463,7 +6463,7 @@ class EventService {
         query.addIncludes(validParams.includes);
       }
       const response = await this.axiosInstance.get(`${query}`);
-      return response.data?.data;
+      return response.data;
     } catch (error) {
       if (error instanceof z.ZodError) {
         const errorMessages = error.errors.map((e) => e.message).join(", ");
@@ -6484,7 +6484,7 @@ class EventService {
    * Retrieves multiple events based on filtering and pagination parameters.
    *
    * @param {GetMultipleEventsParams} params - Optional parameters for filtering and pagination.
-   * @return {Promise<BookwhenEvent[]>} A Promise that resolves to an array of BookwhenEvent objects.
+   * @return {Promise<EventsResponse>} A Promise that resolves to the full JSON:API response object.
    */
   async getMultiple(params = {}) {
     try {
@@ -6492,7 +6492,7 @@ class EventService {
       if (params.includes) query.addIncludes(params.includes);
       if (params.filters) query.addFilters(params.filters);
       const response = await this.axiosInstance.get(`${query}`);
-      return response.data.data;
+      return response.data;
     } catch (error) {
       handleServiceHTTPErrors(error, SERVICE_HTTP_STATUS_CODES);
     }