@metamask-previews/subscription-controller 8.0.1-preview-3866c0ff1 → 8.0.1-preview-e3275932a

package/CHANGELOG.md

@@ -11,7 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- **BREAKING:** Bump minimum Node.js version to 22 ([#9168](https://github.com/MetaMask/core/pull/9168))
 - Bump `@tanstack/query-core` from `^4.43.0` to `^5.62.16` ([#9712](https://github.com/MetaMask/core/pull/9712))
 - Bump `@metamask/transaction-controller` from `^69.5.2` to `^69.6.1` ([#9960](https://github.com/MetaMask/core/pull/9960), [#9969](https://github.com/MetaMask/core/pull/9969))
 - Bump `@metamask/base-data-service` from `^0.1.3` to `^1.0.0` ([#9972](https://github.com/MetaMask/core/pull/9972))

package/dist/SubscriptionController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SubscriptionController-method-action-types.cjs.map

package/dist/SubscriptionController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.cjs","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SubscriptionController } from './SubscriptionController.js';\n\n/**\n * Gets the pricing information from the subscription service.\n *\n * @returns The pricing information.\n */\nexport type SubscriptionControllerGetPricingAction = {\n  type: `SubscriptionController:getPricing`;\n  handler: SubscriptionController['getPricing'];\n};\n\nexport type SubscriptionControllerGetSubscriptionsAction = {\n  type: `SubscriptionController:getSubscriptions`;\n  handler: SubscriptionController['getSubscriptions'];\n};\n\n/**\n * Get the subscription by product.\n *\n * @param productType - The product type.\n * @returns The subscription.\n */\nexport type SubscriptionControllerGetSubscriptionByProductAction = {\n  type: `SubscriptionController:getSubscriptionByProduct`;\n  handler: SubscriptionController['getSubscriptionByProduct'];\n};\n\n/**\n * Get the subscriptions eligibilities.\n *\n * @param request - Optional request object containing user balance to check cohort eligibility.\n * @returns The subscriptions eligibilities.\n */\nexport type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {\n  type: `SubscriptionController:getSubscriptionsEligibilities`;\n  handler: SubscriptionController['getSubscriptionsEligibilities'];\n};\n\nexport type SubscriptionControllerCancelSubscriptionAction = {\n  type: `SubscriptionController:cancelSubscription`;\n  handler: SubscriptionController['cancelSubscription'];\n};\n\nexport type SubscriptionControllerUnCancelSubscriptionAction = {\n  type: `SubscriptionController:unCancelSubscription`;\n  handler: SubscriptionController['unCancelSubscription'];\n};\n\n/**\n * Starts a card-paid subscription checkout session for the requested products\n * (e.g. Shield or Money Account Plus).\n *\n * `isTrialRequested` on the request is ignored and overwritten from pricing\n * (`trialPeriodDays > 0`) and `trialedProducts`.\n *\n * @param request - The start subscription request.\n * @returns The checkout session response.\n */\nexport type SubscriptionControllerStartSubscriptionWithCardAction = {\n  type: `SubscriptionController:startSubscriptionWithCard`;\n  handler: SubscriptionController['startSubscriptionWithCard'];\n};\n\n/**\n * Starts a crypto-paid subscription for the requested products\n * (e.g. Shield or Money Account Plus). Unlike card checkout, this\n * creates the subscription immediately, so local state is refreshed\n * afterwards.\n *\n * `isTrialRequested` on the request is ignored and overwritten from pricing\n * (`trialPeriodDays > 0`) and `trialedProducts`.\n *\n * @param request - The start crypto subscription request.\n * @returns The start crypto subscription response.\n * @throws If `products` is empty.\n */\nexport type SubscriptionControllerStartSubscriptionWithCryptoAction = {\n  type: `SubscriptionController:startSubscriptionWithCrypto`;\n  handler: SubscriptionController['startSubscriptionWithCrypto'];\n};\n\n/**\n * Submits a Shield ERC-20 crypto approval transaction to start or update a\n * crypto subscription.\n *\n * This handler is Shield / `TransactionType.shieldSubscriptionApprove` only.\n * Delegation-based products (e.g. Money Account) must call\n * `startSubscriptionWithCrypto` instead.\n *\n * @param request - The crypto approval request.\n * @param request.productType - The subscription product. Typed as\n * `typeof PRODUCT_TYPES.SHIELD` only at the moment (future might support more\n * product).\n * @param request.txMeta - The transaction metadata. Must have type\n * `TransactionType.shieldSubscriptionApprove`.\n * @param request.isSponsored - Whether the transaction is sponsored.\n * @param request.rewardAccountId - The account ID of the reward subscription\n * to link.\n * @throws If `productType` is not Shield or `txMeta.type` is not\n * `shieldSubscriptionApprove`.\n * @returns void\n */\nexport type SubscriptionControllerSubmitSubscriptionCryptoApprovalAction = {\n  type: `SubscriptionController:submitSubscriptionCryptoApproval`;\n  handler: SubscriptionController['submitSubscriptionCryptoApproval'];\n};\n\n/**\n * Get transaction params to create crypto approve transaction for subscription payment\n *\n * @param request - The request object\n * @param request.chainId - The chain ID\n * @param request.tokenAddress - The address of the token\n * @param request.productType - The product type\n * @param request.interval - The interval\n * @returns The crypto approve transaction params\n */\nexport type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {\n  type: `SubscriptionController:getCryptoApproveTransactionParams`;\n  handler: SubscriptionController['getCryptoApproveTransactionParams'];\n};\n\nexport type SubscriptionControllerUpdatePaymentMethodAction = {\n  type: `SubscriptionController:updatePaymentMethod`;\n  handler: SubscriptionController['updatePaymentMethod'];\n};\n\n/**\n * Gets the billing portal URL.\n *\n * @returns The billing portal URL\n */\nexport type SubscriptionControllerGetBillingPortalUrlAction = {\n  type: `SubscriptionController:getBillingPortalUrl`;\n  handler: SubscriptionController['getBillingPortalUrl'];\n};\n\n/**\n * Cache the last selected payment method for a specific product.\n *\n * @param request - The request object.\n * @param request.product - The product to cache the payment method for.\n * @param request.paymentMethod - The payment method to cache.\n * @param request.paymentMethod.type - The type of the payment method.\n * @param request.paymentMethod.paymentTokenAddress - The payment token address.\n * @param request.paymentMethod.plan - The plan of the payment method.\n */\nexport type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:cacheLastSelectedPaymentMethod`;\n  handler: SubscriptionController['cacheLastSelectedPaymentMethod'];\n};\n\n/**\n * Clear the last selected payment method for a specific product.\n *\n * @param product - The product to clear the payment method for.\n */\nexport type SubscriptionControllerClearLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:clearLastSelectedPaymentMethod`;\n  handler: SubscriptionController['clearLastSelectedPaymentMethod'];\n};\n\n/**\n * Submit sponsorship intents to the Subscription Service backend.\n *\n * This is intended to be used together with the crypto subscription flow.\n * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n *\n * @param request - Request object containing the address and products.\n * @example {\n * address: '0x1234567890123456789012345678901234567890',\n * products: [ProductType.Shield],\n * recurringInterval: RecurringInterval.Month,\n * billingCycles: 1,\n * }\n * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false if the chain does not support sponsorship or the user has already trialed\n * @throws If the crypto payment method or chain is missing from pricing\n */\nexport type SubscriptionControllerSubmitSponsorshipIntentsAction = {\n  type: `SubscriptionController:submitSponsorshipIntents`;\n  handler: SubscriptionController['submitSponsorshipIntents'];\n};\n\n/**\n * Submit a user event from the UI. (e.g. shield modal viewed)\n *\n * @param request - Request object containing the event to submit.\n * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }\n */\nexport type SubscriptionControllerSubmitUserEventAction = {\n  type: `SubscriptionController:submitUserEvent`;\n  handler: SubscriptionController['submitUserEvent'];\n};\n\n/**\n * Assign user to a cohort.\n *\n * @param request - Request object containing the cohort to assign the user to.\n * @example { cohort: 'post_tx' }\n */\nexport type SubscriptionControllerAssignUserToCohortAction = {\n  type: `SubscriptionController:assignUserToCohort`;\n  handler: SubscriptionController['assignUserToCohort'];\n};\n\n/**\n * Link rewards to a subscription.\n *\n * @param request - Request object containing the reward subscription ID.\n * @param request.subscriptionId - The ID of the subscription to link rewards to.\n * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.\n * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }\n * @returns Resolves when the rewards are linked successfully.\n */\nexport type SubscriptionControllerLinkRewardsAction = {\n  type: `SubscriptionController:linkRewards`;\n  handler: SubscriptionController['linkRewards'];\n};\n\n/**\n * Calculate token approve amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token approve amount\n */\nexport type SubscriptionControllerGetTokenApproveAmountAction = {\n  type: `SubscriptionController:getTokenApproveAmount`;\n  handler: SubscriptionController['getTokenApproveAmount'];\n};\n\n/**\n * Calculate token minimum balance amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token balance amount\n */\nexport type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {\n  type: `SubscriptionController:getTokenMinimumBalanceAmount`;\n  handler: SubscriptionController['getTokenMinimumBalanceAmount'];\n};\n\n/**\n * Clears the subscription state and resets to default values.\n */\nexport type SubscriptionControllerClearStateAction = {\n  type: `SubscriptionController:clearState`;\n  handler: SubscriptionController['clearState'];\n};\n\n/**\n * Triggers an access token refresh.\n */\nexport type SubscriptionControllerTriggerAccessTokenRefreshAction = {\n  type: `SubscriptionController:triggerAccessTokenRefresh`;\n  handler: SubscriptionController['triggerAccessTokenRefresh'];\n};\n\nexport type SubscriptionControllerStopAllPollingAction = {\n  type: `SubscriptionController:stopAllPolling`;\n  handler: SubscriptionController['stopAllPolling'];\n};\n\n/**\n * Union of all SubscriptionController action types.\n */\nexport type SubscriptionControllerMethodActions =\n  | SubscriptionControllerGetPricingAction\n  | SubscriptionControllerGetSubscriptionsAction\n  | SubscriptionControllerGetSubscriptionByProductAction\n  | SubscriptionControllerGetSubscriptionsEligibilitiesAction\n  | SubscriptionControllerCancelSubscriptionAction\n  | SubscriptionControllerUnCancelSubscriptionAction\n  | SubscriptionControllerStartSubscriptionWithCardAction\n  | SubscriptionControllerStartSubscriptionWithCryptoAction\n  | SubscriptionControllerSubmitSubscriptionCryptoApprovalAction\n  | SubscriptionControllerGetCryptoApproveTransactionParamsAction\n  | SubscriptionControllerUpdatePaymentMethodAction\n  | SubscriptionControllerGetBillingPortalUrlAction\n  | SubscriptionControllerCacheLastSelectedPaymentMethodAction\n  | SubscriptionControllerClearLastSelectedPaymentMethodAction\n  | SubscriptionControllerSubmitSponsorshipIntentsAction\n  | SubscriptionControllerSubmitUserEventAction\n  | SubscriptionControllerAssignUserToCohortAction\n  | SubscriptionControllerLinkRewardsAction\n  | SubscriptionControllerGetTokenApproveAmountAction\n  | SubscriptionControllerGetTokenMinimumBalanceAmountAction\n  | SubscriptionControllerClearStateAction\n  | SubscriptionControllerTriggerAccessTokenRefreshAction\n  | SubscriptionControllerStopAllPollingAction;\n"]}

package/dist/{SubscriptionController-method-action-types.d.ts → SubscriptionController-method-action-types.d.cts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { SubscriptionController } from './SubscriptionController.js';
+import type { SubscriptionController } from "./SubscriptionController.cjs";
 /**
  * Gets the pricing information from the subscription service.
  *
@@ -247,4 +247,4 @@ export type SubscriptionControllerStopAllPollingAction = {
  * Union of all SubscriptionController action types.
  */
 export type SubscriptionControllerMethodActions = SubscriptionControllerGetPricingAction | SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerGetSubscriptionByProductAction | SubscriptionControllerGetSubscriptionsEligibilitiesAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerUnCancelSubscriptionAction | SubscriptionControllerStartSubscriptionWithCardAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerSubmitSubscriptionCryptoApprovalAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerUpdatePaymentMethodAction | SubscriptionControllerGetBillingPortalUrlAction | SubscriptionControllerCacheLastSelectedPaymentMethodAction | SubscriptionControllerClearLastSelectedPaymentMethodAction | SubscriptionControllerSubmitSponsorshipIntentsAction | SubscriptionControllerSubmitUserEventAction | SubscriptionControllerAssignUserToCohortAction | SubscriptionControllerLinkRewardsAction | SubscriptionControllerGetTokenApproveAmountAction | SubscriptionControllerGetTokenMinimumBalanceAmountAction | SubscriptionControllerClearStateAction | SubscriptionControllerTriggerAccessTokenRefreshAction | SubscriptionControllerStopAllPollingAction;
-//# sourceMappingURL=SubscriptionController-method-action-types.d.ts.map
+//# sourceMappingURL=SubscriptionController-method-action-types.d.cts.map

package/dist/SubscriptionController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.d.cts","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,qCAAoC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;CAChE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,sBAAsB,CAAC,kCAAkC,CAAC,CAAC;CACrE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wDAAwD,GAAG;IACrE,IAAI,EAAE,qDAAqD,CAAC;IAC5D,OAAO,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;CACjE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,sCAAsC,GACtC,4CAA4C,GAC5C,oDAAoD,GACpD,yDAAyD,GACzD,8CAA8C,GAC9C,gDAAgD,GAChD,qDAAqD,GACrD,uDAAuD,GACvD,4DAA4D,GAC5D,6DAA6D,GAC7D,+CAA+C,GAC/C,+CAA+C,GAC/C,0DAA0D,GAC1D,0DAA0D,GAC1D,oDAAoD,GACpD,2CAA2C,GAC3C,8CAA8C,GAC9C,uCAAuC,GACvC,iDAAiD,GACjD,wDAAwD,GACxD,sCAAsC,GACtC,qDAAqD,GACrD,0CAA0C,CAAC"}

package/dist/SubscriptionController-method-action-types.d.mts

@@ -0,0 +1,250 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { SubscriptionController } from "./SubscriptionController.mjs";
+/**
+ * Gets the pricing information from the subscription service.
+ *
+ * @returns The pricing information.
+ */
+export type SubscriptionControllerGetPricingAction = {
+    type: `SubscriptionController:getPricing`;
+    handler: SubscriptionController['getPricing'];
+};
+export type SubscriptionControllerGetSubscriptionsAction = {
+    type: `SubscriptionController:getSubscriptions`;
+    handler: SubscriptionController['getSubscriptions'];
+};
+/**
+ * Get the subscription by product.
+ *
+ * @param productType - The product type.
+ * @returns The subscription.
+ */
+export type SubscriptionControllerGetSubscriptionByProductAction = {
+    type: `SubscriptionController:getSubscriptionByProduct`;
+    handler: SubscriptionController['getSubscriptionByProduct'];
+};
+/**
+ * Get the subscriptions eligibilities.
+ *
+ * @param request - Optional request object containing user balance to check cohort eligibility.
+ * @returns The subscriptions eligibilities.
+ */
+export type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {
+    type: `SubscriptionController:getSubscriptionsEligibilities`;
+    handler: SubscriptionController['getSubscriptionsEligibilities'];
+};
+export type SubscriptionControllerCancelSubscriptionAction = {
+    type: `SubscriptionController:cancelSubscription`;
+    handler: SubscriptionController['cancelSubscription'];
+};
+export type SubscriptionControllerUnCancelSubscriptionAction = {
+    type: `SubscriptionController:unCancelSubscription`;
+    handler: SubscriptionController['unCancelSubscription'];
+};
+/**
+ * Starts a card-paid subscription checkout session for the requested products
+ * (e.g. Shield or Money Account Plus).
+ *
+ * `isTrialRequested` on the request is ignored and overwritten from pricing
+ * (`trialPeriodDays > 0`) and `trialedProducts`.
+ *
+ * @param request - The start subscription request.
+ * @returns The checkout session response.
+ */
+export type SubscriptionControllerStartSubscriptionWithCardAction = {
+    type: `SubscriptionController:startSubscriptionWithCard`;
+    handler: SubscriptionController['startSubscriptionWithCard'];
+};
+/**
+ * Starts a crypto-paid subscription for the requested products
+ * (e.g. Shield or Money Account Plus). Unlike card checkout, this
+ * creates the subscription immediately, so local state is refreshed
+ * afterwards.
+ *
+ * `isTrialRequested` on the request is ignored and overwritten from pricing
+ * (`trialPeriodDays > 0`) and `trialedProducts`.
+ *
+ * @param request - The start crypto subscription request.
+ * @returns The start crypto subscription response.
+ * @throws If `products` is empty.
+ */
+export type SubscriptionControllerStartSubscriptionWithCryptoAction = {
+    type: `SubscriptionController:startSubscriptionWithCrypto`;
+    handler: SubscriptionController['startSubscriptionWithCrypto'];
+};
+/**
+ * Submits a Shield ERC-20 crypto approval transaction to start or update a
+ * crypto subscription.
+ *
+ * This handler is Shield / `TransactionType.shieldSubscriptionApprove` only.
+ * Delegation-based products (e.g. Money Account) must call
+ * `startSubscriptionWithCrypto` instead.
+ *
+ * @param request - The crypto approval request.
+ * @param request.productType - The subscription product. Typed as
+ * `typeof PRODUCT_TYPES.SHIELD` only at the moment (future might support more
+ * product).
+ * @param request.txMeta - The transaction metadata. Must have type
+ * `TransactionType.shieldSubscriptionApprove`.
+ * @param request.isSponsored - Whether the transaction is sponsored.
+ * @param request.rewardAccountId - The account ID of the reward subscription
+ * to link.
+ * @throws If `productType` is not Shield or `txMeta.type` is not
+ * `shieldSubscriptionApprove`.
+ * @returns void
+ */
+export type SubscriptionControllerSubmitSubscriptionCryptoApprovalAction = {
+    type: `SubscriptionController:submitSubscriptionCryptoApproval`;
+    handler: SubscriptionController['submitSubscriptionCryptoApproval'];
+};
+/**
+ * Get transaction params to create crypto approve transaction for subscription payment
+ *
+ * @param request - The request object
+ * @param request.chainId - The chain ID
+ * @param request.tokenAddress - The address of the token
+ * @param request.productType - The product type
+ * @param request.interval - The interval
+ * @returns The crypto approve transaction params
+ */
+export type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {
+    type: `SubscriptionController:getCryptoApproveTransactionParams`;
+    handler: SubscriptionController['getCryptoApproveTransactionParams'];
+};
+export type SubscriptionControllerUpdatePaymentMethodAction = {
+    type: `SubscriptionController:updatePaymentMethod`;
+    handler: SubscriptionController['updatePaymentMethod'];
+};
+/**
+ * Gets the billing portal URL.
+ *
+ * @returns The billing portal URL
+ */
+export type SubscriptionControllerGetBillingPortalUrlAction = {
+    type: `SubscriptionController:getBillingPortalUrl`;
+    handler: SubscriptionController['getBillingPortalUrl'];
+};
+/**
+ * Cache the last selected payment method for a specific product.
+ *
+ * @param request - The request object.
+ * @param request.product - The product to cache the payment method for.
+ * @param request.paymentMethod - The payment method to cache.
+ * @param request.paymentMethod.type - The type of the payment method.
+ * @param request.paymentMethod.paymentTokenAddress - The payment token address.
+ * @param request.paymentMethod.plan - The plan of the payment method.
+ */
+export type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:cacheLastSelectedPaymentMethod`;
+    handler: SubscriptionController['cacheLastSelectedPaymentMethod'];
+};
+/**
+ * Clear the last selected payment method for a specific product.
+ *
+ * @param product - The product to clear the payment method for.
+ */
+export type SubscriptionControllerClearLastSelectedPaymentMethodAction = {
+    type: `SubscriptionController:clearLastSelectedPaymentMethod`;
+    handler: SubscriptionController['clearLastSelectedPaymentMethod'];
+};
+/**
+ * Submit sponsorship intents to the Subscription Service backend.
+ *
+ * This is intended to be used together with the crypto subscription flow.
+ * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.
+ *
+ * @param request - Request object containing the address and products.
+ * @example {
+ * address: '0x1234567890123456789012345678901234567890',
+ * products: [ProductType.Shield],
+ * recurringInterval: RecurringInterval.Month,
+ * billingCycles: 1,
+ * }
+ * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false if the chain does not support sponsorship or the user has already trialed
+ * @throws If the crypto payment method or chain is missing from pricing
+ */
+export type SubscriptionControllerSubmitSponsorshipIntentsAction = {
+    type: `SubscriptionController:submitSponsorshipIntents`;
+    handler: SubscriptionController['submitSponsorshipIntents'];
+};
+/**
+ * Submit a user event from the UI. (e.g. shield modal viewed)
+ *
+ * @param request - Request object containing the event to submit.
+ * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }
+ */
+export type SubscriptionControllerSubmitUserEventAction = {
+    type: `SubscriptionController:submitUserEvent`;
+    handler: SubscriptionController['submitUserEvent'];
+};
+/**
+ * Assign user to a cohort.
+ *
+ * @param request - Request object containing the cohort to assign the user to.
+ * @example { cohort: 'post_tx' }
+ */
+export type SubscriptionControllerAssignUserToCohortAction = {
+    type: `SubscriptionController:assignUserToCohort`;
+    handler: SubscriptionController['assignUserToCohort'];
+};
+/**
+ * Link rewards to a subscription.
+ *
+ * @param request - Request object containing the reward subscription ID.
+ * @param request.subscriptionId - The ID of the subscription to link rewards to.
+ * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.
+ * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }
+ * @returns Resolves when the rewards are linked successfully.
+ */
+export type SubscriptionControllerLinkRewardsAction = {
+    type: `SubscriptionController:linkRewards`;
+    handler: SubscriptionController['linkRewards'];
+};
+/**
+ * Calculate token approve amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token approve amount
+ */
+export type SubscriptionControllerGetTokenApproveAmountAction = {
+    type: `SubscriptionController:getTokenApproveAmount`;
+    handler: SubscriptionController['getTokenApproveAmount'];
+};
+/**
+ * Calculate token minimum balance amount from price info
+ *
+ * @param price - The price info
+ * @param tokenPaymentInfo - The token price info
+ * @returns The token balance amount
+ */
+export type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {
+    type: `SubscriptionController:getTokenMinimumBalanceAmount`;
+    handler: SubscriptionController['getTokenMinimumBalanceAmount'];
+};
+/**
+ * Clears the subscription state and resets to default values.
+ */
+export type SubscriptionControllerClearStateAction = {
+    type: `SubscriptionController:clearState`;
+    handler: SubscriptionController['clearState'];
+};
+/**
+ * Triggers an access token refresh.
+ */
+export type SubscriptionControllerTriggerAccessTokenRefreshAction = {
+    type: `SubscriptionController:triggerAccessTokenRefresh`;
+    handler: SubscriptionController['triggerAccessTokenRefresh'];
+};
+export type SubscriptionControllerStopAllPollingAction = {
+    type: `SubscriptionController:stopAllPolling`;
+    handler: SubscriptionController['stopAllPolling'];
+};
+/**
+ * Union of all SubscriptionController action types.
+ */
+export type SubscriptionControllerMethodActions = SubscriptionControllerGetPricingAction | SubscriptionControllerGetSubscriptionsAction | SubscriptionControllerGetSubscriptionByProductAction | SubscriptionControllerGetSubscriptionsEligibilitiesAction | SubscriptionControllerCancelSubscriptionAction | SubscriptionControllerUnCancelSubscriptionAction | SubscriptionControllerStartSubscriptionWithCardAction | SubscriptionControllerStartSubscriptionWithCryptoAction | SubscriptionControllerSubmitSubscriptionCryptoApprovalAction | SubscriptionControllerGetCryptoApproveTransactionParamsAction | SubscriptionControllerUpdatePaymentMethodAction | SubscriptionControllerGetBillingPortalUrlAction | SubscriptionControllerCacheLastSelectedPaymentMethodAction | SubscriptionControllerClearLastSelectedPaymentMethodAction | SubscriptionControllerSubmitSponsorshipIntentsAction | SubscriptionControllerSubmitUserEventAction | SubscriptionControllerAssignUserToCohortAction | SubscriptionControllerLinkRewardsAction | SubscriptionControllerGetTokenApproveAmountAction | SubscriptionControllerGetTokenMinimumBalanceAmountAction | SubscriptionControllerClearStateAction | SubscriptionControllerTriggerAccessTokenRefreshAction | SubscriptionControllerStopAllPollingAction;
+//# sourceMappingURL=SubscriptionController-method-action-types.d.mts.map

package/dist/SubscriptionController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.d.mts","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,qCAAoC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;CAChE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,sBAAsB,CAAC,kCAAkC,CAAC,CAAC;CACrE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,sBAAsB,CAAC,mCAAmC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,sBAAsB,CAAC,gCAAgC,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oDAAoD,GAAG;IACjE,IAAI,EAAE,iDAAiD,CAAC;IACxD,OAAO,EAAE,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;CAC7D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,wDAAwD,GAAG;IACrE,IAAI,EAAE,qDAAqD,CAAC;IAC5D,OAAO,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;CACjE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,IAAI,EAAE,uCAAuC,CAAC;IAC9C,OAAO,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;CACnD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,sCAAsC,GACtC,4CAA4C,GAC5C,oDAAoD,GACpD,yDAAyD,GACzD,8CAA8C,GAC9C,gDAAgD,GAChD,qDAAqD,GACrD,uDAAuD,GACvD,4DAA4D,GAC5D,6DAA6D,GAC7D,+CAA+C,GAC/C,+CAA+C,GAC/C,0DAA0D,GAC1D,0DAA0D,GAC1D,oDAAoD,GACpD,2CAA2C,GAC3C,8CAA8C,GAC9C,uCAAuC,GACvC,iDAAiD,GACjD,wDAAwD,GACxD,sCAAsC,GACtC,qDAAqD,GACrD,0CAA0C,CAAC"}

package/dist/{SubscriptionController-method-action-types.js → SubscriptionController-method-action-types.mjs}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=SubscriptionController-method-action-types.js.map
+//# sourceMappingURL=SubscriptionController-method-action-types.mjs.map

package/dist/SubscriptionController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscriptionController-method-action-types.mjs","sourceRoot":"","sources":["../src/SubscriptionController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SubscriptionController } from './SubscriptionController.js';\n\n/**\n * Gets the pricing information from the subscription service.\n *\n * @returns The pricing information.\n */\nexport type SubscriptionControllerGetPricingAction = {\n  type: `SubscriptionController:getPricing`;\n  handler: SubscriptionController['getPricing'];\n};\n\nexport type SubscriptionControllerGetSubscriptionsAction = {\n  type: `SubscriptionController:getSubscriptions`;\n  handler: SubscriptionController['getSubscriptions'];\n};\n\n/**\n * Get the subscription by product.\n *\n * @param productType - The product type.\n * @returns The subscription.\n */\nexport type SubscriptionControllerGetSubscriptionByProductAction = {\n  type: `SubscriptionController:getSubscriptionByProduct`;\n  handler: SubscriptionController['getSubscriptionByProduct'];\n};\n\n/**\n * Get the subscriptions eligibilities.\n *\n * @param request - Optional request object containing user balance to check cohort eligibility.\n * @returns The subscriptions eligibilities.\n */\nexport type SubscriptionControllerGetSubscriptionsEligibilitiesAction = {\n  type: `SubscriptionController:getSubscriptionsEligibilities`;\n  handler: SubscriptionController['getSubscriptionsEligibilities'];\n};\n\nexport type SubscriptionControllerCancelSubscriptionAction = {\n  type: `SubscriptionController:cancelSubscription`;\n  handler: SubscriptionController['cancelSubscription'];\n};\n\nexport type SubscriptionControllerUnCancelSubscriptionAction = {\n  type: `SubscriptionController:unCancelSubscription`;\n  handler: SubscriptionController['unCancelSubscription'];\n};\n\n/**\n * Starts a card-paid subscription checkout session for the requested products\n * (e.g. Shield or Money Account Plus).\n *\n * `isTrialRequested` on the request is ignored and overwritten from pricing\n * (`trialPeriodDays > 0`) and `trialedProducts`.\n *\n * @param request - The start subscription request.\n * @returns The checkout session response.\n */\nexport type SubscriptionControllerStartSubscriptionWithCardAction = {\n  type: `SubscriptionController:startSubscriptionWithCard`;\n  handler: SubscriptionController['startSubscriptionWithCard'];\n};\n\n/**\n * Starts a crypto-paid subscription for the requested products\n * (e.g. Shield or Money Account Plus). Unlike card checkout, this\n * creates the subscription immediately, so local state is refreshed\n * afterwards.\n *\n * `isTrialRequested` on the request is ignored and overwritten from pricing\n * (`trialPeriodDays > 0`) and `trialedProducts`.\n *\n * @param request - The start crypto subscription request.\n * @returns The start crypto subscription response.\n * @throws If `products` is empty.\n */\nexport type SubscriptionControllerStartSubscriptionWithCryptoAction = {\n  type: `SubscriptionController:startSubscriptionWithCrypto`;\n  handler: SubscriptionController['startSubscriptionWithCrypto'];\n};\n\n/**\n * Submits a Shield ERC-20 crypto approval transaction to start or update a\n * crypto subscription.\n *\n * This handler is Shield / `TransactionType.shieldSubscriptionApprove` only.\n * Delegation-based products (e.g. Money Account) must call\n * `startSubscriptionWithCrypto` instead.\n *\n * @param request - The crypto approval request.\n * @param request.productType - The subscription product. Typed as\n * `typeof PRODUCT_TYPES.SHIELD` only at the moment (future might support more\n * product).\n * @param request.txMeta - The transaction metadata. Must have type\n * `TransactionType.shieldSubscriptionApprove`.\n * @param request.isSponsored - Whether the transaction is sponsored.\n * @param request.rewardAccountId - The account ID of the reward subscription\n * to link.\n * @throws If `productType` is not Shield or `txMeta.type` is not\n * `shieldSubscriptionApprove`.\n * @returns void\n */\nexport type SubscriptionControllerSubmitSubscriptionCryptoApprovalAction = {\n  type: `SubscriptionController:submitSubscriptionCryptoApproval`;\n  handler: SubscriptionController['submitSubscriptionCryptoApproval'];\n};\n\n/**\n * Get transaction params to create crypto approve transaction for subscription payment\n *\n * @param request - The request object\n * @param request.chainId - The chain ID\n * @param request.tokenAddress - The address of the token\n * @param request.productType - The product type\n * @param request.interval - The interval\n * @returns The crypto approve transaction params\n */\nexport type SubscriptionControllerGetCryptoApproveTransactionParamsAction = {\n  type: `SubscriptionController:getCryptoApproveTransactionParams`;\n  handler: SubscriptionController['getCryptoApproveTransactionParams'];\n};\n\nexport type SubscriptionControllerUpdatePaymentMethodAction = {\n  type: `SubscriptionController:updatePaymentMethod`;\n  handler: SubscriptionController['updatePaymentMethod'];\n};\n\n/**\n * Gets the billing portal URL.\n *\n * @returns The billing portal URL\n */\nexport type SubscriptionControllerGetBillingPortalUrlAction = {\n  type: `SubscriptionController:getBillingPortalUrl`;\n  handler: SubscriptionController['getBillingPortalUrl'];\n};\n\n/**\n * Cache the last selected payment method for a specific product.\n *\n * @param request - The request object.\n * @param request.product - The product to cache the payment method for.\n * @param request.paymentMethod - The payment method to cache.\n * @param request.paymentMethod.type - The type of the payment method.\n * @param request.paymentMethod.paymentTokenAddress - The payment token address.\n * @param request.paymentMethod.plan - The plan of the payment method.\n */\nexport type SubscriptionControllerCacheLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:cacheLastSelectedPaymentMethod`;\n  handler: SubscriptionController['cacheLastSelectedPaymentMethod'];\n};\n\n/**\n * Clear the last selected payment method for a specific product.\n *\n * @param product - The product to clear the payment method for.\n */\nexport type SubscriptionControllerClearLastSelectedPaymentMethodAction = {\n  type: `SubscriptionController:clearLastSelectedPaymentMethod`;\n  handler: SubscriptionController['clearLastSelectedPaymentMethod'];\n};\n\n/**\n * Submit sponsorship intents to the Subscription Service backend.\n *\n * This is intended to be used together with the crypto subscription flow.\n * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n *\n * @param request - Request object containing the address and products.\n * @example {\n * address: '0x1234567890123456789012345678901234567890',\n * products: [ProductType.Shield],\n * recurringInterval: RecurringInterval.Month,\n * billingCycles: 1,\n * }\n * @returns resolves to true if the sponsorship is supported and intents were submitted successfully, false if the chain does not support sponsorship or the user has already trialed\n * @throws If the crypto payment method or chain is missing from pricing\n */\nexport type SubscriptionControllerSubmitSponsorshipIntentsAction = {\n  type: `SubscriptionController:submitSponsorshipIntents`;\n  handler: SubscriptionController['submitSponsorshipIntents'];\n};\n\n/**\n * Submit a user event from the UI. (e.g. shield modal viewed)\n *\n * @param request - Request object containing the event to submit.\n * @example { event: SubscriptionUserEvent.ShieldEntryModalViewed, cohort: 'post_tx' }\n */\nexport type SubscriptionControllerSubmitUserEventAction = {\n  type: `SubscriptionController:submitUserEvent`;\n  handler: SubscriptionController['submitUserEvent'];\n};\n\n/**\n * Assign user to a cohort.\n *\n * @param request - Request object containing the cohort to assign the user to.\n * @example { cohort: 'post_tx' }\n */\nexport type SubscriptionControllerAssignUserToCohortAction = {\n  type: `SubscriptionController:assignUserToCohort`;\n  handler: SubscriptionController['assignUserToCohort'];\n};\n\n/**\n * Link rewards to a subscription.\n *\n * @param request - Request object containing the reward subscription ID.\n * @param request.subscriptionId - The ID of the subscription to link rewards to.\n * @param request.rewardAccountId - The account ID of the reward subscription to link to the subscription.\n * @example { subscriptionId: '1234567890', rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890' }\n * @returns Resolves when the rewards are linked successfully.\n */\nexport type SubscriptionControllerLinkRewardsAction = {\n  type: `SubscriptionController:linkRewards`;\n  handler: SubscriptionController['linkRewards'];\n};\n\n/**\n * Calculate token approve amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token approve amount\n */\nexport type SubscriptionControllerGetTokenApproveAmountAction = {\n  type: `SubscriptionController:getTokenApproveAmount`;\n  handler: SubscriptionController['getTokenApproveAmount'];\n};\n\n/**\n * Calculate token minimum balance amount from price info\n *\n * @param price - The price info\n * @param tokenPaymentInfo - The token price info\n * @returns The token balance amount\n */\nexport type SubscriptionControllerGetTokenMinimumBalanceAmountAction = {\n  type: `SubscriptionController:getTokenMinimumBalanceAmount`;\n  handler: SubscriptionController['getTokenMinimumBalanceAmount'];\n};\n\n/**\n * Clears the subscription state and resets to default values.\n */\nexport type SubscriptionControllerClearStateAction = {\n  type: `SubscriptionController:clearState`;\n  handler: SubscriptionController['clearState'];\n};\n\n/**\n * Triggers an access token refresh.\n */\nexport type SubscriptionControllerTriggerAccessTokenRefreshAction = {\n  type: `SubscriptionController:triggerAccessTokenRefresh`;\n  handler: SubscriptionController['triggerAccessTokenRefresh'];\n};\n\nexport type SubscriptionControllerStopAllPollingAction = {\n  type: `SubscriptionController:stopAllPolling`;\n  handler: SubscriptionController['stopAllPolling'];\n};\n\n/**\n * Union of all SubscriptionController action types.\n */\nexport type SubscriptionControllerMethodActions =\n  | SubscriptionControllerGetPricingAction\n  | SubscriptionControllerGetSubscriptionsAction\n  | SubscriptionControllerGetSubscriptionByProductAction\n  | SubscriptionControllerGetSubscriptionsEligibilitiesAction\n  | SubscriptionControllerCancelSubscriptionAction\n  | SubscriptionControllerUnCancelSubscriptionAction\n  | SubscriptionControllerStartSubscriptionWithCardAction\n  | SubscriptionControllerStartSubscriptionWithCryptoAction\n  | SubscriptionControllerSubmitSubscriptionCryptoApprovalAction\n  | SubscriptionControllerGetCryptoApproveTransactionParamsAction\n  | SubscriptionControllerUpdatePaymentMethodAction\n  | SubscriptionControllerGetBillingPortalUrlAction\n  | SubscriptionControllerCacheLastSelectedPaymentMethodAction\n  | SubscriptionControllerClearLastSelectedPaymentMethodAction\n  | SubscriptionControllerSubmitSponsorshipIntentsAction\n  | SubscriptionControllerSubmitUserEventAction\n  | SubscriptionControllerAssignUserToCohortAction\n  | SubscriptionControllerLinkRewardsAction\n  | SubscriptionControllerGetTokenApproveAmountAction\n  | SubscriptionControllerGetTokenMinimumBalanceAmountAction\n  | SubscriptionControllerClearStateAction\n  | SubscriptionControllerTriggerAccessTokenRefreshAction\n  | SubscriptionControllerStopAllPollingAction;\n"]}