Helio SDK

https://www.npmjs.com/package/@heliofi/sdk
Admin
A lightweight and easy-to-use SDK for interacting with the Helio API, wrapping and enhancing its...
Tokens:9,564
Snippets:100
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install @heliofi/sdk using yarn

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Install the Helio SDK package using yarn. This is an alternative package manager for installing the SDK.

```bash
yarn add @heliofi/sdk
```

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

### Install @heliofi/sdk using npm

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Install the Helio SDK package using npm. This is the first step to integrating Helio's services into your project.

```bash
npm i @heliofi/sdk
```

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

### Install Helio SDK with npm

Source: https://www.npmjs.com/package/%40heliofi/sdk

Install the Helio SDK package using npm. This is the first step to integrate Helio's API functionalities into your project.

```bash
npm i @heliofi/sdk

```

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

### Initialize Helio SDK and Create Paylink

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=dependencies

Example of initializing the Helio SDK with API keys and network, then creating a paylink. Ensure you replace 'your-public-api-key' and 'your-secret-key' with your actual credentials.

```typescript
import { HelioSDK } from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);

const paylinkWebhook = await sdk.paylinkWebhook.create(createPaylinkWebhookDto);
```

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

### Install Helio SDK with yarn

Source: https://www.npmjs.com/package/%40heliofi/sdk

Install the Helio SDK package using yarn. This is an alternative to npm for managing project dependencies.

```bash
yarn add @heliofi/sdk

```

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

### Import reflect-metadata

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Ensure you import 'reflect-metadata' at the top of your project. This is a required setup step for the Helio SDK.

```typescript
import 'reflect-metadata';
```

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

### Import reflect-metadata

Source: https://www.npmjs.com/package/%40heliofi/sdk

Ensure 'reflect-metadata' is imported at the top of your project. This is a required setup step for the Helio SDK to function correctly.

```typescript
import 'reflect-metadata';

```

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

### Initialize Helio SDK and Create Paylink

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Initialize the Helio SDK with your API keys and network configuration. Then, create a paylink using the SDK's paylink service.

```typescript
import { HelioSDK } from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);
```

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

### Initialize Helio SDK and Create Paylink

Source: https://www.npmjs.com/package/%40heliofi/sdk

Initialize the Helio SDK with your API keys and network configuration. Then, create a paylink using the SDK's paylink.create method.

```typescript
import { HelioSDK } from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);

const paylinkWebhook = await sdk.paylinkWebhook.create(createPaylinkWebhookDto);

```

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

### Initialize Helio SDK and Create Paylink

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Initialize the Helio SDK with your API keys and network configuration. Then, use the sdk.paylink.create method to generate a new paylink.

```typescript
import { HelioSDK } from '@heliofi/sdk';

const sdk = new HelioSDK({
  apiKey: 'your-public-api-key',
  secretKey: 'your-secret-key',
  network: 'mainnet', // or 'devnet' (optional, mainnet by default)
});

const paylink = await sdk.paylink.create(createPaylinkDto);

```

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

### Create Paylink Webhook

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Use the sdk.paylinkWebhook.create method to set up a webhook for paylink events. This allows your application to receive real-time notifications.

```typescript
const paylinkWebhook = await sdk.paylinkWebhook.create(createPaylinkWebhookDto);

```

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

### Subscription Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3

Methods for managing subscription webhooks.

```APIDOC
## subscriptionWebhook.createSubscriptionWebhook

### Description
Creates a subscription webhook.

### Method
`createSubscriptionWebhook`

### Parameters
#### Request Body
- **dto** (CreatePaylinkSubscriptionHookDto) - Required - The data transfer object for creating a subscription webhook.

### Response
#### Success Response (200)
- **PaylinkSubscriptionHookEntity** - The created subscription webhook object.

```

```APIDOC
## subscriptionWebhook.getAllSubscriptionWebhooks

### Description
Retrieves all subscription webhooks for a given paylink.

### Method
`getAllSubscriptionWebhooks`

### Parameters
#### Path Parameters
- **paylinkId** (string) - Required - The ID of the paylink.

### Response
#### Success Response (200)
- **PaylinkSubscriptionHookEntity[]** - An array of subscription webhook objects.

```

