rybbit.ts 1.0.0 → 1.0.1

package/dist/endpoints.d.ts

@@ -0,0 +1,96 @@
+import type { DateString, TimeZone, Filter, Bucket, Parameter, Timestamp, SortBy, Order, Mode, Dimension } from './types.js';
+/** Route interfaces, used to construct URLs. */
+export declare class Routes {
+    #private;
+    /**
+     * Create a new route constructor.
+     * @param base The base URL for this constructor.
+     */
+    constructor(base: URL);
+    /** `GET` Returns details for a specific site */
+    getSite(siteId: number): URL;
+    /** `DELETE` Permanently deletes a site and all its data. Requires admin/owner role. */
+    deleteSite(siteId: number): URL;
+    /** `PUT` Updates site configuration settings. Requires admin/owner role. */
+    updateSiteConfig(siteId: number): URL;
+    /** `GET` Returns the list of excluded IP addresses */
+    getExcludedIPs(siteId: number): URL;
+    /** `GET` Returns the list of excluded country codes */
+    getExcludedCountries(siteId: number): URL;
+    /** `GET` Returns the private link key configuration */
+    getPrivateLinkConfig(siteId: number): URL;
+    /** `POST` Generates or revokes a private link key. Requires admin/owner role. */
+    updatePrivateLinkConfig(siteId: number): URL;
+    /** `GET` Returns all organizations the authenticated user is a member of, including all members for each organization */
+    getMyOrganizations(): URL;
+    /** `POST` Creates a new site in an organization. Requires admin/owner role. */
+    createSite(organizationId: string): URL;
+    /** `GET` Returns all members of an organization with user details */
+    getOrganizationMembers(organizationId: string): URL;
+    /** `POST` Adds a user to an organization with a specified role */
+    addOrganizationMember(organizationId: string): URL;
+    /** `GET` Returns high-level analytics metrics for a site */
+    getOverview(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns time-series analytics data broken down by time buckets */
+    getOverviewTimeSeries(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, bucket?: Bucket): URL;
+    /** `GET` Returns dimensional analytics broken down by a specific parameter */
+    getMetric(siteId: number, parameter: Parameter, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, limit?: number, page?: number): URL;
+    /** `GET` Returns the count of active sessions within the specified time window */
+    getLiveVisitors(siteId: number, minutes?: number): URL;
+    /** `GET` Returns a paginated list of events with cursor-based pagination */
+    getEvents(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, pageSize?: number, sinceTimestamp?: Timestamp, beforeTimestamp?: Timestamp): URL;
+    /** `GET` Returns list of unique custom event names with counts */
+    getEventNames(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns property key-value pairs for a specific event */
+    getEventProperties(siteId: number, eventName: string, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns outbound link clicks with occurrence counts */
+    getOutboundLinks(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns unique error messages with occurrence and session counts */
+    getErrorNames(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number): URL;
+    /** `GET` Returns individual error occurrences with context and stack traces */
+    getErrorEvents(siteId: number, errorMessage: string, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number): URL;
+    /** `GET` Returns error occurrence counts over time */
+    getErrorTimeSeries(siteId: number, errorMessage: string, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, bucket?: Bucket): URL;
+    /** `GET` Returns paginated list of goals with conversion metrics */
+    getGoals(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, pageSize?: number, sortBy?: SortBy, order?: Order): URL;
+    /** `GET` Returns sessions that completed a specific goal */
+    getGoalSessions(siteId: number, goalId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number): URL;
+    /** `POST` Creates a new goal */
+    createGoal(siteId: number): URL;
+    /** `PUT` Updates an existing goal */
+    updateGoal(siteId: number, goalId: number): URL;
+    /** `DELETE` Deletes a goal */
+    deleteGoal(siteId: number, goalId: number): URL;
+    /** `GET` Returns all saved funnels for a site */
+    getFunnels(siteId: number): URL;
+    /** `GET` Analyzes funnel conversion data step-by-step */
+    analyzeFunnel(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns sessions that reached or dropped at a specific funnel step */
+    getFunnelStepSessions(siteId: number, stepNumber: number, mode: Mode, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number): URL;
+    /** `POST` Creates a saved funnel */
+    createFunnel(siteId: number): URL;
+    /** `DELETE` Deletes a saved funnel */
+    deleteFunnel(siteId: number, funnelId: number): URL;
+    /** `GET` Returns aggregate Core Web Vitals metrics */
+    getPerformanceOverview(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns performance metrics over time */
+    getPerformanceTimeSeries(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, bucket?: Bucket): URL;
+    /** `GET` Returns performance breakdown by dimension */
+    getPerformanceByDimension(siteId: number, dimension: Dimension, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number, sortBy?: SortBy, sortOrder?: Order): URL;
+    /** `GET` Returns a paginated list of sessions */
+    getSessions(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, limit?: number, userId?: string, identifiedOnly?: boolean): URL;
+    /** `GET` Returns detailed session information with events */
+    getSession(siteId: number, sessionId: string, limit?: number, offset?: number): URL;
+    /** `GET` Returns aggregated session locations for map visualization */
+    getSessionLocations(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>): URL;
+    /** `GET` Returns a paginated list of users */
+    getUsers(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, page?: number, pageSize?: number, sortBy?: SortBy, sortOrder?: Order, identifiedOnly?: boolean): URL;
+    /** `GET` Returns daily session counts for a specific user */
+    getUserSessionCount(siteId: number, userId: string, timezone?: TimeZone): URL;
+    /** `GET` Returns detailed user profile information */
+    getUserInfo(siteId: number, userId: string): URL;
+    /** `GET` Returns cohort-based retention analysis */
+    getRetention(siteId: number, mode?: Mode, range?: number): URL;
+    /** `GET` Returns most common page navigation paths */
+    getJourneys(siteId: number, startDate?: DateString, endDate?: DateString, timezone?: TimeZone, filters?: Array<Filter>, steps?: number, limit?: number): URL;
+}

package/{src/endpoints.ts → dist/endpoints.js}

@@ -1,118 +1,81 @@
-import type {
-    DateString,
-    TimeZone,
-    Filter,
-    Bucket,
-    Parameter,
-    Timestamp,
-    SortBy,
-    Order,
-    Mode,
-    Dimension
-} from './types.js';
-
 /** Route interfaces, used to construct URLs. */
 export class Routes {
     /** Base URL for this route constructor. */
-    #base: URL;
-
+    #base;
     /**
      * Create a new route constructor.
      * @param base The base URL for this constructor.
      */
-    constructor(base: URL) {
+    constructor(base) {
         this.#base = base;
     }
-
     /**
      * Create a URL.
      * @param path The path of this URL.
      * @param queries The queries for this URL.
      * @returns The created URL.
      */
-    #create(path: string, queries?: Record<string, string | undefined>): URL {
+    #create(path, queries) {
         const url = new URL(`${this.#base.origin}${path}`);
-
         if (queries) {
             const search = url.searchParams;
             for (const [name, value] of Object.entries(queries)) {
-                if (value === undefined) continue;
+                if (value === undefined)
+                    continue;
                 search.set(name, value);
             }
         }
-
         return url;
     }
-
     // SITES
-
     /** `GET` Returns details for a specific site */
-    getSite(siteId: number): URL {
+    getSite(siteId) {
         return this.#create(`/api/sites/${siteId}`);
     }
-
     /** `DELETE` Permanently deletes a site and all its data. Requires admin/owner role. */
-    deleteSite(siteId: number): URL {
+    deleteSite(siteId) {
         return this.#create(`/api/sites/${siteId}`);
     }
-
     /** `PUT` Updates site configuration settings. Requires admin/owner role. */
-    updateSiteConfig(siteId: number): URL {
+    updateSiteConfig(siteId) {
         return this.#create(`/api/sites/${siteId}/config`);
     }
-
     /** `GET` Returns the list of excluded IP addresses */
-    getExcludedIPs(siteId: number): URL {
+    getExcludedIPs(siteId) {
         return this.#create(`/api/sites/${siteId}/excluded-ips`);
     }
-
     /** `GET` Returns the list of excluded country codes */
-    getExcludedCountries(siteId: number): URL {
+    getExcludedCountries(siteId) {
         return this.#create(`/api/sites/${siteId}/excluded-counties`);
     }
-
     /** `GET` Returns the private link key configuration */
-    getPrivateLinkConfig(siteId: number): URL {
+    getPrivateLinkConfig(siteId) {
         return this.#create(`/api/sites/${siteId}/private-link-config`);
     }
-
     /** `POST` Generates or revokes a private link key. Requires admin/owner role. */
-    updatePrivateLinkConfig(siteId: number): URL {
+    updatePrivateLinkConfig(siteId) {
         return this.#create(`/api/sites/${siteId}/private-link-config`);
     }
-
     // ORGANIZATIONS
-
     /** `GET` Returns all organizations the authenticated user is a member of, including all members for each organization */
-    getMyOrganizations(): URL {
+    getMyOrganizations() {
         return this.#create(`/api/organizations`);
     }
-
     /** `POST` Creates a new site in an organization. Requires admin/owner role. */
-    createSite(organizationId: string): URL {
+    createSite(organizationId) {
         return this.#create(`/api/organizations/${organizationId}/sites`);
     }
-
     /** `GET` Returns all members of an organization with user details */
-    getOrganizationMembers(organizationId: string): URL {
+    getOrganizationMembers(organizationId) {
         return this.#create(`/api/organizations/${organizationId}/members`);
     }
-
     /** `POST` Adds a user to an organization with a specified role */
-    addOrganizationMember(organizationId: string): URL {
+    addOrganizationMember(organizationId) {
         return this.#create(`/api/organizations/${organizationId}/members`);
     }
-
     // OVERVIEW
-
     /** `GET` Returns high-level analytics metrics for a site */
-    getOverview(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getOverview(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/overview`, {
             start_date: startDate,
             end_date: endDate,
@@ -120,16 +83,8 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     /** `GET` Returns time-series analytics data broken down by time buckets */
-    getOverviewTimeSeries(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        bucket?: Bucket
-    ): URL {
+    getOverviewTimeSeries(siteId, startDate, endDate, timezone, filters, bucket) {
         return this.#create(`/api/sites/${siteId}/overview-bucketed`, {
             start_date: startDate,
             end_date: endDate,
@@ -138,18 +93,8 @@ export class Routes {
             bucket: bucket
         });
     }
-
     /** `GET` Returns dimensional analytics broken down by a specific parameter */
-    getMetric(
-        siteId: number,
-        parameter: Parameter,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        limit?: number,
-        page?: number
-    ): URL {
+    getMetric(siteId, parameter, startDate, endDate, timezone, filters, limit, page) {
         return this.#create(`/api/sites/${siteId}/metric`, {
             start_date: startDate,
             end_date: endDate,
@@ -160,27 +105,15 @@ export class Routes {
             page: page?.toString()
         });
     }
-
     /** `GET` Returns the count of active sessions within the specified time window */
-    getLiveVisitors(siteId: number, minutes?: number): URL {
+    getLiveVisitors(siteId, minutes) {
         return this.#create(`/api/sites/${siteId}/live-user-count`, {
             minutes: minutes?.toString()
         });
     }
-
     // EVENTS
-
     /** `GET` Returns a paginated list of events with cursor-based pagination */
-    getEvents(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        pageSize?: number,
-        sinceTimestamp?: Timestamp,
-        beforeTimestamp?: Timestamp
-    ): URL {
+    getEvents(siteId, startDate, endDate, timezone, filters, pageSize, sinceTimestamp, beforeTimestamp) {
         return this.#create(`/api/sites/${siteId}/events`, {
             start_date: startDate,
             end_date: endDate,
@@ -191,15 +124,8 @@ export class Routes {
             before_timestamp: beforeTimestamp
         });
     }
-
     /** `GET` Returns list of unique custom event names with counts */
-    getEventNames(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getEventNames(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/events/names`, {
             start_date: startDate,
             end_date: endDate,
@@ -207,16 +133,8 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     /** `GET` Returns property key-value pairs for a specific event */
-    getEventProperties(
-        siteId: number,
-        eventName: string,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getEventProperties(siteId, eventName, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/events/properties`, {
             start_date: startDate,
             end_date: endDate,
@@ -225,15 +143,8 @@ export class Routes {
             event_name: eventName
         });
     }
-
     /** `GET` Returns outbound link clicks with occurrence counts */
-    getOutboundLinks(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getOutboundLinks(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/events/outbound`, {
             start_date: startDate,
             end_date: endDate,
@@ -241,19 +152,9 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     // ERRORS
-
     /** `GET` Returns unique error messages with occurrence and session counts */
-    getErrorNames(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number
-    ): URL {
+    getErrorNames(siteId, startDate, endDate, timezone, filters, page, limit) {
         return this.#create(`/api/sites/${siteId}/error-names`, {
             start_date: startDate,
             end_date: endDate,
@@ -263,18 +164,8 @@ export class Routes {
             limit: limit?.toString()
         });
     }
-
     /** `GET` Returns individual error occurrences with context and stack traces */
-    getErrorEvents(
-        siteId: number,
-        errorMessage: string,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number
-    ): URL {
+    getErrorEvents(siteId, errorMessage, startDate, endDate, timezone, filters, page, limit) {
         return this.#create(`/api/sites/${siteId}/error-events`, {
             start_date: startDate,
             end_date: endDate,
@@ -285,17 +176,8 @@ export class Routes {
             errorMessage: errorMessage
         });
     }
-
     /** `GET` Returns error occurrence counts over time */
-    getErrorTimeSeries(
-        siteId: number,
-        errorMessage: string,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        bucket?: Bucket
-    ): URL {
+    getErrorTimeSeries(siteId, errorMessage, startDate, endDate, timezone, filters, bucket) {
         return this.#create(`/api/sites/${siteId}/error-bucketed`, {
             start_date: startDate,
             end_date: endDate,
@@ -305,21 +187,9 @@ export class Routes {
             errorMessage: errorMessage
         });
     }
-
     // GOALS
-
     /** `GET` Returns paginated list of goals with conversion metrics */
-    getGoals(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        pageSize?: number,
-        sortBy?: SortBy,
-        order?: Order
-    ): URL {
+    getGoals(siteId, startDate, endDate, timezone, filters, page, pageSize, sortBy, order) {
         return this.#create(`/api/sites/${siteId}/goals`, {
             start_date: startDate,
             end_date: endDate,
@@ -331,18 +201,8 @@ export class Routes {
             order: order
         });
     }
-
     /** `GET` Returns sessions that completed a specific goal */
-    getGoalSessions(
-        siteId: number,
-        goalId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number
-    ): URL {
+    getGoalSessions(siteId, goalId, startDate, endDate, timezone, filters, page, limit) {
         return this.#create(`/api/sites/${siteId}/goals/${goalId}/sessions`, {
             start_date: startDate,
             end_date: endDate,
@@ -352,37 +212,25 @@ export class Routes {
             limit: limit?.toString()
         });
     }
-
     /** `POST` Creates a new goal */
-    createGoal(siteId: number): URL {
+    createGoal(siteId) {
         return this.#create(`/api/sites/${siteId}/goals`);
     }
-
     /** `PUT` Updates an existing goal */
-    updateGoal(siteId: number, goalId: number): URL {
+    updateGoal(siteId, goalId) {
         return this.#create(`/api/sites/${siteId}/goals/${goalId}`);
     }
-
     /** `DELETE` Deletes a goal */
-    deleteGoal(siteId: number, goalId: number): URL {
+    deleteGoal(siteId, goalId) {
         return this.#create(`/api/sites/${siteId}/goals/${goalId}`);
     }
-
     // FUNNELS
-
     /** `GET` Returns all saved funnels for a site */
-    getFunnels(siteId: number): URL {
+    getFunnels(siteId) {
         return this.#create(`/api/sites/${siteId}/funnels`);
     }
-
     /** `GET` Analyzes funnel conversion data step-by-step */
-    analyzeFunnel(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    analyzeFunnel(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/funnels/analyze`, {
             start_date: startDate,
             end_date: endDate,
@@ -390,19 +238,8 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     /** `GET` Returns sessions that reached or dropped at a specific funnel step */
-    getFunnelStepSessions(
-        siteId: number,
-        stepNumber: number,
-        mode: Mode,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number
-    ): URL {
+    getFunnelStepSessions(siteId, stepNumber, mode, startDate, endDate, timezone, filters, page, limit) {
         return this.#create(`/api/sites/${siteId}/funnels/${stepNumber}/sessions`, {
             start_date: startDate,
             end_date: endDate,
@@ -413,27 +250,17 @@ export class Routes {
             limit: limit?.toString()
         });
     }
-
     /** `POST` Creates a saved funnel */
-    createFunnel(siteId: number): URL {
+    createFunnel(siteId) {
         return this.#create(`/api/sites/${siteId}/funnels`);
     }
-
     /** `DELETE` Deletes a saved funnel */
-    deleteFunnel(siteId: number, funnelId: number): URL {
+    deleteFunnel(siteId, funnelId) {
         return this.#create(`/api/sites/${siteId}/funnels/${funnelId}`);
     }
-
     // PERFORMANCE
-
     /** `GET` Returns aggregate Core Web Vitals metrics */
-    getPerformanceOverview(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getPerformanceOverview(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/performance/overview`, {
             start_date: startDate,
             end_date: endDate,
@@ -441,16 +268,8 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     /** `GET` Returns performance metrics over time */
-    getPerformanceTimeSeries(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        bucket?: Bucket
-    ): URL {
+    getPerformanceTimeSeries(siteId, startDate, endDate, timezone, filters, bucket) {
         return this.#create(`/api/sites/${siteId}/performance/time-series`, {
             start_date: startDate,
             end_date: endDate,
@@ -459,20 +278,8 @@ export class Routes {
             bucket: bucket
         });
     }
-
     /** `GET` Returns performance breakdown by dimension */
-    getPerformanceByDimension(
-        siteId: number,
-        dimension: Dimension,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number,
-        sortBy?: SortBy,
-        sortOrder?: Order
-    ): URL {
+    getPerformanceByDimension(siteId, dimension, startDate, endDate, timezone, filters, page, limit, sortBy, sortOrder) {
         return this.#create(`/api/sites/${siteId}/performance/by-dimension`, {
             start_date: startDate,
             end_date: endDate,
@@ -485,21 +292,9 @@ export class Routes {
             sort_order: sortOrder
         });
     }
-
     // SESSIONS
-
     /** `GET` Returns a paginated list of sessions */
-    getSessions(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        limit?: number,
-        userId?: string,
-        identifiedOnly?: boolean
-    ): URL {
+    getSessions(siteId, startDate, endDate, timezone, filters, page, limit, userId, identifiedOnly) {
         return this.#create(`/api/sites/${siteId}/sessions`, {
             start_date: startDate,
             end_date: endDate,
@@ -511,23 +306,15 @@ export class Routes {
             identified_only: identifiedOnly?.toString()
         });
     }
-
     /** `GET` Returns detailed session information with events */
-    getSession(siteId: number, sessionId: string, limit?: number, offset?: number): URL {
+    getSession(siteId, sessionId, limit, offset) {
         return this.#create(`/api/sites/${siteId}/sessions/${sessionId}`, {
             limit: limit?.toString(),
             offset: offset?.toString()
         });
     }
-
     /** `GET` Returns aggregated session locations for map visualization */
-    getSessionLocations(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>
-    ): URL {
+    getSessionLocations(siteId, startDate, endDate, timezone, filters) {
         return this.#create(`/api/sites/${siteId}/session-locations`, {
             start_date: startDate,
             end_date: endDate,
@@ -535,22 +322,9 @@ export class Routes {
             filters: filters !== undefined ? JSON.stringify(filters) : undefined
         });
     }
-
     // USERS
-
     /** `GET` Returns a paginated list of users */
-    getUsers(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        page?: number,
-        pageSize?: number,
-        sortBy?: SortBy,
-        sortOrder?: Order,
-        identifiedOnly?: boolean
-    ): URL {
+    getUsers(siteId, startDate, endDate, timezone, filters, page, pageSize, sortBy, sortOrder, identifiedOnly) {
         return this.#create(`/api/sites/${siteId}/users`, {
             start_date: startDate,
             end_date: endDate,
@@ -563,40 +337,27 @@ export class Routes {
             identified_only: identifiedOnly?.toString()
         });
     }
-
     /** `GET` Returns daily session counts for a specific user */
-    getUserSessionCount(siteId: number, userId: string, timezone?: TimeZone): URL {
+    getUserSessionCount(siteId, userId, timezone) {
         return this.#create(`/api/sites/${siteId}/users/session-count`, {
             user_id: userId,
             timezone: timezone
         });
     }
-
     /** `GET` Returns detailed user profile information */
-    getUserInfo(siteId: number, userId: string): URL {
+    getUserInfo(siteId, userId) {
         return this.#create(`/api/sites/${siteId}/users/${userId}`);
     }
-
     // MISC
-
     /** `GET` Returns cohort-based retention analysis */
-    getRetention(siteId: number, mode?: Mode, range?: number): URL {
+    getRetention(siteId, mode, range) {
         return this.#create(`/api/sites/${siteId}/retention`, {
             mode: mode,
             range: range?.toString()
         });
     }
-
     /** `GET` Returns most common page navigation paths */
-    getJourneys(
-        siteId: number,
-        startDate?: DateString,
-        endDate?: DateString,
-        timezone?: TimeZone,
-        filters?: Array<Filter>,
-        steps?: number,
-        limit?: number
-    ): URL {
+    getJourneys(siteId, startDate, endDate, timezone, filters, steps, limit) {
         return this.#create(`/api/sites/${siteId}/users`, {
             start_date: startDate,
             end_date: endDate,
@@ -607,3 +368,4 @@ export class Routes {
         });
     }
 }
+//# sourceMappingURL=endpoints.js.map

package/dist/endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../src/endpoints.ts"],"names":[],"mappings":"AAaA,gDAAgD;AAChD,MAAM,OAAO,MAAM;IACf,2CAA2C;IAC3C,KAAK,CAAM;IAEX;;;OAGG;IACH,YAAY,IAAS;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,IAAY,EAAE,OAA4C;QAC9D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC;QAEnD,IAAI,OAAO,EAAE,CAAC;YACV,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC;YAChC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClD,IAAI,KAAK,KAAK,SAAS;oBAAE,SAAS;gBAClC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAED,QAAQ;IAER,gDAAgD;IAChD,OAAO,CAAC,MAAc;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,uFAAuF;IACvF,UAAU,CAAC,MAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,4EAA4E;IAC5E,gBAAgB,CAAC,MAAc;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,sDAAsD;IACtD,cAAc,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,eAAe,CAAC,CAAC;IAC7D,CAAC;IAED,uDAAuD;IACvD,oBAAoB,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,oBAAoB,CAAC,CAAC;IAClE,CAAC;IAED,uDAAuD;IACvD,oBAAoB,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,sBAAsB,CAAC,CAAC;IACpE,CAAC;IAED,iFAAiF;IACjF,uBAAuB,CAAC,MAAc;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,sBAAsB,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IAEhB,yHAAyH;IACzH,kBAAkB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC9C,CAAC;IAED,+EAA+E;IAC/E,UAAU,CAAC,cAAsB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,cAAc,QAAQ,CAAC,CAAC;IACtE,CAAC;IAED,qEAAqE;IACrE,sBAAsB,CAAC,cAAsB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,cAAc,UAAU,CAAC,CAAC;IACxE,CAAC;IAED,kEAAkE;IAClE,qBAAqB,CAAC,cAAsB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,cAAc,UAAU,CAAC,CAAC;IACxE,CAAC;IAED,WAAW;IAEX,4DAA4D;IAC5D,WAAW,CACP,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,WAAW,EAAE;YACjD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,2EAA2E;IAC3E,qBAAqB,CACjB,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,MAAe;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,oBAAoB,EAAE;YAC1D,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;IAED,8EAA8E;IAC9E,SAAS,CACL,MAAc,EACd,SAAoB,EACpB,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,KAAc,EACd,IAAa;QAEb,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,SAAS,EAAE;YAC/C,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,SAAS,EAAE,SAAS;YACpB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;SACzB,CAAC,CAAC;IACP,CAAC;IAED,kFAAkF;IAClF,eAAe,CAAC,MAAc,EAAE,OAAgB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,kBAAkB,EAAE;YACxD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;SAC/B,CAAC,CAAC;IACP,CAAC;IAED,SAAS;IAET,4EAA4E;IAC5E,SAAS,CACL,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,QAAiB,EACjB,cAA0B,EAC1B,eAA2B;QAE3B,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,SAAS,EAAE;YAC/C,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE;YAC/B,eAAe,EAAE,cAAc;YAC/B,gBAAgB,EAAE,eAAe;SACpC,CAAC,CAAC;IACP,CAAC;IAED,kEAAkE;IAClE,aAAa,CACT,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,eAAe,EAAE;YACrD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,kEAAkE;IAClE,kBAAkB,CACd,MAAc,EACd,SAAiB,EACjB,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,oBAAoB,EAAE;YAC1D,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,UAAU,EAAE,SAAS;SACxB,CAAC,CAAC;IACP,CAAC;IAED,gEAAgE;IAChE,gBAAgB,CACZ,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,kBAAkB,EAAE;YACxD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,SAAS;IAET,6EAA6E;IAC7E,aAAa,CACT,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,cAAc,EAAE;YACpD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACP,CAAC;IAED,+EAA+E;IAC/E,cAAc,CACV,MAAc,EACd,YAAoB,EACpB,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,eAAe,EAAE;YACrD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,YAAY,EAAE,YAAY;SAC7B,CAAC,CAAC;IACP,CAAC;IAED,sDAAsD;IACtD,kBAAkB,CACd,MAAc,EACd,YAAoB,EACpB,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,MAAe;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,iBAAiB,EAAE;YACvD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,YAAY;SAC7B,CAAC,CAAC;IACP,CAAC;IAED,QAAQ;IAER,oEAAoE;IACpE,QAAQ,CACJ,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,QAAiB,EACjB,MAAe,EACf,KAAa;QAEb,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,QAAQ,EAAE;YAC9C,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE;YAC/B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,KAAK;SACf,CAAC,CAAC;IACP,CAAC;IAED,4DAA4D;IAC5D,eAAe,CACX,MAAc,EACd,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,MAAM,WAAW,EAAE;YACjE,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACP,CAAC;IAED,gCAAgC;IAChC,UAAU,CAAC,MAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,qCAAqC;IACrC,UAAU,CAAC,MAAc,EAAE,MAAc;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,8BAA8B;IAC9B,UAAU,CAAC,MAAc,EAAE,MAAc;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,UAAU;IAEV,iDAAiD;IACjD,UAAU,CAAC,MAAc;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,CAAC,CAAC;IACxD,CAAC;IAED,yDAAyD;IACzD,aAAa,CACT,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,kBAAkB,EAAE;YACxD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,+EAA+E;IAC/E,qBAAqB,CACjB,MAAc,EACd,UAAkB,EAClB,IAAU,EACV,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,YAAY,UAAU,WAAW,EAAE;YACvE,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACP,CAAC;IAED,oCAAoC;IACpC,YAAY,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,CAAC,CAAC;IACxD,CAAC;IAED,sCAAsC;IACtC,YAAY,CAAC,MAAc,EAAE,QAAgB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,YAAY,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,cAAc;IAEd,sDAAsD;IACtD,sBAAsB,CAClB,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,uBAAuB,EAAE;YAC7D,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,kDAAkD;IAClD,wBAAwB,CACpB,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,MAAe;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,0BAA0B,EAAE;YAChE,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;IAED,uDAAuD;IACvD,yBAAyB,CACrB,MAAc,EACd,SAAoB,EACpB,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc,EACd,MAAe,EACf,SAAiB;QAEjB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,2BAA2B,EAAE;YACjE,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,OAAO,EAAE,MAAM;YACf,UAAU,EAAE,SAAS;SACxB,CAAC,CAAC;IACP,CAAC;IAED,WAAW;IAEX,iDAAiD;IACjD,WAAW,CACP,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,KAAc,EACd,MAAe,EACf,cAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,WAAW,EAAE;YACjD,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,OAAO,EAAE,MAAM;YACf,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE;SAC9C,CAAC,CAAC;IACP,CAAC;IAED,6DAA6D;IAC7D,UAAU,CAAC,MAAc,EAAE,SAAiB,EAAE,KAAc,EAAE,MAAe;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,aAAa,SAAS,EAAE,EAAE;YAC9D,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE;SAC7B,CAAC,CAAC;IACP,CAAC;IAED,uEAAuE;IACvE,mBAAmB,CACf,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB;QAEvB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,oBAAoB,EAAE;YAC1D,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACP,CAAC;IAED,QAAQ;IAER,8CAA8C;IAC9C,QAAQ,CACJ,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,IAAa,EACb,QAAiB,EACjB,MAAe,EACf,SAAiB,EACjB,cAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,QAAQ,EAAE;YAC9C,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtB,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE;YAC/B,OAAO,EAAE,MAAM;YACf,UAAU,EAAE,SAAS;YACrB,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE;SAC9C,CAAC,CAAC;IACP,CAAC;IAED,6DAA6D;IAC7D,mBAAmB,CAAC,MAAc,EAAE,MAAc,EAAE,QAAmB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,sBAAsB,EAAE;YAC5D,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;IACP,CAAC;IAED,sDAAsD;IACtD,WAAW,CAAC,MAAc,EAAE,MAAc;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,UAAU,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,OAAO;IAEP,oDAAoD;IACpD,YAAY,CAAC,MAAc,EAAE,IAAW,EAAE,KAAc;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,YAAY,EAAE;YAClD,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACP,CAAC;IAED,sDAAsD;IACtD,WAAW,CACP,MAAc,EACd,SAAsB,EACtB,OAAoB,EACpB,QAAmB,EACnB,OAAuB,EACvB,KAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,MAAM,QAAQ,EAAE;YAC9C,UAAU,EAAE,SAAS;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACpE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;YACxB,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export type { Bucket, DateString, Dimension, Filter, FilterParameter, FilterType, Mode, Order, Parameter, SortBy, Timestamp, TimeZone } from './types.js';
+export { toDateString } from './utility.js';
+export { Routes } from './endpoints.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { toDateString } from './utility.js';
+export { Routes } from './endpoints.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A date with the format of `year-month-day`.
+ * Example: `2019-02-24`
+ */
+export type DateString = `${number}-${number}-${number}`;
+/**
+ * An ISO 8601 formatted timestamp.
+ * Example: `2024-01-31T14:00:00.000Z`
+ */
+export type Timestamp = string;
+/** List of timezones. */
+export type TimeZone = 'system' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Chicago' | 'America/New_York' | 'America/Halifax' | 'America/Sao_Paulo' | 'Atlantic/South_Georgia' | 'Atlantic/Azores' | 'UTC' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Europe/Helsinki' | 'Europe/Moscow' | 'Asia/Dubai' | 'Asia/Karachi' | 'Asia/Kolkata' | 'Asia/Dhaka' | 'Asia/Bangkok' | 'Asia/Singapore' | 'Asia/Shanghai' | 'Asia/Tokyo' | 'Australia/Sydney' | 'Pacific/Auckland';
+/** List of buckets. */
+export type Bucket = 'minute' | 'five_minutes' | 'ten_minutes' | 'fifteen_minutes' | 'hour' | 'day' | 'week' | 'month' | 'week' | 'year';
+/** List of parameters. */
+export type Parameter = 'pathname' | 'page_title' | 'country' | 'region' | 'city' | 'browser' | 'operating_system' | 'device_type' | 'referrer' | 'channel' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'language' | 'entry_page' | 'exit_page' | 'event_name';
+/** List of sort by choices. */
+export type SortBy = 'goalId' | 'name' | 'goalType' | 'createdAt' | 'first_seen' | 'last_seen' | 'pageviews' | 'sessions' | 'events';
+/** Lust of order choices. */
+export type Order = 'asc' | 'desc';
+/** List of modes. */
+export type Mode = 'day' | 'week' | 'reached' | 'dropped';
+/** List of dimensions. */
+export type Dimension = 'pathname' | 'country' | 'browser' | 'operating_system' | 'device_type';
+/** List of filter parameters. */
+export type FilterParameter = 'country' | 'region' | 'city' | 'browser' | 'operating_system' | 'device_type' | 'pathname' | 'referrer' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'channel' | 'entry_page' | 'exit_page' | 'language';
+/** List of filter types. */
+export type FilterType = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'regex';
+/** A filter object. */
+export interface Filter {
+    /** {@linkcode FilterParameter Parameter} of this filter. */
+    parameter: FilterParameter;
+    /** {@linkcode FilterType Type} of filter. */
+    type: FilterType;
+    /** Values of this filter. */
+    value: Array<string>;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/{src/utility.ts → dist/utility.d.ts}

@@ -1,10 +1,7 @@
 import type { DateString } from './types.js';
-
 /**
  * Converts a {@linkcode Date} to {@linkcode DateString}.
  * @param date The {@linkcode Date} to convert.
  * @returns The converted {@linkcode DateString}.
  */
-export function toDateString(date: Date): DateString {
-    return date.toISOString().split('T')[0] as DateString;
-}
+export declare function toDateString(date: Date): DateString;

package/dist/utility.js

@@ -0,0 +1,9 @@
+/**
+ * Converts a {@linkcode Date} to {@linkcode DateString}.
+ * @param date The {@linkcode Date} to convert.
+ * @returns The converted {@linkcode DateString}.
+ */
+export function toDateString(date) {
+    return date.toISOString().split('T')[0];
+}
+//# sourceMappingURL=utility.js.map

package/dist/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../src/utility.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,IAAU;IACnC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAe,CAAC;AAC1D,CAAC"}

package/package.json

@@ -1,9 +1,14 @@
 {
     "name": "rybbit.ts",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "type": "module",
     "module": "dist/index.js",
     "types": "dist/index.d.ts",
+    "license": "MIT",
+    "homepage": "https://github.com/jacobhumston/rybbit.ts",
+    "repository": {
+        "url": "https://github.com/jacobhumston/rybbit.ts"
+    },
     "scripts": {
         "format": "bunx prettier --write --cache .",
         "compile": "del dist/ && bunx tsc",
@@ -19,7 +24,7 @@
         "typescript": "^5.9.3"
     },
     "files": [
-        "src/",
+        "dist/",
         "LICENSE",
         "README.md",
         "package.json"

package/src/index.ts

@@ -1,16 +0,0 @@
-export type {
-    Bucket,
-    DateString,
-    Dimension,
-    Filter,
-    FilterParameter,
-    FilterType,
-    Mode,
-    Order,
-    Parameter,
-    SortBy,
-    Timestamp,
-    TimeZone
-} from './types.js';
-export { toDateString } from './utility.js';
-export { Routes } from './endpoints.js';

package/src/types.ts

@@ -1,130 +0,0 @@
-/**
- * A date with the format of `year-month-day`.
- * Example: `2019-02-24`
- */
-export type DateString = `${number}-${number}-${number}`;
-
-/**
- * An ISO 8601 formatted timestamp.
- * Example: `2024-01-31T14:00:00.000Z`
- */
-export type Timestamp = string;
-
-/** List of timezones. */
-export type TimeZone =
-    | 'system'
-    | 'Pacific/Honolulu'
-    | 'America/Anchorage'
-    | 'America/Los_Angeles'
-    | 'America/Denver'
-    | 'America/Chicago'
-    | 'America/New_York'
-    | 'America/Halifax'
-    | 'America/Sao_Paulo'
-    | 'Atlantic/South_Georgia'
-    | 'Atlantic/Azores'
-    | 'UTC'
-    | 'Europe/London'
-    | 'Europe/Paris'
-    | 'Europe/Berlin'
-    | 'Europe/Helsinki'
-    | 'Europe/Moscow'
-    | 'Asia/Dubai'
-    | 'Asia/Karachi'
-    | 'Asia/Kolkata'
-    | 'Asia/Dhaka'
-    | 'Asia/Bangkok'
-    | 'Asia/Singapore'
-    | 'Asia/Shanghai'
-    | 'Asia/Tokyo'
-    | 'Australia/Sydney'
-    | 'Pacific/Auckland';
-
-/** List of buckets. */
-export type Bucket =
-    | 'minute'
-    | 'five_minutes'
-    | 'ten_minutes'
-    | 'fifteen_minutes'
-    | 'hour'
-    | 'day'
-    | 'week'
-    | 'month'
-    | 'week'
-    | 'year';
-
-/** List of parameters. */
-export type Parameter =
-    | 'pathname'
-    | 'page_title'
-    | 'country'
-    | 'region'
-    | 'city'
-    | 'browser'
-    | 'operating_system'
-    | 'device_type'
-    | 'referrer'
-    | 'channel'
-    | 'utm_source'
-    | 'utm_medium'
-    | 'utm_campaign'
-    | 'utm_term'
-    | 'utm_content'
-    | 'language'
-    | 'entry_page'
-    | 'exit_page'
-    | 'event_name';
-
-/** List of sort by choices. */
-export type SortBy =
-    | 'goalId'
-    | 'name'
-    | 'goalType'
-    | 'createdAt'
-    | 'first_seen'
-    | 'last_seen'
-    | 'pageviews'
-    | 'sessions'
-    | 'events';
-
-/** Lust of order choices. */
-export type Order = 'asc' | 'desc';
-
-/** List of modes. */
-export type Mode = 'day' | 'week' | 'reached' | 'dropped';
-
-/** List of dimensions. */
-export type Dimension = 'pathname' | 'country' | 'browser' | 'operating_system' | 'device_type';
-
-/** List of filter parameters. */
-export type FilterParameter =
-    | 'country'
-    | 'region'
-    | 'city'
-    | 'browser'
-    | 'operating_system'
-    | 'device_type'
-    | 'pathname'
-    | 'referrer'
-    | 'utm_source'
-    | 'utm_medium'
-    | 'utm_campaign'
-    | 'channel'
-    | 'entry_page'
-    | 'exit_page'
-    | 'language';
-
-/** List of filter types. */
-export type FilterType = 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'regex';
-
-/** A filter object. */
-export interface Filter {
-    /** {@linkcode FilterParameter Parameter} of this filter. */
-    parameter: FilterParameter;
-
-    /** {@linkcode FilterType Type} of filter. */
-    type: FilterType;
-
-    /** Values of this filter. */
-    value: Array<string>;
-}