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

package/dist/modules/notes.js

@@ -7,95 +7,83 @@ exports.NotesModule = void 0;
 const planning_center_base_ts_1 = require("@rachelallyson/planning-center-base-ts");
 class NotesModule extends planning_center_base_ts_1.BaseModule {
     /**
-     * Get all notes
+     * Get all notes across all pages
      */
     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('/notes', params);
+        this.debugLog('notes.getAll', { options });
+        return await this.getAllPages('/notes', {
+            where: options.where,
+            include: options.include,
+            order: options.order
+        });
     }
     /**
-     * Get all notes across all pages
+     * Get a single page of notes 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, page, and order
+     * @returns A single page of results with meta and links for pagination
      */
-    async getAllPagesPaginated(options = {}, paginationOptions) {
-        const params = {};
-        if (options.where) {
-            Object.entries(options.where).forEach(([key, value]) => {
-                params[`where[${key}]`] = value;
-            });
-        }
-        if (options.include) {
-            params.include = options.include.join(',');
-        }
-        return this.getAllPages('/notes', params, paginationOptions);
+    async getPage(options = {}) {
+        this.debugLog('notes.getPage', { options });
+        return this.getList('/notes', {
+            where: options.where,
+            include: options.include,
+            per_page: options.perPage,
+            page: options.page,
+            order: options.order
+        });
     }
     /**
      * Get a single note by ID
      */
     async getById(id, include) {
-        const params = {};
-        if (include) {
-            params.include = include.join(',');
-        }
-        return this.getSingle(`/notes/${id}`, params);
+        this.debugLog('notes.getById', { id, include });
+        return this.getSingle(`/notes/${id}`, include);
     }
     /**
      * Get notes for a specific person
      */
     async getNotesForPerson(personId, 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(`/people/${personId}/notes`, params);
+        this.debugLog('notes.getNotesForPerson', { personId, options });
+        return this.getList(`/people/${personId}/notes`, {
+            where: options.where,
+            include: options.include,
+            per_page: options.perPage,
+            page: options.page,
+            order: options.order
+        });
     }
     /**
      * Create a note for a person
      */
     async create(personId, data) {
+        this.debugLog('notes.create', { personId, data });
         return this.createResource(`/people/${personId}/notes`, data);
     }
     /**
      * Update a note
      */
     async update(id, data) {
+        this.debugLog('notes.update', { id, data });
         return this.updateResource(`/notes/${id}`, data);
     }
     /**
      * Delete a note
      */
     async delete(id) {
+        this.debugLog('notes.delete', { id });
         return this.deleteResource(`/notes/${id}`);
     }
     /**
      * Get all note categories
+     * @param options - Optional pagination options
      */
-    async getNoteCategories() {
-        return this.getList('/note_categories');
+    async getNoteCategories(options) {
+        this.debugLog('notes.getNoteCategories', { options });
+        return this.getList('/note_categories', options ? {
+            per_page: options.perPage,
+            page: options.page,
+        } : undefined);
     }
     /**
      * Get a single note category by ID

package/dist/modules/people.d.ts

@@ -2,14 +2,11 @@
  * v2.0.0 People Module
  */
 import { BaseModule } from '@rachelallyson/planning-center-base-ts';
-import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PaginationOptions, PaginationResult } from '@rachelallyson/planning-center-base-ts';
-import type { PersonResource, EmailResource, EmailAttributes, PhoneNumberResource, PhoneNumberAttributes, AddressResource, AddressAttributes, SocialProfileResource, SocialProfileAttributes, CampusResource, HouseholdResource } from '../types';
-export interface PeopleListOptions {
-    where?: Record<string, any>;
-    include?: string[];
-    perPage?: number;
-    page?: number;
-}
+import type { PcoHttpClient, PaginationHelper, PcoEventEmitter, PcoClientConfig } from '@rachelallyson/planning-center-base-ts';
+import type { PersonResource, PersonAttributes, PersonRelationshipMap, EmailResource, EmailAttributes, PhoneNumberResource, PhoneNumberAttributes, AddressResource, AddressAttributes, SocialProfileAttributes, CampusResource, HouseholdResource, PeopleIncluded, FlattenedPersonResource } from '../types';
+import type { Meta, TopLevelLinks } from '../types/json-api';
+import type { PersonListOptions, PersonPageOptions } from '../types/api-options';
+export type PeopleListOptions = PersonListOptions;
 export interface PersonCreateOptions {
     firstName?: string;
     lastName?: string;
@@ -147,23 +144,26 @@ export declare const DEFAULT_INITIAL_RETRY_CONFIG: Required<Omit<RetryConfig, 'e
 export declare const DEFAULT_AGGRESSIVE_RETRY_CONFIG: Required<Omit<RetryConfig, 'enabled'>>;
 export declare class PeopleModule extends BaseModule {
     private personMatcher;
-    constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter);
+    constructor(httpClient: PcoHttpClient, paginationHelper: PaginationHelper, eventEmitter: PcoEventEmitter, getConfig?: () => PcoClientConfig);
     /**
-     * Get all people with optional filtering
+     * Get all people across all pages with optional filtering
      */
-    getAll(options?: PeopleListOptions): Promise<{
-        data: PersonResource[];
-        meta?: any;
-        links?: any;
-    }>;
+    getAll(options?: PersonListOptions): Promise<import("@rachelallyson/planning-center-base-ts").PaginationResult<PersonResource, PeopleIncluded, PersonRelationshipMap>>;
     /**
-     * Get all people across all pages
+     * Get a single page of people 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, page, and order
+     * @returns A single page of results with meta and links for pagination
      */
-    getAllPagesPaginated(options?: PeopleListOptions, paginationOptions?: PaginationOptions): Promise<PaginationResult<PersonResource>>;
+    getPage(options?: PersonPageOptions): Promise<{
+        data: FlattenedPersonResource[];
+        meta?: Meta;
+        links?: TopLevelLinks;
+    }>;
     /**
      * Get a single person by ID
      */
-    getById(id: string, include?: string[]): Promise<PersonResource>;
+    getById(id: string, include?: string[]): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Verify that a person exists in PCO
      *
@@ -176,7 +176,7 @@ export declare class PeopleModule extends BaseModule {
      * @returns True if person exists, false if not found
      * @throws Error if request times out or other error occurs (except 404)
      *
-     * @example
+     * @gmail.com
      * ```typescript
      * const exists = await client.people.verifyPersonExists(cachedPersonId);
      * if (!exists) {
@@ -188,14 +188,21 @@ export declare class PeopleModule extends BaseModule {
     verifyPersonExists(personId: string, options?: {
         timeout?: number;
     }): Promise<boolean>;
+    /**
+     * Transform PersonCreateOptions (camelCase) to API format (snake_case)
+     * Also handles snake_case input directly (passes through)
+     */
+    private transformPersonData;
     /**
      * Create a new person
+     * Accepts both camelCase (PersonCreateOptions) and snake_case (PersonAttributes) fields
      */
-    create(data: PersonCreateOptions): Promise<PersonResource>;
+    create(data: PersonCreateOptions | Partial<PersonAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Update a person
+     * Accepts both camelCase (PersonCreateOptions) and snake_case (PersonAttributes) fields
      */
-    update(id: string, data: Partial<PersonCreateOptions>): Promise<PersonResource>;
+    update(id: string, data: Partial<PersonCreateOptions> | Partial<PersonAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Delete a person
      */
@@ -203,42 +210,46 @@ export declare class PeopleModule extends BaseModule {
     /**
      * Get a person's primary campus
      */
-    getPrimaryCampus(personId: string): Promise<CampusResource | null>;
+    getPrimaryCampus(personId: string): Promise<CampusResource | import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Campus", import("../types").CampusAttributes, import("../types").CampusRelationships> | null>;
     /**
      * Set a person's primary campus
      */
-    setPrimaryCampus(personId: string, campusId: string): Promise<PersonResource>;
+    setPrimaryCampus(personId: string, campusId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Remove a person's primary campus
      */
-    removePrimaryCampus(personId: string): Promise<PersonResource>;
+    removePrimaryCampus(personId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Get a person's household
      */
-    getHousehold(personId: string): Promise<HouseholdResource | null>;
+    getHousehold(personId: string): Promise<HouseholdResource | import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Household", import("../types").HouseholdAttributes, import("../types").HouseholdRelationships> | null>;
     /**
      * Set a person's household
+     * Uses the household_memberships endpoint to create a membership record
      */
-    setHousehold(personId: string, householdId: string): Promise<PersonResource>;
+    setHousehold(personId: string, householdId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Remove a person from their household
+     * Uses the household_memberships endpoint to delete the membership record
      */
-    removeFromHousehold(personId: string): Promise<PersonResource>;
+    removeFromHousehold(personId: string): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships>>;
     /**
      * Get all people in a specific household
+     * Note: This uses getList() internally, so it returns a single page. Use getAll() with where[household_id] for all pages.
      */
-    getHouseholdMembers(householdId: string, options?: PeopleListOptions): Promise<{
-        data: PersonResource[];
-        meta?: any;
-        links?: any;
+    getHouseholdMembers(householdId: string, options?: PersonPageOptions): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Get people by campus
+     * Note: This uses getList() internally, so it returns a single page. Use getAll() with where[primary_campus_id] for all pages.
      */
-    getByCampus(campusId: string, options?: PeopleListOptions): Promise<{
-        data: PersonResource[];
-        meta?: any;
-        links?: any;
+    getByCampus(campusId: string, options?: PersonPageOptions): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Person", PersonAttributes, import("../types").PersonRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Get a person's workflow cards
@@ -248,9 +259,9 @@ export declare class PeopleModule extends BaseModule {
         perPage?: number;
         page?: number;
     }): Promise<{
-        data: any[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"WorkflowCard", import("../types").WorkflowCardAttributes, import("../types").WorkflowCardRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Get a person's notes
@@ -260,9 +271,9 @@ export declare class PeopleModule extends BaseModule {
         perPage?: number;
         page?: number;
     }): Promise<{
-        data: any[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Note", import("../types").NoteAttributes, import("../types").NoteRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Get a person's field data
@@ -272,9 +283,9 @@ export declare class PeopleModule extends BaseModule {
         perPage?: number;
         page?: number;
     }): Promise<{
-        data: any[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"FieldDatum", import("../types").FieldDatumAttributes, import("../types").FieldDatumRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Get a person's social profiles
@@ -284,9 +295,9 @@ export declare class PeopleModule extends BaseModule {
         perPage?: number;
         page?: number;
     }): Promise<{
-        data: any[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"SocialProfile", SocialProfileAttributes, import("../types").SocialProfileRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Find or create a person with smart matching
@@ -299,13 +310,13 @@ export declare class PeopleModule extends BaseModule {
      *   to a person's profile when a match is found. The contacts are added as non-primary
      *   to preserve existing primary contacts.
      *
-     * @example
+     * @gmail.com
      * ```typescript
      * // Basic find or create
      * const person = await client.people.findOrCreate({
      *   firstName: 'John',
      *   lastName: 'Doe',
-     *   email: 'john@example.com',
+     *   email: 'john@gmail.com',
      *   phone: '+1234567890'
      * });
      *
@@ -313,7 +324,7 @@ export declare class PeopleModule extends BaseModule {
      * const person = await client.people.findOrCreate({
      *   firstName: 'Jane',
      *   lastName: 'Smith',
-     *   email: 'jane@example.com',
+     *   email: 'jane@gmail.com',
      *   phone: '+1987654321',
      *   addMissingContactInfo: true  // Will add phone if person only has email
      * });
@@ -321,7 +332,7 @@ export declare class PeopleModule extends BaseModule {
      *
      * @returns The found or newly created person
      */
-    findOrCreate(options: PersonMatchOptions): Promise<PersonResource>;
+    findOrCreate(options: PersonMatchOptions): Promise<FlattenedPersonResource>;
     /**
      * Search people by multiple criteria
      */
@@ -331,27 +342,28 @@ export declare class PeopleModule extends BaseModule {
         phone?: string;
         status?: string;
         perPage?: number;
+        page?: number;
     }): Promise<{
-        data: PersonResource[];
-        meta?: any;
-        links?: any;
+        data: FlattenedPersonResource[];
+        meta?: Meta;
+        links?: TopLevelLinks;
     }>;
     /**
      * Get person's emails
      */
     getEmails(personId: string): Promise<{
-        data: EmailResource[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Email", EmailAttributes, import("../types").EmailRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Add an email to a person
      */
-    addEmail(personId: string, data: EmailAttributes): Promise<EmailResource>;
+    addEmail(personId: string, data: EmailAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Email", EmailAttributes, import("../types").EmailRelationships>>;
     /**
      * Update a person's email
      */
-    updateEmail(personId: string, emailId: string, data: Partial<EmailAttributes>): Promise<EmailResource>;
+    updateEmail(personId: string, emailId: string, data: Partial<EmailAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Email", EmailAttributes, import("../types").EmailRelationships>>;
     /**
      * Delete a person's email
      */
@@ -360,18 +372,18 @@ export declare class PeopleModule extends BaseModule {
      * Get person's phone numbers
      */
     getPhoneNumbers(personId: string): Promise<{
-        data: PhoneNumberResource[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"PhoneNumber", PhoneNumberAttributes, import("../types").PhoneNumberRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Add a phone number to a person
      */
-    addPhoneNumber(personId: string, data: PhoneNumberAttributes): Promise<PhoneNumberResource>;
+    addPhoneNumber(personId: string, data: PhoneNumberAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"PhoneNumber", PhoneNumberAttributes, import("../types").PhoneNumberRelationships>>;
     /**
      * Update a person's phone number
      */
-    updatePhoneNumber(personId: string, phoneId: string, data: Partial<PhoneNumberAttributes>): Promise<PhoneNumberResource>;
+    updatePhoneNumber(personId: string, phoneId: string, data: Partial<PhoneNumberAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"PhoneNumber", PhoneNumberAttributes, import("../types").PhoneNumberRelationships>>;
     /**
      * Delete a person's phone number
      */
@@ -380,18 +392,18 @@ export declare class PeopleModule extends BaseModule {
      * Get person's addresses
      */
     getAddresses(personId: string): Promise<{
-        data: AddressResource[];
-        meta?: any;
-        links?: any;
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Address", AddressAttributes, import("../types").AddressRelationships, Record<string, never>>[];
+        meta?: import("@rachelallyson/planning-center-base-ts").Meta;
+        links?: import("@rachelallyson/planning-center-base-ts").TopLevelLinks;
     }>;
     /**
      * Add an address to a person
      */
-    addAddress(personId: string, data: AddressAttributes): Promise<AddressResource>;
+    addAddress(personId: string, data: AddressAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Address", AddressAttributes, import("../types").AddressRelationships>>;
     /**
      * Update a person's address
      */
-    updateAddress(personId: string, addressId: string, data: Partial<AddressAttributes>): Promise<AddressResource>;
+    updateAddress(personId: string, addressId: string, data: Partial<AddressAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Address", AddressAttributes, import("../types").AddressRelationships>>;
     /**
      * Delete a person's address
      */
@@ -399,11 +411,11 @@ export declare class PeopleModule extends BaseModule {
     /**
      * Add a social profile to a person
      */
-    addSocialProfile(personId: string, data: SocialProfileAttributes): Promise<SocialProfileResource>;
+    addSocialProfile(personId: string, data: SocialProfileAttributes): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"SocialProfile", SocialProfileAttributes, import("../types").SocialProfileRelationships>>;
     /**
      * Update a person's social profile
      */
-    updateSocialProfile(personId: string, profileId: string, data: Partial<SocialProfileAttributes>): Promise<SocialProfileResource>;
+    updateSocialProfile(personId: string, profileId: string, data: Partial<SocialProfileAttributes>): Promise<import("@rachelallyson/planning-center-base-ts").FlattenedResource<"SocialProfile", SocialProfileAttributes, import("../types").SocialProfileRelationships>>;
     /**
      * Delete a person's social profile
      */