```APIDOC
## subscriptionWebhook.getSubscriptionWebhook

### Description
Retrieves a specific subscription webhook.

### Method
`getSubscriptionWebhook`

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook.

### Response
#### Success Response (200)
- **PaylinkSubscriptionHookEntity** - The subscription webhook object.

```

```APIDOC
## subscriptionWebhook.deleteSubscriptionWebhook

### Description
Deletes a subscription webhook.

### Method
`deleteSubscriptionWebhook`

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Response
#### Success Response (200)
- **void** - Indicates successful deletion.

```

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

### Subscription Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Methods for managing subscription webhooks.

```APIDOC
## subscriptionWebhook.createSubscriptionWebhook

### Description
Creates a subscription webhook.

### Params
- dto: CreatePaylinkSubscriptionHookDto

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.getAllSubscriptionWebhooks

### Description
Retrieves all subscription webhooks for a given paylink.

### Params
- paylinkId: string

### Return
PaylinkSubscriptionHookEntity[]
```

```APIDOC
## subscriptionWebhook.getSubscriptionWebhook

### Description
Retrieves a specific subscription webhook.

### Params
- webhookId: string

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.deleteSubscriptionWebhook

### Description
Deletes a subscription webhook.

### Params
- webhookId: string

### Return
void
```

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

### Subscription Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for managing subscription webhooks.

```APIDOC
## subscriptionWebhook.createSubscriptionWebhook

### Description
Creates a webhook for subscription notifications.

### Method
`createSubscriptionWebhook`

### Parameters
- **dto** (CreatePaylinkSubscriptionHookDto) - Required - The data transfer object for creating a subscription webhook.

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.getAllSubscriptionWebhooks

### Description
Retrieves all subscription webhooks associated with a specific paylink.

### Method
`getAllSubscriptionWebhooks`

### Parameters
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkSubscriptionHookEntity[]
```

```APIDOC
## subscriptionWebhook.getSubscriptionWebhook

### Description
Retrieves a specific subscription webhook by its ID.

### Method
`getSubscriptionWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.deleteSubscriptionWebhook

### Description
Deletes a subscription webhook.

### Method
`deleteSubscriptionWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Subscription Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for managing subscription webhooks.

```APIDOC
## subscriptionWebhook.createSubscriptionWebhook

### Description
Creates a new subscription webhook.

### Params
- **dto** (CreatePaylinkSubscriptionHookDto) - Required - The data transfer object for creating a subscription webhook.

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.getAllSubscriptionWebhooks

### Description
Retrieves all subscription webhooks for a given paylink.

### Params
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkSubscriptionHookEntity[]
```

```APIDOC
## subscriptionWebhook.getSubscriptionWebhook

### Description
Retrieves a specific subscription webhook by its ID.

### Params
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkSubscriptionHookEntity
```

```APIDOC
## subscriptionWebhook.deleteSubscriptionWebhook

### Description
Deletes a subscription webhook.

### Params
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=readme

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all supported currencies.

### Method
Not specified, likely a GET request.

### Parameters
#### Query Parameters
- **type** (CurrencyType) - Optional - The type of currency to filter by.

### Return
Currency[]
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all available currencies.

### Params
- **type** (CurrencyType) - Optional - The type of currency to filter by.

### Return
Currency[]
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all supported currencies.

### Params
- type?: CurrencyType

### Return
Currency[]
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Methods for retrieving currency information.

```APIDOC
## Currency Methods

### Get All Currencies

**Description**: Retrieves a list of all supported currencies.

**Method**: `sdk.currency.getAllCurrencies`

**Params**: `type?: CurrencyType`

**Return**: `Currency[]`
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all available currencies.

### Params
- type?: CurrencyType

### Return
Currency[]
```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all available currencies.

### Method
`getAllCurrencies`

### Parameters
#### Query Parameters
- **type** (CurrencyType) - Optional - The type of currency to filter by.

### Response
#### Success Response (200)
- **Currency[]** - An array of currency objects.

```

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

### Currency Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all supported currencies.

### Method
`getAllCurrencies`

### Parameters
- **type** (CurrencyType) - Optional - The type of currency to filter by.

### Return
Currency[]
```

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

