Account Settings V2 (IAccountSettingsV2Service) Interface
Namespace: CXT.IO.Dashboard.Api.Services
Defines the contract for services within the Dashboard API (BFF) responsible for handling V2 account visibility settings. It serves as an abstraction between the AccountSettingsController and the concrete service implementation.
Purpose
- To retrieve a consolidated view of V2 account settings for a client.
- To save or update V2 account settings for a client, orchestrating the necessary downstream API calls.
Methods
Get account settings
csharp
Task<List<AccountSettingsV2ResponseModel>> GetAccountSettings(string gcn, CancellationToken cancellationToken);- Description: Retrieves all V2 account settings for a given Global Client Number (GCN).
- Parameters:
Parameter Type Description gcnstringThe Global Client Number of the client. cancellationTokenCancellationTokenA token for managing asynchronous operations. - Returns:
Task<List<AccountSettingsV2ResponseModel>>- A list ofAccountSettingsV2ResponseModelobjects, representing the aggregated account settings.
Save account settings
csharp
Task<bool> SaveAccountSettings(string gcn, AccountSettingsV2SaveRequestModel accounts, CancellationToken cancellationToken);- Description: Saves or updates the V2 account settings for a client.
- Parameters:
Parameter Type Description gcnstringThe Global Client Number of the client. accountsAccountSettingsV2SaveRequestModelA model containing the settings to be saved. cancellationTokenCancellationTokenA token for managing asynchronous operations. - Returns:
Task<bool>-trueif all save operations were successful;falseotherwise.
Consumers and Implementers
- Consumer:
AccountSettingsController - Implementer:
AccountSettingsV2Service