@tagadapay/headless-sdk 1.16.0 → 1.17.0

package/dist/core/modules/portal/index.js

@@ -0,0 +1,166 @@
+/**
+ * Customer portal (Subscriptions V3): the store's portal config, the logged-in
+ * customer, retention, plan switches, upsell links and credits.
+ *
+ * Log in with `requestCode` then `verifyCode`; every other call except
+ * `getConfig` needs that session. Subscription actions (pause, skip, …) live on
+ * `client.customer`.
+ *
+ * Endpoints:
+ *   GET  /api/v1/portal/config
+ *   GET  /api/v1/portal/me
+ *   POST /api/v1/portal/cancel-flow
+ *   POST /api/v1/portal/cancel-flow/accept
+ *   POST /api/v1/portal/switch
+ *   GET  /api/v1/portal/offers/:token
+ *   POST /api/v1/portal/offers/accept
+ *   POST /api/v1/portal/next-order
+ *   GET  /api/v1/portal/credits
+ *   POST /api/v1/portal/credits/redeem
+ *   POST /api/v1/portal/credits/packs/buy
+ *   POST /api/v1/portal/profile, /profile/email-code
+ *   POST /api/v1/portal/addresses, /addresses/remove, /addresses/default
+ *   POST /api/v1/portal/payment-methods, /payment-methods/remove, /payment-methods/default
+ *   POST /api/v1/portal/retry-payment
+ *   POST /api/v1/portal/buy-again
+ *   POST /api/v1/portal/membership/join
+ *   POST /api/v1/subscriptions/send-now, /reactivate, /saved-card, /shipping-address, /skip-date, /unskip
+ */
+export class CustomerPortalModule {
+    constructor(http, storeId, setToken) {
+        this.http = http;
+        this.storeId = storeId;
+        this.setToken = setToken;
+    }
+    /** Email a login code to the customer. */
+    async requestCode(email) {
+        await this.http.post('/api/v1/cms/session/request-code', { email, storeId: this.storeId });
+    }
+    /** Exchange the emailed code for a session; later calls send it. */
+    async verifyCode(email, code) {
+        const res = await this.http.post('/api/v1/cms/session/login', {
+            email,
+            code,
+            storeId: this.storeId,
+        });
+        this.setToken(res.token);
+        return res;
+    }
+    /** The store's published portal: design, retention, membership program, products. */
+    async getConfig() {
+        return this.http.get('/api/v1/portal/config', { params: { storeId: this.storeId } });
+    }
+    /** The logged-in customer: profile, orders, subscriptions, membership, credit ledger. */
+    async getMe() {
+        return this.http.get('/api/v1/portal/me');
+    }
+    /** Cancel a subscription or the membership after the reasons step. */
+    async cancelFlow(input) {
+        return this.http.post('/api/v1/portal/cancel-flow', input);
+    }
+    /** Take the retention offer mapped to the chosen reason instead of cancelling. */
+    async acceptCancelOffer(input) {
+        return this.http.post('/api/v1/portal/cancel-flow/accept', input);
+    }
+    /** Move a subscription or the membership to another option now, charged now. */
+    async switchOption(input) {
+        return this.http.post('/api/v1/portal/switch', input);
+    }
+    /** The upsell a signed link (`/account/offer/<token>`) offers. No login: the token is the authorization. */
+    async getOffer(token) {
+        return this.http.get(`/api/v1/portal/offers/${encodeURIComponent(token)}`);
+    }
+    /** Accept a signed upsell link and pay it with the card of the original order. A second accept charges nothing. */
+    async acceptOffer(input) {
+        return this.http.post('/api/v1/portal/offers/accept', input);
+    }
+    /** Ship a one-time item with the subscription's next renewal, charged with it; quantity 0 takes it off. */
+    async addToNextOrder(input) {
+        return this.http.post('/api/v1/portal/next-order', input);
+    }
+    /** Credit balance and ledger of the logged-in customer. */
+    async getCredits() {
+        return this.http.get('/api/v1/portal/credits');
+    }
+    /** Pay a product with credits. */
+    async redeemCredits(input) {
+        return this.http.post('/api/v1/portal/credits/redeem', input);
+    }
+    /** Buy a credit pack with the stored card. */
+    async buyCreditPack(input) {
+        return this.http.post('/api/v1/portal/credits/packs/buy', input);
+    }
+    // ── The customer's own account ─────────────────────────────────────────────
+    /** Email a code to a new address; `updateProfile` saves that email with it (`emailCode`). */
+    async requestEmailChangeCode(email) {
+        await this.http.post('/api/v1/portal/profile/email-code', { email });
+    }
+    /** The logged-in customer's name, email and phone. */
+    async updateProfile(profile) {
+        await this.http.post('/api/v1/portal/profile', profile);
+    }
+    /** Add an address, or replace the one with that id; `isDefault` makes it the default. */
+    async saveAddress(address) {
+        return this.http.post('/api/v1/portal/addresses', address);
+    }
+    /** Remove an address; the default one stays until another is the default. */
+    async removeAddress(addressId) {
+        await this.http.post('/api/v1/portal/addresses/remove', { addressId });
+    }
+    async setDefaultAddress(addressId) {
+        await this.http.post('/api/v1/portal/addresses/default', { addressId });
+    }
+    /** Save a card tokenized with `client.payment.tokenizeCard`. */
+    async addCard(input) {
+        return this.http.post('/api/v1/portal/payment-methods', input);
+    }
+    /** Remove a saved card; refused while a live subscription is paid with it. */
+    async removeCard(paymentMethodId) {
+        await this.http.post('/api/v1/portal/payment-methods/remove', { paymentMethodId });
+    }
+    /** The default card also becomes the card of every live subscription. */
+    async setDefaultPaymentMethod(paymentMethodId) {
+        await this.http.post('/api/v1/portal/payment-methods/default', { paymentMethodId });
+    }
+    /** Charge a past-due subscription again now. */
+    async retryPayment(subscriptionId) {
+        return this.http.post('/api/v1/portal/retry-payment', { subscriptionId });
+    }
+    /** Order products again at today's one-time price with the default card and address. */
+    async buyAgain(lines) {
+        return this.http.post('/api/v1/portal/buy-again', { lines: lines.map(({ variantId, quantity }) => ({ variantId, quantity })) });
+    }
+    /** Buy the Membership's monthly or yearly option with the default card. */
+    async joinMembership(billing) {
+        return this.http.post('/api/v1/portal/membership/join', { billing });
+    }
+    /** Buy one product now at its one-time price with the default card and address. */
+    async buyNow(variantId, quantity = 1) {
+        return this.buyAgain([{ variantId, quantity }]);
+    }
+    /** Charge and ship a subscription's next order today. */
+    async sendNow(subscriptionId) {
+        return this.http.post('/api/v1/subscriptions/send-now', { subscriptionId });
+    }
+    /** Restart a cancelled subscription, or keep one set to end at its period end. */
+    async reactivateSubscription(subscriptionId) {
+        return this.http.post('/api/v1/subscriptions/reactivate', { subscriptionId });
+    }
+    /** Bill a subscription on another saved card. */
+    async setSubscriptionCard(subscriptionId, paymentMethodId) {
+        return this.http.post('/api/v1/subscriptions/saved-card', { subscriptionId, paymentMethodId });
+    }
+    /** Ship a subscription to an address of the book; null follows the default address. */
+    async setSubscriptionAddress(subscriptionId, addressId) {
+        return this.http.post('/api/v1/subscriptions/shipping-address', { subscriptionId, addressId });
+    }
+    /** Skip one upcoming delivery date (`YYYY-MM-DD`); skipping the next one moves the next charge. */
+    async skipDate(subscriptionId, date) {
+        return this.http.post('/api/v1/subscriptions/skip-date', { subscriptionId, date });
+    }
+    /** Take back a skipped delivery date (`YYYY-MM-DD`). */
+    async unskipDate(subscriptionId, date) {
+        return this.http.post('/api/v1/subscriptions/unskip', { subscriptionId, date });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/core/modules/portal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/modules/portal/index.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,oBAAoB;IAC/B,YACmB,IAAgB,EAChB,OAAe,EACf,QAAiC;QAFjC,SAAI,GAAJ,IAAI,CAAY;QAChB,YAAO,GAAP,OAAO,CAAQ;QACf,aAAQ,GAAR,QAAQ,CAAyB;IACjD,CAAC;IAEJ,0CAA0C;IAC1C,KAAK,CAAC,WAAW,CAAC,KAAa;QAC7B,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,IAAY;QAC1C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAyB,2BAA2B,EAAE;YACpF,KAAK;YACL,IAAI;YACJ,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,qFAAqF;IACrF,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAqB,uBAAuB,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,KAAK;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAW,mBAAmB,CAAC,CAAC;IACtD,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,UAAU,CAAC,KAA4B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,4BAA4B,EAAE,KAAK,CAAC,CAAC;IACjF,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,iBAAiB,CAAC,KAA6B;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,mCAAmC,EAAE,KAAK,CAAC,CAAC;IACxF,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,YAAY,CAAC,KAAwB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,uBAAuB,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;IAED,4GAA4G;IAC5G,KAAK,CAAC,QAAQ,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAc,yBAAyB,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,mHAAmH;IACnH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAA0B,8BAA8B,EAAE,KAAK,CAAC,CAAC;IACxF,CAAC;IAED,2GAA2G;IAC3G,KAAK,CAAC,cAAc,CAAC,KAAgC;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,2BAA2B,EAAE,KAAK,CAAC,CAAC;IAChF,CAAC;IAED,2DAA2D;IAC3D,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAgB,wBAAwB,CAAC,CAAC;IAChE,CAAC;IAED,kCAAkC;IAClC,KAAK,CAAC,aAAa,CAAC,KAA+B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAA2B,+BAA+B,EAAE,KAAK,CAAC,CAAC;IAC1F,CAAC;IAED,8CAA8C;IAC9C,KAAK,CAAC,aAAa,CAAC,KAA+B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAA2B,kCAAkC,EAAE,KAAK,CAAC,CAAC;IAC7F,CAAC;IAED,8EAA8E;IAE9E,6FAA6F;IAC7F,KAAK,CAAC,sBAAsB,CAAC,KAAa;QACxC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,aAAa,CAAC,OAA2B;QAC7C,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,yFAAyF;IACzF,KAAK,CAAC,WAAW,CAAC,OAA2B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,6EAA6E;IAC7E,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,OAAO,CAAC,KAAyB;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,8EAA8E;IAC9E,KAAK,CAAC,UAAU,CAAC,eAAuB;QACtC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,uBAAuB,CAAC,eAAuB;QACnD,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,eAAe,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,gDAAgD;IAChD,KAAK,CAAC,YAAY,CAAC,cAAsB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,wFAAwF;IACxF,KAAK,CAAC,QAAQ,CAAC,KAAoC;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAClI,CAAC;IAED,2EAA2E;IAC3E,KAAK,CAAC,cAAc,CAAC,OAAgB;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,mFAAmF;IACnF,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,QAAQ,GAAG,CAAC;QAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,OAAO,CAAC,cAAsB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,sBAAsB,CAAC,cAAsB;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,iDAAiD;IACjD,KAAK,CAAC,mBAAmB,CAAC,cAAsB,EAAE,eAAuB;QACvE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,uFAAuF;IACvF,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,SAAwB;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC;IACjG,CAAC;IAED,mGAAmG;IACnG,KAAK,CAAC,QAAQ,CAAC,cAAsB,EAAE,IAAY;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,UAAU,CAAC,cAAsB,EAAE,IAAY;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}