### Currency Methods

Source: https://www.npmjs.com/package/@heliofi/sdk

Methods for retrieving currency information.

```APIDOC
## currency.getAllCurrencies

### Description
Retrieves all supported currencies.

### Method
`getAllCurrencies`

### Parameters
#### Query Parameters
- **type** (CurrencyType) - Optional - The type of currency to filter by.

### Response
#### Success Response (200)
- **Currency[]** - An array of currency objects.
```

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

### Deposit Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3

Methods for managing deposit webhooks.

```APIDOC
## depositWebhook.createDepositWebhook

### Description
Creates a deposit webhook.

### Method
`createDepositWebhook`

### Parameters
#### Request Body
- **dto** (CreateDepositHookByApiKeyDto) - Required - The data transfer object for creating a deposit webhook.

### Response
#### Success Response (200)
- **DepositHook** - The created deposit webhook object.

```

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

### Deposit Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for managing deposit webhooks.

```APIDOC
## depositWebhook.createDepositWebhook

### Description
Creates a new deposit webhook.

### Params
- **dto** (CreateDepositHookByApiKeyDto) - Required - The data transfer object for creating a deposit webhook.

### Return
DepositHook
```

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

### Deposit Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for managing deposit webhooks.

```APIDOC
## depositWebhook.createDepositWebhook

### Description
Creates a webhook for deposit notifications.

### Method
`createDepositWebhook`

### Parameters
- **dto** (CreateDepositHookByApiKeyDto) - Required - The data transfer object for creating a deposit webhook.

### Return
DepositHook
```

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

### Deposit Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Methods for managing deposit webhooks.

```APIDOC
## depositWebhook.createDepositWebhook

### Description
Creates a deposit webhook.

### Params
- dto: CreateDepositHookByApiKeyDto

### Return
DepositHook
```

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

### Deposit Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=readme

Methods for managing deposit webhooks.

```APIDOC
## depositWebhook.createDepositWebhook

### Description
Creates a deposit webhook.

### Method
Not specified, likely a POST request.

### Parameters
#### Request Body
- **dto** (CreateDepositHookByApiKeyDto) - Required - Data transfer object for creating a deposit webhook.

### Return
DepositHook
```

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

### Deposit Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for managing customer deposits.

```APIDOC
## deposit.create

### Description
Creates a new customer deposit record.

### Params
- **dto** (CreateDepositCustomerDto) - Required - The data transfer object for creating a deposit.

### Return
DepositCustomerEntity
```

```APIDOC
## deposit.recordActivity

### Description
Records activity for a deposit token.

### Params
- **tokenId** (string) - Required - The ID of the deposit token.

### Return
void
```

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

### Deposit Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk

Methods for managing customer deposits.

```APIDOC
## deposit.create

### Description
Creates a new customer deposit record.

### Params
- dto: CreateDepositCustomerDto

### Return
DepositCustomerEntity
```

```APIDOC
## deposit.recordActivity

### Description
Records activity for a deposit token.

### Params
- tokenId: string

### Return
void
```

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

### Deposit Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependencies

Methods for managing deposits.

```APIDOC
## deposit.create

### Description
Creates a new deposit.

### Params
- dto: CreateDepositCustomerDto

### Return
DepositCustomerEntity
```

```APIDOC
## deposit.recordActivity

### Description
Records activity for a deposit.

### Params
- tokenId: string

### Return
void
```

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

### Paylink Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for managing paylink webhooks.

```APIDOC
## paylinkWebhook.createPaylinkWebhook

### Description
Creates a webhook for paylink transaction notifications.

### Method
`createPaylinkWebhook`

### Parameters
- **dto** (CreatePaylinkTransactionHookDto) - Required - The data transfer object for creating a paylink webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.getAllPaylinkWebhooks

### Description
Retrieves all webhooks associated with a specific paylink.

### Method
`getAllPaylinkWebhooks`

### Parameters
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## paylinkWebhook.getPaylinkWebhook

### Description
Retrieves a specific paylink webhook by its ID.

### Method
`getPaylinkWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.deletePaylinkWebhook

### Description
Deletes a paylink webhook.

### Method
`deletePaylinkWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Paylink Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for managing paylink webhooks.

```APIDOC
## paylinkWebhook.createPaylinkWebhook

