@stackfactor/client-api 1.2.6 → 1.2.8

package/dist/cjs/lib/partnerships.d.ts

@@ -0,0 +1,141 @@
+/** Who to invite, and on what terms. */
+export interface PartnerInvitationInput {
+    /** The programme being offered. */
+    programmeId: string;
+    /**
+     * The invitee's email address. Whether it belongs to an existing StackFactor
+     * account is resolved server-side and NEVER reflected in the response.
+     */
+    invitedEmail: string;
+    invitedOrganizationName?: string | null;
+    /** Matches a tier `key` on the programme. */
+    tier?: string | null;
+    seatAllocation?: number | null;
+}
+/** Optional status filters for either listing. */
+export interface PartnershipListParams {
+    /**
+     * One or more of "invited" | "active" | "declined" | "revoked" |
+     * "terminated" | "expired".
+     */
+    statuses?: string[];
+}
+/** Vendor-side listing filters. */
+export interface VendorPartnershipListParams extends PartnershipListParams {
+    /** Restrict to a single one of the vendor's programmes. */
+    programmeId?: string | null;
+}
+/**
+ * Invite an organization to one of the calling vendor's programmes, by email.
+ *
+ * Returns success whether or not the address belongs to a StackFactor account —
+ * an address that matches nobody still produces a record that simply expires, so
+ * "they ignored me" and "no such account" are indistinguishable. This is
+ * deliberate: it stops the endpoint being used to discover who has an account.
+ * The invitation code is emailed to the invitee and is not part of the response.
+ * POST /api/v1/partnerships/invite
+ * @param {PartnerInvitationInput} data Programme, email and optional tier / seats
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const invitePartner: (data: PartnerInvitationInput, authToken: string) => Promise<object>;
+/**
+ * Re-issue an open invitation's code and extend its window. The previously
+ * emailed code stops working.
+ * POST /api/v1/partnerships/resend/:id
+ * @param {String} id Partnership id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const resendInvitation: (id: string, authToken: string) => Promise<object>;
+/**
+ * Withdraw an invitation that has not been answered.
+ * POST /api/v1/partnerships/revoke/:id
+ * @param {String} id Partnership id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const revokeInvitation: (id: string, authToken: string) => Promise<object>;
+/**
+ * The partnerships of the calling vendor's own programmes.
+ *
+ * Scoped to the vendor server-side: one vendor can never see a partnership
+ * belonging to another vendor's programme, so a competitor's partner list is not
+ * discoverable.
+ * POST /api/v1/partnerships/vendor
+ * @param {VendorPartnershipListParams} params Optional programme / status filters
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listVendorPartnerships: (params: VendorPartnershipListParams, authToken: string) => Promise<object>;
+/**
+ * The calling tenant's own standing, across every vendor it partners with.
+ *
+ * Each row carries `termsVersionCurrent` and `termsReacceptanceRequired`. Drift
+ * is surfaced, not enforced — a partner whose vendor revised its terms keeps its
+ * catalog, and clears the flag with `reacceptTerms`.
+ * POST /api/v1/partnerships
+ * @param {PartnershipListParams} params Optional status filter
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listTenantPartnerships: (params: PartnershipListParams, authToken: string) => Promise<object>;
+/**
+ * Preview the invitation a code names, so the invitee can read the programme and
+ * its terms before deciding. Reads only; nothing changes.
+ *
+ * An unknown code, a code addressed to another organization, and an expired one
+ * all fail identically, so this cannot be used to probe which codes are real.
+ * POST /api/v1/partnerships/invitation
+ * @param {String} code The invitation code the user typed
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const readInvitation: (code: string, authToken: string) => Promise<object>;
+/**
+ * Accept an invitation on the organization's behalf.
+ *
+ * `termsVersion` must match the programme's current published terms — accepting
+ * a version that has since been revised returns 409 rather than succeeding
+ * against terms nobody agreed to.
+ * POST /api/v1/partnerships/accept
+ * @param {String} code The invitation code the user typed
+ * @param {Number} termsVersion The terms version being accepted
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const acceptInvitation: (code: string, termsVersion: number, authToken: string) => Promise<object>;
+/**
+ * Decline an invitation. Terminal — a change of mind is a new invitation.
+ * POST /api/v1/partnerships/decline
+ * @param {String} code The invitation code the user typed
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const declineInvitation: (code: string, authToken: string) => Promise<object>;
+/**
+ * Accept a revised set of terms on an already-active partnership, clearing the
+ * `termsReacceptanceRequired` flag the listing raises.
+ * POST /api/v1/partnerships/reaccept/:id
+ * @param {String} id Partnership id
+ * @param {Number} termsVersion The terms version being accepted
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const reacceptTerms: (id: string, termsVersion: number, authToken: string) => Promise<object>;
+/**
+ * End an active partnership — the vendor removing a partner, or the partner
+ * leaving. The caller must be on one end of the edge.
+ *
+ * Granted content stops resolving on the next read. The record is kept rather
+ * than deleted: roll-up reporting freezes at the final state, and credentials
+ * already earned stay valid to their normal expiry. The partner's own billing
+ * plan, content and people are untouched.
+ * POST /api/v1/partnerships/terminate/:id
+ * @param {String} id Partnership id
+ * @param {String} reason Free-text reason, retained on the record
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const terminatePartnership: (id: string, reason: string | null, authToken: string) => Promise<object>;
+//# sourceMappingURL=partnerships.d.ts.map

package/dist/cjs/lib/partnerships.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"partnerships.d.ts","sourceRoot":"","sources":["../../../src/lib/partnerships.ts"],"names":[],"mappings":"AAoCA,wCAAwC;AACxC,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,kDAAkD;AAClD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,mCAAmC;AACnC,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAID;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,GACxB,MAAM,sBAAsB,EAC5B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,2BAA2B,EACnC,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAIF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,qBAAqB,EAC7B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GACzB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,GAC3B,MAAM,MAAM,EACZ,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,GACxB,IAAI,MAAM,EACV,cAAc,MAAM,EACpB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAIF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,QAAQ,MAAM,GAAG,IAAI,EACrB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}

package/dist/cjs/lib/partnerships.js

@@ -0,0 +1,247 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.terminatePartnership = exports.reacceptTerms = exports.declineInvitation = exports.acceptInvitation = exports.readInvitation = exports.listTenantPartnerships = exports.listVendorPartnerships = exports.revokeInvitation = exports.resendInvitation = exports.invitePartner = void 0;
+const axiosClient_js_1 = require("./axiosClient.js");
+// ── Vendor side ───────────────────────────────────────────────────────────────
+/**
+ * Invite an organization to one of the calling vendor's programmes, by email.
+ *
+ * Returns success whether or not the address belongs to a StackFactor account —
+ * an address that matches nobody still produces a record that simply expires, so
+ * "they ignored me" and "no such account" are indistinguishable. This is
+ * deliberate: it stops the endpoint being used to discover who has an account.
+ * The invitation code is emailed to the invitee and is not part of the response.
+ * POST /api/v1/partnerships/invite
+ * @param {PartnerInvitationInput} data Programme, email and optional tier / seats
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const invitePartner = (data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/invite`, data, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.invitePartner = invitePartner;
+/**
+ * Re-issue an open invitation's code and extend its window. The previously
+ * emailed code stops working.
+ * POST /api/v1/partnerships/resend/:id
+ * @param {String} id Partnership id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const resendInvitation = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/resend/${id}`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.resendInvitation = resendInvitation;
+/**
+ * Withdraw an invitation that has not been answered.
+ * POST /api/v1/partnerships/revoke/:id
+ * @param {String} id Partnership id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const revokeInvitation = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/revoke/${id}`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.revokeInvitation = revokeInvitation;
+/**
+ * The partnerships of the calling vendor's own programmes.
+ *
+ * Scoped to the vendor server-side: one vendor can never see a partnership
+ * belonging to another vendor's programme, so a competitor's partner list is not
+ * discoverable.
+ * POST /api/v1/partnerships/vendor
+ * @param {VendorPartnershipListParams} params Optional programme / status filters
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listVendorPartnerships = (params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/vendor`, params, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listVendorPartnerships = listVendorPartnerships;
+// ── Partner side ──────────────────────────────────────────────────────────────
+/**
+ * The calling tenant's own standing, across every vendor it partners with.
+ *
+ * Each row carries `termsVersionCurrent` and `termsReacceptanceRequired`. Drift
+ * is surfaced, not enforced — a partner whose vendor revised its terms keeps its
+ * catalog, and clears the flag with `reacceptTerms`.
+ * POST /api/v1/partnerships
+ * @param {PartnershipListParams} params Optional status filter
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listTenantPartnerships = (params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships`, params, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listTenantPartnerships = listTenantPartnerships;
+/**
+ * Preview the invitation a code names, so the invitee can read the programme and
+ * its terms before deciding. Reads only; nothing changes.
+ *
+ * An unknown code, a code addressed to another organization, and an expired one
+ * all fail identically, so this cannot be used to probe which codes are real.
+ * POST /api/v1/partnerships/invitation
+ * @param {String} code The invitation code the user typed
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const readInvitation = (code, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/invitation`, { code }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.readInvitation = readInvitation;
+/**
+ * Accept an invitation on the organization's behalf.
+ *
+ * `termsVersion` must match the programme's current published terms — accepting
+ * a version that has since been revised returns 409 rather than succeeding
+ * against terms nobody agreed to.
+ * POST /api/v1/partnerships/accept
+ * @param {String} code The invitation code the user typed
+ * @param {Number} termsVersion The terms version being accepted
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const acceptInvitation = (code, termsVersion, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/accept`, { code, termsVersion }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.acceptInvitation = acceptInvitation;
+/**
+ * Decline an invitation. Terminal — a change of mind is a new invitation.
+ * POST /api/v1/partnerships/decline
+ * @param {String} code The invitation code the user typed
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const declineInvitation = (code, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/decline`, { code }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.declineInvitation = declineInvitation;
+/**
+ * Accept a revised set of terms on an already-active partnership, clearing the
+ * `termsReacceptanceRequired` flag the listing raises.
+ * POST /api/v1/partnerships/reaccept/:id
+ * @param {String} id Partnership id
+ * @param {Number} termsVersion The terms version being accepted
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const reacceptTerms = (id, termsVersion, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/reaccept/${id}`, { termsVersion }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.reacceptTerms = reacceptTerms;
+// ── Either side ───────────────────────────────────────────────────────────────
+/**
+ * End an active partnership — the vendor removing a partner, or the partner
+ * leaving. The caller must be on one end of the edge.
+ *
+ * Granted content stops resolving on the next read. The record is kept rather
+ * than deleted: roll-up reporting freezes at the final state, and credentials
+ * already earned stay valid to their normal expiry. The partner's own billing
+ * plan, content and people are untouched.
+ * POST /api/v1/partnerships/terminate/:id
+ * @param {String} id Partnership id
+ * @param {String} reason Free-text reason, retained on the record
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const terminatePartnership = (id, reason, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/partnerships/terminate/${id}`, { reason }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.terminatePartnership = terminatePartnership;
+//# sourceMappingURL=partnerships.js.map

package/dist/cjs/lib/partnerships.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partnerships.js","sourceRoot":"","sources":["../../../src/lib/partnerships.ts"],"names":[],"mappings":";;;AACA,qDAA0C;AAiE1C,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACI,MAAM,aAAa,GAAG,CAC3B,IAA4B,EAC5B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,IAAI,EAAE;YAC/D,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAhBW,QAAA,aAAa,iBAgBxB;AAEF;;;;;;;GAOG;AACI,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,+BAA+B,EAAE,EAAE,EACnC,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,gBAAgB,oBAkB3B;AAEF;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,+BAA+B,EAAE,EAAE,EACnC,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,gBAAgB,oBAkB3B;AAEF;;;;;;;;;;GAUG;AACI,MAAM,sBAAsB,GAAG,CACpC,MAAmC,EACnC,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,MAAM,EAAE;YACjE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAhBW,QAAA,sBAAsB,0BAgBjC;AAEF,iFAAiF;AAEjF;;;;;;;;;;GAUG;AACI,MAAM,sBAAsB,GAAG,CACpC,MAA6B,EAC7B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,MAAM,EAAE;YAC1D,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAhBW,QAAA,sBAAsB,0BAgBjC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,cAAc,GAAG,CAC5B,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,iCAAiC,EACjC,EAAE,IAAI,EAAE,EACR,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,cAAc,kBAkBzB;AAEF;;;;;;;;;;;GAWG;AACI,MAAM,gBAAgB,GAAG,CAC9B,IAAY,EACZ,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,6BAA6B,EAC7B,EAAE,IAAI,EAAE,YAAY,EAAE,EACtB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,gBAAgB,oBAmB3B;AAEF;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAC/B,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,8BAA8B,EAC9B,EAAE,IAAI,EAAE,EACR,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAlBW,QAAA,iBAAiB,qBAkB5B;AAEF;;;;;;;;GAQG;AACI,MAAM,aAAa,GAAG,CAC3B,EAAU,EACV,YAAoB,EACpB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,iCAAiC,EAAE,EAAE,EACrC,EAAE,YAAY,EAAE,EAChB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,aAAa,iBAmBxB;AAEF,iFAAiF;AAEjF;;;;;;;;;;;;;GAaG;AACI,MAAM,oBAAoB,GAAG,CAClC,EAAU,EACV,MAAqB,EACrB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,CAAC,IAAI,CACzB,kCAAkC,EAAE,EAAE,EACtC,EAAE,MAAM,EAAE,EACV,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAnBW,QAAA,oBAAoB,wBAmB/B"}

package/dist/esm/lib/channelProgrammes.d.ts

@@ -0,0 +1,134 @@
+/** Create / update payload for a programme's draft. */
+export interface ChannelProgrammeInput {
+    name?: string;
+    description?: string | null;
+    /** What the programme exists to serve, shown to an invitee before accepting. */
+    objectives?: string[];
+    tiers?: ChannelProgrammeTier[];
+    terms?: ChannelProgrammeTerms;
+    /** This programme's slice of the vendor's PARTNER_SEATS pool. */
+    seatPool?: number;
+    /** How long an invitation to this programme stays open, in days. */
+    invitationValidityDays?: number;
+}
+/**
+ * A tier gates seat allocation and certification requirements — and nothing
+ * else. It deliberately does NOT scope content: the programme grants content and
+ * every partner in it sees all of it.
+ */
+export interface ChannelProgrammeTier {
+    /** Stable machine key, referenced by a partnership's `tier`. */
+    key: string;
+    name: string;
+    description?: string | null;
+    defaultSeatAllocation?: number;
+    requiredCredentialIds?: string[];
+}
+/**
+ * Structured rather than prose, because the partner-facing scorecard has to read
+ * it.
+ *
+ * `version` is managed server-side and moves ONLY when the terms themselves
+ * change — adding content to a programme does not invalidate existing
+ * acceptances. A partnership's acceptance points at this number.
+ */
+export interface ChannelProgrammeTerms {
+    version?: number;
+    body?: string;
+    completionWindowDays?: number | null;
+    minimumCertifiedUsers?: number | null;
+}
+/** Optional filters for the programme listing. */
+export interface ChannelProgrammeListParams {
+    /** "draft" | "published" — which version to project display fields from. */
+    version?: string;
+    includeDeleted?: boolean;
+}
+/**
+ * List the calling vendor's own channel programmes.
+ * POST /api/v1/exceed/channelprogrammes
+ * @param {ChannelProgrammeListParams} params Optional version / deleted filters
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listChannelProgrammes: (params: ChannelProgrammeListParams, authToken: string) => Promise<object>;
+/**
+ * Create a programme, in draft. Nothing is visible to any partner until it is
+ * published and a partnership becomes active.
+ * PUT /api/v1/exceed/channelprogrammes
+ * @param {ChannelProgrammeInput} data Programme data (at minimum `name`)
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const createChannelProgramme: (data: ChannelProgrammeInput, authToken: string) => Promise<object>;
+/**
+ * Read one of the calling vendor's programmes.
+ * GET /api/v1/exceed/channelprogrammes/programme/:id/:version
+ * @param {String} id Programme id
+ * @param {String} version "draft" | "published"
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const getChannelProgramme: (id: string, version: string, authToken: string) => Promise<object>;
+/**
+ * Update a programme's draft.
+ * POST /api/v1/exceed/channelprogrammes/update
+ * @param {String} id Programme id
+ * @param {ChannelProgrammeInput} data Fields to merge into the draft
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const updateChannelProgramme: (id: string, data: ChannelProgrammeInput, authToken: string) => Promise<object>;
+/**
+ * Publish a programme's draft. The only operation that changes what partners can
+ * see — content granted or revoked since the last publish takes effect here.
+ * POST /api/v1/exceed/channelprogrammes/publish/:id
+ * @param {String} id Programme id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const publishChannelProgramme: (id: string, authToken: string) => Promise<object>;
+/**
+ * Discard draft changes, restoring the draft from the published version.
+ * GET /api/v1/exceed/channelprogrammes/discard/:id
+ * @param {String} id Programme id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const discardChannelProgrammeChanges: (id: string, authToken: string) => Promise<object>;
+/**
+ * Soft-delete a programme.
+ *
+ * Does NOT cascade to partnerships: a partnership records that an organization
+ * accepted terms on a date, which stays true whether or not the programme still
+ * exists. Terminate active partnerships first if that is the intent.
+ * DELETE /api/v1/exceed/channelprogrammes
+ * @param {String} id Programme id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const deleteChannelProgramme: (id: string, authToken: string) => Promise<object>;
+/**
+ * Add learning content to a programme's grant.
+ *
+ * Additive and idempotent — pass what you want added, not the whole list, so two
+ * channel managers granting concurrently do not overwrite each other. Takes
+ * effect for partners only once the programme is published.
+ * POST /api/v1/exceed/channelprogrammes/content/grant
+ * @param {String} id Programme id
+ * @param {String[]} learningContentIds Content ids to add to the grant
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const grantLearningContent: (id: string, learningContentIds: string[], authToken: string) => Promise<object>;
+/**
+ * Remove learning content from a programme's grant. Takes effect for partners
+ * only once the programme is published.
+ * POST /api/v1/exceed/channelprogrammes/content/revoke
+ * @param {String} id Programme id
+ * @param {String[]} learningContentIds Content ids to remove from the grant
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const revokeLearningContent: (id: string, learningContentIds: string[], authToken: string) => Promise<object>;
+//# sourceMappingURL=channelProgrammes.d.ts.map

package/dist/esm/lib/channelProgrammes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channelProgrammes.d.ts","sourceRoot":"","sources":["../../../src/lib/channelProgrammes.ts"],"names":[],"mappings":"AAuBA,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAC/B,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,kDAAkD;AAClD,MAAM,WAAW,0BAA0B;IACzC,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,0BAA0B,EAClC,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAahB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GACjC,MAAM,qBAAqB,EAC3B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,IAAI,MAAM,EACV,SAAS,MAAM,EACf,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,GACjC,IAAI,MAAM,EACV,MAAM,qBAAqB,EAC3B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAClC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,GACzC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GACjC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,oBAAoB,MAAM,EAAE,EAC5B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,oBAAoB,MAAM,EAAE,EAC5B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}