@capgo/capacitor-pay 8.0.12 → 8.1.0

package/dist/docs.json

@@ -213,10 +213,159 @@
           "name": "isReadyToPayRequest",
           "tags": [],
           "docs": "Raw `IsReadyToPayRequest` JSON as defined by the Google Pay API.\nSupply the card networks and auth methods you intend to support at runtime.",
+          "complexTypes": [
+            "GooglePayIsReadyToPayRequest"
+          ],
+          "type": "GooglePayIsReadyToPayRequest"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayIsReadyToPayRequest",
+      "slug": "googlepayisreadytopayrequest",
+      "docs": "Typed helper for the Google Pay `IsReadyToPayRequest` JSON.\nThe native Android implementation still accepts arbitrary JSON (forward compatible).",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "allowedPaymentMethods",
+          "tags": [],
+          "docs": "The list of payment methods you want to check for readiness.",
+          "complexTypes": [
+            "GooglePayAllowedPaymentMethod"
+          ],
+          "type": "GooglePayAllowedPaymentMethod[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayAllowedPaymentMethod",
+      "slug": "googlepayallowedpaymentmethod",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "",
           "complexTypes": [
             "Record"
           ],
-          "type": "Record<string, unknown>"
+          "type": "(string & Record<never, never>) | 'CARD' | undefined"
+        },
+        {
+          "name": "parameters",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayCardPaymentMethodParameters"
+          ],
+          "type": "GooglePayCardPaymentMethodParameters"
+        },
+        {
+          "name": "tokenizationSpecification",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayTokenizationSpecification"
+          ],
+          "type": "GooglePayTokenizationSpecification"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayCardPaymentMethodParameters",
+      "slug": "googlepaycardpaymentmethodparameters",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "allowedAuthMethods",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayAuthMethod"
+          ],
+          "type": "GooglePayAuthMethod[] | undefined"
+        },
+        {
+          "name": "allowedCardNetworks",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayCardNetwork"
+          ],
+          "type": "GooglePayCardNetwork[] | undefined"
+        },
+        {
+          "name": "billingAddressRequired",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "billingAddressParameters",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayBillingAddressParameters"
+          ],
+          "type": "GooglePayBillingAddressParameters"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayBillingAddressParameters",
+      "slug": "googlepaybillingaddressparameters",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "format",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "'MIN' | 'FULL' | (string & Record<never, never>) | undefined"
+        },
+        {
+          "name": "phoneNumberRequired",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayTokenizationSpecification",
+      "slug": "googlepaytokenizationspecification",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "(string & Record<never, never>) | 'PAYMENT_GATEWAY' | 'DIRECT' | undefined"
+        },
+        {
+          "name": "parameters",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string>"
         }
       ]
     },
@@ -491,6 +640,15 @@
           "docs": "Optional opaque application data passed back in the payment token.",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "recurringPaymentRequest",
+          "tags": [],
+          "docs": "Recurring payment configuration (iOS 16+).",
+          "complexTypes": [
+            "ApplePayRecurringPaymentRequest"
+          ],
+          "type": "ApplePayRecurringPaymentRequest"
         }
       ]
     },
@@ -526,6 +684,100 @@
         }
       ]
     },