### Description
Creates a new paylink webhook.

### Params
- **dto** (CreatePaylinkTransactionHookDto) - Required - The data transfer object for creating a paylink webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.getAllPaylinkWebhooks

### Description
Retrieves all paylink webhooks for a given paylink.

### Params
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## paylinkWebhook.getPaylinkWebhook

### Description
Retrieves a specific paylink webhook by its ID.

### Params
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.deletePaylinkWebhook

### Description
Deletes a paylink webhook.

### Params
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Paylink Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependencies

Methods for managing paylink webhooks.

```APIDOC
## paylinkWebhook.createPaylinkWebhook

### Description
Creates a paylink webhook.

### Params
- dto: CreatePaylinkTransactionHookDto

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.getAllPaylinkWebhooks

### Description
Retrieves all webhooks for a given paylink.

### Params
- paylinkId: string

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## paylinkWebhook.getPaylinkWebhook

### Description
Retrieves a specific paylink webhook.

### Params
- webhookId: string

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## paylinkWebhook.deletePaylinkWebhook

### Description
Deletes a paylink webhook.

### Params
- webhookId: string

### Return
void
```

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

### Transaction Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3

Methods for managing transaction webhooks.

```APIDOC
## transactionWebhook.createTransactionWebhook

### Description
Creates a transaction webhook.

### Method
`createTransactionWebhook`

### Parameters
#### Request Body
- **dto** (CreatePaylinkTransactionHookDto) - Required - The data transfer object for creating a transaction webhook.

### Response
#### Success Response (200)
- **PaylinkTransactionHookEntity** - The created transaction webhook object.

```

```APIDOC
## transactionWebhook.getAllTransactionWebhooks

### Description
Retrieves all transaction webhooks for a given paylink.

### Method
`getAllTransactionWebhooks`

### Parameters
#### Path Parameters
- **paylinkId** (string) - Required - The ID of the paylink.

### Response
#### Success Response (200)
- **PaylinkTransactionHookEntity[]** - An array of transaction webhook objects.

```

```APIDOC
## transactionWebhook.getTransactionWebhook

### Description
Retrieves a specific transaction webhook.

### Method
`getTransactionWebhook`

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook.

### Response
#### Success Response (200)
- **PaylinkTransactionHookEntity** - The transaction webhook object.

```

```APIDOC
## transactionWebhook.deleteTransactionWebhook

### Description
Deletes a transaction webhook.

### Method
`deleteTransactionWebhook`

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Response
#### Success Response (200)
- **void** - Indicates successful deletion.

```

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

### Transaction Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=readme

Methods for managing transaction webhooks.

```APIDOC
## transactionWebhook.createTransactionWebhook

### Description
Creates a transaction webhook.

### Params
- dto: CreatePaylinkTransactionHookDto

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.getAllTransactionWebhooks

### Description
Retrieves all transaction webhooks for a given paylink.

### Params
- paylinkId: string

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## transactionWebhook.getTransactionWebhook

### Description
Retrieves a specific transaction webhook.

### Params
- webhookId: string

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.deleteTransactionWebhook

### Description
Deletes a transaction webhook.

### Params
- webhookId: string

### Return
void
```

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

### Transaction Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for managing transaction webhooks.

```APIDOC
## transactionWebhook.createTransactionWebhook

### Description
Creates a new transaction webhook.

### Params
- **dto** (CreatePaylinkTransactionHookDto) - Required - The data transfer object for creating a transaction webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.getAllTransactionWebhooks

### Description
Retrieves all transaction webhooks for a given paylink.

### Params
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## transactionWebhook.getTransactionWebhook

### Description
Retrieves a specific transaction webhook by its ID.

### Params
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.deleteTransactionWebhook

### Description
Deletes a transaction webhook.

### Params
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Transaction Webhook Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for managing transaction webhooks.

```APIDOC
## transactionWebhook.createTransactionWebhook

### Description
Creates a webhook for transaction notifications.

### Method
`createTransactionWebhook`

### Parameters
- **dto** (CreatePaylinkTransactionHookDto) - Required - The data transfer object for creating a transaction webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.getAllTransactionWebhooks

