mek_stripe_terminal

https://pub.dev/documentation/mek_stripe_terminal
Admin
A Flutter plugin that integrates with the Stripe Terminal SDK, enabling Flutter applications to...
Tokens:158,493
Snippets:1,006
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### APIDOC: SetupIntent Class

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal

A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer’s card without immediately collecting a payment.
Later, you can use PaymentIntents to drive the payment flow.

```APIDOC
class SetupIntent:
```

--------------------------------

### Confirm Setup Intent

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Confirms the given SetupIntent.

```APIDOC
confirmSetupIntent(setupIntent: SetupIntent) -> CancelableFuture<SetupIntent>
```

--------------------------------

### APIDOC: ReaderPortableDelegate.onStartInstallingUpdate Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderPortableDelegate/onStartInstallingUpdate

This API documentation describes the `onStartInstallingUpdate` abstract method, which is part of the `ReaderPortableDelegate` mixin. This method is invoked by the SDK when a connected reader starts installing a necessary software update. It provides details on the parameters required for this callback.

```APIDOC
Method: onStartInstallingUpdate
Return Type: void
Description: The SDK is reporting that the reader has started installation of a required update that must be completed before the reader can be used.

Parameters:
  update:
    Type: ReaderSoftwareUpdate
    Description: Represents the software update being installed.
  cancelUpdate:
    Type: Cancellable
    Description: An object that can be used to cancel the update process.
```

--------------------------------

### Dart Implementation Example for onReaderReconnectStarted

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderReconnectionDelegate/onReaderReconnectStarted

A basic Dart code example demonstrating the structure for implementing the `onReaderReconnectStarted` method. This snippet shows the method signature as it would appear in a class or mixin that implements `ReaderReconnectionDelegate`.

```Dart
void onReaderReconnectStarted(
  Reader reader,
  Cancellable cancelReconnect,
  DisconnectReason reason,
) {}
```

--------------------------------

### API Specification for SetupAttempt.onBehalfOf Property

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt/onBehalfOf

This API documentation entry describes the 'onBehalfOf' property of the 'SetupAttempt' class. It specifies its type as a nullable String, its immutability (final), and its purpose in linking a setup attempt to a specific Stripe Connect account.

```APIDOC
SetupAttempt.onBehalfOf:
  Type: String?
  Modifiers: final
  Description: (Connect) The account (if any) for which the setup is intended.
```

--------------------------------

### ReaderPortableDelegate.onFinishInstallingUpdate API Definition

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderPortableDelegate/onFinishInstallingUpdate

Defines the abstract `onFinishInstallingUpdate` method signature. This method is part of the `ReaderPortableDelegate` mixin and is invoked when a `ReaderSoftwareUpdate` installation completes. It provides details about the update and any exceptions encountered during the process.

```APIDOC
void onFinishInstallingUpdate(
  ReaderSoftwareUpdate? update,
  TerminalException? exception
)
```

--------------------------------

### Collect Setup Intent Payment Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Collects a payment method for the given SetupIntent.

```APIDOC
collectSetupIntentPaymentMethod(
  setupIntent: SetupIntent,
  {
    required allowRedisplay: AllowRedisplay,
    customerCancellationEnabled: bool = false
  }
) -> CancelableFuture<SetupIntent>
```

--------------------------------

### SetupIntentStatus.values Constant Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntentStatus/values-constant

This API documentation describes the `values` constant of the `SetupIntentStatus` enum. It provides a constant `List` containing all possible `SetupIntentStatus` enum values, ordered by their declaration. This constant is useful for iterating through or referencing all defined states of a setup intent.

```APIDOC
const values:
  Type: List<SetupIntentStatus>
  Description: A constant List of the values in this enum, in order of their declaration.
  Source: mek_stripe_terminal package
```

--------------------------------

### API Documentation for SetupAttemptStatus Enum

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptStatus

This section provides a detailed API reference for the `SetupAttemptStatus` enum. It outlines its inheritance hierarchy, available extensions, the specific values it can hold, its inherited and direct properties, methods, operators, and constants. This enum is crucial for understanding the lifecycle and state of a setup attempt within the Stripe Terminal integration.