+    {
+      "name": "ApplePayRecurringPaymentRequest",
+      "slug": "applepayrecurringpaymentrequest",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "paymentDescription",
+          "tags": [],
+          "docs": "A description for the recurring payment shown in the Apple Pay sheet.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "regularBilling",
+          "tags": [],
+          "docs": "The recurring billing item (for example your subscription).",
+          "complexTypes": [
+            "ApplePayRecurringPaymentSummaryItem"
+          ],
+          "type": "ApplePayRecurringPaymentSummaryItem"
+        },
+        {
+          "name": "managementURL",
+          "tags": [],
+          "docs": "URL where the user can manage the recurring payment (cancel, update, etc).",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "billingAgreement",
+          "tags": [],
+          "docs": "Optional billing agreement text shown to the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "tokenNotificationURL",
+          "tags": [],
+          "docs": "Optional URL where Apple can send token update notifications.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "trialBilling",
+          "tags": [],
+          "docs": "Optional trial billing item (for example a free trial period).",
+          "complexTypes": [
+            "ApplePayRecurringPaymentSummaryItem"
+          ],
+          "type": "ApplePayRecurringPaymentSummaryItem"
+        }
+      ]
+    },
+    {
+      "name": "ApplePayRecurringPaymentSummaryItem",
+      "slug": "applepayrecurringpaymentsummaryitem",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "intervalUnit",
+          "tags": [],
+          "docs": "Unit of time between recurring payments.",
+          "complexTypes": [
+            "ApplePayRecurringPaymentIntervalUnit"
+          ],
+          "type": "ApplePayRecurringPaymentIntervalUnit"
+        },
+        {
+          "name": "intervalCount",
+          "tags": [],
+          "docs": "Number of `intervalUnit` units between recurring payments (for example `1` month, `2` weeks).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "startDate",
+          "tags": [],
+          "docs": "Start date of the recurring period.\n\nOn supported platforms this may be either:\n- a `number` representing milliseconds since Unix epoch, or\n- a `string` in a date format accepted by the native implementation\n  (for example an ISO 8601 date-time string or a `yyyy-MM-dd` date string).",
+          "complexTypes": [],
+          "type": "string | number | undefined"
+        },
+        {
+          "name": "endDate",
+          "tags": [],
+          "docs": "End date of the recurring period.\n\nOn supported platforms this may be either:\n- a `number` representing milliseconds since Unix epoch, or\n- a `string` in a date format accepted by the native implementation\n  (for example an ISO 8601 date-time string or a `yyyy-MM-dd` date string).",
+          "complexTypes": [],
+          "type": "string | number | undefined"
+        }
+      ]
+    },
     {
       "name": "GooglePayPaymentOptions",
       "slug": "googlepaypaymentoptions",
@@ -547,9 +799,121 @@
           "tags": [],
           "docs": "Raw `PaymentDataRequest` JSON as defined by the Google Pay API.\nProvide transaction details, merchant info, and tokenization parameters.",
           "complexTypes": [
-            "Record"
+            "GooglePayPaymentDataRequest"
           ],
-          "type": "Record<string, unknown>"
+          "type": "GooglePayPaymentDataRequest"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayPaymentDataRequest",
+      "slug": "googlepaypaymentdatarequest",
+      "docs": "Typed helper for the Google Pay `PaymentDataRequest` JSON.\nThe native Android implementation still accepts arbitrary JSON (forward compatible).",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "apiVersion",
+          "tags": [],
+          "docs": "Google Pay API version, typically `2`.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "apiVersionMinor",
+          "tags": [],
+          "docs": "Google Pay API minor version, typically `0`.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "allowedPaymentMethods",
+          "tags": [],
+          "docs": "Allowed payment method configurations.",
+          "complexTypes": [
+            "GooglePayAllowedPaymentMethod"
+          ],
+          "type": "GooglePayAllowedPaymentMethod[] | undefined"
+        },
+        {
+          "name": "merchantInfo",
+          "tags": [],
+          "docs": "Merchant information displayed in the Google Pay sheet.",
+          "complexTypes": [
+            "GooglePayMerchantInfo"
+          ],
+          "type": "GooglePayMerchantInfo"
+        },
+        {
+          "name": "transactionInfo",
+          "tags": [],
+          "docs": "Transaction details (amount, currency, etc).",
+          "complexTypes": [
+            "GooglePayTransactionInfo"
+          ],
+          "type": "GooglePayTransactionInfo"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayMerchantInfo",
+      "slug": "googlepaymerchantinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "merchantId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "merchantName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GooglePayTransactionInfo",
+      "slug": "googlepaytransactioninfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalPriceStatus",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "GooglePayTotalPriceStatus"
+          ],
+          "type": "GooglePayTotalPriceStatus"
+        },
+        {
+          "name": "totalPrice",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "currencyCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "countryCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     }
@@ -584,6 +948,10 @@
           "text": "'AmEx'",
           "complexTypes": []
         },
