npm - @capawesome/capacitor-square-mobile-payments - Versions diffs - 0.1.1 → 0.1.3 - Mend

@capawesome/capacitor-square-mobile-payments 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/README.md +100 -3
package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/SquareMobilePaymentsPlugin.java +24 -0
package/dist/docs.json +128 -1
package/dist/esm/definitions.d.ts +66 -2
package/dist/esm/definitions.js +6 -0
package/dist/esm/definitions.js.map +1 -1
package/dist/esm/web.d.ts +5 -1
package/dist/esm/web.js +12 -0
package/dist/esm/web.js.map +1 -1
package/dist/plugin.cjs.js +18 -0
package/dist/plugin.cjs.js.map +1 -1
package/dist/plugin.js +18 -0
package/dist/plugin.js.map +1 -1
package/ios/Plugin/Classes/Results/IsAppleAccountLinkedResult.swift +16 -0
package/ios/Plugin/Classes/Results/IsDeviceCapableResult.swift +16 -0
package/ios/Plugin/SquareMobilePayments.swift +81 -0
package/ios/Plugin/SquareMobilePaymentsPlugin.swift +85 -0
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -2,6 +2,12 @@
 Unofficial Capacitor plugin for [Square Mobile Payments SDK](https://developer.squareup.com/docs/mobile-payments-sdk).[^1]
+<div class="capawesome-z29o10a">
+  <a href="https://cloud.capawesome.io/" target="_blank">
+    <img alt="Deliver Live Updates to your Capacitor app with Capawesome Cloud" src="https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1" />
+  </a>
+</div>
 ## Features
 This plugin provides a comprehensive integration with Square's Mobile Payments SDK for in-person payment processing. Here are some of the key features:
@@ -99,13 +105,15 @@ More details can be found in the [Square Mobile Payments SDK iOS setup guide](ht
 #### Privacy Descriptions
-Add the `NSLocationWhenInUseUsageDescription` and `NSBluetoothAlwaysUsageDescription` keys to the `ios/App/App/Info.plist` file, which tells the user why your app is requesting location and Bluetooth permissions:
+Add the `NSLocationWhenInUseUsageDescription`, `NSBluetoothAlwaysUsageDescription`, and `NSMicrophoneUsageDescription` keys to the `ios/App/App/Info.plist` file, which tells the user why your app is requesting location, Bluetooth, and microphone permissions:
 ```xml
 <key>NSBluetoothAlwaysUsageDescription</key>
 <string>We need Bluetooth access to connect to Square card readers.</string>
 <key>NSLocationWhenInUseUsageDescription</key>
 <string>We need your location to confirm payments are occurring in a supported Square location.</string>
+<key>NSMicrophoneUsageDescription</key>
+<string>We need microphone access to receive data from magstripe card readers.</string>
 ```
 ## Configuration
@@ -216,6 +224,10 @@ const getAvailableMethods = async () => {
 * [`startPayment(...)`](#startpayment)
 * [`cancelPayment()`](#cancelpayment)
 * [`getAvailableCardInputMethods()`](#getavailablecardinputmethods)
+* [`linkAppleAccount()`](#linkappleaccount)
+* [`relinkAppleAccount()`](#relinkappleaccount)
+* [`isAppleAccountLinked()`](#isappleaccountlinked)
+* [`isDeviceCapable()`](#isdevicecapable)
 * [`checkPermissions()`](#checkpermissions)
 * [`requestPermissions()`](#requestpermissions)
 * [`addListener('readerPairingDidBegin', ...)`](#addlistenerreaderpairingdidbegin-)
@@ -541,6 +553,76 @@ Only available on Android and iOS.
 --------------------
+### linkAppleAccount()
+```typescript
+linkAppleAccount() => Promise<void>
+```
+Link a Square seller account with an Apple ID for Tap to Pay on iPhone.
+Presents an Apple sheet prompting the user to accept the Tap to Pay
+on iPhone terms and conditions.
+Only available on iOS.
+**Since:** 0.1.3
+--------------------
+### relinkAppleAccount()
+```typescript
+relinkAppleAccount() => Promise<void>
+```
+Re-link a Square seller account with a different Apple ID.
+Presents an Apple sheet to change the associated Apple ID by
+showing the Tap to Pay terms and conditions again.
+Only available on iOS.
+**Since:** 0.1.3
+--------------------
+### isAppleAccountLinked()
+```typescript
+isAppleAccountLinked() => Promise<IsAppleAccountLinkedResult>
+```
+Check if an Apple ID is already linked to a Square seller account.
+Only available on iOS.
+**Returns:** <code>Promise&lt;<a href="#isappleaccountlinkedresult">IsAppleAccountLinkedResult</a>&gt;</code>
+**Since:** 0.1.3
+--------------------
+### isDeviceCapable()
+```typescript
+isDeviceCapable() => Promise<IsDeviceCapableResult>
+```
+Check if the device is capable of Tap to Pay on iPhone.
+Only available on iOS.
+**Returns:** <code>Promise&lt;<a href="#isdevicecapableresult">IsDeviceCapableResult</a>&gt;</code>
+**Since:** 0.1.3
+--------------------
 ### checkPermissions()
 ```typescript
@@ -940,12 +1022,26 @@ Only available on Android and iOS.
 | **`cardInputMethods`** | <code>CardInputMethod[]</code> | The available card input methods. | 0.0.1 |
+#### IsAppleAccountLinkedResult
+| Prop         | Type                 | Description                                                 | Since |
+| ------------ | -------------------- | ----------------------------------------------------------- | ----- |
+| **`linked`** | <code>boolean</code> | Whether an Apple ID is linked to the Square seller account. | 0.1.3 |
+#### IsDeviceCapableResult
+| Prop          | Type                 | Description                                            | Since |
+| ------------- | -------------------- | ------------------------------------------------------ | ----- |
+| **`capable`** | <code>boolean</code> | Whether the device is capable of Tap to Pay on iPhone. | 0.1.3 |
 #### PermissionStatus
 | Prop                   | Type                                                        | Description                                                                                                                                 | Since |
 | ---------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
 | **`location`**         | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for accessing location. Required to confirm that payments are occurring in a supported Square location.                    | 0.0.1 |
-| **`recordAudio`**      | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for recording audio. Required to receive data from magstripe readers. Only available on Android.                           | 0.0.1 |
+| **`recordAudio`**      | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for recording audio. Required to receive data from magstripe readers.                                                      | 0.0.1 |
 | **`bluetoothConnect`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for Bluetooth connect. Required to receive data from contactless and chip readers. Only available on Android.              | 0.0.1 |
 | **`bluetoothScan`**    | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for Bluetooth scan. Required to store information during checkout. Only available on Android.                              | 0.0.1 |
 | **`readPhoneState`**   | <code><a href="#permissionstate">PermissionState</a></code> | Permission state for reading phone state. Required to identify the device sending information to Square servers. Only available on Android. | 0.0.1 |
@@ -1159,6 +1255,7 @@ Callback to receive payment cancellation notifications.
 | **`ContactlessAndChip`** | <code>'CONTACTLESS_AND_CHIP'</code> | Square Reader for contactless and chip. | 0.0.1 |
 | **`Magstripe`**          | <code>'MAGSTRIPE'</code>            | Square Reader for magstripe.            | 0.0.1 |
 | **`Stand`**              | <code>'STAND'</code>                | Square Stand.                           | 0.0.1 |
+| **`TapToPay`**           | <code>'TAP_TO_PAY'</code>           | Tap to Pay on iPhone.                   | 0.1.3 |
 | **`Unknown`**            | <code>'UNKNOWN'</code>              | Unknown reader model.                   | 0.0.1 |
@@ -1287,4 +1384,4 @@ See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/mai
 See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/square-mobile-payments/LICENSE).
-[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Square, Inc. or any of their affiliates or subsidiaries.
+[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Square, Inc. or any of their affiliates or subsidiaries.

package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/SquareMobilePaymentsPlugin.java CHANGED Viewed

@@ -431,6 +431,26 @@ public class SquareMobilePaymentsPlugin extends Plugin {
         }
     }
+    @PluginMethod
+    public void linkAppleAccount(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+    @PluginMethod
+    public void relinkAppleAccount(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+    @PluginMethod
+    public void isAppleAccountLinked(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+    @PluginMethod
+    public void isDeviceCapable(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
     @PluginMethod
     public void checkPermissions(PluginCall call) {
         super.checkPermissions(call);
@@ -450,6 +470,10 @@ public class SquareMobilePaymentsPlugin extends Plugin {
         call.reject(message);
     }
+    private void rejectCallAsUnimplemented(@NonNull PluginCall call) {
+        call.unimplemented("This method is not available on this platform.");
+    }
     private void resolveCall(@NonNull PluginCall call) {
         call.resolve();
     }

package/dist/docs.json CHANGED Viewed

@@ -315,6 +315,70 @@
         ],
         "slug": "getavailablecardinputmethods"
       },
+      {
+        "name": "linkAppleAccount",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.3"
+          }
+        ],
+        "docs": "Link a Square seller account with an Apple ID for Tap to Pay on iPhone.\n\nPresents an Apple sheet prompting the user to accept the Tap to Pay\non iPhone terms and conditions.\n\nOnly available on iOS.",
+        "complexTypes": [],
+        "slug": "linkappleaccount"
+      },
+      {
+        "name": "relinkAppleAccount",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.3"
+          }
+        ],
+        "docs": "Re-link a Square seller account with a different Apple ID.\n\nPresents an Apple sheet to change the associated Apple ID by\nshowing the Tap to Pay terms and conditions again.\n\nOnly available on iOS.",
+        "complexTypes": [],
+        "slug": "relinkappleaccount"
+      },
+      {
+        "name": "isAppleAccountLinked",
+        "signature": "() => Promise<IsAppleAccountLinkedResult>",
+        "parameters": [],
+        "returns": "Promise<IsAppleAccountLinkedResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.3"
+          }
+        ],
+        "docs": "Check if an Apple ID is already linked to a Square seller account.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "IsAppleAccountLinkedResult"
+        ],
+        "slug": "isappleaccountlinked"
+      },
+      {
+        "name": "isDeviceCapable",
+        "signature": "() => Promise<IsDeviceCapableResult>",
+        "parameters": [],
+        "returns": "Promise<IsDeviceCapableResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.3"
+          }
+        ],
+        "docs": "Check if the device is capable of Tap to Pay on iPhone.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "IsDeviceCapableResult"
+        ],
+        "slug": "isdevicecapable"
+      },
       {
         "name": "checkPermissions",
         "signature": "() => Promise<PermissionStatus>",
@@ -1428,6 +1492,58 @@
         }
       ]
     },
+    {
+      "name": "IsAppleAccountLinkedResult",
+      "slug": "isappleaccountlinkedresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.3",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "linked",
+          "tags": [
+            {
+              "text": "0.1.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether an Apple ID is linked to the Square seller account.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "IsDeviceCapableResult",
+      "slug": "isdevicecapableresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.3",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "capable",
+          "tags": [
+            {
+              "text": "0.1.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the device is capable of Tap to Pay on iPhone.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "PermissionStatus",
       "slug": "permissionstatus",
@@ -1462,7 +1578,7 @@
               "name": "since"
             }
           ],
-          "docs": "Permission state for recording audio.\n\nRequired to receive data from magstripe readers.\n\nOnly available on Android.",
+          "docs": "Permission state for recording audio.\n\nRequired to receive data from magstripe readers.",
           "complexTypes": [
             "PermissionState"
           ],
@@ -2233,6 +2349,17 @@
           ],
           "docs": "Square Stand."
         },
+        {
+          "name": "TapToPay",
+          "value": "'TAP_TO_PAY'",
+          "tags": [
+            {
+              "text": "0.1.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Tap to Pay on iPhone."
+        },
         {
           "name": "Unknown",
           "value": "'UNKNOWN'",

package/dist/esm/definitions.d.ts CHANGED Viewed

@@ -157,6 +157,44 @@ export interface SquareMobilePaymentsPlugin {
      * @since 0.0.1
      */
     getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;
+    /**
+     * Link a Square seller account with an Apple ID for Tap to Pay on iPhone.
+     *
+     * Presents an Apple sheet prompting the user to accept the Tap to Pay
+     * on iPhone terms and conditions.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.3
+     */
+    linkAppleAccount(): Promise<void>;
+    /**
+     * Re-link a Square seller account with a different Apple ID.
+     *
+     * Presents an Apple sheet to change the associated Apple ID by
+     * showing the Tap to Pay terms and conditions again.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.3
+     */
+    relinkAppleAccount(): Promise<void>;
+    /**
+     * Check if an Apple ID is already linked to a Square seller account.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.3
+     */
+    isAppleAccountLinked(): Promise<IsAppleAccountLinkedResult>;
+    /**
+     * Check if the device is capable of Tap to Pay on iPhone.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.3
+     */
+    isDeviceCapable(): Promise<IsDeviceCapableResult>;
     /**
      * Check the current permission status.
      *
@@ -515,6 +553,28 @@ export interface GetAvailableCardInputMethodsResult {
      */
     cardInputMethods: CardInputMethod[];
 }
+/**
+ * @since 0.1.3
+ */
+export interface IsAppleAccountLinkedResult {
+    /**
+     * Whether an Apple ID is linked to the Square seller account.
+     *
+     * @since 0.1.3
+     */
+    linked: boolean;
+}
+/**
+ * @since 0.1.3
+ */
+export interface IsDeviceCapableResult {
+    /**
+     * Whether the device is capable of Tap to Pay on iPhone.
+     *
+     * @since 0.1.3
+     */
+    capable: boolean;
+}
 /**
  * @since 0.0.1
  */
@@ -1059,6 +1119,12 @@ export declare enum ReaderModel {
      * @since 0.0.1
      */
     Stand = "STAND",
+    /**
+     * Tap to Pay on iPhone.
+     *
+     * @since 0.1.3
+     */
+    TapToPay = "TAP_TO_PAY",
     /**
      * Unknown reader model.
      *
@@ -1361,8 +1427,6 @@ export interface PermissionStatus {
      *
      * Required to receive data from magstripe readers.
      *
-     * Only available on Android.
-     *
      * @since 0.0.1
      */
     recordAudio?: PermissionState;

package/dist/esm/definitions.js CHANGED Viewed

@@ -147,6 +147,12 @@ export var ReaderModel;
      * @since 0.0.1
      */
     ReaderModel["Stand"] = "STAND";
+    /**
+     * Tap to Pay on iPhone.
+     *
+     * @since 0.1.3
+     */
+    ReaderModel["TapToPay"] = "TAP_TO_PAY";
     /**
      * Unknown reader model.
      *

package/dist/esm/definitions.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA+9BA;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,wCAAyB,CAAA;IACzB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAyBX;AAzBD,WAAY,eAAe;IACzB;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,kCAAe,CAAA;IACf;;;;OAIG;IACH,kCAAe,CAAA;AACjB,CAAC,EAzBW,eAAe,KAAf,eAAe,QAyB1B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACxB;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,8CAA4B,CAAA;AAC9B,CAAC,EAnBW,cAAc,KAAd,cAAc,QAmBzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB;;;;OAIG;IACH,iCAAmB,CAAA;IACnB;;;;OAIG;IACH,+BAAiB,CAAA;AACnB,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,uBAaX;AAbD,WAAY,uBAAuB;IACjC;;;;OAIG;IACH,0CAAe,CAAA;IACf;;;;OAIG;IACH,wCAAa,CAAA;AACf,CAAC,EAbW,uBAAuB,KAAvB,uBAAuB,QAalC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,oCAAqB,CAAA;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;AACnB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAyBX;AAzBD,WAAY,WAAW;IACrB;;;;OAIG;IACH,0DAA2C,CAAA;IAC3C;;;;OAIG;IACH,sCAAuB,CAAA;IACvB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAzBW,WAAW,KAAX,WAAW,QAyBtB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YA+BX;AA/BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,+BAAe,CAAA;IACf;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,iCAAiB,CAAA;IACjB;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA/BW,YAAY,KAAZ,YAAY,QA+BvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YAuDX;AAvDD,WAAY,YAAY;IACtB;;;;;;OAMG;IACH,sEAAsD,CAAA;IACtD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,oDAAoC,CAAA;IACpC;;;;;;OAMG;IACH,+BAAe,CAAA;IACf;;;;;;OAMG;IACH,mCAAmB,CAAA;IACnB;;;;OAIG;IACH,qDAAqC,CAAA;AACvC,CAAC,EAvDW,YAAY,KAAZ,YAAY,QAuDvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBA+DX;AA/DD,WAAY,iBAAiB;IAC3B;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,2DAAsC,CAAA;IACtC;;;;;;OAMG;IACH,6DAAwC,CAAA;IACxC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,4EAAuD,CAAA;IACvD;;;;;;OAMG;IACH,kEAA6C,CAAA;IAC7C;;;;OAIG;IACH,wCAAmB,CAAA;AACrB,CAAC,EA/DW,iBAAiB,KAAjB,iBAAiB,QA+D5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;IACjB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aA+BX;AA/BD,WAAY,aAAa;IACvB;;;;OAIG;IACH,wCAAuB,CAAA;IACvB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,kCAAiB,CAAA;IACjB;;;;OAIG;IACH,oCAAmB,CAAA;AACrB,CAAC,EA/BW,aAAa,KAAb,aAAa,QA+BxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SA6DX;AA7DD,WAAY,SAAS;IACnB;;;;OAIG;IACH,0BAAa,CAAA;IACb;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,iDAAoC,CAAA;IACpC;;;;OAIG;IACH,kCAAqB,CAAA;IACrB;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,wBAAW,CAAA;IACX;;;;OAIG;IACH,mCAAsB,CAAA;IACtB;;;;OAIG;IACH,gCAAmB,CAAA;IACnB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;OAIG;IACH,4BAAe,CAAA;AACjB,CAAC,EA7DW,SAAS,KAAT,SAAS,QA6DpB;AAqED;;GAEG;AACH,MAAM,CAAN,IAAY,SAyEX;AAzED,WAAY,SAAS;IACnB;;;;OAIG;IACH,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,0DAA6C,CAAA;IAC7C;;;;OAIG;IACH,oEAAuD,CAAA;IACvD;;;;OAIG;IACH,kEAAqD,CAAA;IACrD;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,mEAAsD,CAAA;IACtD;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,6CAAgC,CAAA;IAChC;;;;OAIG;IACH,qEAAwD,CAAA;IACxD;;;;OAIG;IACH,2DAA8C,CAAA;IAC9C;;;;OAIG;IACH,gDAAmC,CAAA;AACrC,CAAC,EAzEW,SAAS,KAAT,SAAS,QAyEpB","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/*\n @since 0.0.1\n /\nexport interface SquareMobilePaymentsPlugin {\n /\n Initialize the Square Mobile Payments SDK.\n \n This method must be called before any other method.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n initialize(options: InitializeOptions): Promise<void>;\n /\n Authorize the SDK with a Square access token.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n authorize(options: AuthorizeOptions): Promise<void>;\n /\n Check if the SDK is currently authorized.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n isAuthorized(): Promise<IsAuthorizedResult>;\n /\n Deauthorize the SDK and clear the current authorization.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n deauthorize(): Promise<void>;\n /\n Show the Square settings screen.\n \n This displays a pre-built settings UI where merchants can view and manage\n * their paired readers.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n showSettings(): Promise<void>;\n /\n Show the Mock Reader UI for testing.\n \n This displays a mock reader interface for testing payment flows without\n * physical hardware. This is only for development and testing purposes and\n * is therefore only available in debug builds.\n \n Only available on Android and iOS.\n \n @since 0.1.1\n /\n showMockReader(): Promise<void>;\n /\n Hide the Mock Reader UI.\n \n Only available on Android and iOS.\n \n @since 0.1.1\n /\n hideMockReader(): Promise<void>;\n /\n Get the current SDK settings.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getSettings(): Promise<GetSettingsResult>;\n /\n Start pairing with a Square reader.\n \n This initiates the reader pairing process. The SDK will search for nearby\n * readers and pair with the first one found.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n startPairing(): Promise<void>;\n /\n Stop the reader pairing process.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n stopPairing(): Promise<void>;\n /\n Check if a pairing process is currently in progress.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n isPairingInProgress(): Promise<IsPairingInProgressResult>;\n /\n Get a list of all paired readers.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getReaders(): Promise<GetReadersResult>;\n /\n Forget a paired reader.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n forgetReader(options: ForgetReaderOptions): Promise<void>;\n /\n Retry connecting to a reader.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n retryConnection(options: RetryConnectionOptions): Promise<void>;\n /\n Start a payment flow.\n \n This presents the payment UI and processes the payment using the specified\n * parameters. Only one payment can be active at a time.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n startPayment(options: StartPaymentOptions): Promise<void>;\n /\n Cancel an ongoing payment.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n cancelPayment(): Promise<void>;\n /\n Get the currently available card input methods.\n \n This returns the card entry methods that are available based on the\n * connected readers (e.g., TAP, DIP, SWIPE, KEYED).\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;\n /\n Check the current permission status.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n checkPermissions(): Promise<PermissionStatus>;\n /\n Request the required permissions.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n requestPermissions(): Promise<PermissionStatus>;\n /\n Listen for reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidBegin',\n listenerFunc: ReaderPairingDidBeginListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for successful reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidSucceed',\n listenerFunc: ReaderPairingDidSucceedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for failed reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidFail',\n listenerFunc: ReaderPairingDidFailListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader added events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerWasAdded',\n listenerFunc: ReaderWasAddedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader removed events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerWasRemoved',\n listenerFunc: ReaderWasRemovedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader status and property changes.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerDidChange',\n listenerFunc: ReaderDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for available card input method changes.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'availableCardInputMethodsDidChange',\n listenerFunc: AvailableCardInputMethodsDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for successful payment completion events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidFinish',\n listenerFunc: PaymentDidFinishListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for failed payment events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidFail',\n listenerFunc: PaymentDidFailListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for cancelled payment events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidCancel',\n listenerFunc: PaymentDidCancelListener,\n ): Promise<PluginListenerHandle>;\n /\n Remove all listeners for this plugin.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n removeAllListeners(): Promise<void>;\n}\n\n/\n @since 0.0.1\n /\nexport interface InitializeOptions {\n /\n The Square location ID.\n \n @since 0.0.1\n * @example 'LOCATION_ID'\n /\n locationId: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface AuthorizeOptions {\n /\n The Square access token.\n \n @since 0.0.1\n * @example 'EAAAEOuLQPDbLd...'\n /\n accessToken: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface IsAuthorizedResult {\n /\n Whether the SDK is currently authorized.\n \n @since 0.0.1\n /\n authorized: boolean;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetSettingsResult {\n /\n The SDK version.\n \n @since 0.0.1\n * @example '2.0.0'\n /\n version: string;\n /\n The current environment.\n \n @since 0.0.1\n * @example 'production'\n /\n environment: Environment;\n}\n\n/\n @since 0.0.1\n /\nexport interface IsPairingInProgressResult {\n /\n Whether a pairing process is currently in progress.\n \n @since 0.0.1\n /\n inProgress: boolean;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetReadersResult {\n /\n The list of paired readers.\n \n @since 0.0.1\n /\n readers: ReaderInfo[];\n}\n\n/\n @since 0.0.1\n /\nexport interface ForgetReaderOptions {\n /\n The serial number of the reader to forget.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface RetryConnectionOptions {\n /\n The serial number of the reader to retry connection.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface StartPaymentOptions {\n /\n The payment parameters.\n \n @since 0.0.1\n /\n paymentParameters: PaymentParameters;\n /\n The prompt parameters.\n \n @since 0.0.1\n /\n promptParameters: PromptParameters;\n}\n\n/\n @since 0.0.1\n /\nexport interface PaymentParameters {\n /\n The amount of money to charge.\n \n @since 0.0.1\n /\n amountMoney: Money;\n /\n A unique identifier for this payment attempt.\n \n This is used for idempotent payment requests.\n \n @since 0.0.1\n * @example 'a1b2c3d4-e5f6-4a5b-8c9d-1e2f3a4b5c6d'\n /\n paymentAttemptId: string;\n /\n The processing mode for this payment.\n \n @since 0.0.1\n * @default ProcessingMode.AutoDetect\n /\n processingMode?: ProcessingMode;\n /\n A user-defined reference ID to associate with the payment.\n \n @since 0.0.1\n * @example 'ORDER-12345'\n /\n referenceId?: string;\n /\n An optional note to add to the payment.\n \n @since 0.0.1\n * @example 'Birthday gift'\n /\n note?: string;\n /\n The Square order ID to associate with this payment.\n \n @since 0.0.1\n * @example 'CAISENgvlJ6jLWAzERDzjyHVybY'\n /\n orderId?: string;\n /\n The tip amount.\n \n @since 0.0.1\n /\n tipMoney?: Money;\n /\n The application fee.\n \n @since 0.0.1\n /\n applicationFee?: Money;\n /\n Whether to automatically complete the payment.\n \n If false, the payment will be authorized but not captured, requiring\n * manual completion via the Payments API.\n \n @since 0.0.1\n * @default true\n /\n autocomplete?: boolean;\n /\n The duration to delay before automatically completing or canceling the payment.\n \n Only applicable when autocomplete is false.\n \n @since 0.0.1\n * @example 'PT1H'\n /\n delayDuration?: string;\n /\n The action to take when the delay duration expires.\n \n Only applicable when autocomplete is false.\n \n @since 0.0.1\n /\n delayAction?: DelayAction;\n}\n\n/\n @since 0.0.1\n /\nexport interface PromptParameters {\n /\n The prompt mode.\n \n @since 0.0.1\n * @default PromptMode.Default\n /\n mode?: PromptMode;\n /\n Additional payment methods to allow.\n \n @since 0.0.1\n * @default []\n /\n additionalMethods?: AdditionalPaymentMethod[];\n}\n\n/\n @since 0.0.1\n /\nexport interface Money {\n /\n The amount in the smallest currency unit (e.g., cents for USD).\n \n @since 0.0.1\n * @example 100\n /\n amount: number;\n /\n The ISO 4217 currency code.\n \n @since 0.0.1\n * @example 'USD'\n /\n currency: CurrencyCode;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetAvailableCardInputMethodsResult {\n /\n The available card input methods.\n \n @since 0.0.1\n /\n cardInputMethods: CardInputMethod[];\n}\n\n/\n @since 0.0.1\n /\nexport interface ReaderInfo {\n /\n The reader's serial number.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n /\n The reader's model.\n \n @since 0.0.1\n /\n model: ReaderModel;\n /\n The reader's current status.\n \n @since 0.0.1\n /\n status: ReaderStatus;\n /\n The reader's firmware version.\n \n @since 0.0.1\n * @example '1.2.3'\n /\n firmwareVersion?: string;\n /\n The reader's battery level (0-100).\n \n @since 0.0.1\n * @example 85\n /\n batteryLevel?: number;\n /\n Whether the reader is currently charging.\n \n @since 0.0.1\n /\n isCharging?: boolean;\n /\n The card input methods supported by this reader.\n \n @since 0.0.1\n /\n supportedCardInputMethods: CardInputMethod[];\n /\n Additional information about why the reader is unavailable.\n \n Only present when status is ReaderUnavailable.\n \n @since 0.0.1\n /\n unavailableReasonInfo?: UnavailableReasonInfo;\n}\n\n/\n @since 0.0.1\n /\nexport interface UnavailableReasonInfo {\n /\n The reason code why the reader is unavailable.\n \n @since 0.0.1\n /\n reason: UnavailableReason;\n /\n A human-readable message describing why the reader is unavailable.\n \n @since 0.0.1\n /\n message?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface Payment {\n /\n The unique identifier for this payment.\n \n For offline payments, this may be null until synced.\n \n @since 0.0.1\n * @example 'AbCdEfGhIjKlMnOpQrStUvWxYz'\n /\n id: string \| null;\n /\n The payment type.\n \n @since 0.0.1\n /\n type: PaymentType;\n /\n The payment status.\n \n @since 0.0.1\n /\n status: PaymentStatus;\n /\n The amount paid.\n \n @since 0.0.1\n /\n amountMoney: Money;\n /\n The tip amount.\n \n @since 0.0.1\n /\n tipMoney?: Money;\n /\n The application fee.\n \n @since 0.0.1\n /\n applicationFee?: Money;\n /\n The reference ID provided in the payment parameters.\n \n @since 0.0.1\n /\n referenceId?: string;\n /\n The order ID associated with this payment.\n \n @since 0.0.1\n /\n orderId?: string;\n /\n Card payment details.\n \n Only present for card payments.\n \n @since 0.0.1\n /\n cardDetails?: CardPaymentDetails;\n /\n The time the payment was created (ISO 8601 format).\n \n @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n /\n createdAt?: string;\n /\n The time the payment was updated (ISO 8601 format).\n \n @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n /\n updatedAt?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface CardPaymentDetails {\n /\n The card information.\n \n @since 0.0.1\n /\n card: Card;\n /\n The card entry method used.\n \n @since 0.0.1\n /\n entryMethod: CardInputMethod;\n /\n The authorization code.\n \n @since 0.0.1\n * @example '123456'\n /\n authorizationCode?: string;\n /\n The EMV application name.\n \n @since 0.0.1\n * @example 'VISA CREDIT'\n /\n applicationName?: string;\n /\n The EMV application identifier.\n \n @since 0.0.1\n * @example 'A0000000031010'\n /\n applicationId?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface Card {\n /\n The card brand.\n \n @since 0.0.1\n /\n brand: CardBrand;\n /\n The last four digits of the card number.\n \n @since 0.0.1\n * @example '1234'\n /\n lastFourDigits: string;\n /\n The cardholder name.\n \n @since 0.0.1\n * @example 'John Doe'\n /\n cardholderName?: string;\n /\n The card expiration month (1-12).\n \n @since 0.0.1\n * @example 12\n /\n expirationMonth?: number;\n /\n The card expiration year.\n \n @since 0.0.1\n * @example 2025\n /\n expirationYear?: number;\n}\n\n/\n Callback to receive reader pairing start notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidBeginListener = () => void;\n\n/\n Callback to receive reader pairing success notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidSucceedListener = () => void;\n\n/\n Callback to receive reader pairing failure notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidFailListener = (\n event: ReaderPairingDidFailEvent,\n) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderPairingDidFailEvent {\n /\n The error code.\n \n @since 0.0.1\n /\n code?: string;\n /\n The error message.\n \n @since 0.0.1\n /\n message: string;\n}\n\n/\n Callback to receive reader added notifications.\n \n @since 0.0.1\n /\nexport type ReaderWasAddedListener = (event: ReaderWasAddedEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderWasAddedEvent {\n /\n The reader that was added.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n}\n\n/\n Callback to receive reader removed notifications.\n \n @since 0.0.1\n /\nexport type ReaderWasRemovedListener = (event: ReaderWasRemovedEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderWasRemovedEvent {\n /\n The reader that was removed.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n}\n\n/\n Callback to receive reader change notifications.\n \n @since 0.0.1\n /\nexport type ReaderDidChangeListener = (event: ReaderDidChangeEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderDidChangeEvent {\n /\n The reader that changed.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n /\n The type of change that occurred.\n \n @since 0.0.1\n /\n change: ReaderChange;\n}\n\n/\n Callback to receive available card input method change notifications.\n \n @since 0.0.1\n /\nexport type AvailableCardInputMethodsDidChangeListener = (\n event: AvailableCardInputMethodsDidChangeEvent,\n) => void;\n\n/\n @since 0.0.1\n /\nexport interface AvailableCardInputMethodsDidChangeEvent {\n /\n The available card input methods.\n \n @since 0.0.1\n /\n cardInputMethods: CardInputMethod[];\n}\n\n/\n Callback to receive payment completion notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidFinishListener = (event: PaymentDidFinishEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidFinishEvent {\n /\n The completed payment.\n \n @since 0.0.1\n /\n payment: Payment;\n}\n\n/\n Callback to receive payment failure notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidFailListener = (event: PaymentDidFailEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidFailEvent {\n /\n The failed payment.\n \n @since 0.0.1\n /\n payment?: Payment;\n /\n The error code.\n \n @since 0.0.1\n /\n code?: string;\n /\n The error message.\n \n @since 0.0.1\n /\n message: string;\n}\n\n/\n Callback to receive payment cancellation notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidCancelListener = (event: PaymentDidCancelEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidCancelEvent {\n /\n The cancelled payment.\n \n @since 0.0.1\n /\n payment?: Payment;\n}\n\n/\n @since 0.0.1\n /\nexport enum Environment {\n /\n Production environment.\n \n @since 0.0.1\n /\n Production = 'production',\n /\n Sandbox environment for testing.\n \n @since 0.0.1\n /\n Sandbox = 'sandbox',\n}\n\n/\n @since 0.0.1\n /\nexport enum CardInputMethod {\n /\n Contactless card tap (NFC).\n \n @since 0.0.1\n /\n Tap = 'TAP',\n /\n EMV chip card insertion.\n \n @since 0.0.1\n /\n Dip = 'DIP',\n /\n Magnetic stripe swipe.\n \n @since 0.0.1\n /\n Swipe = 'SWIPE',\n /\n Manually keyed card entry.\n \n @since 0.0.1\n /\n Keyed = 'KEYED',\n}\n\n/\n @since 0.0.1\n /\nexport enum ProcessingMode {\n /\n Automatically detect the best processing mode (online or offline).\n \n @since 0.0.1\n /\n AutoDetect = 'AUTO_DETECT',\n /\n Process the payment online only.\n \n @since 0.0.1\n /\n OnlineOnly = 'ONLINE_ONLY',\n /\n Allow offline payment processing.\n \n @since 0.0.1\n /\n OfflineOnly = 'OFFLINE_ONLY',\n}\n\n/\n @since 0.0.1\n /\nexport enum PromptMode {\n /\n Use the default Square payment UI.\n \n @since 0.0.1\n /\n Default = 'DEFAULT',\n /\n Use a custom payment UI.\n \n @since 0.0.1\n /\n Custom = 'CUSTOM',\n}\n\n/\n @since 0.0.1\n /\nexport enum AdditionalPaymentMethod {\n /\n Allow manually keyed card entry.\n \n @since 0.0.1\n /\n Keyed = 'KEYED',\n /\n Allow cash payments.\n \n @since 0.0.1\n /\n Cash = 'CASH',\n}\n\n/\n @since 0.0.1\n /\nexport enum DelayAction {\n /\n Automatically complete the payment when the delay expires.\n \n @since 0.0.1\n /\n Complete = 'COMPLETE',\n /\n Automatically cancel the payment when the delay expires.\n \n @since 0.0.1\n /\n Cancel = 'CANCEL',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderModel {\n /\n Square Reader for contactless and chip.\n \n @since 0.0.1\n /\n ContactlessAndChip = 'CONTACTLESS_AND_CHIP',\n /\n Square Reader for magstripe.\n \n @since 0.0.1\n /\n Magstripe = 'MAGSTRIPE',\n /\n Square Stand.\n \n @since 0.0.1\n /\n Stand = 'STAND',\n /\n Unknown reader model.\n \n @since 0.0.1\n /\n Unknown = 'UNKNOWN',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderStatus {\n /\n Reader is paired, connected, and ready to accept payments.\n \n @since 0.0.1\n /\n Ready = 'READY',\n /\n Reader is connecting to Square servers.\n \n @since 0.0.1\n /\n ConnectingToSquare = 'CONNECTING_TO_SQUARE',\n /\n Reader is connecting to the mobile device.\n \n @since 0.0.1\n /\n ConnectingToDevice = 'CONNECTING_TO_DEVICE',\n /\n Reader has a hardware or connection error in an unrecoverable state.\n \n @since 0.0.1\n /\n Faulty = 'FAULTY',\n /\n Reader is connected but unable to process payments.\n \n @since 0.0.1\n /\n ReaderUnavailable = 'READER_UNAVAILABLE',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderChange {\n /\n Reader battery started charging.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryDidBeginCharging = 'BATTERY_DID_BEGIN_CHARGING',\n /\n Reader battery stopped charging.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryDidEndCharging = 'BATTERY_DID_END_CHARGING',\n /\n Reader battery level changed.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryLevelDidChange = 'BATTERY_LEVEL_DID_CHANGE',\n /\n Reader battery charging status changed.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BatteryCharging = 'BATTERY_CHARGING',\n /\n Reader was added.\n \n Only available on Android.\n \n @since 0.0.1\n /\n Added = 'ADDED',\n /\n Reader was removed.\n \n Only available on Android.\n \n @since 0.0.1\n /\n Removed = 'REMOVED',\n /\n Reader status changed.\n \n @since 0.0.1\n /\n StatusDidChange = 'STATUS_DID_CHANGE',\n}\n\n/\n @since 0.0.1\n /\nexport enum UnavailableReason {\n /\n Bluetooth connection issue.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BluetoothError = 'BLUETOOTH_ERROR',\n /\n Bluetooth failure.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BluetoothFailure = 'BLUETOOTH_FAILURE',\n /\n Bluetooth is disabled.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BluetoothDisabled = 'BLUETOOTH_DISABLED',\n /\n Reader firmware is updating.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n FirmwareUpdate = 'FIRMWARE_UPDATE',\n /\n Blocking firmware update.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BlockingUpdate = 'BLOCKING_UPDATE',\n /\n Reader is unavailable offline.\n \n Only available on Android.\n \n @since 0.0.1\n /\n ReaderUnavailableOffline = 'READER_UNAVAILABLE_OFFLINE',\n /\n Device is in developer mode.\n \n Only available on Android.\n \n @since 0.0.1\n /\n DeviceDeveloperMode = 'DEVICE_DEVELOPER_MODE',\n /\n Unknown reason.\n \n @since 0.0.1\n /\n Unknown = 'UNKNOWN',\n}\n\n/\n @since 0.0.1\n /\nexport enum PaymentType {\n /\n Payment processed online.\n \n @since 0.0.1\n /\n Online = 'ONLINE',\n /\n Payment processed offline.\n \n @since 0.0.1\n /\n Offline = 'OFFLINE',\n}\n\n/\n @since 0.0.1\n /\nexport enum PaymentStatus {\n /\n Payment was completed successfully.\n \n @since 0.0.1\n /\n Completed = 'COMPLETED',\n /\n Payment was approved but not yet completed.\n \n @since 0.0.1\n /\n Approved = 'APPROVED',\n /\n Payment was canceled.\n \n @since 0.0.1\n /\n Canceled = 'CANCELED',\n /\n Payment failed.\n \n @since 0.0.1\n /\n Failed = 'FAILED',\n /\n Payment is pending.\n \n @since 0.0.1\n /\n Pending = 'PENDING',\n}\n\n/\n @since 0.0.1\n /\nexport enum CardBrand {\n /\n Visa card.\n \n @since 0.0.1\n /\n Visa = 'VISA',\n /\n Mastercard.\n \n @since 0.0.1\n /\n Mastercard = 'MASTERCARD',\n /\n American Express card.\n \n @since 0.0.1\n /\n AmericanExpress = 'AMERICAN_EXPRESS',\n /\n Discover card.\n \n @since 0.0.1\n /\n Discover = 'DISCOVER',\n /\n Discover Diners card.\n \n @since 0.0.1\n /\n DiscoverDiners = 'DISCOVER_DINERS',\n /\n JCB card.\n \n @since 0.0.1\n /\n Jcb = 'JCB',\n /\n UnionPay card.\n \n @since 0.0.1\n /\n UnionPay = 'UNION_PAY',\n /\n Interac card.\n \n @since 0.0.1\n /\n Interac = 'INTERAC',\n /\n Eftpos card.\n \n @since 0.0.1\n /\n Eftpos = 'EFTPOS',\n /\n Other or unknown card brand.\n \n @since 0.0.1\n /\n Other = 'OTHER',\n}\n\n/\n @since 0.0.1\n /\nexport interface PermissionStatus {\n /\n Permission state for accessing location.\n \n Required to confirm that payments are occurring in a supported Square location.\n \n @since 0.0.1\n /\n location: PermissionState;\n /\n Permission state for recording audio.\n \n Required to receive data from magstripe readers.\n \n Only available on Android.\n \n @since 0.0.1\n /\n recordAudio?: PermissionState;\n /\n Permission state for Bluetooth connect.\n \n Required to receive data from contactless and chip readers.\n \n Only available on Android.\n \n @since 0.0.1\n /\n bluetoothConnect?: PermissionState;\n /\n Permission state for Bluetooth scan.\n \n Required to store information during checkout.\n \n Only available on Android.\n \n @since 0.0.1\n /\n bluetoothScan?: PermissionState;\n /\n Permission state for reading phone state.\n \n Required to identify the device sending information to Square servers.\n \n Only available on Android.\n \n @since 0.0.1\n /\n readPhoneState?: PermissionState;\n /\n Permission state for using Bluetooth.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n bluetooth?: PermissionState;\n}\n\n/\n @since 0.0.1\n /\nexport type CurrencyCode = string;\n\n/\n @since 0.0.1\n /\nexport enum ErrorCode {\n /\n The location ID is missing.\n \n @since 0.0.1\n /\n LocationIdMissing = 'LOCATION_ID_MISSING',\n /\n The access token is missing.\n \n @since 0.0.1\n /\n AccessTokenMissing = 'ACCESS_TOKEN_MISSING',\n /\n The serial number is missing.\n \n @since 0.0.1\n /\n SerialNumberMissing = 'SERIAL_NUMBER_MISSING',\n /\n The payment parameters are missing.\n \n @since 0.0.1\n /\n PaymentParametersMissing = 'PAYMENT_PARAMETERS_MISSING',\n /\n The prompt parameters are missing.\n \n @since 0.0.1\n /\n PromptParametersMissing = 'PROMPT_PARAMETERS_MISSING',\n /\n The amount money is missing.\n \n @since 0.0.1\n /\n AmountMoneyMissing = 'AMOUNT_MONEY_MISSING',\n /\n The payment attempt ID is missing.\n \n @since 0.0.1\n /\n PaymentAttemptIdMissing = 'PAYMENT_ATTEMPT_ID_MISSING',\n /\n The SDK is not initialized.\n \n @since 0.0.1\n /\n NotInitialized = 'NOT_INITIALIZED',\n /\n The SDK is not authorized.\n \n @since 0.0.1\n /\n NotAuthorized = 'NOT_AUTHORIZED',\n /\n A pairing process is already in progress.\n \n @since 0.0.1\n /\n PairingAlreadyInProgress = 'PAIRING_ALREADY_IN_PROGRESS',\n /\n No payment is in progress.\n \n @since 0.0.1\n /\n NoPaymentInProgress = 'NO_PAYMENT_IN_PROGRESS',\n /\n Reader not found.\n \n @since 0.0.1\n */\n ReaderNotFound = 'READER_NOT_FOUND',\n}\n"]}
1	+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA6hCA;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,wCAAyB,CAAA;IACzB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAyBX;AAzBD,WAAY,eAAe;IACzB;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,kCAAe,CAAA;IACf;;;;OAIG;IACH,kCAAe,CAAA;AACjB,CAAC,EAzBW,eAAe,KAAf,eAAe,QAyB1B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACxB;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,8CAA4B,CAAA;AAC9B,CAAC,EAnBW,cAAc,KAAd,cAAc,QAmBzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB;;;;OAIG;IACH,iCAAmB,CAAA;IACnB;;;;OAIG;IACH,+BAAiB,CAAA;AACnB,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,uBAaX;AAbD,WAAY,uBAAuB;IACjC;;;;OAIG;IACH,0CAAe,CAAA;IACf;;;;OAIG;IACH,wCAAa,CAAA;AACf,CAAC,EAbW,uBAAuB,KAAvB,uBAAuB,QAalC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,oCAAqB,CAAA;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;AACnB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WA+BX;AA/BD,WAAY,WAAW;IACrB;;;;OAIG;IACH,0DAA2C,CAAA;IAC3C;;;;OAIG;IACH,sCAAuB,CAAA;IACvB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,sCAAuB,CAAA;IACvB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EA/BW,WAAW,KAAX,WAAW,QA+BtB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YA+BX;AA/BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,+BAAe,CAAA;IACf;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,iCAAiB,CAAA;IACjB;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA/BW,YAAY,KAAZ,YAAY,QA+BvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YAuDX;AAvDD,WAAY,YAAY;IACtB;;;;;;OAMG;IACH,sEAAsD,CAAA;IACtD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,oDAAoC,CAAA;IACpC;;;;;;OAMG;IACH,+BAAe,CAAA;IACf;;;;;;OAMG;IACH,mCAAmB,CAAA;IACnB;;;;OAIG;IACH,qDAAqC,CAAA;AACvC,CAAC,EAvDW,YAAY,KAAZ,YAAY,QAuDvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBA+DX;AA/DD,WAAY,iBAAiB;IAC3B;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,2DAAsC,CAAA;IACtC;;;;;;OAMG;IACH,6DAAwC,CAAA;IACxC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,4EAAuD,CAAA;IACvD;;;;;;OAMG;IACH,kEAA6C,CAAA;IAC7C;;;;OAIG;IACH,wCAAmB,CAAA;AACrB,CAAC,EA/DW,iBAAiB,KAAjB,iBAAiB,QA+D5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;IACjB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aA+BX;AA/BD,WAAY,aAAa;IACvB;;;;OAIG;IACH,wCAAuB,CAAA;IACvB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,kCAAiB,CAAA;IACjB;;;;OAIG;IACH,oCAAmB,CAAA;AACrB,CAAC,EA/BW,aAAa,KAAb,aAAa,QA+BxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SA6DX;AA7DD,WAAY,SAAS;IACnB;;;;OAIG;IACH,0BAAa,CAAA;IACb;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,iDAAoC,CAAA;IACpC;;;;OAIG;IACH,kCAAqB,CAAA;IACrB;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,wBAAW,CAAA;IACX;;;;OAIG;IACH,mCAAsB,CAAA;IACtB;;;;OAIG;IACH,gCAAmB,CAAA;IACnB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;OAIG;IACH,4BAAe,CAAA;AACjB,CAAC,EA7DW,SAAS,KAAT,SAAS,QA6DpB;AAmED;;GAEG;AACH,MAAM,CAAN,IAAY,SAyEX;AAzED,WAAY,SAAS;IACnB;;;;OAIG;IACH,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,0DAA6C,CAAA;IAC7C;;;;OAIG;IACH,oEAAuD,CAAA;IACvD;;;;OAIG;IACH,kEAAqD,CAAA;IACrD;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,mEAAsD,CAAA;IACtD;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,6CAAgC,CAAA;IAChC;;;;OAIG;IACH,qEAAwD,CAAA;IACxD;;;;OAIG;IACH,2DAA8C,CAAA;IAC9C;;;;OAIG;IACH,gDAAmC,CAAA;AACrC,CAAC,EAzEW,SAAS,KAAT,SAAS,QAyEpB","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/*\n @since 0.0.1\n /\nexport interface SquareMobilePaymentsPlugin {\n /\n Initialize the Square Mobile Payments SDK.\n \n This method must be called before any other method.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n initialize(options: InitializeOptions): Promise<void>;\n /\n Authorize the SDK with a Square access token.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n authorize(options: AuthorizeOptions): Promise<void>;\n /\n Check if the SDK is currently authorized.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n isAuthorized(): Promise<IsAuthorizedResult>;\n /\n Deauthorize the SDK and clear the current authorization.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n deauthorize(): Promise<void>;\n /\n Show the Square settings screen.\n \n This displays a pre-built settings UI where merchants can view and manage\n * their paired readers.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n showSettings(): Promise<void>;\n /\n Show the Mock Reader UI for testing.\n \n This displays a mock reader interface for testing payment flows without\n * physical hardware. This is only for development and testing purposes and\n * is therefore only available in debug builds.\n \n Only available on Android and iOS.\n \n @since 0.1.1\n /\n showMockReader(): Promise<void>;\n /\n Hide the Mock Reader UI.\n \n Only available on Android and iOS.\n \n @since 0.1.1\n /\n hideMockReader(): Promise<void>;\n /\n Get the current SDK settings.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getSettings(): Promise<GetSettingsResult>;\n /\n Start pairing with a Square reader.\n \n This initiates the reader pairing process. The SDK will search for nearby\n * readers and pair with the first one found.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n startPairing(): Promise<void>;\n /\n Stop the reader pairing process.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n stopPairing(): Promise<void>;\n /\n Check if a pairing process is currently in progress.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n isPairingInProgress(): Promise<IsPairingInProgressResult>;\n /\n Get a list of all paired readers.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getReaders(): Promise<GetReadersResult>;\n /\n Forget a paired reader.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n forgetReader(options: ForgetReaderOptions): Promise<void>;\n /\n Retry connecting to a reader.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n retryConnection(options: RetryConnectionOptions): Promise<void>;\n /\n Start a payment flow.\n \n This presents the payment UI and processes the payment using the specified\n * parameters. Only one payment can be active at a time.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n startPayment(options: StartPaymentOptions): Promise<void>;\n /\n Cancel an ongoing payment.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n cancelPayment(): Promise<void>;\n /\n Get the currently available card input methods.\n \n This returns the card entry methods that are available based on the\n * connected readers (e.g., TAP, DIP, SWIPE, KEYED).\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;\n /\n Link a Square seller account with an Apple ID for Tap to Pay on iPhone.\n \n Presents an Apple sheet prompting the user to accept the Tap to Pay\n * on iPhone terms and conditions.\n \n Only available on iOS.\n \n @since 0.1.3\n /\n linkAppleAccount(): Promise<void>;\n /\n Re-link a Square seller account with a different Apple ID.\n \n Presents an Apple sheet to change the associated Apple ID by\n * showing the Tap to Pay terms and conditions again.\n \n Only available on iOS.\n \n @since 0.1.3\n /\n relinkAppleAccount(): Promise<void>;\n /\n Check if an Apple ID is already linked to a Square seller account.\n \n Only available on iOS.\n \n @since 0.1.3\n /\n isAppleAccountLinked(): Promise<IsAppleAccountLinkedResult>;\n /\n Check if the device is capable of Tap to Pay on iPhone.\n \n Only available on iOS.\n \n @since 0.1.3\n /\n isDeviceCapable(): Promise<IsDeviceCapableResult>;\n /\n Check the current permission status.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n checkPermissions(): Promise<PermissionStatus>;\n /\n Request the required permissions.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n requestPermissions(): Promise<PermissionStatus>;\n /\n Listen for reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidBegin',\n listenerFunc: ReaderPairingDidBeginListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for successful reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidSucceed',\n listenerFunc: ReaderPairingDidSucceedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for failed reader pairing events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerPairingDidFail',\n listenerFunc: ReaderPairingDidFailListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader added events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerWasAdded',\n listenerFunc: ReaderWasAddedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader removed events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerWasRemoved',\n listenerFunc: ReaderWasRemovedListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for reader status and property changes.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'readerDidChange',\n listenerFunc: ReaderDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for available card input method changes.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'availableCardInputMethodsDidChange',\n listenerFunc: AvailableCardInputMethodsDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for successful payment completion events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidFinish',\n listenerFunc: PaymentDidFinishListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for failed payment events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidFail',\n listenerFunc: PaymentDidFailListener,\n ): Promise<PluginListenerHandle>;\n /\n Listen for cancelled payment events.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n addListener(\n eventName: 'paymentDidCancel',\n listenerFunc: PaymentDidCancelListener,\n ): Promise<PluginListenerHandle>;\n /\n Remove all listeners for this plugin.\n \n Only available on Android and iOS.\n \n @since 0.0.1\n /\n removeAllListeners(): Promise<void>;\n}\n\n/\n @since 0.0.1\n /\nexport interface InitializeOptions {\n /\n The Square location ID.\n \n @since 0.0.1\n * @example 'LOCATION_ID'\n /\n locationId: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface AuthorizeOptions {\n /\n The Square access token.\n \n @since 0.0.1\n * @example 'EAAAEOuLQPDbLd...'\n /\n accessToken: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface IsAuthorizedResult {\n /\n Whether the SDK is currently authorized.\n \n @since 0.0.1\n /\n authorized: boolean;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetSettingsResult {\n /\n The SDK version.\n \n @since 0.0.1\n * @example '2.0.0'\n /\n version: string;\n /\n The current environment.\n \n @since 0.0.1\n * @example 'production'\n /\n environment: Environment;\n}\n\n/\n @since 0.0.1\n /\nexport interface IsPairingInProgressResult {\n /\n Whether a pairing process is currently in progress.\n \n @since 0.0.1\n /\n inProgress: boolean;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetReadersResult {\n /\n The list of paired readers.\n \n @since 0.0.1\n /\n readers: ReaderInfo[];\n}\n\n/\n @since 0.0.1\n /\nexport interface ForgetReaderOptions {\n /\n The serial number of the reader to forget.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface RetryConnectionOptions {\n /\n The serial number of the reader to retry connection.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface StartPaymentOptions {\n /\n The payment parameters.\n \n @since 0.0.1\n /\n paymentParameters: PaymentParameters;\n /\n The prompt parameters.\n \n @since 0.0.1\n /\n promptParameters: PromptParameters;\n}\n\n/\n @since 0.0.1\n /\nexport interface PaymentParameters {\n /\n The amount of money to charge.\n \n @since 0.0.1\n /\n amountMoney: Money;\n /\n A unique identifier for this payment attempt.\n \n This is used for idempotent payment requests.\n \n @since 0.0.1\n * @example 'a1b2c3d4-e5f6-4a5b-8c9d-1e2f3a4b5c6d'\n /\n paymentAttemptId: string;\n /\n The processing mode for this payment.\n \n @since 0.0.1\n * @default ProcessingMode.AutoDetect\n /\n processingMode?: ProcessingMode;\n /\n A user-defined reference ID to associate with the payment.\n \n @since 0.0.1\n * @example 'ORDER-12345'\n /\n referenceId?: string;\n /\n An optional note to add to the payment.\n \n @since 0.0.1\n * @example 'Birthday gift'\n /\n note?: string;\n /\n The Square order ID to associate with this payment.\n \n @since 0.0.1\n * @example 'CAISENgvlJ6jLWAzERDzjyHVybY'\n /\n orderId?: string;\n /\n The tip amount.\n \n @since 0.0.1\n /\n tipMoney?: Money;\n /\n The application fee.\n \n @since 0.0.1\n /\n applicationFee?: Money;\n /\n Whether to automatically complete the payment.\n \n If false, the payment will be authorized but not captured, requiring\n * manual completion via the Payments API.\n \n @since 0.0.1\n * @default true\n /\n autocomplete?: boolean;\n /\n The duration to delay before automatically completing or canceling the payment.\n \n Only applicable when autocomplete is false.\n \n @since 0.0.1\n * @example 'PT1H'\n /\n delayDuration?: string;\n /\n The action to take when the delay duration expires.\n \n Only applicable when autocomplete is false.\n \n @since 0.0.1\n /\n delayAction?: DelayAction;\n}\n\n/\n @since 0.0.1\n /\nexport interface PromptParameters {\n /\n The prompt mode.\n \n @since 0.0.1\n * @default PromptMode.Default\n /\n mode?: PromptMode;\n /\n Additional payment methods to allow.\n \n @since 0.0.1\n * @default []\n /\n additionalMethods?: AdditionalPaymentMethod[];\n}\n\n/\n @since 0.0.1\n /\nexport interface Money {\n /\n The amount in the smallest currency unit (e.g., cents for USD).\n \n @since 0.0.1\n * @example 100\n /\n amount: number;\n /\n The ISO 4217 currency code.\n \n @since 0.0.1\n * @example 'USD'\n /\n currency: CurrencyCode;\n}\n\n/\n @since 0.0.1\n /\nexport interface GetAvailableCardInputMethodsResult {\n /\n The available card input methods.\n \n @since 0.0.1\n /\n cardInputMethods: CardInputMethod[];\n}\n\n/\n @since 0.1.3\n /\nexport interface IsAppleAccountLinkedResult {\n /\n Whether an Apple ID is linked to the Square seller account.\n \n @since 0.1.3\n /\n linked: boolean;\n}\n\n/\n @since 0.1.3\n /\nexport interface IsDeviceCapableResult {\n /\n Whether the device is capable of Tap to Pay on iPhone.\n \n @since 0.1.3\n /\n capable: boolean;\n}\n\n/\n @since 0.0.1\n /\nexport interface ReaderInfo {\n /\n The reader's serial number.\n \n @since 0.0.1\n * @example 'CRR123456789'\n /\n serialNumber: string;\n /\n The reader's model.\n \n @since 0.0.1\n /\n model: ReaderModel;\n /\n The reader's current status.\n \n @since 0.0.1\n /\n status: ReaderStatus;\n /\n The reader's firmware version.\n \n @since 0.0.1\n * @example '1.2.3'\n /\n firmwareVersion?: string;\n /\n The reader's battery level (0-100).\n \n @since 0.0.1\n * @example 85\n /\n batteryLevel?: number;\n /\n Whether the reader is currently charging.\n \n @since 0.0.1\n /\n isCharging?: boolean;\n /\n The card input methods supported by this reader.\n \n @since 0.0.1\n /\n supportedCardInputMethods: CardInputMethod[];\n /\n Additional information about why the reader is unavailable.\n \n Only present when status is ReaderUnavailable.\n \n @since 0.0.1\n /\n unavailableReasonInfo?: UnavailableReasonInfo;\n}\n\n/\n @since 0.0.1\n /\nexport interface UnavailableReasonInfo {\n /\n The reason code why the reader is unavailable.\n \n @since 0.0.1\n /\n reason: UnavailableReason;\n /\n A human-readable message describing why the reader is unavailable.\n \n @since 0.0.1\n /\n message?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface Payment {\n /\n The unique identifier for this payment.\n \n For offline payments, this may be null until synced.\n \n @since 0.0.1\n * @example 'AbCdEfGhIjKlMnOpQrStUvWxYz'\n /\n id: string \| null;\n /\n The payment type.\n \n @since 0.0.1\n /\n type: PaymentType;\n /\n The payment status.\n \n @since 0.0.1\n /\n status: PaymentStatus;\n /\n The amount paid.\n \n @since 0.0.1\n /\n amountMoney: Money;\n /\n The tip amount.\n \n @since 0.0.1\n /\n tipMoney?: Money;\n /\n The application fee.\n \n @since 0.0.1\n /\n applicationFee?: Money;\n /\n The reference ID provided in the payment parameters.\n \n @since 0.0.1\n /\n referenceId?: string;\n /\n The order ID associated with this payment.\n \n @since 0.0.1\n /\n orderId?: string;\n /\n Card payment details.\n \n Only present for card payments.\n \n @since 0.0.1\n /\n cardDetails?: CardPaymentDetails;\n /\n The time the payment was created (ISO 8601 format).\n \n @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n /\n createdAt?: string;\n /\n The time the payment was updated (ISO 8601 format).\n \n @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n /\n updatedAt?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface CardPaymentDetails {\n /\n The card information.\n \n @since 0.0.1\n /\n card: Card;\n /\n The card entry method used.\n \n @since 0.0.1\n /\n entryMethod: CardInputMethod;\n /\n The authorization code.\n \n @since 0.0.1\n * @example '123456'\n /\n authorizationCode?: string;\n /\n The EMV application name.\n \n @since 0.0.1\n * @example 'VISA CREDIT'\n /\n applicationName?: string;\n /\n The EMV application identifier.\n \n @since 0.0.1\n * @example 'A0000000031010'\n /\n applicationId?: string;\n}\n\n/\n @since 0.0.1\n /\nexport interface Card {\n /\n The card brand.\n \n @since 0.0.1\n /\n brand: CardBrand;\n /\n The last four digits of the card number.\n \n @since 0.0.1\n * @example '1234'\n /\n lastFourDigits: string;\n /\n The cardholder name.\n \n @since 0.0.1\n * @example 'John Doe'\n /\n cardholderName?: string;\n /\n The card expiration month (1-12).\n \n @since 0.0.1\n * @example 12\n /\n expirationMonth?: number;\n /\n The card expiration year.\n \n @since 0.0.1\n * @example 2025\n /\n expirationYear?: number;\n}\n\n/\n Callback to receive reader pairing start notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidBeginListener = () => void;\n\n/\n Callback to receive reader pairing success notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidSucceedListener = () => void;\n\n/\n Callback to receive reader pairing failure notifications.\n \n @since 0.0.1\n /\nexport type ReaderPairingDidFailListener = (\n event: ReaderPairingDidFailEvent,\n) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderPairingDidFailEvent {\n /\n The error code.\n \n @since 0.0.1\n /\n code?: string;\n /\n The error message.\n \n @since 0.0.1\n /\n message: string;\n}\n\n/\n Callback to receive reader added notifications.\n \n @since 0.0.1\n /\nexport type ReaderWasAddedListener = (event: ReaderWasAddedEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderWasAddedEvent {\n /\n The reader that was added.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n}\n\n/\n Callback to receive reader removed notifications.\n \n @since 0.0.1\n /\nexport type ReaderWasRemovedListener = (event: ReaderWasRemovedEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderWasRemovedEvent {\n /\n The reader that was removed.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n}\n\n/\n Callback to receive reader change notifications.\n \n @since 0.0.1\n /\nexport type ReaderDidChangeListener = (event: ReaderDidChangeEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface ReaderDidChangeEvent {\n /\n The reader that changed.\n \n @since 0.0.1\n /\n reader: ReaderInfo;\n /\n The type of change that occurred.\n \n @since 0.0.1\n /\n change: ReaderChange;\n}\n\n/\n Callback to receive available card input method change notifications.\n \n @since 0.0.1\n /\nexport type AvailableCardInputMethodsDidChangeListener = (\n event: AvailableCardInputMethodsDidChangeEvent,\n) => void;\n\n/\n @since 0.0.1\n /\nexport interface AvailableCardInputMethodsDidChangeEvent {\n /\n The available card input methods.\n \n @since 0.0.1\n /\n cardInputMethods: CardInputMethod[];\n}\n\n/\n Callback to receive payment completion notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidFinishListener = (event: PaymentDidFinishEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidFinishEvent {\n /\n The completed payment.\n \n @since 0.0.1\n /\n payment: Payment;\n}\n\n/\n Callback to receive payment failure notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidFailListener = (event: PaymentDidFailEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidFailEvent {\n /\n The failed payment.\n \n @since 0.0.1\n /\n payment?: Payment;\n /\n The error code.\n \n @since 0.0.1\n /\n code?: string;\n /\n The error message.\n \n @since 0.0.1\n /\n message: string;\n}\n\n/\n Callback to receive payment cancellation notifications.\n \n @since 0.0.1\n /\nexport type PaymentDidCancelListener = (event: PaymentDidCancelEvent) => void;\n\n/\n @since 0.0.1\n /\nexport interface PaymentDidCancelEvent {\n /\n The cancelled payment.\n \n @since 0.0.1\n /\n payment?: Payment;\n}\n\n/\n @since 0.0.1\n /\nexport enum Environment {\n /\n Production environment.\n \n @since 0.0.1\n /\n Production = 'production',\n /\n Sandbox environment for testing.\n \n @since 0.0.1\n /\n Sandbox = 'sandbox',\n}\n\n/\n @since 0.0.1\n /\nexport enum CardInputMethod {\n /\n Contactless card tap (NFC).\n \n @since 0.0.1\n /\n Tap = 'TAP',\n /\n EMV chip card insertion.\n \n @since 0.0.1\n /\n Dip = 'DIP',\n /\n Magnetic stripe swipe.\n \n @since 0.0.1\n /\n Swipe = 'SWIPE',\n /\n Manually keyed card entry.\n \n @since 0.0.1\n /\n Keyed = 'KEYED',\n}\n\n/\n @since 0.0.1\n /\nexport enum ProcessingMode {\n /\n Automatically detect the best processing mode (online or offline).\n \n @since 0.0.1\n /\n AutoDetect = 'AUTO_DETECT',\n /\n Process the payment online only.\n \n @since 0.0.1\n /\n OnlineOnly = 'ONLINE_ONLY',\n /\n Allow offline payment processing.\n \n @since 0.0.1\n /\n OfflineOnly = 'OFFLINE_ONLY',\n}\n\n/\n @since 0.0.1\n /\nexport enum PromptMode {\n /\n Use the default Square payment UI.\n \n @since 0.0.1\n /\n Default = 'DEFAULT',\n /\n Use a custom payment UI.\n \n @since 0.0.1\n /\n Custom = 'CUSTOM',\n}\n\n/\n @since 0.0.1\n /\nexport enum AdditionalPaymentMethod {\n /\n Allow manually keyed card entry.\n \n @since 0.0.1\n /\n Keyed = 'KEYED',\n /\n Allow cash payments.\n \n @since 0.0.1\n /\n Cash = 'CASH',\n}\n\n/\n @since 0.0.1\n /\nexport enum DelayAction {\n /\n Automatically complete the payment when the delay expires.\n \n @since 0.0.1\n /\n Complete = 'COMPLETE',\n /\n Automatically cancel the payment when the delay expires.\n \n @since 0.0.1\n /\n Cancel = 'CANCEL',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderModel {\n /\n Square Reader for contactless and chip.\n \n @since 0.0.1\n /\n ContactlessAndChip = 'CONTACTLESS_AND_CHIP',\n /\n Square Reader for magstripe.\n \n @since 0.0.1\n /\n Magstripe = 'MAGSTRIPE',\n /\n Square Stand.\n \n @since 0.0.1\n /\n Stand = 'STAND',\n /\n Tap to Pay on iPhone.\n \n @since 0.1.3\n /\n TapToPay = 'TAP_TO_PAY',\n /\n Unknown reader model.\n \n @since 0.0.1\n /\n Unknown = 'UNKNOWN',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderStatus {\n /\n Reader is paired, connected, and ready to accept payments.\n \n @since 0.0.1\n /\n Ready = 'READY',\n /\n Reader is connecting to Square servers.\n \n @since 0.0.1\n /\n ConnectingToSquare = 'CONNECTING_TO_SQUARE',\n /\n Reader is connecting to the mobile device.\n \n @since 0.0.1\n /\n ConnectingToDevice = 'CONNECTING_TO_DEVICE',\n /\n Reader has a hardware or connection error in an unrecoverable state.\n \n @since 0.0.1\n /\n Faulty = 'FAULTY',\n /\n Reader is connected but unable to process payments.\n \n @since 0.0.1\n /\n ReaderUnavailable = 'READER_UNAVAILABLE',\n}\n\n/\n @since 0.0.1\n /\nexport enum ReaderChange {\n /\n Reader battery started charging.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryDidBeginCharging = 'BATTERY_DID_BEGIN_CHARGING',\n /\n Reader battery stopped charging.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryDidEndCharging = 'BATTERY_DID_END_CHARGING',\n /\n Reader battery level changed.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BatteryLevelDidChange = 'BATTERY_LEVEL_DID_CHANGE',\n /\n Reader battery charging status changed.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BatteryCharging = 'BATTERY_CHARGING',\n /\n Reader was added.\n \n Only available on Android.\n \n @since 0.0.1\n /\n Added = 'ADDED',\n /\n Reader was removed.\n \n Only available on Android.\n \n @since 0.0.1\n /\n Removed = 'REMOVED',\n /\n Reader status changed.\n \n @since 0.0.1\n /\n StatusDidChange = 'STATUS_DID_CHANGE',\n}\n\n/\n @since 0.0.1\n /\nexport enum UnavailableReason {\n /\n Bluetooth connection issue.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n BluetoothError = 'BLUETOOTH_ERROR',\n /\n Bluetooth failure.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BluetoothFailure = 'BLUETOOTH_FAILURE',\n /\n Bluetooth is disabled.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BluetoothDisabled = 'BLUETOOTH_DISABLED',\n /\n Reader firmware is updating.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n FirmwareUpdate = 'FIRMWARE_UPDATE',\n /\n Blocking firmware update.\n \n Only available on Android.\n \n @since 0.0.1\n /\n BlockingUpdate = 'BLOCKING_UPDATE',\n /\n Reader is unavailable offline.\n \n Only available on Android.\n \n @since 0.0.1\n /\n ReaderUnavailableOffline = 'READER_UNAVAILABLE_OFFLINE',\n /\n Device is in developer mode.\n \n Only available on Android.\n \n @since 0.0.1\n /\n DeviceDeveloperMode = 'DEVICE_DEVELOPER_MODE',\n /\n Unknown reason.\n \n @since 0.0.1\n /\n Unknown = 'UNKNOWN',\n}\n\n/\n @since 0.0.1\n /\nexport enum PaymentType {\n /\n Payment processed online.\n \n @since 0.0.1\n /\n Online = 'ONLINE',\n /\n Payment processed offline.\n \n @since 0.0.1\n /\n Offline = 'OFFLINE',\n}\n\n/\n @since 0.0.1\n /\nexport enum PaymentStatus {\n /\n Payment was completed successfully.\n \n @since 0.0.1\n /\n Completed = 'COMPLETED',\n /\n Payment was approved but not yet completed.\n \n @since 0.0.1\n /\n Approved = 'APPROVED',\n /\n Payment was canceled.\n \n @since 0.0.1\n /\n Canceled = 'CANCELED',\n /\n Payment failed.\n \n @since 0.0.1\n /\n Failed = 'FAILED',\n /\n Payment is pending.\n \n @since 0.0.1\n /\n Pending = 'PENDING',\n}\n\n/\n @since 0.0.1\n /\nexport enum CardBrand {\n /\n Visa card.\n \n @since 0.0.1\n /\n Visa = 'VISA',\n /\n Mastercard.\n \n @since 0.0.1\n /\n Mastercard = 'MASTERCARD',\n /\n American Express card.\n \n @since 0.0.1\n /\n AmericanExpress = 'AMERICAN_EXPRESS',\n /\n Discover card.\n \n @since 0.0.1\n /\n Discover = 'DISCOVER',\n /\n Discover Diners card.\n \n @since 0.0.1\n /\n DiscoverDiners = 'DISCOVER_DINERS',\n /\n JCB card.\n \n @since 0.0.1\n /\n Jcb = 'JCB',\n /\n UnionPay card.\n \n @since 0.0.1\n /\n UnionPay = 'UNION_PAY',\n /\n Interac card.\n \n @since 0.0.1\n /\n Interac = 'INTERAC',\n /\n Eftpos card.\n \n @since 0.0.1\n /\n Eftpos = 'EFTPOS',\n /\n Other or unknown card brand.\n \n @since 0.0.1\n /\n Other = 'OTHER',\n}\n\n/\n @since 0.0.1\n /\nexport interface PermissionStatus {\n /\n Permission state for accessing location.\n \n Required to confirm that payments are occurring in a supported Square location.\n \n @since 0.0.1\n /\n location: PermissionState;\n /\n Permission state for recording audio.\n \n Required to receive data from magstripe readers.\n \n @since 0.0.1\n /\n recordAudio?: PermissionState;\n /\n Permission state for Bluetooth connect.\n \n Required to receive data from contactless and chip readers.\n \n Only available on Android.\n \n @since 0.0.1\n /\n bluetoothConnect?: PermissionState;\n /\n Permission state for Bluetooth scan.\n \n Required to store information during checkout.\n \n Only available on Android.\n \n @since 0.0.1\n /\n bluetoothScan?: PermissionState;\n /\n Permission state for reading phone state.\n \n Required to identify the device sending information to Square servers.\n \n Only available on Android.\n \n @since 0.0.1\n /\n readPhoneState?: PermissionState;\n /\n Permission state for using Bluetooth.\n \n Only available on iOS.\n \n @since 0.0.1\n /\n bluetooth?: PermissionState;\n}\n\n/\n @since 0.0.1\n /\nexport type CurrencyCode = string;\n\n/\n @since 0.0.1\n /\nexport enum ErrorCode {\n /\n The location ID is missing.\n \n @since 0.0.1\n /\n LocationIdMissing = 'LOCATION_ID_MISSING',\n /\n The access token is missing.\n \n @since 0.0.1\n /\n AccessTokenMissing = 'ACCESS_TOKEN_MISSING',\n /\n The serial number is missing.\n \n @since 0.0.1\n /\n SerialNumberMissing = 'SERIAL_NUMBER_MISSING',\n /\n The payment parameters are missing.\n \n @since 0.0.1\n /\n PaymentParametersMissing = 'PAYMENT_PARAMETERS_MISSING',\n /\n The prompt parameters are missing.\n \n @since 0.0.1\n /\n PromptParametersMissing = 'PROMPT_PARAMETERS_MISSING',\n /\n The amount money is missing.\n \n @since 0.0.1\n /\n AmountMoneyMissing = 'AMOUNT_MONEY_MISSING',\n /\n The payment attempt ID is missing.\n \n @since 0.0.1\n /\n PaymentAttemptIdMissing = 'PAYMENT_ATTEMPT_ID_MISSING',\n /\n The SDK is not initialized.\n \n @since 0.0.1\n /\n NotInitialized = 'NOT_INITIALIZED',\n /\n The SDK is not authorized.\n \n @since 0.0.1\n /\n NotAuthorized = 'NOT_AUTHORIZED',\n /\n A pairing process is already in progress.\n \n @since 0.0.1\n /\n PairingAlreadyInProgress = 'PAIRING_ALREADY_IN_PROGRESS',\n /\n No payment is in progress.\n \n @since 0.0.1\n /\n NoPaymentInProgress = 'NO_PAYMENT_IN_PROGRESS',\n /\n Reader not found.\n \n @since 0.0.1\n */\n ReaderNotFound = 'READER_NOT_FOUND',\n}\n"]}

package/dist/esm/web.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import { WebPlugin } from '@capacitor/core';
-import type { AuthorizeOptions, ForgetReaderOptions, GetAvailableCardInputMethodsResult, GetReadersResult, GetSettingsResult, InitializeOptions, IsAuthorizedResult, IsPairingInProgressResult, PermissionStatus, RetryConnectionOptions, SquareMobilePaymentsPlugin, StartPaymentOptions } from './definitions';
+import type { AuthorizeOptions, ForgetReaderOptions, GetAvailableCardInputMethodsResult, GetReadersResult, GetSettingsResult, InitializeOptions, IsAppleAccountLinkedResult, IsAuthorizedResult, IsDeviceCapableResult, IsPairingInProgressResult, PermissionStatus, RetryConnectionOptions, SquareMobilePaymentsPlugin, StartPaymentOptions } from './definitions';
 export declare class SquareMobilePaymentsWeb extends WebPlugin implements SquareMobilePaymentsPlugin {
     initialize(_options: InitializeOptions): Promise<void>;
     authorize(_options: AuthorizeOptions): Promise<void>;
@@ -18,6 +18,10 @@ export declare class SquareMobilePaymentsWeb extends WebPlugin implements Square
     startPayment(_options: StartPaymentOptions): Promise<void>;
     cancelPayment(): Promise<void>;
     getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;
+    linkAppleAccount(): Promise<void>;
+    relinkAppleAccount(): Promise<void>;
+    isAppleAccountLinked(): Promise<IsAppleAccountLinkedResult>;
+    isDeviceCapable(): Promise<IsDeviceCapableResult>;
     checkPermissions(): Promise<PermissionStatus>;
     requestPermissions(): Promise<PermissionStatus>;
 }