```APIDOC
enum SetupAttemptStatus:
  Description: Statuses for a SetupAttempt

  Inheritance:
    - Object
    - Enum
    - SetupAttemptStatus

  Available Extensions:
    - EnumName

  Values:
    - requiresConfirmation
    - requiresAction
    - processing
    - succeeded
    - failed
    - abandoned

  Properties:
    - hashCode: int (inherited)
      Description: The hash code for this object.
    - index: int (inherited)
      Description: A numeric identifier for the enumerated value.
    - name: String
      Description: The name of the enum value.
    - runtimeType: Type (inherited)
      Description: A representation of the runtime type of the object.

  Methods:
    - noSuchMethod(invocation: Invocation): dynamic (inherited)
      Description: Invoked when a nonexistent method or property is accessed.
    - toString(): String (inherited)
      Description: A string representation of this object.

  Operators:
    - operator ==(other: Object): bool (inherited)
      Description: The equality operator.

  Constants:
    - values: List<SetupAttemptStatus>
      Description: A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### Retrieve Setup Intent (Terminal Class)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Retrieves a `SetupIntent` object using its client secret. This asynchronous method returns a `Future` containing the `SetupIntent`.

```APIDOC
retrieveSetupIntent(String clientSecret) -> Future<SetupIntent>
  clientSecret: The client secret of the SetupIntent to retrieve.
Description: Retrieves an SetupIntent with a client secret.
```

--------------------------------

### APIDOC: SetupIntent Class Overview

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/latestAttempt

API documentation providing an overview of the `SetupIntent` class, including its originating package and version.

```APIDOC
SetupIntent class:
  Package: mek_stripe_terminal 4.4.1
```

--------------------------------

### SetupAttemptPaymentMethodDetails Class API Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptPaymentMethodDetails-class

Comprehensive API documentation for the `SetupAttemptPaymentMethodDetails` class, detailing its purpose, annotations, properties with their types and descriptions, and inherited methods and operators.

```APIDOC
SetupAttemptPaymentMethodDetails class
  Description: Details about a PaymentMethod at a specific time. ex: at time of transaction for a SetupAttempt.
  Annotations: @DataClass()

  Properties:
    cardPresent: SetupAttemptCardPresentDetails?
      Description: If this is a card present payment method (ie self.type == PaymentMethodTypeCardPresent), this contains additional information.
      Modifiers: final
    hashCode: int
      Description: The hash code for this object.
      Modifiers: no setter, inherited
    interacPresent: SetupAttemptCardPresentDetails?
      Description: If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional information.
      Modifiers: final
    runtimeType: Type
      Description: A representation of the runtime type of the object.
      Modifiers: no setter, inherited

  Methods:
    noSuchMethod(invocation: Invocation): dynamic
      Description: Invoked when a nonexistent method or property is accessed.
      Modifiers: inherited
    toString(): String
      Description: A string representation of this object.
      Modifiers: inherited

  Operators:
    operator ==(other: Object): bool
      Description: The equality operator.
      Modifiers: inherited
```

--------------------------------

### API Documentation for createSetupIntent Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal/createSetupIntent

Defines the signature and parameters for the `createSetupIntent` method, including types, descriptions, and default values for each parameter. This method returns a `Future` that resolves to a `SetupIntent`.

```APIDOC
Terminal.createSetupIntent(
  customerId: String?,
  metadata: Map<String, String>?,
  onBehalfOf: String?,
  description: String?,
  usage: SetupIntentUsage = SetupIntentUsage.offSession
) -> Future<SetupIntent>

Parameters:
  customerId (String?, optional):
    If present, the SetupIntent’s payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
  metadata (Map<String, String>?, optional):
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  onBehalfOf (String?, optional):
    Connect Only: The Stripe account ID for which this SetupIntent is created.
  description (String?, optional):
    An arbitrary string attached to the object. Often useful for displaying to users.
  usage (SetupIntentUsage, optional, default: SetupIntentUsage.offSession):
    Indicates how the payment method is intended to be used in the future.
