@rachelallyson/planning-center-check-ins-ts 1.0.0 → 3.0.0

package/dist/modules/labels.js

@@ -10,99 +10,48 @@ class LabelsModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all labels with optional filtering
+     * Get all labels across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
-        const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
-            params.include = options.include.join(',');
-        }
-        if (options.perPage) {
-            params.per_page = options.perPage;
-        }
-        if (options.page) {
-            params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/labels', params);
+        const params = this.buildLabelsParams(options);
+        return this.getAllPages('/labels', params);
     }
     /**
-     * Get a single label by ID
+     * Get a single page of labels with optional filtering and pagination.
      */
-    async getById(id, include) {
-        const params = {};
-        if (include) {
-            params.include = include.join(',');
-        }
-        return this.getSingle(`/check-ins/v2/labels/${id}`, params);
+    async getPage(options = {}) {
+        return this.getList('/labels', {
+            where: options.where,
+            include: options.include,
+            per_page: options.perPage,
+            page: options.page,
+        });
     }
-    // ===== Event Labels =====
-    /**
-     * Get all event labels
-     */
-    async getEventLabels(options = {}) {
+    buildLabelsParams(options) {
         const params = {};
         if (options.where) {
             Object.entries(options.where).forEach(([key, value]) => {
                 params[`where[${key}]`] = value;
             });
         }
-        if (options.include) {
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/event_labels', params);
+        return params;
     }
     /**
-     * Get a single event label by ID
-     */
-    async getEventLabelById(id, include) {
-        const params = {};
-        if (include) {
-            params.include = include.join(',');
-        }
-        return this.getSingle(`/check-ins/v2/event_labels/${id}`, params);
-    }
-    // ===== Location Labels =====
-    /**
-     * Get all location labels
-     */
-    async getLocationLabels(options = {}) {
-        const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
-            params.include = options.include.join(',');
-        }
-        if (options.perPage) {
-            params.per_page = options.perPage;
-        }
-        if (options.page) {
-            params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/location_labels', params);
-    }
-    /**
-     * Get a single location label by ID
+     * Get a single label by ID
      */
-    async getLocationLabelById(id, include) {
+    async getById(id, include) {
         const params = {};
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/location_labels/${id}`, params);
+        return this.getSingle(`/labels/${id}`, params);
     }
 }
 exports.LabelsModule = LabelsModule;

package/dist/modules/locations.d.ts

@@ -2,7 +2,7 @@
  * Locations Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { LocationResource, LocationEventPeriodResource, LocationEventTimeResource, LocationLabelResource } from '../types';
 export interface LocationsListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface LocationsListOptions {
 export declare class LocationsModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all locations with optional filtering
+     * Get all locations across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: LocationsListOptions): Promise<{
+    getAll(options?: LocationsListOptions): Promise<PaginationResult<LocationResource>>;
+    /**
+     * Get a single page of locations with optional filtering and pagination.
+     */
+    getPage(options?: LocationsListOptions): Promise<{
         data: LocationResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single location by ID
      */
@@ -41,7 +47,10 @@ export declare class LocationsModule extends BaseModule {
         links?: any;
     }>;
     /**
-     * Get location labels for a location
+     * Get location labels for a location.
+     * Note: The API docs list location_labels only under check_ins (check_in_id + location_id).
+     * If this returns empty or 404, use checkIns.getLocationLabels(checkInId, locationId) instead.
+     * @see https://developer.planning.center/docs/#/apps/check-ins/2025-05-28/vertices/location_label
      */
     getLocationLabels(locationId: string): Promise<{
         data: LocationLabelResource[];

package/dist/modules/locations.js

@@ -10,25 +10,31 @@ class LocationsModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all locations with optional filtering
+     * Get all locations across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
+        const params = this.buildParams(options);
+        return this.getAllPages('/locations', params);
+    }
+    /**
+     * Get a single page of locations with optional filtering and pagination.
+     */
+    async getPage(options = {}) {
+        const params = this.buildParams(options);
+        return this.getList('/locations', params);
+    }
+    buildParams(options) {
         const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
+        if (options.where)
+            Object.entries(options.where).forEach(([k, v]) => { params[`where[${k}]`] = v; });
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/locations', params);
+        return params;
     }
     /**
      * Get a single location by ID
@@ -38,26 +44,29 @@ class LocationsModule extends planning_center_base_ts_1.BaseModule {
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/locations/${id}`, params);
+        return this.getSingle(`/locations/${id}`, params);
     }
     // ===== Associations =====
     /**
      * Get location event periods for a location
      */
     async getLocationEventPeriods(locationId) {
-        return this.getList(`/check-ins/v2/locations/${locationId}/location_event_periods`);
+        return this.getList(`/locations/${locationId}/location_event_periods`);
     }
     /**
      * Get location event times for a location
      */
     async getLocationEventTimes(locationId) {
-        return this.getList(`/check-ins/v2/locations/${locationId}/location_event_times`);
+        return this.getList(`/locations/${locationId}/location_event_times`);
     }
     /**
-     * Get location labels for a location
+     * Get location labels for a location.
+     * Note: The API docs list location_labels only under check_ins (check_in_id + location_id).
+     * If this returns empty or 404, use checkIns.getLocationLabels(checkInId, locationId) instead.
+     * @see https://developer.planning.center/docs/#/apps/check-ins/2025-05-28/vertices/location_label
      */
     async getLocationLabels(locationId) {
-        return this.getList(`/check-ins/v2/locations/${locationId}/location_labels`);
+        return this.getList(`/locations/${locationId}/location_labels`);
     }
 }
 exports.LocationsModule = LocationsModule;

package/dist/modules/options.d.ts

@@ -2,7 +2,7 @@
  * Options Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { OptionResource } from '../types';
 export interface OptionsListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface OptionsListOptions {
 export declare class OptionsModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all options with optional filtering
+     * Get all options across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: OptionsListOptions): Promise<{
+    getAll(options?: OptionsListOptions): Promise<PaginationResult<OptionResource>>;
+    /**
+     * Get a single page of options with optional filtering and pagination.
+     */
+    getPage(options?: OptionsListOptions): Promise<{
         data: OptionResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single option by ID
      */

package/dist/modules/options.js

@@ -10,25 +10,31 @@ class OptionsModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all options with optional filtering
+     * Get all options across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
+        const params = this.buildParams(options);
+        return this.getAllPages('/options', params);
+    }
+    /**
+     * Get a single page of options with optional filtering and pagination.
+     */
+    async getPage(options = {}) {
+        const params = this.buildParams(options);
+        return this.getList('/options', params);
+    }
+    buildParams(options) {
         const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
+        if (options.where)
+            Object.entries(options.where).forEach(([k, v]) => { params[`where[${k}]`] = v; });
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/options', params);
+        return params;
     }
     /**
      * Get a single option by ID
@@ -38,7 +44,7 @@ class OptionsModule extends planning_center_base_ts_1.BaseModule {
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/options/${id}`, params);
+        return this.getSingle(`/options/${id}`, params);
     }
 }
 exports.OptionsModule = OptionsModule;

package/dist/modules/organization.js

@@ -13,7 +13,8 @@ class OrganizationModule extends planning_center_base_ts_1.BaseModule {
      * Get organization information
      */
     async get() {
-        return this.getSingle('/check-ins/v2/organization');
+        // Organization is the root of the Check-Ins API (baseURL is .../check-ins/v2)
+        return this.getSingle('/');
     }
 }
 exports.OrganizationModule = OrganizationModule;

package/dist/modules/passes.d.ts

@@ -2,7 +2,7 @@
  * Passes Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { PassResource } from '../types';
 export interface PassesListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface PassesListOptions {
 export declare class PassesModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all passes with optional filtering
+     * Get all passes across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: PassesListOptions): Promise<{
+    getAll(options?: PassesListOptions): Promise<PaginationResult<PassResource>>;
+    /**
+     * Get a single page of passes with optional filtering and pagination.
+     */
+    getPage(options?: PassesListOptions): Promise<{
         data: PassResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single pass by ID
      */

package/dist/modules/passes.js

@@ -10,25 +10,31 @@ class PassesModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all passes with optional filtering
+     * Get all passes across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
+        const params = this.buildParams(options);
+        return this.getAllPages('/passes', params);
+    }
+    /**
+     * Get a single page of passes with optional filtering and pagination.
+     */
+    async getPage(options = {}) {
+        const params = this.buildParams(options);
+        return this.getList('/passes', params);
+    }
+    buildParams(options) {
         const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
+        if (options.where)
+            Object.entries(options.where).forEach(([k, v]) => { params[`where[${k}]`] = v; });
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/passes', params);
+        return params;
     }
     /**
      * Get a single pass by ID
@@ -38,7 +44,7 @@ class PassesModule extends planning_center_base_ts_1.BaseModule {
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/passes/${id}`, params);
+        return this.getSingle(`/passes/${id}`, params);
     }
 }
 exports.PassesModule = PassesModule;

package/dist/modules/pre-checks.d.ts

@@ -2,7 +2,7 @@
  * PreChecks Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { PreCheckResource } from '../types';
 export interface PreChecksListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface PreChecksListOptions {
 export declare class PreChecksModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all pre-checks with optional filtering
+     * Get all pre-checks across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: PreChecksListOptions): Promise<{
+    getAll(options?: PreChecksListOptions): Promise<PaginationResult<PreCheckResource>>;
+    /**
+     * Get a single page of pre-checks with optional filtering and pagination.
+     */
+    getPage(options?: PreChecksListOptions): Promise<{
         data: PreCheckResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single pre-check by ID
      */

package/dist/modules/pre-checks.js

@@ -10,25 +10,31 @@ class PreChecksModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all pre-checks with optional filtering
+     * Get all pre-checks across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
+        const params = this.buildParams(options);
+        return this.getAllPages('/pre_checks', params);
+    }
+    /**
+     * Get a single page of pre-checks with optional filtering and pagination.
+     */
+    async getPage(options = {}) {
+        const params = this.buildParams(options);
+        return this.getList('/pre_checks', params);
+    }
+    buildParams(options) {
         const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
+        if (options.where)
+            Object.entries(options.where).forEach(([k, v]) => { params[`where[${k}]`] = v; });
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/pre_checks', params);
+        return params;
     }
     /**
      * Get a single pre-check by ID
@@ -38,7 +44,7 @@ class PreChecksModule extends planning_center_base_ts_1.BaseModule {
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/pre_checks/${id}`, params);
+        return this.getSingle(`/pre_checks/${id}`, params);
     }
 }
 exports.PreChecksModule = PreChecksModule;

package/dist/modules/roster-list-persons.d.ts

@@ -2,7 +2,7 @@
  * RosterListPersons Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { RosterListPersonResource } from '../types';
 export interface RosterListPersonsListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface RosterListPersonsListOptions {
 export declare class RosterListPersonsModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all roster list persons with optional filtering
+     * Get all roster list persons across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: RosterListPersonsListOptions): Promise<{
+    getAll(options?: RosterListPersonsListOptions): Promise<PaginationResult<RosterListPersonResource>>;
+    /**
+     * Get a single page of roster list persons with optional filtering and pagination.
+     */
+    getPage(options?: RosterListPersonsListOptions): Promise<{
         data: RosterListPersonResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single roster list person by ID
      */

package/dist/modules/roster-list-persons.js

@@ -10,25 +10,31 @@ class RosterListPersonsModule extends planning_center_base_ts_1.BaseModule {
         super(httpClient, paginationHelper, eventEmitter);
     }
     /**
-     * Get all roster list persons with optional filtering
+     * Get all roster list persons across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
     async getAll(options = {}) {
+        const params = this.buildParams(options);
+        return this.getAllPages('/roster_list_persons', params);
+    }
+    /**
+     * Get a single page of roster list persons with optional filtering and pagination.
+     */
+    async getPage(options = {}) {
+        const params = this.buildParams(options);
+        return this.getList('/roster_list_persons', params);
+    }
+    buildParams(options) {
         const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
+        if (options.where)
+            Object.entries(options.where).forEach(([k, v]) => { params[`where[${k}]`] = v; });
+        if (options.include)
             params.include = options.include.join(',');
-        }
-        if (options.perPage) {
+        if (options.perPage != null)
             params.per_page = options.perPage;
-        }
-        if (options.page) {
+        if (options.page != null)
             params.page = options.page;
-        }
-        return this.getList('/check-ins/v2/roster_list_persons', params);
+        return params;
     }
     /**
      * Get a single roster list person by ID
@@ -38,7 +44,7 @@ class RosterListPersonsModule extends planning_center_base_ts_1.BaseModule {
         if (include) {
             params.include = include.join(',');
         }
-        return this.getSingle(`/check-ins/v2/roster_list_persons/${id}`, params);
+        return this.getSingle(`/roster_list_persons/${id}`, params);
     }
 }
 exports.RosterListPersonsModule = RosterListPersonsModule;

package/dist/modules/stations.d.ts

@@ -2,7 +2,7 @@
  * Stations Module for Check-Ins API
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationResult, Meta, TopLevelLinks } from '@rachelallyson/planning-center-base-ts';
 import type { StationResource } from '../types';
 export interface StationsListOptions {
     where?: Record<string, any>;
@@ -13,13 +13,19 @@ export interface StationsListOptions {
 export declare class StationsModule extends BaseModule {
     constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all stations with optional filtering
+     * Get all stations across all pages with optional filtering.
+     * Use getPage() when you need a single page or custom perPage/page.
      */
-    getAll(options?: StationsListOptions): Promise<{
+    getAll(options?: StationsListOptions): Promise<PaginationResult<StationResource>>;
+    /**
+     * Get a single page of stations with optional filtering and pagination.
+     */
+    getPage(options?: StationsListOptions): Promise<{
         data: StationResource[];
-        meta?: any;
-        links?: any;
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
+    private buildParams;
     /**
      * Get a single station by ID
      */