@rachelallyson/planning-center-people-ts 2.11.0 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +4 -3
- package/dist/modules/lists.d.ts +4 -0
- package/dist/modules/lists.js +10 -0
- package/dist/people/lists.d.ts +4 -0
- package/dist/people/lists.js +11 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [2.12.0] - 2026-01-14
|
|
9
|
+
|
|
10
|
+
### ✨ **New Features**
|
|
11
|
+
|
|
12
|
+
- **📋 List Run Functionality**: Added ability to run a List to update its results
|
|
13
|
+
- New `runList()` function in `src/people/lists.ts` for running lists via the function API
|
|
14
|
+
- New `run()` method in `ListsModule` for running lists via the module API
|
|
15
|
+
- Endpoint: `POST /people/v2/lists/{list_id}/run`
|
|
16
|
+
- Updates list results based on current list rules
|
|
17
|
+
|
|
8
18
|
## [2.11.0] - 2025-01-15
|
|
9
19
|
|
|
10
20
|
### ✨ **New Features**
|
package/dist/index.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ export type { RateLimitHeaders, RateLimitInfo } from '@rachelallyson/planning-ce
|
|
|
18
18
|
export { PcoRateLimiter } from '@rachelallyson/planning-center-base-ts';
|
|
19
19
|
export type { ErrorContext } from '@rachelallyson/planning-center-base-ts';
|
|
20
20
|
export { ErrorCategory, ErrorSeverity, handleNetworkError, handleTimeoutError, handleValidationError, PcoError, retryWithBackoff, shouldNotRetry, withErrorBoundary, } from '@rachelallyson/planning-center-base-ts';
|
|
21
|
-
export { createFieldDefinition, createFieldOption, createPerson, createPersonAddress, createPersonEmail, createPersonFieldData, createPersonPhoneNumber, createPersonSocialProfile, createWorkflowCard, createWorkflowCardNote, deleteFieldDefinition, deletePerson, deletePersonFieldData, deleteSocialProfile, getFieldDefinitions, getFieldOptions, getHousehold, getHouseholds, getTabs, getListById, getListCategories, getLists, getNote, getNoteCategories, getNotes, getOrganization, getPeople, getPerson, getPersonAddresses, getPersonEmails, getPersonFieldData, getPersonPhoneNumbers, getPersonSocialProfiles, getWorkflow, getWorkflowCardNotes, getWorkflowCards, getWorkflows, updatePerson, updatePersonAddress, } from './people';
|
|
21
|
+
export { createFieldDefinition, createFieldOption, createPerson, createPersonAddress, createPersonEmail, createPersonFieldData, createPersonPhoneNumber, createPersonSocialProfile, createWorkflowCard, createWorkflowCardNote, deleteFieldDefinition, deletePerson, deletePersonFieldData, deleteSocialProfile, getFieldDefinitions, getFieldOptions, getHousehold, getHouseholds, getTabs, getListById, getListCategories, getLists, runList, getNote, getNoteCategories, getNotes, getOrganization, getPeople, getPerson, getPersonAddresses, getPersonEmails, getPersonFieldData, getPersonPhoneNumbers, getPersonSocialProfiles, getWorkflow, getWorkflowCardNotes, getWorkflowCards, getWorkflows, updatePerson, updatePersonAddress, } from './people';
|
|
22
22
|
export { attemptRecovery, CircuitBreaker, classifyError, createErrorReport, DEFAULT_RETRY_CONFIG, executeBulkOperation, retryWithExponentialBackoff, TIMEOUT_CONFIG, withTimeout, } from './error-scenarios';
|
|
23
23
|
export { buildQueryParams, calculateAge, createPersonWithContact, createWorkflowCardWithNote, exportAllPeopleData, extractFileUrl, formatDate, formatPersonName, getCompletePersonProfile, getFileExtension, getFilename, getListsWithCategories, getOrganizationInfo, getPeopleByHousehold, getPersonWorkflowCardsWithNotes, getPrimaryContact, isFileUpload, isFileUrl, isValidEmail, isValidPhone, normalizeEmail, normalizePhone, processFileValue, searchPeople, validatePersonData, } from './helpers';
|
|
24
24
|
export { AdaptiveRateLimiter, ApiCache, batchFetchPersonDetails, fetchAllPages, getCachedPeople, monitorPerformance, PerformanceMonitor, processInBatches, processLargeDataset, streamPeopleData, } from './performance';
|
package/dist/index.js
CHANGED
|
@@ -15,9 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
16
|
};
|
|
17
17
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.
|
|
19
|
-
exports.
|
|
20
|
-
exports.createSlowMockClient = exports.createErrorMockClient = exports.createTestClient = exports.createRecordingClient = exports.createMockClient = exports.RequestRecorder = exports.MockResponseBuilder = exports.MockPcoClient = exports.streamPeopleData = exports.processLargeDataset = exports.processInBatches = exports.PerformanceMonitor = exports.monitorPerformance = exports.getCachedPeople = exports.fetchAllPages = exports.batchFetchPersonDetails = void 0;
|
|
18
|
+
exports.getNoteCategories = exports.getNote = exports.runList = exports.getLists = exports.getListCategories = exports.getListById = exports.getTabs = exports.getHouseholds = exports.getHousehold = exports.getFieldOptions = exports.getFieldDefinitions = exports.deleteSocialProfile = exports.deletePersonFieldData = exports.deletePerson = exports.deleteFieldDefinition = exports.createWorkflowCardNote = exports.createWorkflowCard = exports.createPersonSocialProfile = exports.createPersonPhoneNumber = exports.createPersonFieldData = exports.createPersonEmail = exports.createPersonAddress = exports.createPerson = exports.createFieldOption = exports.createFieldDefinition = exports.withErrorBoundary = exports.shouldNotRetry = exports.retryWithBackoff = exports.PcoError = exports.handleValidationError = exports.handleTimeoutError = exports.handleNetworkError = exports.ErrorSeverity = exports.ErrorCategory = exports.PcoRateLimiter = exports.PcoApiError = exports.updateClientTokens = exports.refreshAccessToken = exports.hasRefreshTokenCapability = exports.attemptTokenRefresh = exports.post = exports.patch = exports.getSingle = exports.getRateLimitInfo = exports.getList = exports.getAllPages = exports.del = exports.createPcoClient = exports.PcoClientManager = exports.PcoClient = void 0;
|
|
19
|
+
exports.AdaptiveRateLimiter = exports.validatePersonData = exports.searchPeople = exports.processFileValue = exports.normalizePhone = exports.normalizeEmail = exports.isValidPhone = exports.isValidEmail = exports.isFileUrl = exports.isFileUpload = exports.getPrimaryContact = exports.getPersonWorkflowCardsWithNotes = exports.getPeopleByHousehold = exports.getOrganizationInfo = exports.getListsWithCategories = exports.getFilename = exports.getFileExtension = exports.getCompletePersonProfile = exports.formatPersonName = exports.formatDate = exports.extractFileUrl = exports.exportAllPeopleData = exports.createWorkflowCardWithNote = exports.createPersonWithContact = exports.calculateAge = exports.buildQueryParams = exports.withTimeout = exports.TIMEOUT_CONFIG = exports.retryWithExponentialBackoff = exports.executeBulkOperation = exports.DEFAULT_RETRY_CONFIG = exports.createErrorReport = exports.classifyError = exports.CircuitBreaker = exports.attemptRecovery = exports.updatePersonAddress = exports.updatePerson = exports.getWorkflows = exports.getWorkflowCards = exports.getWorkflowCardNotes = exports.getWorkflow = exports.getPersonSocialProfiles = exports.getPersonPhoneNumbers = exports.getPersonFieldData = exports.getPersonEmails = exports.getPersonAddresses = exports.getPerson = exports.getPeople = exports.getOrganization = exports.getNotes = void 0;
|
|
20
|
+
exports.createSlowMockClient = exports.createErrorMockClient = exports.createTestClient = exports.createRecordingClient = exports.createMockClient = exports.RequestRecorder = exports.MockResponseBuilder = exports.MockPcoClient = exports.streamPeopleData = exports.processLargeDataset = exports.processInBatches = exports.PerformanceMonitor = exports.monitorPerformance = exports.getCachedPeople = exports.fetchAllPages = exports.batchFetchPersonDetails = exports.ApiCache = void 0;
|
|
21
21
|
// Main client class
|
|
22
22
|
var client_1 = require("./client");
|
|
23
23
|
Object.defineProperty(exports, "PcoClient", { enumerable: true, get: function () { return client_1.PcoClient; } });
|
|
@@ -80,6 +80,7 @@ Object.defineProperty(exports, "getTabs", { enumerable: true, get: function () {
|
|
|
80
80
|
Object.defineProperty(exports, "getListById", { enumerable: true, get: function () { return people_1.getListById; } });
|
|
81
81
|
Object.defineProperty(exports, "getListCategories", { enumerable: true, get: function () { return people_1.getListCategories; } });
|
|
82
82
|
Object.defineProperty(exports, "getLists", { enumerable: true, get: function () { return people_1.getLists; } });
|
|
83
|
+
Object.defineProperty(exports, "runList", { enumerable: true, get: function () { return people_1.runList; } });
|
|
83
84
|
Object.defineProperty(exports, "getNote", { enumerable: true, get: function () { return people_1.getNote; } });
|
|
84
85
|
Object.defineProperty(exports, "getNoteCategories", { enumerable: true, get: function () { return people_1.getNoteCategories; } });
|
|
85
86
|
Object.defineProperty(exports, "getNotes", { enumerable: true, get: function () { return people_1.getNotes; } });
|
package/dist/modules/lists.d.ts
CHANGED
package/dist/modules/lists.js
CHANGED
|
@@ -88,5 +88,15 @@ class ListsModule extends planning_center_base_ts_1.BaseModule {
|
|
|
88
88
|
async getPeople(listId) {
|
|
89
89
|
return this.getList(`/lists/${listId}/people`);
|
|
90
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Run a List to update its results
|
|
93
|
+
*/
|
|
94
|
+
async run(listId) {
|
|
95
|
+
const response = await this.httpClient.request({
|
|
96
|
+
method: 'POST',
|
|
97
|
+
endpoint: `/lists/${listId}/run`,
|
|
98
|
+
});
|
|
99
|
+
return response.data.data;
|
|
100
|
+
}
|
|
91
101
|
}
|
|
92
102
|
exports.ListsModule = ListsModule;
|
package/dist/people/lists.d.ts
CHANGED
|
@@ -28,3 +28,7 @@ export declare function getListCategories(client: PcoClientState, params?: {
|
|
|
28
28
|
per_page?: number;
|
|
29
29
|
page?: number;
|
|
30
30
|
}, context?: Partial<ErrorContext>): Promise<ListCategoriesList>;
|
|
31
|
+
/**
|
|
32
|
+
* Run a List to update its results
|
|
33
|
+
*/
|
|
34
|
+
export declare function runList(client: PcoClientState, listId: string, context?: Partial<ErrorContext>): Promise<ListSingle>;
|
package/dist/people/lists.js
CHANGED
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.getLists = getLists;
|
|
4
4
|
exports.getListById = getListById;
|
|
5
5
|
exports.getListCategories = getListCategories;
|
|
6
|
+
exports.runList = runList;
|
|
6
7
|
const core_1 = require("../core");
|
|
7
8
|
const helpers_1 = require("../helpers");
|
|
8
9
|
/**
|
|
@@ -35,3 +36,13 @@ async function getListCategories(client, params, context) {
|
|
|
35
36
|
method: 'GET',
|
|
36
37
|
});
|
|
37
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* Run a List to update its results
|
|
41
|
+
*/
|
|
42
|
+
async function runList(client, listId, context) {
|
|
43
|
+
return (0, core_1.post)(client, `/lists/${listId}/run`, {}, undefined, {
|
|
44
|
+
...context,
|
|
45
|
+
endpoint: `/lists/${listId}/run`,
|
|
46
|
+
method: 'POST',
|
|
47
|
+
});
|
|
48
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rachelallyson/planning-center-people-ts",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.12.0",
|
|
4
4
|
"description": "A strictly typed TypeScript client for Planning Center Online People API with comprehensive functionality and enhanced developer experience",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|