```

--------------------------------

### Get Singleton Terminal Instance (Dart)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal/instance

This Dart code snippet defines a static getter named `instance` for the `Terminal` class. It provides a way to access the single, shared instance of the `Terminal` object. An assertion ensures that the instance has been initialized using `Terminal.initTerminal` before it is accessed, preventing null pointer exceptions and guiding developers to the correct initialization method.

```Dart
static Terminal get instance {
  assert(_instance != null,
      'Please before use a Terminal instance init it with [Terminal.initTerminal] static method');
  return _instance!;
}
```

--------------------------------

### APIDOC: PaymentIntentParameters.setupFutureUsage Property Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/PaymentIntentParameters/setupFutureUsage

Comprehensive API documentation for the `setupFutureUsage` property of the `PaymentIntentParameters` class. It outlines the property's type, purpose, and behavior regarding future payments and the attachment of payment methods to a customer.

```APIDOC
Class: PaymentIntentParameters
  Property: setupFutureUsage
    Type: PaymentIntentUsage?
    Description: Indicates that you intend to make future payments with this PaymentIntent’s payment method. Providing this parameter will attach the payment method to the PaymentIntent’s Customer, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
```

--------------------------------

### Dart Future.catchError Example

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/CancelableFuture/catchError

An example demonstrating how to use `catchError` with a `Future` to handle specific error types, such as HTTP status codes, by using the optional `test` function.

```Dart
Future.delayed(
  const Duration(seconds: 1),
  () => throw 401,
).then((value) {
  throw 'Unreachable';
}).catchError((err) {
  print('Error: $err'); // Prints 401.
}, test: (error) {
  return error is int && error >= 400;
});
```

--------------------------------

### SetupIntent Class API Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent-class

Detailed API reference for the SetupIntent class, including its properties and methods, from the mek_stripe_terminal Dart package. This class is used for setting up and saving customer payment credentials.

```APIDOC
SetupIntent class
Annotations:
  @DataClass()

Properties:
  created: DateTime
    Description: When the intent was created.
    Modifiers: final
  customerId: String?
    Description: The identifier of a customer object to which the SetupIntent is attached, if applicable.
    Modifiers: final
  hashCode: int
    Description: The hash code for this object.
    Modifiers: no setter, inherited
  id: String
    Description: The unique identifier for the intent.
    Modifiers: final
  latestAttempt: SetupAttempt?
    Description: The most recent SetupAttempt for this SetupIntent
    Modifiers: final
  metadata: Map<String, String>
    Description: Set of key-value pairs attached to the object.
    Modifiers: final
  runtimeType: Type
    Description: A representation of the runtime type of the object.
    Modifiers: no setter, inherited
  status: SetupIntentStatus
    Description: The status of the intent.
    Modifiers: final
  usage: SetupIntentUsage
    Description: An SetupIntentUsage value describing how the SetupIntent will be used. Defaults to off-session if not set.
    Modifiers: final

Methods:
  noSuchMethod(invocation: Invocation): dynamic
    Description: Invoked when a nonexistent method or property is accessed.
    Modifiers: inherited
  toString(): String
    Description: A string representation of this object.
    Modifiers: inherited

Operators:
  operator ==(other: Object): bool
    Description: The equality operator.
    Modifiers: inherited
```

--------------------------------

### Dart whenComplete Method Usage Example

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/CancelableFuture/whenComplete

Provides a practical Dart example demonstrating the use of `whenComplete` with an asynchronous task, showcasing its execution after the task finishes and how it can be used for cleanup or final actions.

```Dart
void main() async {
  var value =
      await waitTask().whenComplete(() => print('do something here'));
  // Prints "do something here" after waitTask() completed.
  print(value); // Prints "done"
}

Future<String> waitTask() {
  Future.delayed(const Duration(seconds: 5));
  return Future.value('done');
}
```

--------------------------------

### onReaderReconnectSucceeded Method Implementation Example

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderReconnectionDelegate/onReaderReconnectSucceeded

A basic implementation example for the `onReaderReconnectSucceeded` method in Dart. This method is part of the `ReaderReconnectionDelegate` mixin and is invoked upon successful reconnection to a reader, allowing custom logic to be executed.

```Dart
void onReaderReconnectSucceeded(Reader reader) {}
```

--------------------------------

### API Documentation for PaymentIntent.setupFutureUsage Property

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/PaymentIntent/setupFutureUsage

Comprehensive API documentation for the `setupFutureUsage` property of the `PaymentIntent` class, outlining its type, modifiers, and purpose within the Stripe Terminal integration.

```APIDOC
PaymentIntent class:
  setupFutureUsage property:
    Type: PaymentIntentUsage?
    Modifiers: final
    Description: Value of setup_future_usage associated with this PaymentIntent, if any.
