Account Settings Client (IAccountSettingsClient) Interface

Namespace: Cxt.Account.Settings.API.Abstractions

Defines the contract for components interacting directly with the data persistence layer (e.g., database, microservice) for account settings.

Purpose

• Abstracts low-level data storage and retrieval operations.
• Provides a clear data access contract for AccountSettingsService.
• Enables CRUD (Create, Retrieve, Update, Delete) operations for account preferences.
• Promotes loose coupling, making the API agnostic to the underlying data storage technology.

Methods

Add Client Account Settings Preferences Client

Task<bool> AddClientAccountSettingsPreferencesClient(AddAccountSettingDto request);

• Description: Persists a new account setting preference.
• Parameters:

  Parameter	Type	Description
  request	AddAccountSettingDto	Contains details for the new setting (expects AccountHidden as an integer).

• Returns: Task<bool> - true if successful, false otherwise.

Update Client Account Settings Preferences Client

Task<bool> UpdateClientAccountSettingsPreferencesClient(AddAccountSettingDto request);

• Description: Updates an existing account setting preference.
• Parameters:

  Parameter	Type	Description
  request	AddAccountSettingDto	Contains updated details. The target account is identified by GCN, AccountNumber, and ProfileId within the DTO.

• Returns: Task<bool> - true if successful, false otherwise.

Delete Client Account Settings Preferences Client

Task<bool> DeleteClientAccountSettingsPreferencesClient(AccountSettingsDeleteRequest request);

• Description: Deletes an account setting preference.
• Parameters:

  Parameter	Type	Description
  request	AccountSettingsDeleteRequest	Specifies GCN, account number, and account type of the preference to delete.

• Returns: Task<bool> - true if successful, false otherwise.

Retrieve Client Account Settings Preferences Client

Task<List<AccountSettingsPreferencesDto>> RetrieveClientAccountSettingsPreferencesClient(string gcn, CancellationToken cancellationToken);

• Description: Retrieves all stored account setting preferences for a client GCN.
• Parameters:

  Parameter	Type	Description
  gcn	string	Global Client Number.
  cancellationToken	CancellationToken	For observing cancellation requests.

• Returns: Task<List<AccountSettingsPreferencesDto>> - List of AccountSettingsPreferencesDto representing stored preferences. Returns an empty list if none are found.

Consumers and Implementers

• Primary Consumer: AccountSettingsService (see Core API Services Overview).
• Primary Implementer: AccountSettingsClient Class.