Skip to content

Some improvements with Readme file for better readability (syntax highlights) #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Some improvements with Readme file for better readability (syntax highlights) #73

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c13565d
Added language syntax highlights to fenced-code-blocks
ausshadu Dec 14, 2023
39d8adb
Some further code-blocks highlighted
ausshadu Dec 14, 2023
fbf2bd7
Merge branch 'master' into master
kingisaac95 Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 59 additions & 57 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@ The React Native Wrapper for LinkSDK allows you to do all the functions that can

Install `lean-react-native`

```
```shell
npm install --save lean-react-native
```

If you don't already have `react-native-webview` added to your project you should also install this

```
```shell
npm install --save react-native-webview
```

Go to your ios folder and run
```
Navigate to your project's **ios** directory and run

```shell
pod install
```

## Usage
The Wrapper uses a `ref` to access internal functions.

```
```jsx
import React, { useRef } from 'react'
import { View, TouchableOpacity, Text } from 'react-native'
import LinkSDK from 'lean-react-native'
Expand All @@ -35,7 +36,7 @@ const App = () => {
return (
<View>
<TouchableOpacity
onPress={() => Lean.current.link({ customer_id: "CUSTOMER_ID" })}
onPress={() => Lean.current.link({ customer_id: "CUSTOMER_ID" }) }
>
<Text>Link Account</Text>
</TouchableOpacity>
Expand Down Expand Up @@ -76,14 +77,14 @@ The LinkSDK supports 6 methods. `link`, `connect`, `reconnect`, `createPaymentSo

Use link when you want to create an `Entity` for use with the Data API.

```
Lean.current.link({
customer_id: "YOUR_CUSTOMER_ID",
permissions: ["identity","accounts","balance","transactions"],
bank_identifier: "LEAN_MB1", //optional
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```js
Lean.current.link({
customer_id: "YOUR_CUSTOMER_ID",
permissions: ["identity","accounts","balance","transactions"],
bank_identifier: "LEAN_MB1", // optional
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```

| Parameter | Required | Description |
Expand All @@ -100,15 +101,15 @@ Use link when you want to create an `Entity` for use with the Data API.

Use connect when you want to create an `Entity` and a `Payment Source` for use with the Data and Payments APIs.

```
Lean.current.connect({
customer_id: "YOUR_CUSTOMER_ID",
permissions: ["identity","accounts","balance","transactions", "payments"],
bank_identifier: "LEAN_MB1",
payment_destination_id: "PAYMENT_DEST_ID",
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```js
Lean.current.connect({
customer_id: "YOUR_CUSTOMER_ID",
permissions: ["identity","accounts","balance","transactions", "payments"],
bank_identifier: "LEAN_MB1",
payment_destination_id: "PAYMENT_DEST_ID",
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```

| Parameter | Required | Description |
Expand All @@ -126,10 +127,10 @@ Use connect when you want to create an `Entity` and a `Payment Source` for use w

Use reconnect when a call to an `Entity` returns `RECONNECT_REQUIRED`.

```
Lean.current.reconnect({
reconnect_id: "RECONNECT_ID"
})
```js
Lean.current.reconnect({
reconnect_id: "RECONNECT_ID"
})
```

| Parameter | Required | Description |
Expand All @@ -144,13 +145,13 @@ Use reconnect when a call to an `Entity` returns `RECONNECT_REQUIRED`.

Use createPaymentSource to create a `Payment Source` for use the Payments API.

```
Lean.current.createPaymentSource({
customer_id: "CUSTOMER_ID",
bank_identifier: "LEAN_MB1",
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```js
Lean.current.createPaymentSource({
customer_id: "CUSTOMER_ID",
bank_identifier: "LEAN_MB1",
success_redirect_url: "myapp://www.myapp.com/success", // required for Open Banking banks
fail_redirect_url: "myapp://www.myapp.com/success" // required for Open Banking banks
})
```

| Parameter | Required | Description |
Expand All @@ -166,12 +167,12 @@ Use createPaymentSource to create a `Payment Source` for use the Payments API.

Use updatePaymentSource to create a new beneficiary within an existing `Payment Source`.

```
Lean.current.updatePaymentSource({
customer_id: "CUSTOMER_ID",
payment_source_id: "PAYMENT_SOURCE_ID",
payment_destination_id: "PAYMENT_DESTINATION_ID"
})
```js
Lean.current.updatePaymentSource({
customer_id: "CUSTOMER_ID",
payment_source_id: "PAYMENT_SOURCE_ID",
payment_destination_id: "PAYMENT_DESTINATION_ID"
})
```

| Parameter | Required | Description |
Expand All @@ -186,25 +187,25 @@ Use updatePaymentSource to create a new beneficiary within an existing `Payment

Use pay to initiate a payment against a `Payment Intent`.

```
Lean.current.pay({
payment_intent_id: "PAYMENT_INTENT_ID",
account_id: "ACCOUNT_ID"
})
```js
Lean.current.pay({
payment_intent_id: "PAYMENT_INTENT_ID",
account_id: "ACCOUNT_ID"
})
```

| Parameter | Required | Description |
|---------------------|----------|----------------------------------------------------------------------------------------------------------------|
| payment_intent_id | True | The Customer you want to create a payment source for |
| account_id | False | Allows you to use a specific account for a customer payment source (available at payment_source.account[n].id) |
| account_id | False | Allows you to use a specific account for a customer payment source (available at `payment_source.account[n].id`) |

---

## Callbacks

By providing a callback into the component, the LinkSDK will report back with an object in the following format:

```
```js
{
method: "LINK",
status: "SUCCESS",
Expand Down Expand Up @@ -234,20 +235,21 @@ By providing a callback into the component, the LinkSDK will report back with an

You can disable hardware acceleration on the webview by passing android specific props into the webview:

```
```jsx
<LinkSDK
webViewProps={{
androidHardwareAccelerationDisabled: true,
}}
appToken: "YOUR_APP_TOKEN"
sandbox: false
>
ref={Lean}
webViewProps={{ androidHardwareAccelerationDisabled: true }} // 👈🏻
appToken="MY_APP_TOKEN"
version="{version_number}"
country="{country_of_operation}"
sandbox={false}
/>
```

### JDK version issues on Android

You may get gradle errors if you have a different JDK on the development system compared to the local JDK delivered with the Android SDK. The solution is to set JAVA_HOME in gradlew or gradlew.bat to point to the SDK JDK path. On Windows:
You may get gradle errors if you have a different JDK on the development system compared to the local JDK delivered with the Android SDK. The solution is to set `JAVA_HOME` in gradlew or gradlew.bat to point to the SDK JDK path. On Windows:

```
```shell
SET JAVA_HOME="\Program Files\Android\Android Studio\jre"
```
```