```

--------------------------------

### CardNetworks operator == Method Implementation Example

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/CardNetworks/operator_equals

An example implementation of the `operator ==` method for the `CardNetworks` class in Dart, demonstrating how to compare `CardNetworks` instances based on their `available` and `preferred` properties, ensuring proper equality checks.

```Dart
@override
bool operator ==(Object other) =>
    identical(this, other) ||
    other is CardNetworks &&
        runtimeType == other.runtimeType &&
        $listEquality.equals(_self.available, other.available) &&
        _self.preferred == other.preferred;
```

--------------------------------

### SetupIntent Class Property: usage (API Documentation)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/usage

API documentation for the 'usage' property of the `SetupIntent` class, detailing its type, finality, and purpose as described in the official documentation. It specifies that 'usage' is of type `SetupIntentUsage` and defaults to 'off-session' if not explicitly set.

```APIDOC
SetupIntent:
  properties:
    usage:
      type: SetupIntentUsage
      modifiers: final
      description: An SetupIntentUsage value describing how the SetupIntent will be used. Defaults to off-session if not set.
```

--------------------------------

### API Documentation for SetupIntentUsage Enum

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntentUsage

Detailed API reference for the `SetupIntentUsage` enum, including its purpose, inheritance, available extensions, defined values, properties, methods, operators, and constants.

```APIDOC
enum SetupIntentUsage:
  Description: The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future. Stripe will use the chosen option to pick the most frictionless flow for the customer.

  Inheritance:
    - Object
    - Enum
    - SetupIntentUsage

  Available Extensions:
    - EnumName

  Values:
    - onSession: const SetupIntentUsage
      Description: An on-session usage indicates to Stripe that future payments will take place while the customer is actively in your checkout flow and able to authenticate the payment method. With the on-session option, you can postpone authenticating the card details until a future checkout to avoid upfront friction.
    - offSession: const SetupIntentUsage
      Description: An off-session usage indicates to Stripe that future payments will take place without the direct involvement of the customer. Creating an off-session SetupIntent might incur some initial friction from additional authentication steps, but can reduce customer intervention in later off-session payments.

  Properties:
    - hashCode: int (inherited from Object)
      Description: The hash code for this object.
    - index: int (inherited from Enum)
      Description: A numeric identifier for the enumerated value.
    - name: String (provided by EnumName extension)
      Description: The name of the enum value.
    - runtimeType: Type (inherited from Object)
      Description: A representation of the runtime type of the object.

  Methods:
    - noSuchMethod(Invocation invocation): dynamic (inherited)
      Description: Invoked when a nonexistent method or property is accessed.
    - toString(): String (inherited)
      Description: A string representation of this object.

  Operators:
    - operator ==(Object other): bool (inherited)
      Description: The equality operator.

  Constants:
    - values: const List<SetupIntentUsage>
      Description: A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### Dart ReceiptDetails operator == Implementation Example

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReceiptDetails/operator_equals

Provides an example implementation of the `operator ==` method for the `ReceiptDetails` class in Dart. It checks for identity or deep equality based on several internal properties of `ReceiptDetails`, ensuring consistency with the `hashCode` method.

```Dart
@override
bool operator ==(Object other) =>
    identical(this, other) ||
    other is ReceiptDetails &&
        runtimeType == other.runtimeType &&
        _self.accountType == other.accountType &&
        _self.applicationPreferredName == other.applicationPreferredName &&
        _self.authorizationCode == other.authorizationCode &&
        _self.authorizationResponseCode == other.authorizationResponseCode &&
        _self.applicationCryptogram == other.applicationCryptogram &&
        _self.dedicatedFileName == other.dedicatedFileName &&
        _self.transactionStatusInformation == other.transactionStatusInformation &&
        _self.terminalVerificationResults == other.terminalVerificationResults;
```

--------------------------------

### createSetupIntent API Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Creates a new SetupIntent with the given parameters.

```APIDOC
Terminal.createSetupIntent({
  String? customerId,
  Map<String, String>? metadata,
  String? onBehalfOf,
  String? description,
  SetupIntentUsage usage = SetupIntentUsage.offSession
}) → Future<SetupIntent>
```

--------------------------------

### Dart Implementation Example for onReaderReconnectFailed

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderReconnectionDelegate/onReaderReconnectFailed

A basic Dart code snippet demonstrating the implementation structure for the `onReaderReconnectFailed` method. This example provides the method signature as expected by the `ReaderReconnectionDelegate` mixin, serving as a template for developers to add their specific handling logic, such as user interface updates or logging.