### Description
Retrieves all transaction webhooks associated with a specific paylink.

### Method
`getAllTransactionWebhooks`

### Parameters
- **paylinkId** (string) - Required - The ID of the paylink.

### Return
PaylinkTransactionHookEntity[]
```

```APIDOC
## transactionWebhook.getTransactionWebhook

### Description
Retrieves a specific transaction webhook by its ID.

### Method
`getTransactionWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook.

### Return
PaylinkTransactionHookEntity
```

```APIDOC
## transactionWebhook.deleteTransactionWebhook

### Description
Deletes a transaction webhook.

### Method
`deleteTransactionWebhook`

### Parameters
- **webhookId** (string) - Required - The ID of the webhook to delete.

### Return
void
```

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

### Paylink Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for creating, updating, and disabling paylinks.

```APIDOC
## paylink.create

### Description
Creates a new paylink.

### Params
- **dto** (CreatePaylinkWithApiDto) - Required - The data transfer object for creating a paylink.

### Return
ShallowEnrichedPaylink
```

```APIDOC
## paylink.update

### Description
Updates an existing paylink.

### Params
- **paylinkId** (string) - Required - The ID of the paylink to update.
- **dto** (UpdatePaylinkWithApiDto) - Required - The data transfer object for updating a paylink.

### Return
Paylink
```

```APIDOC
## paylink.disable

### Description
Disables a paylink.

### Params
- **paylinkId** (string) - Required - The ID of the paylink to disable.

### Return
boolean
```

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

### Paylink Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=readme

Methods for creating, updating, and disabling paylinks.

```APIDOC
## paylink.create

### Description
Creates a new paylink.

### Method
Not specified, likely a POST request.

### Parameters
#### Request Body
- **dto** (CreatePaylinkWithApiDto) - Required - Data transfer object for creating a paylink.

### Return
ShallowEnrichedPaylink
```

```APIDOC
## paylink.update

### Description
Updates an existing paylink.

### Method
Not specified, likely a PUT or PATCH request.

### Parameters
#### Path Parameters
- **paylinkId** (string) - Required - The ID of the paylink to update.
#### Request Body
- **dto** (UpdatePaylinkWithApiDto) - Required - Data transfer object for updating a paylink.

### Return
Paylink
```

```APIDOC
## paylink.disable

### Description
Disables a paylink.

### Method
Not specified, likely a DELETE or POST request.

### Parameters
#### Path Parameters
- **paylinkId** (string) - Required - The ID of the paylink to disable.

### Return
boolean
```

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

### Create Paylink Webhook

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Use the Helio SDK to create a paylink webhook. This allows you to receive notifications for paylink events.

```typescript
const paylinkWebhook = await sdk.paylinkWebhook.create(createPaylinkWebhookDto);
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Method
`getTransaction`

### Parameters
#### Path Parameters
- **transactionSignature** (string) - Required - The signature of the transaction to retrieve.

### Response
#### Success Response (200)
- **Transaction** - The transaction object.

```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction by its deposit ID.

### Method
`getDepositTransaction`

### Parameters
#### Path Parameters
- **depositId** (string) - Required - The ID of the deposit transaction.
#### Query Parameters
- **from** (string) - Optional - The starting point for the query.
- **to** (string) - Optional - The ending point for the query.
- **senderPK** (string) - Optional - The public key of the sender.

### Response
#### Success Response (200)
- **Transaction** - The deposit transaction object.

```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Method
`getDepositTransactionsByCustomerToken`

### Parameters
#### Path Parameters
- **customerToken** (string) - Required - The customer token.
#### Query Parameters
- **from** (string) - Optional - The starting point for the query.
- **to** (string) - Optional - The ending point for the query.
- **senderPK** (string) - Optional - The public key of the sender.

### Response
#### Success Response (200)
- **Transaction** - The deposit transaction object.

```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk/v/3.0.3?activeTab=code

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Params
- **transactionSignature** (string) - Required - The signature of the transaction.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction by its ID.

