skyflow-js 2.5.0-beta.8 → 2.5.0

package/README.md

@@ -25,7 +25,7 @@ Skyflow’s JavaScript SDK can be used to securely collect, tokenize, and reveal
 Using script tag
 
 ```html
-<script src="https://js.skyflow.com/v1/index.js"></script>
+<script src="https://js.skyflow.com/v2/index.js"></script>
 ```
 
 
@@ -134,6 +134,7 @@ For `env` parameter, there are 2 accepted values in Skyflow.Env
 - [**Insert data into the vault**](#insert-data-into-the-vault)
 - [**Using Skyflow Elements to collect data**](#using-skyflow-elements-to-collect-data)
 - [**Using Skyflow Elements to update data**](#using-skyflow-elements-to-update-data)
+- [**Bin lookup**](#bin-lookup)
 - [**Using validations on Collect Elements**](#validations)
 - [**Event Listener on Collect Elements**](#event-listener-on-collect-elements)
 - [**UI Error for Collect Elements**](#ui-error-for-collect-elements)
@@ -203,6 +204,55 @@ The sample response:
 }
 ```
 
+## Update data in the vault
+
+To update data in the vault by skyflowID, use the `update(request, options?)` method of the Skyflow client. The request object is a JSON object describing the data to update, including the `table`, `fields`, and the `skyflowID` of the record to update. The options parameter takes an object of optional parameters for the update and includes an option to return tokenized data for the updated fields. 
+
+```javascript
+const updateRecord = {
+  table: 'string',       // Table in which record should be updated.
+  fields: {
+    column1: 'value',   // Fields to update. Column names should match vault column names.
+    //...additional fields here
+  },
+  skyflowID: 'string', // The skyflow_id of the record to update.
+};
+
+const options = {
+  tokens: true,        // Indicates whether or not tokens should be returned for the updated data. Defaults to 'true'
+};
+
+skyflowClient.update(updateRecord, options);
+```
+
+An [example](https://github.com/skyflowapi/skyflow-js/blob/main/samples/using-script-tag/pure-update.html) of update call: 
+```javascript
+skyflowClient.update({
+  table: 'cards',
+  fields: {
+    cardNumber: '41111111111',
+    cvv: '123',
+  },
+  skyflowID: '43127a6c-5c15-4513-aa15-29f50bb37182'
+});
+```
+
+The sample response:
+
+```javascript
+{
+  "updatedField": {
+    "skyflowID": "43127a6c-5c15-4513-aa15-29f50bb37182",
+    "cardNumber": "f390186-e7e2-466f-91e5-48e12c2bcbc1",
+    "cvv": "1989cb56-63da-4482-a2df-1f74cd0d1a5"
+  }
+}
+```
+
+**Note**:
+- The `skyflowID` field is required and should be the Skyflow ID of the record you want to update.
+- If tokens is set to true, the response will include tokens for the updated fields.
+
 ## Using Skyflow Elements to collect data
 
 **Skyflow Elements** provide developers with pre-built form elements to securely collect sensitive data client-side. These elements are hosted by Skyflow and injected into your web page as iFrames. This reduces your PCI compliance scope by not exposing your front-end application to sensitive data. Follow the steps below to securely collect data with Skyflow Elements on your web page. 
@@ -745,6 +795,97 @@ cvvElement.mount('#cvv'); //Assumes there is a div with id='#cvv' in the webpage
   ]
 }
 ```
+
+## BIN Lookup
+
+Skyflow supports BIN (Bank Identification Number) lookup to help identify co-badged cards and enable card network selection.
+
+**What is BIN Lookup?**
+A Bank Identification Number (BIN) represents the first 8 digits of a card number and identifies the issuing bank, card scheme, and country.
+For co-badged cards, merchants are required to offer consumers a choice of which network to process the payment through.
+You can use Skyflow’s BIN Lookup API to detect such cards and provide the appropriate options to users.
+
+### Example: Calling the BIN Lookup API
+```javascript
+// Function to call Skyflow's BIN Lookup API
+const binLookup = (bin) => {
+  const myHeaders = new Headers();
+  myHeaders.append("X-skyflow-authorization", "<BEARER_TOKEN>"); // TODO: replace bearer token
+  myHeaders.append("Content-Type", "application/json");
+
+  const raw = JSON.stringify({
+    "BIN": bin
+  });
+
+  const requestOptions = {
+    method: "POST",
+    headers: myHeaders,
+    body: raw,
+    redirect: "follow"
+  };
+
+  // TODO: replace <VAULT_URL> with your Skyflow vault URL
+  return fetch(`${VAULT_URL}/v1/card_lookup`, requestOptions);
+};
+```
+
+**Sample Response :**
+```javascript
+{
+  "cards_data": [
+    {
+      "BIN": "54284800",
+      "issuer_name": "CREDIT MUTUEL ARKEA",
+      "country_code": "FR",
+      "currency": "",
+      "card_type": "Credit",
+      "card_category": "",
+      "card_scheme": "CARTES BANCAIRES"
+    },
+    {
+      "BIN": "54284800",
+      "issuer_name": "Credit Mutuel Arkea",
+      "country_code": "FR",
+      "currency": "",
+      "card_type": "Credit",
+      "card_category": "Mastercard Standard",
+      "card_scheme": "MASTERCARD"
+    }
+  ]
+}
+```
+
+### Updating the Card Element with Network Schemes
+```javascript
+const options = {
+  required: false,      // Optional, indicates whether the field is marked as required. Defaults to 'false'.
+  enableCardIcon: true, // Optional, indicates whether a card icon should be enabled (only applicable for CARD_NUMBER ElementType).
+  enableCopy: false,    // Optional, enables the copy icon to collect elements to copy text to clipboard. Defaults to 'false').
+  format: String,       // Optional, format for the element 
+  translation: {},      // Optional, indicates the allowed data type value for format. 
+  cardMetadata: {},     // Optional, metadata to control card number element behavior. (only applicable for CARD_NUMBER ElementType).
+  masking: true,        // Optional, indicates whether the input should be masked. Defaults to 'false'.
+  maskingChar: '*',     // Optional, character used for masking input when masking is enabled. Defaults to '*'.
+};
+```
+
+`cardMetadata`: An object of metadata keys to control card number element behavior. It supports an optional key called `scheme`, which accepts an array of Skyflow accept card types based on which SDK will display card brand choice dropdown in the card number element. `Skyflow.CardType`   is an enum with all skyflow supported card schemes.
+
+```javascript
+import Skyflow from 'skyflow-js'
+
+const cardMetadata = { 
+  scheme: Skyflow.CardType [] // Optional, array of skyflow supported card types. 
+}
+```
+
+- By default, SDK will populate its own auto-detected card scheme.
+
+### Samples
+
+- [Card brand choice](https://github.com/skyflowapi/skyflow-js/blob/main/samples/using-script-tag/card-brand-choice.html):
+This sample illustrates how to use Bin Lookup API and display the available card schemes.
+
 ## Using Skyflow Elements to update data
 
 You can update the data in a vault with Skyflow Elements. Use the following steps to securely update data.