```Dart
void onReaderReconnectFailed(Reader reader) {}
```

--------------------------------

### SetupIntent Class: id Property API Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/id

Detailed API documentation for the `id` property of the `SetupIntent` class, outlining its type, modifiers, and a description of its function as a unique identifier.

```APIDOC
SetupIntent:
  Properties:
    id:
      Type: String
      Modifiers: final
      Description: The unique identifier for the intent.
```

--------------------------------

### getConnectionStatus API Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Get the current ConnectionStatus.

```APIDOC
Terminal.getConnectionStatus() → Future<ConnectionStatus>
```

--------------------------------

### SetupIntent.toString() Method API Documentation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/toString

API documentation for the `toString` method of the `SetupIntent` class. This method provides a string representation of the object, typically overridden to offer useful information for inspection, debugging, or logging.

```APIDOC
Class: SetupIntent
  Method: toString()
    Signature: String toString()
    Inherited: Yes
    Description: A string representation of this object. Some classes have a default textual representation, often paired with a static `parse` function. Other classes, like `SetupIntent`, override `toString` to provide useful information when inspecting the object, mainly for debugging or logging, by listing its key properties.
    Return Type: String
```

--------------------------------

### Cancel Setup Intent

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Cancels an existing SetupIntent.

```APIDOC
cancelSetupIntent(setupIntent: SetupIntent) -> Future<SetupIntent>
```

--------------------------------

### API Documentation: SetupAttempt Class Overview

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt/paymentMethodId

An overview of the 'SetupAttempt' class, indicating its package origin and version, providing context for the properties and methods it contains.

```APIDOC
Class: SetupAttempt
  Package: mek_stripe_terminal
  Version: 4.4.1
```

--------------------------------

### installAvailableUpdate API Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Installs the available update for the connected reader.

```APIDOC
Terminal.installAvailableUpdate() → Future<void>
```

--------------------------------

### SetupAttemptCardPresentDetails Class API Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptCardPresentDetails-class

Detailed API documentation for the `SetupAttemptCardPresentDetails` class, including its constructor, properties, methods, and operators, used for handling card-present payment details in Stripe Terminal integrations.

```APIDOC
SetupAttemptCardPresentDetails class
  Description: An object representing details from a transaction using a cardPresent payment method.
  Annotations: @DataClass()

  Constructors:
    SetupAttemptCardPresentDetails.new({required String emvAuthData, required String generatedCard})
      Modifier: const

  Properties:
    emvAuthData: String
      Description: The Authorization Response Cryptogram (ARPC) from the issuer.
      Modifier: final
    generatedCard: String
      Description: The ID of the Card PaymentMethod which was generated by this SetupAttempt.
      Modifier: final
    hashCode: int (inherited)
      Description: The hash code for this object.
      Modifier: no setter
    runtimeType: Type (inherited)
      Description: A representation of the runtime type of the object.
      Modifier: no setter

  Methods:
    noSuchMethod(Invocation invocation): dynamic (inherited)
      Description: Invoked when a nonexistent method or property is accessed.
    toString(): String (inherited)
      Description: A string representation of this object.

  Operators:
    operator ==(Object other): bool (inherited)
      Description: The equality operator.
```

--------------------------------

### APIDOC: SetupAttemptPaymentMethodDetails.toString() Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptPaymentMethodDetails/toString

API documentation for the `toString()` method, which provides a string representation of the `SetupAttemptPaymentMethodDetails` object. It clarifies that this method is inherited and typically used for debugging or logging purposes.

```APIDOC
SetupAttemptPaymentMethodDetails:
  Methods:
    toString():
      Description: A string representation of this object. Inherited.
      Return Type: String
      Notes: Some classes provide a default textual representation, while others override `toString` to provide useful information for inspecting the object, mainly for debugging or logging.
```

--------------------------------

### SetupIntent.created Property API Documentation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/created

API documentation for the 'created' property of the SetupIntent class, detailing its type, modifiers, and purpose.

```APIDOC
Class: SetupIntent
  Properties:
    created:
      Type: DateTime
      Modifiers: final
      Description: When the intent was created.
```

--------------------------------

### Get Terminal Instance (Static Property)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Provides the singleton instance of the `Terminal` class. This property has no setter.

```APIDOC
static instance -> Terminal
Description: The singleton instance of the Terminal class.
Setter: No
```

--------------------------------

