@revenuecat/purchases-capacitor 10.0.2 → 10.2.0

package/dist/docs.json

@@ -28,6 +28,61 @@
         ],
         "slug": "configure"
       },
+      {
+        "name": "parseAsWebPurchaseRedemption",
+        "signature": "(options: { urlString: string; }) => Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Set the urlString used to open the App.",
+            "type": "{ urlString: string; }"
+          }
+        ],
+        "returns": "Promise<{ webPurchaseRedemption: WebPurchaseRedemption | null; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Set the urlString used to open the App."
+          },
+          {
+            "name": "returns",
+            "text": "A promise of a WebPurchaseRedemption\nobject that can be redeemed using {@link redeemWebPurchase} or null if the link is invalid."
+          }
+        ],
+        "docs": "Parses the given URL string into a [WebPurchaseRedemption] object that can be used to redeem web purchases.",
+        "complexTypes": [
+          "WebPurchaseRedemption"
+        ],
+        "slug": "parseaswebpurchaseredemption"
+      },
+      {
+        "name": "redeemWebPurchase",
+        "signature": "(options: { webPurchaseRedemption: WebPurchaseRedemption; }) => Promise<WebPurchaseRedemptionResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The WebPurchaseRedemption object obtained from {@link parseAsWebPurchaseRedemption}.",
+            "type": "{ webPurchaseRedemption: WebPurchaseRedemption; }"
+          }
+        ],
+        "returns": "Promise<WebPurchaseRedemptionResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The WebPurchaseRedemption object obtained from {@link parseAsWebPurchaseRedemption}."
+          },
+          {
+            "name": "returns",
+            "text": "The result of the redemption process.\nCan throw if an invalid WebPurchaseRedemption parameter is passed or Purchases is not configured."
+          }
+        ],
+        "docs": "Redeems the web purchase associated with the Redemption Link obtained with [parseAsWebPurchaseRedemption].",
+        "complexTypes": [
+          "WebPurchaseRedemptionResult",
+          "WebPurchaseRedemption"
+        ],
+        "slug": "redeemwebpurchase"
+      },
       {
         "name": "setMockWebResults",
         "signature": "(options: { shouldMockWebResults: boolean; }) => Promise<void>",
@@ -1669,6 +1724,15 @@
             "PurchasesStoreTransaction"
           ],
           "type": "PurchasesStoreTransaction[]"
+        },
+        {
+          "name": "subscriptionsByProductIdentifier",
+          "tags": [],
+          "docs": "Information about the customer's subscriptions for each product identifier.",
+          "complexTypes": [
+            "PurchasesSubscriptionInfo"
+          ],
+          "type": "{ [key: string]: PurchasesSubscriptionInfo; }"
         }
       ]
     },
@@ -1747,7 +1811,7 @@
         {
           "name": "periodType",
           "tags": [],
-          "docs": "The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.",
+          "docs": "The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL, PREPAID.",
           "complexTypes": [],
           "type": "string"
         },
@@ -1797,8 +1861,10 @@
           "name": "store",
           "tags": [],
           "docs": "The store where this entitlement was unlocked from.",
-          "complexTypes": [],
-          "type": "'PLAY_STORE' | 'APP_STORE' | 'STRIPE' | 'MAC_APP_STORE' | 'PROMOTIONAL' | 'AMAZON' | 'RC_BILLING' | 'EXTERNAL' | 'UNKNOWN_STORE'"
+          "complexTypes": [
+            "Store"
+          ],
+          "type": "Store"
         },
         {
           "name": "productIdentifier",
@@ -1853,8 +1919,10 @@
           "name": "ownershipType",
           "tags": [],
           "docs": "Supported ownership types for an entitlement.\nPURCHASED if the purchase was made directly by this user.\nFAMILY_SHARED if the purchase has been shared to this user by a family member.\nUNKNOWN if the purchase has no or an unknown ownership type.",
-          "complexTypes": [],
-          "type": "'FAMILY_SHARED' | 'PURCHASED' | 'UNKNOWN'"
+          "complexTypes": [
+            "OwnershipType"
+          ],
+          "type": "OwnershipType"
         },
         {
           "name": "verification",
@@ -1901,6 +1969,219 @@
         }
       ]
     },
