@stackfactor/client-api 1.2.6 → 1.2.8

package/dist/esm/lib/partnerships.js

@@ -0,0 +1,234 @@
+import { client } from "./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>}
+ */
+export const invitePartner = (data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/invite`, data, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const resendInvitation = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/resend/${id}`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const revokeInvitation = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/revoke/${id}`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const listVendorPartnerships = (params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/vendor`, params, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+// ── 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>}
+ */
+export const listTenantPartnerships = (params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships`, params, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const readInvitation = (code, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/invitation`, { code }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const acceptInvitation = (code, termsVersion, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/accept`, { code, termsVersion }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const declineInvitation = (code, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/decline`, { code }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const reacceptTerms = (id, termsVersion, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/reaccept/${id}`, { termsVersion }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+// ── 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>}
+ */
+export const terminatePartnership = (id, reason, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/partnerships/terminate/${id}`, { reason }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+//# sourceMappingURL=partnerships.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"partnerships.js","sourceRoot":"","sources":["../../../src/lib/partnerships.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAiE1C,iFAAiF;AAEjF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,IAA4B,EAC5B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAAmC,EACnC,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF,iFAAiF;AAEjF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAA6B,EAC7B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,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;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,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,MAAM,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;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,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,MAAM,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;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,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,MAAM,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;AAEF,iFAAiF;AAEjF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,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,MAAM,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackfactor/client-api",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "Node.js library for the StackFactor API",
   "publishConfig": {
     "access": "public"