### Get String Representation (Terminal Class)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Returns a string representation of this object. This method is inherited from the `Object` class.

```APIDOC
toString() -> String
Description: A string representation of this object.
Inherited: Yes
```

--------------------------------

### Terminal.installAvailableUpdate Method API Reference

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal/installAvailableUpdate

Detailed API documentation for the `installAvailableUpdate` method, including its return type, signature, and a comprehensive explanation of its functionality, user interaction requirements, error handling, and specific limitations with certain reader types.

```APIDOC
Future<void>
installAvailableUpdate()

Installs the available update for the connected reader.

Stripe Terminal reader updates will either be updated automatically upon connection,
or announced as available but not automatically installed. When the Stripe Terminal SDK
announces an optional update, you can present that update to your app’s user and let them
decide when to perform that update. When your user chooses to perform a reader update, call
this method to start the installation.

In your app you should display the progress of the update to the user. You should also instruct
the user to wait for the update to complete:
“Do not leave this page, and keep the reader in range and powered on until the update is complete.”
??? You can set UIApplication.shared.isIdleTimerDisabled to true while the update is being installed to prevent the device from automatically locking.

If an error occurs while installing the update (e.g. because the update was interrupted),
delegate will receive `PhysicalReaderDelegate.onFinishInstallingUpdate` with the exception. If the
update completed successfully, the same method will be called with `null` exception.

You must implement the ability to update your reader’s software in your app. Though we expect
required software updates to be very rare, by using Stripe Terminal, you are obligated
to include this functionality.

Note: It is an error to call this method when the SDK is connected to the Verifone P400 or WisePOS E readers.
```

--------------------------------

### APIDOC: Enum: SetupIntentStatus

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal

No description provided.

```APIDOC
Enum: SetupIntentStatus
Description: No description provided.
```

--------------------------------

### ReaderDisconnectDelegate.onDisconnect Method Implementation in Dart

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderDisconnectDelegate/onDisconnect

Provides a basic implementation example for the `onDisconnect` method in Dart, showing its signature and an empty body.

```Dart
void onDisconnect(DisconnectReason reason) {}
```

--------------------------------

### APIDOC: SetupAttempt Class

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

```APIDOC
class SetupAttempt:
```

--------------------------------

### Get hasIncrementalUpdate Property Implementation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderSoftwareUpdate/hasIncrementalUpdate

Provides the Dart implementation for the 'hasIncrementalUpdate' getter. It checks if the 'components' set contains 'UpdateComponent.incremental' to determine if the update is incremental.

```Dart
bool get hasIncrementalUpdate => components.contains(UpdateComponent.incremental);
```

--------------------------------

### Dart Implementation of createSetupIntent Method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal/createSetupIntent

Provides the Dart code implementation for the `createSetupIntent` method. This asynchronous method forwards the provided parameters to an underlying platform-specific implementation to create the SetupIntent.

```Dart
Future<SetupIntent> createSetupIntent({
  String? customerId,
  Map<String, String>? metadata,
  String? onBehalfOf,
  String? description,
  SetupIntentUsage usage = SetupIntentUsage.offSession,
}) async {
  return await _platform.createSetupIntent(
    customerId: customerId,
    metadata: metadata,
    onBehalfOf: onBehalfOf,
    description: description,
    usage: usage,
  );
}
```

--------------------------------

### ReaderSoftwareUpdate.onlyInstallRequiredUpdates Property Definition

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/ReaderSoftwareUpdate/onlyInstallRequiredUpdates

Defines the `onlyInstallRequiredUpdates` property within the `ReaderSoftwareUpdate` class. This final boolean property indicates whether only required software updates should be installed.

```Dart
final bool onlyInstallRequiredUpdates;
```

--------------------------------

### API Documentation for SetupAttempt.status Property

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt/status

This entry provides structured API documentation for the 'status' property of the 'SetupAttempt' class. It outlines the property's type, modifiers, and a brief description of its purpose.

```APIDOC
Class: SetupAttempt
  Property: status
    Type: SetupAttemptStatus
    Modifiers: final
    Description: The status of this SetupAttempt.
```

--------------------------------

### API Documentation for SetupIntent metadata property

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntent/metadata

Defines the `metadata` property of the `SetupIntent` class, detailing its type as a `Map<String, String>` and its purpose as a set of key-value pairs attached to the object. It is a final property.