+    {
+      "name": "PurchasesSubscriptionInfo",
+      "slug": "purchasessubscriptioninfo",
+      "docs": "Subscription purchases of the Customer.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "productIdentifier",
+          "tags": [],
+          "docs": "The product identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "purchaseDate",
+          "tags": [],
+          "docs": "Date when the last subscription period started.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "originalPurchaseDate",
+          "tags": [],
+          "docs": "Date when this subscription first started. This property does not update with renewals.\nThis property also does not update for product changes within a subscription group or\nre-subscriptions by lapsed subscribers.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "expiresDate",
+          "tags": [],
+          "docs": "Date when the subscription expires/expired",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "store",
+          "tags": [],
+          "docs": "Store where the subscription was purchased.",
+          "complexTypes": [
+            "Store"
+          ],
+          "type": "Store"
+        },
+        {
+          "name": "unsubscribeDetectedAt",
+          "tags": [],
+          "docs": "Date when RevenueCat detected that auto-renewal was turned off for this subscription.\nNote the subscription may still be active, check the `expiresDate` attribute.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "isSandbox",
+          "tags": [],
+          "docs": "Whether or not the purchase was made in sandbox mode.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "billingIssuesDetectedAt",
+          "tags": [],
+          "docs": "Date when RevenueCat detected any billing issues with this subscription.\nIf and when the billing issue gets resolved, this field is set to nil.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "gracePeriodExpiresDate",
+          "tags": [],
+          "docs": "Date when any grace period for this subscription expires/expired.\nnil if the customer has never been in a grace period.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "ownershipType",
+          "tags": [],
+          "docs": "How the Customer received access to this subscription:\n- [OwnershipType.PURCHASED]: The customer bought the subscription.\n- [OwnershipType.FAMILY_SHARED]: The Customer has access to the product via their family.",
+          "complexTypes": [
+            "OwnershipType"
+          ],
+          "type": "OwnershipType"
+        },
+        {
+          "name": "periodType",
+          "tags": [],
+          "docs": "Type of the current subscription period:\n- [PeriodType.NORMAL]: The product is in a normal period (default)\n- [PeriodType.TRIAL]: The product is in a free trial period\n- [PeriodType.INTRO]: The product is in an introductory pricing period\n- [PeriodType.PREPAID]: The product is in a prepaid pricing period",
+          "complexTypes": [
+            "PeriodType"
+          ],
+          "type": "PeriodType"
+        },
+        {
+          "name": "refundedAt",
+          "tags": [],
+          "docs": "Date when RevenueCat detected a refund of this subscription.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "storeTransactionId",
+          "tags": [],
+          "docs": "The transaction id in the store of the subscription.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "isActive",
+          "tags": [],
+          "docs": "Whether the subscription is currently active.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "willRenew",
+          "tags": [],
+          "docs": "Whether the subscription will renew at the next billing period.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PurchasesError",
+      "slug": "purchaseserror",
+      "docs": "Type encapsulating an error in an SDK operation.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PURCHASES_ERROR_CODE"
+          ],
+          "type": "PURCHASES_ERROR_CODE"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "readableErrorCode",
+          "tags": [
+            {
+              "text": "access readableErrorCode through userInfo.readableErrorCode",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userInfo",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "ErrorInfo"
+          ],
+          "type": "ErrorInfo"
+        },
+        {
+          "name": "underlyingErrorMessage",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userCancelled",
+          "tags": [
+            {
+              "text": "use code === Purchases.PURCHASES_ERROR_CODE.PURCHASE_CANCELLED_ERROR instead",
+              "name": "deprecated"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | null"
+        }
+      ]
+    },
+    {
+      "name": "ErrorInfo",
+      "slug": "errorinfo",
+      "docs": "Type encapsulating extra info on an error in an SDK operation.",
+      "tags": [
+        {
+          "name": "public"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "readableErrorCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "PurchasesOfferings",
       "slug": "purchasesofferings",
@@ -3290,6 +3571,42 @@
         }
       ]
     },
