feat: Documents bin/last4 in Android SDK (#21)

Basis-Theory · Jan 5, 2023 · e897385 · e897385 · vercel · Jan 5, 2023
1 parent ac3c133
commit e897385
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 18 deletions.
diff --git a/docs/sdks/mobile/android/events.mdx b/docs/sdks/mobile/android/events.mdx
@@ -9,7 +9,7 @@ callbacks within your application.
 
 ## ChangeEvent
 
-Raised whenever the element's value is changed.
+Raised whenever the element's value is changed, upon each keypress and after pasting multiple characters into the element.
 
 ### Schema
 

diff --git a/docs/sdks/mobile/android/index.mdx b/docs/sdks/mobile/android/index.mdx
@@ -74,7 +74,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-      implementation 'com.github.basis-theory.basistheory-android:lib:<version>'
+      implementation 'com.github.basis-theory:basistheory-android:<version>'
   }
 ```
 

diff --git a/docs/sdks/mobile/android/types.mdx b/docs/sdks/mobile/android/types.mdx
@@ -128,22 +128,14 @@ to your application via the property:
 
 #### CardMetadata
 
-| Name       | Type      | Description                                           |
-|------------|-----------|-------------------------------------------------------|
-| brand      | `String`  | The card [brand identifier](#brand-identifiers)       |
-| cardMask   | `String`  | The card number mask corresponding to this card brand |
-| cvcMask    | `String`  | The CVC mask corresponding to this card brand         |
-| isComplete | `Boolean` | Whether this card number is complete for this brand   |
-
-#### ChangeEvent
-
-The card brand is also included within [ChangeEvents](./events#changeevent) published by the `CardNumberElement`
-within an [EventDetails](./events#eventdetails) record of the form:
-
-| Property | Type     | Value                |
-|----------|----------|----------------------|
-| type     | `String` | `cardBrand`          |
-| message  | `String` | The brand identifier |
+| Name       | Type      | Description                                                       |
+|------------|-----------|-------------------------------------------------------------------|
+| brand      | `String`  | The card [brand identifier](#brand-identifiers)                   |
+| cardMask   | `String`  | The card number mask corresponding to this card brand             |
+| cvcMask    | `String`  | The CVC mask corresponding to this card brand                     |
+| isComplete | `Boolean` | Whether this card number is complete for this brand               |
+| bin        | `String`  | The first 6 digits of the card number if complete, otherwise null |
+| last4      | `String`  | The last 4 digits of the card number if complete, otherwise null  |
 
 #### Brand Identifiers
 
@@ -160,6 +152,14 @@ within an [EventDetails](./events#eventdetails) record of the form:
 - `hiper`
 - `hipercard`
 
+### ChangeEvent Details
+
+The `CardNumberElement` emits [ChangeEvents](./events#changeevent) that may contain several types of [EventDetail](./events#eventdetails) records.
+
+- `cardBrand`: Contains the [brand identifier](#brand-identifiers) for the card brand. Only included once enough digits are entered to determine a card brand.
+- `bin`: Contains the first 6 digits of the card number. Only included for complete card numbers satisfying the brand-specific mask.
+- `last4`: Contains the last 4 digits of the card number. Only included for complete card numbers satisfying the brand-specific mask.
+
 ## CardExpirationDateElement
 
 The `CardExpirationDateElement` can be used to securely collect credit card expiration dates within
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,7 +74,7 @@ Add this dependency to your project's build file: @@
       }
       dependencies {
-          implementation 'com.github.basis-theory.basistheory-android:lib:<version>'
+          implementation 'com.github.basis-theory:basistheory-android:<version>'
       }
     ```
@@ Expand Down @@