```APIDOC
Class: SetupIntent
Property: metadata
  Type: Map<String, String>
  Modifiers: final
  Description: Set of key-value pairs attached to the object.
```

--------------------------------

### TerminalExceptionCode: invalidReaderForUpdate

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/TerminalExceptionCode

Indicates that `StripeTerminal.installUpdate` was passed an update intended for a different reader. Updates can only be installed on the reader connected when the update was announced. This error is specific to iOS.

```APIDOC
invalidReaderForUpdate: TerminalExceptionCode
  Description: Only IOS. `StripeTerminal.installUpdate` was passed an update that is for a different reader.
  Constraint: Updates can only be installed on the reader that was connected when the update was announced.
```

--------------------------------

### SetupAttempt.paymentMethodDetails Property Definition

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt/paymentMethodDetails

Provides the API documentation and Dart implementation for the `paymentMethodDetails` property, which stores details about the payment method used during a SetupIntent confirmation.

```APIDOC
SetupAttempt.paymentMethodDetails:
  Type: SetupAttemptPaymentMethodDetails?
  Modifiers: final
  Description: Details about the payment method at the time of SetupIntent confirmation.
```

```Dart
final SetupAttemptPaymentMethodDetails? paymentMethodDetails;
```

--------------------------------

### Dart: Get incrementalAuthorizationSupported Property Implementation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/CardPresentDetails/incrementalAuthorizationSupported

This Dart code snippet provides the implementation for the `incrementalAuthorizationSupported` getter. It returns `true` if the `incrementalAuthorizationStatus` is `IncrementalAuthorizationStatus.supported`, indicating that incremental authorization is available.

```Dart
bool get incrementalAuthorizationSupported =>
    incrementalAuthorizationStatus == IncrementalAuthorizationStatus.supported;
```

--------------------------------

### SetupAttemptCardPresentDetails Constructor API Definition

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptCardPresentDetails/SetupAttemptCardPresentDetails

API documentation for the `SetupAttemptCardPresentDetails` constructor, outlining its required string parameters: `emvAuthData` and `generatedCard`. This definition specifies the types and requirements for each parameter.

```APIDOC
SetupAttemptCardPresentDetails.new:
  Type: Constructor
  Signature: const SetupAttemptCardPresentDetails({
    required String emvAuthData,
    required String generatedCard
  })
  Parameters:
    emvAuthData:
      Type: String
      Required: true
      Description: EMV authentication data.
    generatedCard:
      Type: String
      Required: true
      Description: Generated card data.
```

--------------------------------

### TapToPayReaderDelegate.onAcceptTermsOfService Method Implementation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/TapToPayReaderDelegate/onAcceptTermsOfService

Example implementation of the `onAcceptTermsOfService` method for the `TapToPayReaderDelegate` class in Dart. This snippet shows a minimal, empty implementation, indicating that no specific action is required within the app when this callback is triggered.

```Dart
void onAcceptTermsOfService() {}
```

--------------------------------

### SetupAttempt Class API Reference (Dart)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt-class

Comprehensive API documentation for the `SetupAttempt` class in the `mek_stripe_terminal` package, outlining its attributes, methods, and operators for inspecting Stripe SetupIntent confirmation attempts.

```APIDOC
SetupAttempt class:
  description: A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
  annotations:
    - @DataClass()

  Properties:
    applicationId: String?
      description: The ID of the Connect application that created the SetupIntent.
      modifiers: final
    created: DateTime
      description: Time at which the object was created.
      modifiers: final
    customerId: String?
      description: ID of the Customer this SetupIntent belongs to, if one exists.
      modifiers: final
    hashCode: int
      description: The hash code for this object.
      modifiers: no setter, inherited
    id: String
      description: The unique identifier for the SetupAttempt.
      modifiers: final
    onBehalfOf: String?
      description: (Connect) The account (if any) for which the setup is intended.
      modifiers: final
    paymentMethodDetails: SetupAttemptPaymentMethodDetails?
      description: Details about the payment method at the time of SetupIntent confirmation.
      modifiers: final
    paymentMethodId: String?
      description: ID of the payment method used with this SetupAttempt.
      modifiers: final
    runtimeType: Type
      description: A representation of the runtime type of the object.
      modifiers: no setter, inherited
    setupIntentId: String
      description: ID of the SetupIntent that this attempt belongs to.
      modifiers: final
    status: SetupAttemptStatus
      description: The status of this SetupAttempt.
      modifiers: final

  Methods:
    noSuchMethod(invocation: Invocation): dynamic
      description: Invoked when a nonexistent method or property is accessed.
      modifiers: inherited
    toString(): String
      description: A string representation of this object.
      modifiers: inherited

  Operators:
    operator ==(other: Object): bool
      description: The equality operator.
      modifiers: inherited
```