+    {
+      "name": "WebPurchaseRedemptionResultType",
+      "slug": "webpurchaseredemptionresulttype",
+      "members": [
+        {
+          "name": "SUCCESS",
+          "value": "\"SUCCESS\"",
+          "tags": [],
+          "docs": "The redemption was successful."
+        },
+        {
+          "name": "ERROR",
+          "value": "\"ERROR\"",
+          "tags": [],
+          "docs": "The redemption failed."
+        },
+        {
+          "name": "PURCHASE_BELONGS_TO_OTHER_USER",
+          "value": "\"PURCHASE_BELONGS_TO_OTHER_USER\"",
+          "tags": [],
+          "docs": "The purchase associated to the link belongs to another user."
+        },
+        {
+          "name": "INVALID_TOKEN",
+          "value": "\"INVALID_TOKEN\"",
+          "tags": [],
+          "docs": "The token is invalid."
+        },
+        {
+          "name": "EXPIRED",
+          "value": "\"EXPIRED\"",
+          "tags": [],
+          "docs": "The token has expired. A new Redemption Link will be sent to the email used during purchase."
+        }
+      ]
+    },
     {
       "name": "VERIFICATION_RESULT",
       "slug": "verification_result",
@@ -3320,6 +3637,222 @@
         }
       ]
     },
