Class ProfileService

Service class for managing user related operations.

Hierarchy

ApiService
- ProfileService

Index

Methods

addAccount getAccounts getAvailableCurrencies getProfile getSingleAccount updateProfile getInstance

Methods

addAccount

addAccount(addAccountRequest: AddAccountRequest): Promise<Account>
Adds a new customer account.
Parameters
- addAccountRequest: AddAccountRequest
  The request payload for adding an account.
Returns Promise<Account>
A promise that resolves to the newly added customer account.
Throws
If the HTTP request fails.
Example
```
// Example usage:
profileService.addAccount()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error adding customer account.`);
  });
```
- Defined in profile/services/profile.service.ts:167

getAccounts

getAccounts(): Promise<Account[]>
Retrieves customer accounts.

Returns Promise<Account[]>
A Promise that resolves to the retrieved customer accounts.
Throws
If the HTTP request fails.
Example
```
// Example usage:
profileService.getAccounts()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching customer accounts.`);
  });
```
- Defined in profile/services/profile.service.ts:123

getAvailableCurrencies

getAvailableCurrencies(): Promise<AvailableCurrencies>
Get available currencies for a customer.

Returns Promise<AvailableCurrencies>
A promise that resolves to the available currencies.
Throws
If the HTTP request fails.
Example
```
// Example usage:
profileService.getAvailableCurrencies()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching available currencies.`);
  });
```
- Defined in profile/services/profile.service.ts:188

getProfile

getProfile(include?: ProfileInclude[]): Promise<CustomerInfo>
Retrieves customer information. By default, limited information is returned (include param is empty array).
Parameters
- include: ProfileInclude[] = []
  The list of additional information to include in the response.
Returns Promise<CustomerInfo>
A Promise that resolves to the retrieved customer information.
Throws
If the HTTP request fails.
Example
```
// Example usage:
profileService.getProfile()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching customer information.`);
  });
```
- Defined in profile/services/profile.service.ts:67

getSingleAccount

getSingleAccount(accountId: string): Promise<Account>
Retrieves customer account.
Parameters
- accountId: string
  The ID of the account to retrieve.
Returns Promise<Account>
A Promise that resolves to the retrieved customer account.
Throws
If the HTTP request fails.
Example
```
// Example usage:
profileService.getSingleAccount()
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error fetching customer account.`);
  });
```
- Defined in profile/services/profile.service.ts:145

updateProfile

updateProfile(
updateCustomerRequest: UpdateCustomerRequest,
): Promise<CustomerInfo>
Updates customer personal information.

Updating the following customer details might result in customer restriction and require new KYC Verification:
- firstName, lastName - re-trigger KYC verification
- address - re-trigger address verification of KYC process
To update the following details, the customer must be non-KYC verified. If the customer is KYC verified, you cannot update these details:
- birthDate
Parameters
- updateCustomerRequest: UpdateCustomerRequest
  The customer personal information which we want to update.
Returns Promise<CustomerInfo>
A Promise that resolves to the updated customer information.
Example
```
// Example usage:
profileService.updateProfile(updateCustomerRequest)
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(`Error updating customer information.`);
  });
```
- Defined in profile/services/profile.service.ts:102

`Static`getInstance

getInstance(): ProfileService
Function
Retrieves the singleton instance of the ProfileService class.

Returns ProfileService
The singleton instance of the ProfileService class.
Static
Example
```
// Usage:
const profileService = ProfileService.getInstance();
```
- Defined in profile/services/profile.service.ts:40