@capawesome/capacitor-square-mobile-payments 0.0.1

package/dist/docs.json

@@ -0,0 +1,2999 @@
+{
+  "api": {
+    "name": "SquareMobilePaymentsPlugin",
+    "slug": "squaremobilepaymentsplugin",
+    "docs": "",
+    "tags": [
+      {
+        "text": "0.0.1",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "initialize",
+        "signature": "(options: InitializeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "InitializeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Initialize the Square Mobile Payments SDK.\n\nThis method must be called before any other method.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "InitializeOptions"
+        ],
+        "slug": "initialize"
+      },
+      {
+        "name": "authorize",
+        "signature": "(options: AuthorizeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AuthorizeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Authorize the SDK with a Square access token.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "AuthorizeOptions"
+        ],
+        "slug": "authorize"
+      },
+      {
+        "name": "isAuthorized",
+        "signature": "() => Promise<IsAuthorizedResult>",
+        "parameters": [],
+        "returns": "Promise<IsAuthorizedResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Check if the SDK is currently authorized.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsAuthorizedResult"
+        ],
+        "slug": "isauthorized"
+      },
+      {
+        "name": "deauthorize",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Deauthorize the SDK and clear the current authorization.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "deauthorize"
+      },
+      {
+        "name": "showSettings",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Show the Square settings screen.\n\nThis displays a pre-built settings UI where merchants can view and manage\ntheir paired readers.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "showsettings"
+      },
+      {
+        "name": "getSettings",
+        "signature": "() => Promise<GetSettingsResult>",
+        "parameters": [],
+        "returns": "Promise<GetSettingsResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Get the current SDK settings.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetSettingsResult"
+        ],
+        "slug": "getsettings"
+      },
+      {
+        "name": "startPairing",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Start pairing with a Square reader.\n\nThis initiates the reader pairing process. The SDK will search for nearby\nreaders and pair with the first one found.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "startpairing"
+      },
+      {
+        "name": "stopPairing",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Stop the reader pairing process.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "stoppairing"
+      },
+      {
+        "name": "isPairingInProgress",
+        "signature": "() => Promise<IsPairingInProgressResult>",
+        "parameters": [],
+        "returns": "Promise<IsPairingInProgressResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Check if a pairing process is currently in progress.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsPairingInProgressResult"
+        ],
+        "slug": "ispairinginprogress"
+      },
+      {
+        "name": "getReaders",
+        "signature": "() => Promise<GetReadersResult>",
+        "parameters": [],
+        "returns": "Promise<GetReadersResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Get a list of all paired readers.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetReadersResult"
+        ],
+        "slug": "getreaders"
+      },
+      {
+        "name": "forgetReader",
+        "signature": "(options: ForgetReaderOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ForgetReaderOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Forget a paired reader.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "ForgetReaderOptions"
+        ],
+        "slug": "forgetreader"
+      },
+      {
+        "name": "retryConnection",
+        "signature": "(options: RetryConnectionOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RetryConnectionOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Retry connecting to a reader.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "RetryConnectionOptions"
+        ],
+        "slug": "retryconnection"
+      },
+      {
+        "name": "startPayment",
+        "signature": "(options: StartPaymentOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartPaymentOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Start a payment flow.\n\nThis presents the payment UI and processes the payment using the specified\nparameters. Only one payment can be active at a time.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "StartPaymentOptions"
+        ],
+        "slug": "startpayment"
+      },
+      {
+        "name": "cancelPayment",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Cancel an ongoing payment.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "cancelpayment"
+      },
+      {
+        "name": "getAvailableCardInputMethods",
+        "signature": "() => Promise<GetAvailableCardInputMethodsResult>",
+        "parameters": [],
+        "returns": "Promise<GetAvailableCardInputMethodsResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Get the currently available card input methods.\n\nThis returns the card entry methods that are available based on the\nconnected readers (e.g., TAP, DIP, SWIPE, KEYED).\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetAvailableCardInputMethodsResult"
+        ],
+        "slug": "getavailablecardinputmethods"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Check the current permission status.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Request the required permissions.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerPairingDidBegin', listenerFunc: ReaderPairingDidBeginListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerPairingDidBegin'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderPairingDidBeginListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for reader pairing events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderPairingDidBeginListener"
+        ],
+        "slug": "addlistenerreaderpairingdidbegin-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerPairingDidSucceed', listenerFunc: ReaderPairingDidSucceedListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerPairingDidSucceed'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderPairingDidSucceedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for successful reader pairing events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderPairingDidSucceedListener"
+        ],
+        "slug": "addlistenerreaderpairingdidsucceed-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerPairingDidFail', listenerFunc: ReaderPairingDidFailListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerPairingDidFail'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderPairingDidFailListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for failed reader pairing events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderPairingDidFailListener"
+        ],
+        "slug": "addlistenerreaderpairingdidfail-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerWasAdded', listenerFunc: ReaderWasAddedListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerWasAdded'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderWasAddedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for reader added events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderWasAddedListener"
+        ],
+        "slug": "addlistenerreaderwasadded-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerWasRemoved', listenerFunc: ReaderWasRemovedListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerWasRemoved'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderWasRemovedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for reader removed events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderWasRemovedListener"
+        ],
+        "slug": "addlistenerreaderwasremoved-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'readerDidChange', listenerFunc: ReaderDidChangeListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'readerDidChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReaderDidChangeListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for reader status and property changes.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReaderDidChangeListener"
+        ],
+        "slug": "addlistenerreaderdidchange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'availableCardInputMethodsDidChange', listenerFunc: AvailableCardInputMethodsDidChangeListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'availableCardInputMethodsDidChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "AvailableCardInputMethodsDidChangeListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for available card input method changes.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "AvailableCardInputMethodsDidChangeListener"
+        ],
+        "slug": "addlisteneravailablecardinputmethodsdidchange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'paymentDidFinish', listenerFunc: PaymentDidFinishListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'paymentDidFinish'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "PaymentDidFinishListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for successful payment completion events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PaymentDidFinishListener"
+        ],
+        "slug": "addlistenerpaymentdidfinish-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'paymentDidFail', listenerFunc: PaymentDidFailListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'paymentDidFail'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "PaymentDidFailListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for failed payment events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PaymentDidFailListener"
+        ],
+        "slug": "addlistenerpaymentdidfail-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'paymentDidCancel', listenerFunc: PaymentDidCancelListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'paymentDidCancel'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "PaymentDidCancelListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for cancelled payment events.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PaymentDidCancelListener"
+        ],
+        "slug": "addlistenerpaymentdidcancel-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "InitializeOptions",
+      "slug": "initializeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "locationId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'LOCATION_ID'",
+              "name": "example"
+            }
+          ],
+          "docs": "The Square location ID.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "AuthorizeOptions",
+      "slug": "authorizeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "accessToken",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'EAAAEOuLQPDbLd...'",
+              "name": "example"
+            }
+          ],
+          "docs": "The Square access token.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "IsAuthorizedResult",
+      "slug": "isauthorizedresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "authorized",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the SDK is currently authorized.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "GetSettingsResult",
+      "slug": "getsettingsresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'2.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The SDK version.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "environment",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'production'",
+              "name": "example"
+            }
+          ],
+          "docs": "The current environment.",
+          "complexTypes": [
+            "Environment"
+          ],
+          "type": "Environment"
+        }
+      ]
+    },
+    {
+      "name": "IsPairingInProgressResult",
+      "slug": "ispairinginprogressresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "inProgress",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a pairing process is currently in progress.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "GetReadersResult",
+      "slug": "getreadersresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "readers",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The list of paired readers.",
+          "complexTypes": [
+            "ReaderInfo"
+          ],
+          "type": "ReaderInfo[]"
+        }
+      ]
+    },
+    {
+      "name": "ReaderInfo",
+      "slug": "readerinfo",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "serialNumber",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'CRR123456789'",
+              "name": "example"
+            }
+          ],
+          "docs": "The reader's serial number.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "model",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reader's model.",
+          "complexTypes": [
+            "ReaderModel"
+          ],
+          "type": "ReaderModel"
+        },
+        {
+          "name": "status",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reader's current status.",
+          "complexTypes": [
+            "ReaderStatus"
+          ],
+          "type": "ReaderStatus"
+        },
+        {
+          "name": "firmwareVersion",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'1.2.3'",
+              "name": "example"
+            }
+          ],
+          "docs": "The reader's firmware version.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "batteryLevel",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "85",
+              "name": "example"
+            }
+          ],
+          "docs": "The reader's battery level (0-100).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "isCharging",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the reader is currently charging.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "supportedCardInputMethods",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The card input methods supported by this reader.",
+          "complexTypes": [
+            "CardInputMethod"
+          ],
+          "type": "CardInputMethod[]"
+        },
+        {
+          "name": "unavailableReasonInfo",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Additional information about why the reader is unavailable.\n\nOnly present when status is ReaderUnavailable.",
+          "complexTypes": [
+            "UnavailableReasonInfo"
+          ],
+          "type": "UnavailableReasonInfo"
+        }
+      ]
+    },
+    {
+      "name": "UnavailableReasonInfo",
+      "slug": "unavailablereasoninfo",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reason",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reason code why the reader is unavailable.",
+          "complexTypes": [
+            "UnavailableReason"
+          ],
+          "type": "UnavailableReason"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "A human-readable message describing why the reader is unavailable.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ForgetReaderOptions",
+      "slug": "forgetreaderoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "serialNumber",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'CRR123456789'",
+              "name": "example"
+            }
+          ],
+          "docs": "The serial number of the reader to forget.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "RetryConnectionOptions",
+      "slug": "retryconnectionoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "serialNumber",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'CRR123456789'",
+              "name": "example"
+            }
+          ],
+          "docs": "The serial number of the reader to retry connection.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "StartPaymentOptions",
+      "slug": "startpaymentoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "paymentParameters",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The payment parameters.",
+          "complexTypes": [
+            "PaymentParameters"
+          ],
+          "type": "PaymentParameters"
+        },
+        {
+          "name": "promptParameters",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The prompt parameters.",
+          "complexTypes": [
+            "PromptParameters"
+          ],
+          "type": "PromptParameters"
+        }
+      ]
+    },
+    {
+      "name": "PaymentParameters",
+      "slug": "paymentparameters",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "amountMoney",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The amount of money to charge.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "paymentAttemptId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'a1b2c3d4-e5f6-4a5b-8c9d-1e2f3a4b5c6d'",
+              "name": "example"
+            }
+          ],
+          "docs": "A unique identifier for this payment attempt.\n\nThis is used for idempotent payment requests.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "processingMode",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "ProcessingMode.AutoDetect",
+              "name": "default"
+            }
+          ],
+          "docs": "The processing mode for this payment.",
+          "complexTypes": [
+            "ProcessingMode"
+          ],
+          "type": "ProcessingMode"
+        },
+        {
+          "name": "referenceId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'ORDER-12345'",
+              "name": "example"
+            }
+          ],
+          "docs": "A user-defined reference ID to associate with the payment.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "note",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'Birthday gift'",
+              "name": "example"
+            }
+          ],
+          "docs": "An optional note to add to the payment.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "orderId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'CAISENgvlJ6jLWAzERDzjyHVybY'",
+              "name": "example"
+            }
+          ],
+          "docs": "The Square order ID to associate with this payment.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "tipMoney",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The tip amount.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "applicationFee",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The application fee.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "autocomplete",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether to automatically complete the payment.\n\nIf false, the payment will be authorized but not captured, requiring\nmanual completion via the Payments API.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "delayDuration",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'PT1H'",
+              "name": "example"
+            }
+          ],
+          "docs": "The duration to delay before automatically completing or canceling the payment.\n\nOnly applicable when autocomplete is false.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "delayAction",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The action to take when the delay duration expires.\n\nOnly applicable when autocomplete is false.",
+          "complexTypes": [
+            "DelayAction"
+          ],
+          "type": "DelayAction"
+        }
+      ]
+    },
+    {
+      "name": "Money",
+      "slug": "money",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "amount",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "100",
+              "name": "example"
+            }
+          ],
+          "docs": "The amount in the smallest currency unit (e.g., cents for USD).",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "currency",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'USD'",
+              "name": "example"
+            }
+          ],
+          "docs": "The ISO 4217 currency code.",
+          "complexTypes": [
+            "CurrencyCode"
+          ],
+          "type": "CurrencyCode"
+        }
+      ]
+    },
+    {
+      "name": "PromptParameters",
+      "slug": "promptparameters",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "mode",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "PromptMode.Default",
+              "name": "default"
+            }
+          ],
+          "docs": "The prompt mode.",
+          "complexTypes": [
+            "PromptMode"
+          ],
+          "type": "PromptMode"
+        },
+        {
+          "name": "additionalMethods",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "[]",
+              "name": "default"
+            }
+          ],
+          "docs": "Additional payment methods to allow.",
+          "complexTypes": [
+            "AdditionalPaymentMethod"
+          ],
+          "type": "AdditionalPaymentMethod[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetAvailableCardInputMethodsResult",
+      "slug": "getavailablecardinputmethodsresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cardInputMethods",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The available card input methods.",
+          "complexTypes": [
+            "CardInputMethod"
+          ],
+          "type": "CardInputMethod[]"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "location",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for accessing location.\n\nRequired to confirm that payments are occurring in a supported Square location.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "recordAudio",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for recording audio.\n\nRequired to receive data from magstripe readers.\n\nOnly available on Android.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "bluetoothConnect",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for Bluetooth connect.\n\nRequired to receive data from contactless and chip readers.\n\nOnly available on Android.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "bluetoothScan",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for Bluetooth scan.\n\nRequired to store information during checkout.\n\nOnly available on Android.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "readPhoneState",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for reading phone state.\n\nRequired to identify the device sending information to Square servers.\n\nOnly available on Android.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "bluetooth",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Permission state for using Bluetooth.\n\nOnly available on iOS.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "ReaderPairingDidFailEvent",
+      "slug": "readerpairingdidfailevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The error code.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The error message.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ReaderWasAddedEvent",
+      "slug": "readerwasaddedevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reader",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reader that was added.",
+          "complexTypes": [
+            "ReaderInfo"
+          ],
+          "type": "ReaderInfo"
+        }
+      ]
+    },
+    {
+      "name": "ReaderWasRemovedEvent",
+      "slug": "readerwasremovedevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reader",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reader that was removed.",
+          "complexTypes": [
+            "ReaderInfo"
+          ],
+          "type": "ReaderInfo"
+        }
+      ]
+    },
+    {
+      "name": "ReaderDidChangeEvent",
+      "slug": "readerdidchangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "reader",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reader that changed.",
+          "complexTypes": [
+            "ReaderInfo"
+          ],
+          "type": "ReaderInfo"
+        },
+        {
+          "name": "change",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The type of change that occurred.",
+          "complexTypes": [
+            "ReaderChange"
+          ],
+          "type": "ReaderChange"
+        }
+      ]
+    },
+    {
+      "name": "AvailableCardInputMethodsDidChangeEvent",
+      "slug": "availablecardinputmethodsdidchangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cardInputMethods",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The available card input methods.",
+          "complexTypes": [
+            "CardInputMethod"
+          ],
+          "type": "CardInputMethod[]"
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidFinishEvent",
+      "slug": "paymentdidfinishevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "payment",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The completed payment.",
+          "complexTypes": [
+            "Payment"
+          ],
+          "type": "Payment"
+        }
+      ]
+    },
+    {
+      "name": "Payment",
+      "slug": "payment",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'AbCdEfGhIjKlMnOpQrStUvWxYz'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier for this payment.\n\nFor offline payments, this may be null until synced.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The payment type.",
+          "complexTypes": [
+            "PaymentType"
+          ],
+          "type": "PaymentType"
+        },
+        {
+          "name": "status",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The payment status.",
+          "complexTypes": [
+            "PaymentStatus"
+          ],
+          "type": "PaymentStatus"
+        },
+        {
+          "name": "amountMoney",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The amount paid.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "tipMoney",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The tip amount.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "applicationFee",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The application fee.",
+          "complexTypes": [
+            "Money"
+          ],
+          "type": "Money"
+        },
+        {
+          "name": "referenceId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The reference ID provided in the payment parameters.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "orderId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The order ID associated with this payment.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "cardDetails",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Card payment details.\n\nOnly present for card payments.",
+          "complexTypes": [
+            "CardPaymentDetails"
+          ],
+          "type": "CardPaymentDetails"
+        },
+        {
+          "name": "createdAt",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'2024-01-15T10:30:00Z'",
+              "name": "example"
+            }
+          ],
+          "docs": "The time the payment was created (ISO 8601 format).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "updatedAt",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'2024-01-15T10:30:00Z'",
+              "name": "example"
+            }
+          ],
+          "docs": "The time the payment was updated (ISO 8601 format).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "CardPaymentDetails",
+      "slug": "cardpaymentdetails",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "card",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The card information.",
+          "complexTypes": [
+            "Card"
+          ],
+          "type": "Card"
+        },
+        {
+          "name": "entryMethod",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The card entry method used.",
+          "complexTypes": [
+            "CardInputMethod"
+          ],
+          "type": "CardInputMethod"
+        },
+        {
+          "name": "authorizationCode",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'123456'",
+              "name": "example"
+            }
+          ],
+          "docs": "The authorization code.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "applicationName",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'VISA CREDIT'",
+              "name": "example"
+            }
+          ],
+          "docs": "The EMV application name.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "applicationId",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'A0000000031010'",
+              "name": "example"
+            }
+          ],
+          "docs": "The EMV application identifier.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "Card",
+      "slug": "card",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "brand",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The card brand.",
+          "complexTypes": [
+            "CardBrand"
+          ],
+          "type": "CardBrand"
+        },
+        {
+          "name": "lastFourDigits",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'1234'",
+              "name": "example"
+            }
+          ],
+          "docs": "The last four digits of the card number.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "cardholderName",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'John Doe'",
+              "name": "example"
+            }
+          ],
+          "docs": "The cardholder name.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "expirationMonth",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "12",
+              "name": "example"
+            }
+          ],
+          "docs": "The card expiration month (1-12).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "expirationYear",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "2025",
+              "name": "example"
+            }
+          ],
+          "docs": "The card expiration year.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidFailEvent",
+      "slug": "paymentdidfailevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "payment",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The failed payment.",
+          "complexTypes": [
+            "Payment"
+          ],
+          "type": "Payment"
+        },
+        {
+          "name": "code",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The error code.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The error message.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidCancelEvent",
+      "slug": "paymentdidcancelevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "payment",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "The cancelled payment.",
+          "complexTypes": [
+            "Payment"
+          ],
+          "type": "Payment"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "Environment",
+      "slug": "environment",
+      "members": [
+        {
+          "name": "Production",
+          "value": "'production'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Production environment."
+        },
+        {
+          "name": "Sandbox",
+          "value": "'sandbox'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Sandbox environment for testing."
+        }
+      ]
+    },
+    {
+      "name": "ReaderModel",
+      "slug": "readermodel",
+      "members": [
+        {
+          "name": "ContactlessAndChip",
+          "value": "'CONTACTLESS_AND_CHIP'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Square Reader for contactless and chip."
+        },
+        {
+          "name": "Magstripe",
+          "value": "'MAGSTRIPE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Square Reader for magstripe."
+        },
+        {
+          "name": "Stand",
+          "value": "'STAND'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Square Stand."
+        },
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Unknown reader model."
+        }
+      ]
+    },
+    {
+      "name": "ReaderStatus",
+      "slug": "readerstatus",
+      "members": [
+        {
+          "name": "Ready",
+          "value": "'READY'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader is paired, connected, and ready to accept payments."
+        },
+        {
+          "name": "ConnectingToSquare",
+          "value": "'CONNECTING_TO_SQUARE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader is connecting to Square servers."
+        },
+        {
+          "name": "ConnectingToDevice",
+          "value": "'CONNECTING_TO_DEVICE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader is connecting to the mobile device."
+        },
+        {
+          "name": "Faulty",
+          "value": "'FAULTY'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader has a hardware or connection error in an unrecoverable state."
+        },
+        {
+          "name": "ReaderUnavailable",
+          "value": "'READER_UNAVAILABLE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader is connected but unable to process payments."
+        }
+      ]
+    },
+    {
+      "name": "CardInputMethod",
+      "slug": "cardinputmethod",
+      "members": [
+        {
+          "name": "Tap",
+          "value": "'TAP'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Contactless card tap (NFC)."
+        },
+        {
+          "name": "Dip",
+          "value": "'DIP'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "EMV chip card insertion."
+        },
+        {
+          "name": "Swipe",
+          "value": "'SWIPE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Magnetic stripe swipe."
+        },
+        {
+          "name": "Keyed",
+          "value": "'KEYED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Manually keyed card entry."
+        }
+      ]
+    },
+    {
+      "name": "UnavailableReason",
+      "slug": "unavailablereason",
+      "members": [
+        {
+          "name": "BluetoothError",
+          "value": "'BLUETOOTH_ERROR'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Bluetooth connection issue.\n\nOnly available on iOS."
+        },
+        {
+          "name": "BluetoothFailure",
+          "value": "'BLUETOOTH_FAILURE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Bluetooth failure.\n\nOnly available on Android."
+        },
+        {
+          "name": "BluetoothDisabled",
+          "value": "'BLUETOOTH_DISABLED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Bluetooth is disabled.\n\nOnly available on Android."
+        },
+        {
+          "name": "FirmwareUpdate",
+          "value": "'FIRMWARE_UPDATE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader firmware is updating.\n\nOnly available on iOS."
+        },
+        {
+          "name": "BlockingUpdate",
+          "value": "'BLOCKING_UPDATE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Blocking firmware update.\n\nOnly available on Android."
+        },
+        {
+          "name": "ReaderUnavailableOffline",
+          "value": "'READER_UNAVAILABLE_OFFLINE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader is unavailable offline.\n\nOnly available on Android."
+        },
+        {
+          "name": "DeviceDeveloperMode",
+          "value": "'DEVICE_DEVELOPER_MODE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Device is in developer mode.\n\nOnly available on Android."
+        },
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Unknown reason."
+        }
+      ]
+    },
+    {
+      "name": "ProcessingMode",
+      "slug": "processingmode",
+      "members": [
+        {
+          "name": "AutoDetect",
+          "value": "'AUTO_DETECT'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Automatically detect the best processing mode (online or offline)."
+        },
+        {
+          "name": "OnlineOnly",
+          "value": "'ONLINE_ONLY'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Process the payment online only."
+        },
+        {
+          "name": "OfflineOnly",
+          "value": "'OFFLINE_ONLY'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow offline payment processing."
+        }
+      ]
+    },
+    {
+      "name": "DelayAction",
+      "slug": "delayaction",
+      "members": [
+        {
+          "name": "Complete",
+          "value": "'COMPLETE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Automatically complete the payment when the delay expires."
+        },
+        {
+          "name": "Cancel",
+          "value": "'CANCEL'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Automatically cancel the payment when the delay expires."
+        }
+      ]
+    },
+    {
+      "name": "PromptMode",
+      "slug": "promptmode",
+      "members": [
+        {
+          "name": "Default",
+          "value": "'DEFAULT'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Use the default Square payment UI."
+        },
+        {
+          "name": "Custom",
+          "value": "'CUSTOM'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Use a custom payment UI."
+        }
+      ]
+    },
+    {
+      "name": "AdditionalPaymentMethod",
+      "slug": "additionalpaymentmethod",
+      "members": [
+        {
+          "name": "Keyed",
+          "value": "'KEYED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow manually keyed card entry."
+        },
+        {
+          "name": "Cash",
+          "value": "'CASH'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow cash payments."
+        }
+      ]
+    },
+    {
+      "name": "ReaderChange",
+      "slug": "readerchange",
+      "members": [
+        {
+          "name": "BatteryDidBeginCharging",
+          "value": "'BATTERY_DID_BEGIN_CHARGING'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader battery started charging.\n\nOnly available on iOS."
+        },
+        {
+          "name": "BatteryDidEndCharging",
+          "value": "'BATTERY_DID_END_CHARGING'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader battery stopped charging.\n\nOnly available on iOS."
+        },
+        {
+          "name": "BatteryLevelDidChange",
+          "value": "'BATTERY_LEVEL_DID_CHANGE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader battery level changed.\n\nOnly available on iOS."
+        },
+        {
+          "name": "BatteryCharging",
+          "value": "'BATTERY_CHARGING'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader battery charging status changed.\n\nOnly available on Android."
+        },
+        {
+          "name": "Added",
+          "value": "'ADDED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader was added.\n\nOnly available on Android."
+        },
+        {
+          "name": "Removed",
+          "value": "'REMOVED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader was removed.\n\nOnly available on Android."
+        },
+        {
+          "name": "StatusDidChange",
+          "value": "'STATUS_DID_CHANGE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Reader status changed."
+        }
+      ]
+    },
+    {
+      "name": "PaymentType",
+      "slug": "paymenttype",
+      "members": [
+        {
+          "name": "Online",
+          "value": "'ONLINE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment processed online."
+        },
+        {
+          "name": "Offline",
+          "value": "'OFFLINE'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment processed offline."
+        }
+      ]
+    },
+    {
+      "name": "PaymentStatus",
+      "slug": "paymentstatus",
+      "members": [
+        {
+          "name": "Completed",
+          "value": "'COMPLETED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment was completed successfully."
+        },
+        {
+          "name": "Approved",
+          "value": "'APPROVED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment was approved but not yet completed."
+        },
+        {
+          "name": "Canceled",
+          "value": "'CANCELED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment was canceled."
+        },
+        {
+          "name": "Failed",
+          "value": "'FAILED'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment failed."
+        },
+        {
+          "name": "Pending",
+          "value": "'PENDING'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Payment is pending."
+        }
+      ]
+    },
+    {
+      "name": "CardBrand",
+      "slug": "cardbrand",
+      "members": [
+        {
+          "name": "Visa",
+          "value": "'VISA'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Visa card."
+        },
+        {
+          "name": "Mastercard",
+          "value": "'MASTERCARD'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Mastercard."
+        },
+        {
+          "name": "AmericanExpress",
+          "value": "'AMERICAN_EXPRESS'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "American Express card."
+        },
+        {
+          "name": "Discover",
+          "value": "'DISCOVER'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Discover card."
+        },
+        {
+          "name": "DiscoverDiners",
+          "value": "'DISCOVER_DINERS'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Discover Diners card."
+        },
+        {
+          "name": "Jcb",
+          "value": "'JCB'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "JCB card."
+        },
+        {
+          "name": "UnionPay",
+          "value": "'UNION_PAY'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "UnionPay card."
+        },
+        {
+          "name": "Interac",
+          "value": "'INTERAC'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Interac card."
+        },
+        {
+          "name": "Eftpos",
+          "value": "'EFTPOS'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Eftpos card."
+        },
+        {
+          "name": "Other",
+          "value": "'OTHER'",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Other or unknown card brand."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "CurrencyCode",
+      "slug": "currencycode",
+      "docs": "",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "ReaderPairingDidBeginListener",
+      "slug": "readerpairingdidbeginlistener",
+      "docs": "Callback to receive reader pairing start notifications.",
+      "types": [
+        {
+          "text": "(): void",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "ReaderPairingDidSucceedListener",
+      "slug": "readerpairingdidsucceedlistener",
+      "docs": "Callback to receive reader pairing success notifications.",
+      "types": [
+        {
+          "text": "(): void",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "ReaderPairingDidFailListener",
+      "slug": "readerpairingdidfaillistener",
+      "docs": "Callback to receive reader pairing failure notifications.",
+      "types": [
+        {
+          "text": "(event: ReaderPairingDidFailEvent): void",
+          "complexTypes": [
+            "ReaderPairingDidFailEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "ReaderWasAddedListener",
+      "slug": "readerwasaddedlistener",
+      "docs": "Callback to receive reader added notifications.",
+      "types": [
+        {
+          "text": "(event: ReaderWasAddedEvent): void",
+          "complexTypes": [
+            "ReaderWasAddedEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "ReaderWasRemovedListener",
+      "slug": "readerwasremovedlistener",
+      "docs": "Callback to receive reader removed notifications.",
+      "types": [
+        {
+          "text": "(event: ReaderWasRemovedEvent): void",
+          "complexTypes": [
+            "ReaderWasRemovedEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "ReaderDidChangeListener",
+      "slug": "readerdidchangelistener",
+      "docs": "Callback to receive reader change notifications.",
+      "types": [
+        {
+          "text": "(event: ReaderDidChangeEvent): void",
+          "complexTypes": [
+            "ReaderDidChangeEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "AvailableCardInputMethodsDidChangeListener",
+      "slug": "availablecardinputmethodsdidchangelistener",
+      "docs": "Callback to receive available card input method change notifications.",
+      "types": [
+        {
+          "text": "(event: AvailableCardInputMethodsDidChangeEvent): void",
+          "complexTypes": [
+            "AvailableCardInputMethodsDidChangeEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidFinishListener",
+      "slug": "paymentdidfinishlistener",
+      "docs": "Callback to receive payment completion notifications.",
+      "types": [
+        {
+          "text": "(event: PaymentDidFinishEvent): void",
+          "complexTypes": [
+            "PaymentDidFinishEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidFailListener",
+      "slug": "paymentdidfaillistener",
+      "docs": "Callback to receive payment failure notifications.",
+      "types": [
+        {
+          "text": "(event: PaymentDidFailEvent): void",
+          "complexTypes": [
+            "PaymentDidFailEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "PaymentDidCancelListener",
+      "slug": "paymentdidcancellistener",
+      "docs": "Callback to receive payment cancellation notifications.",
+      "types": [
+        {
+          "text": "(event: PaymentDidCancelEvent): void",
+          "complexTypes": [
+            "PaymentDidCancelEvent"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}