+    {
+      "name": "PURCHASES_ERROR_CODE",
+      "slug": "purchases_error_code",
+      "members": [
+        {
+          "name": "UNKNOWN_ERROR",
+          "value": "\"0\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PURCHASE_CANCELLED_ERROR",
+          "value": "\"1\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "STORE_PROBLEM_ERROR",
+          "value": "\"2\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PURCHASE_NOT_ALLOWED_ERROR",
+          "value": "\"3\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PURCHASE_INVALID_ERROR",
+          "value": "\"4\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PRODUCT_NOT_AVAILABLE_FOR_PURCHASE_ERROR",
+          "value": "\"5\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PRODUCT_ALREADY_PURCHASED_ERROR",
+          "value": "\"6\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RECEIPT_ALREADY_IN_USE_ERROR",
+          "value": "\"7\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_RECEIPT_ERROR",
+          "value": "\"8\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MISSING_RECEIPT_FILE_ERROR",
+          "value": "\"9\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "NETWORK_ERROR",
+          "value": "\"10\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_CREDENTIALS_ERROR",
+          "value": "\"11\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UNEXPECTED_BACKEND_RESPONSE_ERROR",
+          "value": "\"12\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RECEIPT_IN_USE_BY_OTHER_SUBSCRIBER_ERROR",
+          "value": "\"13\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_APP_USER_ID_ERROR",
+          "value": "\"14\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "OPERATION_ALREADY_IN_PROGRESS_ERROR",
+          "value": "\"15\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UNKNOWN_BACKEND_ERROR",
+          "value": "\"16\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_APPLE_SUBSCRIPTION_KEY_ERROR",
+          "value": "\"17\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INELIGIBLE_ERROR",
+          "value": "\"18\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INSUFFICIENT_PERMISSIONS_ERROR",
+          "value": "\"19\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PAYMENT_PENDING_ERROR",
+          "value": "\"20\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_SUBSCRIBER_ATTRIBUTES_ERROR",
+          "value": "\"21\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "LOG_OUT_ANONYMOUS_USER_ERROR",
+          "value": "\"22\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CONFIGURATION_ERROR",
+          "value": "\"23\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "UNSUPPORTED_ERROR",
+          "value": "\"24\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "EMPTY_SUBSCRIBER_ATTRIBUTES_ERROR",
+          "value": "\"25\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PRODUCT_DISCOUNT_MISSING_IDENTIFIER_ERROR",
+          "value": "\"26\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PRODUCT_DISCOUNT_MISSING_SUBSCRIPTION_GROUP_IDENTIFIER_ERROR",
+          "value": "\"28\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "CUSTOMER_INFO_ERROR",
+          "value": "\"29\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "SYSTEM_INFO_ERROR",
+          "value": "\"30\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "BEGIN_REFUND_REQUEST_ERROR",
+          "value": "\"31\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "PRODUCT_REQUEST_TIMED_OUT_ERROR",
+          "value": "\"32\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "API_ENDPOINT_BLOCKED",
+          "value": "\"33\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "INVALID_PROMOTIONAL_OFFER_ERROR",
+          "value": "\"34\"",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "OFFLINE_CONNECTION_ERROR",
+          "value": "\"35\"",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
     {
       "name": "PACKAGE_TYPE",
       "slug": "package_type",
@@ -3763,6 +4296,141 @@
         }
       ]
     },
+    {
+      "name": "WebPurchaseRedemption",
+      "slug": "webpurchaseredemption",
+      "docs": "An object containing the redemption link to be redeemed.",
+      "types": [
+        {
+          "text": "{\n    /**\n     * The redemption link to be redeemed.\n     */\n    redemptionLink: string;\n}",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "WebPurchaseRedemptionResult",
+      "slug": "webpurchaseredemptionresult",
+      "docs": "The result of a redemption attempt.",
+      "types": [
+        {
+          "text": "{\n    result: WebPurchaseRedemptionResultType.SUCCESS;\n    customerInfo: CustomerInfo;\n}",
+          "complexTypes": [
+            "WebPurchaseRedemptionResultType",
+            "CustomerInfo"
+          ]
+        },
+        {
+          "text": "{\n    result: WebPurchaseRedemptionResultType.ERROR;\n    error: PurchasesError;\n}",
+          "complexTypes": [
+            "WebPurchaseRedemptionResultType",
+            "PurchasesError"
+          ]
+        },
+        {
+          "text": "{\n    result: WebPurchaseRedemptionResultType.PURCHASE_BELONGS_TO_OTHER_USER;\n}",
+          "complexTypes": [
+            "WebPurchaseRedemptionResultType"
+          ]
+        },
+        {
+          "text": "{\n    result: WebPurchaseRedemptionResultType.INVALID_TOKEN;\n}",
+          "complexTypes": [
+            "WebPurchaseRedemptionResultType"
+          ]
+        },
+        {
+          "text": "{\n    result: WebPurchaseRedemptionResultType.EXPIRED;\n    obfuscatedEmail: string;\n}",
+          "complexTypes": [
+            "WebPurchaseRedemptionResultType"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Store",
+      "slug": "store",
+      "docs": "The supported stores for purchases.",
+      "types": [
+        {
+          "text": "\"PLAY_STORE\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"APP_STORE\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"STRIPE\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"MAC_APP_STORE\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"PROMOTIONAL\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"AMAZON\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"RC_BILLING\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"EXTERNAL\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"UNKNOWN_STORE\"",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "OwnershipType",
+      "slug": "ownershiptype",
+      "docs": "The supported ownership types for an entitlement.",
+      "types": [
+        {
+          "text": "\"PURCHASED\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"FAMILY_SHARED\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"UNKNOWN\"",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PeriodType",
+      "slug": "periodtype",
+      "docs": "The supported period types for an entitlement.",
+      "types": [
+        {
+          "text": "\"NORMAL\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"INTRO\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"TRIAL\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"PREPAID\"",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "CustomerInfoUpdateListener",
       "slug": "customerinfoupdatelistener",