@rachelallyson/planning-center-people-ts 2.14.1 → 3.1.0

package/dist/modules/reports.d.ts

@@ -1,53 +1,39 @@
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient } from '@rachelallyson/planning-center-base-ts';
-import type { PaginationHelper } from '@rachelallyson/planning-center-base-ts';
-import type { PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
-import type { PaginationOptions, PaginationResult } from '@rachelallyson/planning-center-base-ts';
-import type { ReportResource, ReportAttributes, ReportsList, PersonResource } from '../types';
+import type { ReportResource, ReportAttributes } from '../types';
+import type { ReportListOptions, ReportPageOptions } from '../types/api-options';
 /**
  * Reports module for managing report-related operations
  */
 export declare class ReportsModule extends BaseModule {
-    constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all reports
+     * Get all reports across all pages
      */
-    getAll(params?: {
-        where?: Record<string, any>;
-        include?: string[];
-        per_page?: number;
-        page?: number;
-    }): Promise<ReportsList>;
+    getAll(params?: ReportListOptions): Promise<import("@rachelallyson/planning-center-base-ts").PaginationResult<ReportResource, import("@rachelallyson/planning-center-base-ts").ResourceObject<string, any, any>, Record<string, never>>>;
+    /**
+     * Get a single page of reports with optional filtering and pagination control
+     * Use this when you need a specific page or want to limit the number of results
+     * @param params - List parameters including where, include, perPage, page, and order
+     * @returns A single page of results with meta and links for pagination
+     */
+    getPage(params?: ReportPageOptions): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Report", ReportAttributes, import("../types").ReportRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
+    }>;
     /**
      * Get a specific report by ID
      */
-    getById(id: string, include?: string[]): Promise<ReportResource>;
+    getById(id: string, include?: string[]): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Report", ReportAttributes, import("../types").ReportRelationships>>;
     /**
      * Create a new report
      */
-    create(data: ReportAttributes): Promise<ReportResource>;
+    create(data: ReportAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Report", ReportAttributes, import("../types").ReportRelationships>>;
     /**
      * Update an existing report
      */
-    update(id: string, data: Partial<ReportAttributes>): Promise<ReportResource>;
+    update(id: string, data: Partial<ReportAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Report", ReportAttributes, import("../types").ReportRelationships>>;
     /**
      * Delete a report
      */
     delete(id: string): Promise<void>;
-    /**
-     * Get the person who created a report
-     */
-    getCreatedBy(reportId: string): Promise<PersonResource>;
-    /**
-     * Get the person who last updated a report
-     */
-    getUpdatedBy(reportId: string): Promise<PersonResource>;
-    /**
-     * Get all reports with pagination support
-     */
-    getAllPagesPaginated(params?: {
-        where?: Record<string, any>;
-        include?: string[];
-        per_page?: number;
-    }, paginationOptions?: PaginationOptions): Promise<PaginationResult<ReportResource>>;
 }

package/dist/modules/reports.js

@@ -6,72 +6,60 @@ const planning_center_base_ts_1 = require("@rachelallyson/planning-center-base-t
  * Reports module for managing report-related operations
  */
 class ReportsModule extends planning_center_base_ts_1.BaseModule {
-    constructor(httpClient, paginationHelper, eventEmitter) {
-        super(httpClient, paginationHelper, eventEmitter);
-    }
     /**
-     * Get all reports
+     * Get all reports across all pages
      */
     async getAll(params) {
-        return this.getList('/reports', params);
+        this.debugLog('reports.getAll', { params });
+        return await this.getAllPages('/reports', {
+            where: params?.where,
+            include: params?.include,
+            order: params?.order
+        });
+    }
+    /**
+     * Get a single page of reports with optional filtering and pagination control
+     * Use this when you need a specific page or want to limit the number of results
+     * @param params - List parameters including where, include, perPage, page, and order
+     * @returns A single page of results with meta and links for pagination
+     */
+    async getPage(params) {
+        this.debugLog('reports.getPage', { params });
+        return this.getList('/reports', {
+            where: params?.where,
+            include: params?.include,
+            per_page: params?.perPage,
+            page: params?.page,
+            order: params?.order
+        });
     }
     /**
      * Get a specific report by ID
      */
     async getById(id, include) {
-        const params = {};
-        if (include) {
-            params.include = include.join(',');
-        }
-        return this.getSingle(`/reports/${id}`, params);
+        this.debugLog('reports.getById', { id, include });
+        return this.getSingle(`/reports/${id}`, include);
     }
     /**
      * Create a new report
      */
     async create(data) {
+        this.debugLog('reports.create', { data });
         return this.createResource('/reports', data);
     }
     /**
      * Update an existing report
      */
     async update(id, data) {
+        this.debugLog('reports.update', { id, data });
         return this.updateResource(`/reports/${id}`, data);
     }
     /**
      * Delete a report
      */
     async delete(id) {
+        this.debugLog('reports.delete', { id });
         return this.deleteResource(`/reports/${id}`);
     }
-    /**
-     * Get the person who created a report
-     */
-    async getCreatedBy(reportId) {
-        return this.getSingle(`/reports/${reportId}/created_by`);
-    }
-    /**
-     * Get the person who last updated a report
-     */
-    async getUpdatedBy(reportId) {
-        return this.getSingle(`/reports/${reportId}/updated_by`);
-    }
-    /**
-     * Get all reports with pagination support
-     */
-    async getAllPagesPaginated(params, paginationOptions) {
-        const queryParams = {};
-        if (params?.where) {
-            Object.entries(params.where).forEach(([key, value]) => {
-                queryParams[`where[${key}]`] = value;
-            });
-        }
-        if (params?.include) {
-            queryParams.include = params.include.join(',');
-        }
-        if (params?.per_page) {
-            queryParams.per_page = params.per_page;
-        }
-        return this.getAllPages('/reports', queryParams, paginationOptions);
-    }
 }
 exports.ReportsModule = ReportsModule;

package/dist/modules/service-time.d.ts

@@ -1,46 +1,41 @@
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient } from '@rachelallyson/planning-center-base-ts';
-import type { PaginationHelper } from '@rachelallyson/planning-center-base-ts';
-import type { PcoEventEmitter } from '@rachelallyson/planning-center-base-ts';
-import type { PaginationOptions, PaginationResult } from '@rachelallyson/planning-center-base-ts';
-import type { ServiceTimeResource, ServiceTimeAttributes, ServiceTimesList } from '../types';
+import type { ServiceTimeResource, ServiceTimeAttributes } from '../types';
+import type { ServiceTimeListOptions, ServiceTimePageOptions } from '../types/api-options';
 /**
  * ServiceTime module for managing service time-related operations
  * ServiceTimes are campus-scoped resources
  */
 export declare class ServiceTimeModule extends BaseModule {
-    constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
     /**
-     * Get all service times for a specific campus
+     * Get all service times for a specific campus across all pages
      */
-    getAll(campusId: string, params?: {
-        where?: Record<string, any>;
-        include?: string[];
-        per_page?: number;
-        page?: number;
-    }): Promise<ServiceTimesList>;
+    getAll(campusId: string, params?: ServiceTimeListOptions): Promise<import("@rachelallyson/planning-center-base-ts").PaginationResult<ServiceTimeResource, import("@rachelallyson/planning-center-base-ts").ResourceObject<string, any, any>, Record<string, never>>>;
+    /**
+     * Get a single page of service times for a campus with optional filtering and pagination control
+     * Use this when you need a specific page or want to limit the number of results
+     * @param campusId - The campus ID
+     * @param params - List parameters including where, include, perPage, page, and order
+     * @returns A single page of results with meta and links for pagination
+     */
+    getPage(campusId: string, params?: ServiceTimePageOptions): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"ServiceTime", ServiceTimeAttributes, import("../types").ServiceTimeRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
+    }>;
     /**
      * Get a specific service time by ID for a campus
      */
-    getById(campusId: string, id: string, include?: string[]): Promise<ServiceTimeResource>;
+    getById(campusId: string, id: string, include?: string[]): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"ServiceTime", ServiceTimeAttributes, import("../types").ServiceTimeRelationships>>;
     /**
      * Create a new service time for a campus
      */
-    create(campusId: string, data: ServiceTimeAttributes): Promise<ServiceTimeResource>;
+    create(campusId: string, data: ServiceTimeAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"ServiceTime", ServiceTimeAttributes, import("../types").ServiceTimeRelationships>>;
     /**
      * Update an existing service time for a campus
      */
-    update(campusId: string, id: string, data: Partial<ServiceTimeAttributes>): Promise<ServiceTimeResource>;
+    update(campusId: string, id: string, data: Partial<ServiceTimeAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"ServiceTime", ServiceTimeAttributes, import("../types").ServiceTimeRelationships>>;
     /**
      * Delete a service time for a campus
      */
     delete(campusId: string, id: string): Promise<void>;
-    /**
-     * Get all service times for a campus with pagination support
-     */
-    getAllPagesPaginated(campusId: string, params?: {
-        where?: Record<string, any>;
-        include?: string[];
-        per_page?: number;
-    }, paginationOptions?: PaginationOptions): Promise<PaginationResult<ServiceTimeResource>>;
 }

package/dist/modules/service-time.js

@@ -7,60 +7,60 @@ const planning_center_base_ts_1 = require("@rachelallyson/planning-center-base-t
  * ServiceTimes are campus-scoped resources
  */
 class ServiceTimeModule extends planning_center_base_ts_1.BaseModule {
-    constructor(httpClient, paginationHelper, eventEmitter) {
-        super(httpClient, paginationHelper, eventEmitter);
-    }
     /**
-     * Get all service times for a specific campus
+     * Get all service times for a specific campus across all pages
      */
     async getAll(campusId, params) {
-        return this.getList(`/campuses/${campusId}/service_times`, params);
+        this.debugLog('serviceTime.getAll', { campusId, params });
+        return this.getAllPages(`/campuses/${campusId}/service_times`, {
+            where: params?.where,
+            include: params?.include,
+            order: params?.order
+        });
+    }
+    /**
+     * Get a single page of service times for a campus with optional filtering and pagination control
+     * Use this when you need a specific page or want to limit the number of results
+     * @param campusId - The campus ID
+     * @param params - List parameters including where, include, perPage, page, and order
+     * @returns A single page of results with meta and links for pagination
+     */
+    async getPage(campusId, params) {
+        return this.getList(`/campuses/${campusId}/service_times`, {
+            where: params?.where,
+            include: params?.include,
+            per_page: params?.perPage,
+            page: params?.page,
+            order: params?.order
+        });
     }
     /**
      * Get a specific service time by ID for a campus
      */
     async getById(campusId, id, include) {
-        const params = {};
-        if (include) {
-            params.include = include.join(',');
-        }
-        return this.getSingle(`/campuses/${campusId}/service_times/${id}`, params);
+        this.debugLog('serviceTime.getById', { campusId, id, include });
+        return this.getSingle(`/campuses/${campusId}/service_times/${id}`, include);
     }
     /**
      * Create a new service time for a campus
      */
     async create(campusId, data) {
+        this.debugLog('serviceTime.create', { campusId, data });
         return this.createResource(`/campuses/${campusId}/service_times`, data);
     }
     /**
      * Update an existing service time for a campus
      */
     async update(campusId, id, data) {
+        this.debugLog('serviceTime.update', { campusId, id, data });
         return this.updateResource(`/campuses/${campusId}/service_times/${id}`, data);
     }
     /**
      * Delete a service time for a campus
      */
     async delete(campusId, id) {
+        this.debugLog('serviceTime.delete', { campusId, id });
         return this.deleteResource(`/campuses/${campusId}/service_times/${id}`);
     }
-    /**
-     * Get all service times for a campus with pagination support
-     */
-    async getAllPagesPaginated(campusId, params, paginationOptions) {
-        const queryParams = {};
-        if (params?.where) {
-            Object.entries(params.where).forEach(([key, value]) => {
-                queryParams[`where[${key}]`] = value;
-            });
-        }
-        if (params?.include) {
-            queryParams.include = params.include.join(',');
-        }
-        if (params?.per_page) {
-            queryParams.per_page = params.per_page;
-        }
-        return this.getAllPages(`/campuses/${campusId}/service_times`, queryParams, paginationOptions);
-    }
 }
 exports.ServiceTimeModule = ServiceTimeModule;

package/dist/modules/workflows.d.ts

@@ -2,14 +2,9 @@
  * v2.0.0 Workflows Module
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PaginationOptions, PaginationResult } from '@rachelallyson/planning-center-base-ts';
-import type { WorkflowResource, WorkflowAttributes, WorkflowCardResource, WorkflowCardAssignableAttributes, WorkflowCardSnoozeAttributes, WorkflowCardEmailAttributes, WorkflowCardNoteResource, WorkflowCardNoteAttributes } from '../types';
-export interface WorkflowListOptions {
-    where?: Record<string, any>;
-    include?: string[];
-    perPage?: number;
-    page?: number;
-}
+import type { WorkflowResource, WorkflowAttributes, WorkflowCardResource, WorkflowCardAttributes, WorkflowCardAssignableAttributes, WorkflowCardSnoozeAttributes, WorkflowCardEmailAttributes, WorkflowCardNoteResource, WorkflowCardNoteAttributes, Meta, TopLevelLinks } from '../types';
+import type { WorkflowListOptions, WorkflowPageOptions } from '../types/api-options';
+export type { WorkflowListOptions };
 export interface AddPersonToWorkflowOptions {
     note?: string;
     skipIfExists?: boolean;
@@ -18,73 +13,73 @@ export interface AddPersonToWorkflowOptions {
 }
 export declare class WorkflowsModule extends BaseModule {
     /**
-     * Get all workflows
+     * Get all workflows across all pages
      */
-    getAll(options?: WorkflowListOptions): Promise<{
-        data: WorkflowResource[];
-        meta?: any;
-        links?: any;
-    }>;
+    getAll(options?: WorkflowListOptions): Promise<import("@rachelallyson/planning-center-base-ts").PaginationResult<WorkflowResource, import("@rachelallyson/planning-center-base-ts").ResourceObject<string, any, any>, Record<string, never>>>;
     /**
-     * Get all workflows across all pages
+     * Get a single page of workflows with optional filtering and pagination control
+     * Use this when you need a specific page or want to limit the number of results
+     * @param options - List options including where, include, perPage, and page
+     * @returns A single page of results with meta and links for pagination
      */
-    getAllPagesPaginated(options?: WorkflowListOptions, paginationOptions?: PaginationOptions): Promise<PaginationResult<WorkflowResource>>;
+    getPage(options?: WorkflowPageOptions): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Workflow", WorkflowAttributes, import("../types").WorkflowRelationships, Record<string, never>>[];
+        meta?: Meta;
+        links?: TopLevelLinks;
+    }>;
     /**
      * Get a single workflow by ID
      */
-    getById(id: string, include?: string[]): Promise<WorkflowResource>;
+    getById(id: string, include?: string[]): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Workflow", WorkflowAttributes, import("../types").WorkflowRelationships>>;
     /**
      * Create a workflow
      */
-    create(data: WorkflowAttributes): Promise<WorkflowResource>;
+    create(data: WorkflowAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Workflow", WorkflowAttributes, import("../types").WorkflowRelationships>>;
     /**
      * Update a workflow
      */
-    update(id: string, data: Partial<WorkflowAttributes>): Promise<WorkflowResource>;
+    update(id: string, data: Partial<WorkflowAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Workflow", WorkflowAttributes, import("../types").WorkflowRelationships>>;
     /**
      * Delete a workflow
      */
     delete(id: string): Promise<void>;
     /**
      * Get workflow cards for a person
-     */
-    getPersonWorkflowCards(personId: string): Promise<{
-        data: WorkflowCardResource[];
-        meta?: any;
-        links?: any;
+     * @param personId - The person ID
+     * @param options - Optional pagination options
+     */
+    getPersonWorkflowCards(personId: string, options?: {
+        perPage?: number;
+        page?: number;
+    }): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships, Record<string, never>>[];
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
     /**
      * Add a person to a workflow with smart duplicate detection
      */
-    addPersonToWorkflow(personId: string, workflowId: string, options?: AddPersonToWorkflowOptions): Promise<WorkflowCardResource>;
+    addPersonToWorkflow(personId: string, workflowId: string, options?: AddPersonToWorkflowOptions): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Create a workflow card
      */
-    createWorkflowCard(workflowId: string, personId: string): Promise<WorkflowCardResource>;
+    createWorkflowCard(workflowId: string, personId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Update a workflow card
      */
-    updateWorkflowCard(workflowCardId: string, data: Partial<WorkflowCardAssignableAttributes>, personId?: string): Promise<WorkflowCardResource>;
+    updateWorkflowCard(workflowCardId: string, data: Partial<WorkflowCardAssignableAttributes>, personId?: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Get workflow card notes
      */
     getWorkflowCardNotes(personId: string, workflowCardId: string): Promise<{
-        data: WorkflowCardNoteResource[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCardNote", WorkflowCardNoteAttributes, {}, Record<string, never>>[];
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
     /**
      * Create a workflow card note
      */
-    createWorkflowCardNote(personId: string, workflowCardId: string, data: WorkflowCardNoteAttributes): Promise<WorkflowCardNoteResource>;
-    /**
-     * Update a workflow card note
-     */
-    updateWorkflowCardNote(personId: string, workflowCardId: string, noteId: string, data: Partial<WorkflowCardNoteAttributes>): Promise<WorkflowCardNoteResource>;
-    /**
-     * Delete a workflow card note
-     */
-    deleteWorkflowCardNote(personId: string, workflowCardId: string, noteId: string): Promise<void>;
+    createWorkflowCardNote(personId: string, workflowCardId: string, data: WorkflowCardNoteAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCardNote", WorkflowCardNoteAttributes, {}>>;
     /**
      * Create a workflow card with a note
      */
@@ -95,35 +90,35 @@ export declare class WorkflowsModule extends BaseModule {
     /**
      * Move a workflow card back to the previous step
      */
-    goBackWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    goBackWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Move a workflow card to the next step
      */
-    promoteWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    promoteWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Remove a workflow card
      */
-    removeWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    removeWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Restore a workflow card
      */
-    restoreWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    restoreWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Send an email to the subject of the workflow card
      */
-    sendEmailWorkflowCard(personId: string, workflowCardId: string, data: WorkflowCardEmailAttributes): Promise<WorkflowCardResource>;
+    sendEmailWorkflowCard(personId: string, workflowCardId: string, data: WorkflowCardEmailAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Move a workflow card to the next step without completing the current step
      */
-    skipStepWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    skipStepWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Snooze a workflow card for a specific duration
      */
-    snoozeWorkflowCard(personId: string, workflowCardId: string, data: WorkflowCardSnoozeAttributes): Promise<WorkflowCardResource>;
+    snoozeWorkflowCard(personId: string, workflowCardId: string, data: WorkflowCardSnoozeAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Unsnooze a workflow card
      */
-    unsnoozeWorkflowCard(personId: string, workflowCardId: string): Promise<WorkflowCardResource>;
+    unsnoozeWorkflowCard(personId: string, workflowCardId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", WorkflowCardAttributes, import("../types").WorkflowCardRelationships>>;
     /**
      * Format note template with variables
      */