--------------------------------

### API Documentation for retrieveSetupIntent method

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal/retrieveSetupIntent

This section provides the API signature and details for the `retrieveSetupIntent` method, part of the `Terminal` class. It outlines the method's return type and the required `clientSecret` parameter.

```APIDOC
Terminal class
retrieveSetupIntent(
  clientSecret: String
) -> Future<SetupIntent>
  clientSecret: The client secret of the SetupIntent to retrieve.
```

--------------------------------

### Dart Declaration of SetupAttempt.onBehalfOf Property

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttempt/onBehalfOf

This Dart code snippet illustrates the declaration of the 'onBehalfOf' property as a final, nullable String. It is part of the 'SetupAttempt' class, typically used to specify the account for which a Stripe setup is intended.

```Dart
final String? onBehalfOf;
```

--------------------------------

### Clear Cached Credentials

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Terminal-class

Clears the current connection token, saved reader sessions, and any other cached credentials. This method can be used to switch accounts in your app, for example, to switch between live and test Stripe API keys on your backend.

```APIDOC
clearCachedCredentials() -> Future<void>
```

--------------------------------

### SetupIntentStatus Enum API Reference (Dart)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupIntentStatus

Detailed API documentation for the `SetupIntentStatus` enum, including its inheritance chain, all defined enumeration values, inherited and specific properties, methods, operators, and constants.

```APIDOC
enum SetupIntentStatus:
  Inheritance:
    - Object
    - Enum
  Available extensions:
    - EnumName

  Values:
    - requiresPaymentMethod
    - requiresConfirmation
    - requiresAction
    - processing
    - succeeded
    - cancelled

  Properties:
    - hashCode: int (inherited from Object)
      Description: The hash code for this object.
    - index: int (inherited from Enum)
      Description: A numeric identifier for the enumerated value.
    - name: String (provided by EnumName extension)
      Description: The name of the enum value.
    - runtimeType: Type (inherited from Object)
      Description: A representation of the runtime type of the object.

  Methods:
    - noSuchMethod(invocation: Invocation): dynamic (inherited)
      Description: Invoked when a nonexistent method or property is accessed.
    - toString(): String (inherited)
      Description: A string representation of this object.

  Operators:
    - operator ==(other: Object): bool (inherited)
      Description: The equality operator.

  Constants:
    - values: List<SetupIntentStatus>
      Description: A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### Get Reader Battery Status in Dart

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/Reader/batteryStatus

Retrieves the battery status of a `Reader` object by converting its internal `batteryLevel` to a `BatteryStatus` enum. This getter provides a convenient way to access the reader's battery state.

```Dart
BatteryStatus? get batteryStatus => BatteryStatus.from(batteryLevel);
```

--------------------------------

### SetupAttemptCardPresentDetails.toString Method API Documentation

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/SetupAttemptCardPresentDetails/toString

Documents the `toString` method for the `SetupAttemptCardPresentDetails` class, detailing its purpose as a string representation of the object for debugging or logging. It highlights that this method is inherited and often overridden to provide specific object details.

```APIDOC
Class: SetupAttemptCardPresentDetails
Method: toString()
  @override
  Returns: String
  Description: Provides a string representation of this object. This method is typically overridden to offer useful information for debugging or logging purposes, detailing the object's state. Some classes have a default textual representation, while others provide specific details for inspection.
```

--------------------------------

### Stripe Terminal Error: Reader Connection Offline Needs Update (iOS)

Source: https://pub.dev/documentation/mek_stripe_terminal/latest/mek_stripe_terminal/TerminalExceptionCode

This iOS-specific error indicates that the reader's software is outdated. An online connection is required to install necessary updates before the reader can be used for offline payments.

```APIDOC
readerConnectionOfflineNeedsUpdate:
  Type: TerminalExceptionCode
  Platform: iOS Only
  Description: The device software version running on this reader is out of date. You must connect to this reader while online to install required updates before this reader can be used for offline payments.
```
Tokens:
Raw