### Params
- **depositId** (string) - Required - The ID of the deposit transaction.
- **from** (string) - Optional - The starting date for filtering transactions.
- **to** (string) - Optional - The ending date for filtering transactions.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Params
- **customerToken** (string) - Required - The customer token.
- **from** (string) - Optional - The starting date for filtering transactions.
- **to** (string) - Optional - The ending date for filtering transactions.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/@heliofi/sdk

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Method
`getTransaction`

### Parameters
#### Path Parameters
- **transactionSignature** (string) - Required - The signature of the transaction to retrieve.

### Response
#### Success Response (200)
- **Transaction** - The transaction object.
```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction by its ID.

### Method
`getDepositTransaction`

### Parameters
#### Path Parameters
- **depositId** (string) - Required - The ID of the deposit transaction.
#### Query Parameters
- **from** (string) - Optional - Filter by sender address.
- **to** (string) - Optional - Filter by receiver address.
- **senderPK** (string) - Optional - Filter by sender public key.

### Response
#### Success Response (200)
- **Transaction** - The deposit transaction object.
```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Method
`getDepositTransactionsByCustomerToken`

### Parameters
#### Path Parameters
- **customerToken** (string) - Required - The customer token.
#### Query Parameters
- **from** (string) - Optional - Filter by sender address.
- **to** (string) - Optional - Filter by receiver address.
- **senderPK** (string) - Optional - Filter by sender public key.

### Response
#### Success Response (200)
- **Transaction** - The deposit transaction object.
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=readme

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Method
Not specified, likely a GET request.

### Parameters
#### Query Parameters
- **transactionSignature** (string) - Required - The signature of the transaction.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction.

### Method
Not specified, likely a GET request.

### Parameters
#### Query Parameters
- **depositId** (string) - Required - The ID of the deposit.
- **from** (string) - Optional - The starting address for the transaction.
- **to** (string) - Optional - The ending address for the transaction.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Method
Not specified, likely a GET request.

### Parameters
#### Query Parameters
- **customerToken** (string) - Required - The customer token.
- **from** (string) - Optional - The starting address for the transaction.
- **to** (string) - Optional - The ending address for the transaction.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Params
- transactionSignature: string

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction by its ID.

### Params
- depositId: string
- from?: string
- to?: string
- senderPK?: string

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Params
- customerToken: string
- from?: string
- to?: string
- senderPK?: string

### Return
Transaction
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=code

Methods for retrieving transaction details.

```APIDOC
## Transaction Methods

### Get Transaction

**Description**: Retrieves details of a specific transaction.

**Method**: `sdk.transaction.getTransaction`

**Params**: `transactionSignature: string`

**Return**: `Transaction`

### Get Deposit Transaction

**Description**: Retrieves details of a deposit transaction.

**Method**: `sdk.transaction.getDepositTransaction`

**Params**: `depositId: string; from?: string; to?: string; senderPK?: string`

**Return**: `Transaction`

### Get Deposit Transactions By Customer Token

**Description**: Retrieves deposit transactions associated with a customer token.

**Method**: `sdk.transaction.getDepositTransactionsByCustomerToken`

**Params**: `customerToken: string; from?: string; to?: string; senderPK?: string`

**Return**: `Transaction`
```

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

### Transaction Methods

Source: https://www.npmjs.com/package/%40heliofi/sdk?activeTab=dependents

Methods for retrieving transaction details.

```APIDOC
## transaction.getTransaction

### Description
Retrieves a specific transaction by its signature.

### Method
`getTransaction`

### Parameters
- **transactionSignature** (string) - Required - The signature of the transaction.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransaction

### Description
Retrieves a deposit transaction by its ID.

### Method
`getDepositTransaction`

### Parameters
- **depositId** (string) - Required - The ID of the deposit.
- **from** (string) - Optional - The starting date for filtering.
- **to** (string) - Optional - The ending date for filtering.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```

```APIDOC
## transaction.getDepositTransactionsByCustomerToken

### Description
Retrieves deposit transactions associated with a customer token.

### Method
`getDepositTransactionsByCustomerToken`

### Parameters
- **customerToken** (string) - Required - The customer token.
- **from** (string) - Optional - The starting date for filtering.
- **to** (string) - Optional - The ending date for filtering.
- **senderPK** (string) - Optional - The public key of the sender.

### Return
Transaction
```
Tokens:
Raw