@zackbart/connecta 0.27.0 → 0.28.1

package/dist/providers/planning-center.d.ts

@@ -0,0 +1,59 @@
+import type { Connector, ConnectorCallAdmissionPolicy } from "../types.js";
+/** Planning Center's REST origin. Override only for a proxy or test double. */
+export declare const PLANNING_CENTER_API_BASE_URL = "https://api.planningcenteronline.com";
+/** The products behind `/<app>/v2`, in the order their guides list them. */
+export declare const PLANNING_CENTER_APPS: readonly ["people", "services", "groups", "check-ins", "calendar", "registrations", "giving", "publishing", "webhooks", "api"];
+export type PlanningCenterApp = (typeof PLANNING_CENTER_APPS)[number];
+/**
+ * One reviewed `X-PCO-API-Version` per product, sent on every request.
+ *
+ * The header is optional, and omitting it is the trap: Planning Center then
+ * applies a per-application default chosen in a web dashboard, so behavior
+ * would follow whoever last clicked there rather than this file. Each date is
+ * the newest non-beta version in the product's documentation graph on
+ * 2026-10-05, and every projection below is written against it. A breaking
+ * change arrives as a new dated version, never inside this one, so moving a
+ * pin is a reviewed change to this table, its drift manifest, and whatever
+ * projection the version's change list touches. Notes worth keeping:
+ *
+ * - groups `2023-07-10` removed every person attribute from `Membership`, so a
+ *   membership is nameless without `include=person`.
+ * - calendar `2026-06-22` may return `BookedEvent*` stubs in place of events on
+ *   booking and conflict traversals for users without access to the event.
+ * - webhooks `2022-10-20` renamed `Subscription` to `WebhookSubscription`.
+ * - services `2018-11-01` and giving `2019-10-18` are simply the newest there is.
+ *
+ * The hatches send the same pin for the app their path names and accept a
+ * per-call `version` override for an endpoint only a newer version serves.
+ */
+export declare const PLANNING_CENTER_API_VERSIONS: Readonly<Record<PlanningCenterApp, string>>;
+export interface PlanningCenterOptions {
+    /** Which organization this is and what it should be used for. Required. */
+    purpose: string;
+    /** Human-readable display name. Defaults to "Planning Center". */
+    title?: string;
+    /** Organization-specific conventions appended to the maintained guide. */
+    instructions?: string;
+    /** Downstream auth ownership. Defaults to one shared deployment grant. */
+    authScope?: "shared" | "personal";
+    /** Connector-specific inline result limit; omit to inherit the deployment. */
+    maxResultBytes?: number;
+    /**
+     * The `User-Agent` Planning Center sees. It asks integrations to identify
+     * themselves and refuses a request without one; name your deployment and a
+     * contact. Defaults to one naming connecta.
+     */
+    userAgent?: string;
+    /** Default `per_page` for list tools. Defaults to 25; Planning Center's maximum is 100. */
+    defaultPageSize?: number;
+    /**
+     * Replaces the default per-runtime budget (100 calls per 20 seconds, five at
+     * a time). Split it when two connections share one token's user, because
+     * Planning Center meters that user once.
+     */
+    callAdmission?: ConnectorCallAdmissionPolicy;
+    /** API origin override for a proxy or test double. */
+    baseUrl?: string;
+}
+/** A maintained Planning Center Online connection over the REST API. */
+export declare function planningCenter(id: string, options: PlanningCenterOptions): Connector;