+        {
+          "text": "'amex'",
+          "complexTypes": []
+        },
         {
           "text": "'Bancomat'",
           "complexTypes": []
@@ -620,6 +988,10 @@
           "text": "'Discover'",
           "complexTypes": []
         },
+        {
+          "text": "'discover'",
+          "complexTypes": []
+        },
         {
           "text": "'Eftpos'",
           "complexTypes": []
@@ -656,6 +1028,10 @@
           "text": "'JCB'",
           "complexTypes": []
         },
+        {
+          "text": "'jcb'",
+          "complexTypes": []
+        },
         {
           "text": "'mada'",
           "complexTypes": []
@@ -664,10 +1040,18 @@
           "text": "'Maestro'",
           "complexTypes": []
         },
+        {
+          "text": "'maestro'",
+          "complexTypes": []
+        },
         {
           "text": "'MasterCard'",
           "complexTypes": []
         },
+        {
+          "text": "'masterCard'",
+          "complexTypes": []
+        },
         {
           "text": "'Meeza'",
           "complexTypes": []
@@ -708,9 +1092,17 @@
           "text": "'Visa'",
           "complexTypes": []
         },
+        {
+          "text": "'visa'",
+          "complexTypes": []
+        },
         {
           "text": "'VPay'",
           "complexTypes": []
+        },
+        {
+          "text": "'vPay'",
+          "complexTypes": []
         }
       ]
     },
@@ -743,6 +1135,60 @@
         }
       ]
     },
+    {
+      "name": "GooglePayAuthMethod",
+      "slug": "googlepayauthmethod",
+      "docs": "",
+      "types": [
+        {
+          "text": "'PAN_ONLY'",
+          "complexTypes": []
+        },
+        {
+          "text": "'CRYPTOGRAM_3DS'",
+          "complexTypes": []
+        },
+        {
+          "text": "(string & Record<never, never>)",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "GooglePayCardNetwork",
+      "slug": "googlepaycardnetwork",
+      "docs": "",
+      "types": [
+        {
+          "text": "'AMEX'",
+          "complexTypes": []
+        },
+        {
+          "text": "'DISCOVER'",
+          "complexTypes": []
+        },
+        {
+          "text": "'JCB'",
+          "complexTypes": []
+        },
+        {
+          "text": "'MASTERCARD'",
+          "complexTypes": []
+        },
+        {
+          "text": "'VISA'",
+          "complexTypes": []
+        },
+        {
+          "text": "(string & Record<never, never>)",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    },
     {
       "name": "Exclude",
       "slug": "exclude",
@@ -840,6 +1286,54 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "ApplePayRecurringPaymentIntervalUnit",
+      "slug": "applepayrecurringpaymentintervalunit",
+      "docs": "",
+      "types": [
+        {
+          "text": "'day'",
+          "complexTypes": []
+        },
+        {
+          "text": "'week'",
+          "complexTypes": []
+        },
+        {
+          "text": "'month'",
+          "complexTypes": []
+        },
+        {
+          "text": "'year'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "GooglePayTotalPriceStatus",
+      "slug": "googlepaytotalpricestatus",
+      "docs": "",
+      "types": [
+        {
+          "text": "'NOT_CURRENTLY_KNOWN'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ESTIMATED'",
+          "complexTypes": []
+        },
+        {
+          "text": "'FINAL'",
+          "complexTypes": []
+        },
+        {
+          "text": "(string & Record<never, never>)",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
     }
   ],
   "pluginConfigs": []