Rename ..ReturnType to ..Result (#6509)

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/create-customer-result.interface.ts

@@ -0,0 +1,3 @@
+export interface CreateCustomerResult {
+  readonly holderId: string;
+}

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/do-transfer-or-issue-card-return-type.interface.ts → services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/do-transfer-or-issue-card-result.interface.ts

@@ -1,4 +1,4 @@
-export class DoTransferOrIssueCardReturnType {
+export class DoTransferOrIssueCardResult {
   isNewCardCreated: boolean;
   amountTransferredInMajorUnit: number;
 }

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-return-type.interface.ts → services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-result.interface.ts

@@ -1,5 +1,5 @@
 import { IntersolveVisaCardStatus } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-visa-card-status.enum';
 
-export interface GetPhysicalCardReturnType {
+export interface GetPhysicalCardResult {
   readonly status: IntersolveVisaCardStatus;
 }

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-return-type.interface.ts → services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-result.interface.ts

@@ -1,6 +1,6 @@
 import { IntersolveVisaTokenStatus } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-visa-token-status.enum';
 
-export interface GetTokenReturnType {
+export interface GetTokenResult {
   readonly blocked: boolean;
   readonly status: IntersolveVisaTokenStatus;
   readonly balance: number;

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-return-type.interface.ts → services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-result.interface.ts

@@ -1,4 +1,4 @@
-export interface GetTransactionInformationReturnType {
+export interface GetTransactionInformationResult {
   readonly spentThisMonth: number;
   readonly lastTransactionDate: Date | null;
 }

services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/issue-token-return-type.interface.ts → services/121-service/src/payments/fsp-integration/intersolve-visa/interfaces/issue-token-result.interface.ts

@@ -1,6 +1,6 @@
 import { IntersolveVisaTokenStatus } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-visa-token-status.enum';
 
-export interface IssueTokenReturnType {
+export interface IssueTokenResult {
   readonly code: string;
   readonly blocked: boolean;
   readonly status: IntersolveVisaTokenStatus | undefined;

services/121-service/src/payments/fsp-integration/intersolve-visa/intersolve-visa.api.service.ts

@@ -18,11 +18,11 @@ import { TransferRequestIntersolveApiDto } from '@121-service/src/payments/fsp-i
 import { TransferResponseIntersolveApiDto } from '@121-service/src/payments/fsp-integration/intersolve-visa/dtos/intersolve-api/transfer-response-intersolve-api.dto';
 import { IntersolveBlockTokenReasonCodeEnum } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-block-token-reason-code.enum';
 import { IntersolveVisa121ErrorText } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-visa-121-error-text.enum';
-import { CreateCustomerReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/create-customer-return-type.interface';
-import { GetPhysicalCardReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-return-type.interface';
-import { GetTokenReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-return-type.interface';
-import { GetTransactionInformationReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-return-type.interface';
-import { IssueTokenReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/issue-token-return-type.interface';
+import { CreateCustomerResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/create-customer-result.interface';
+import { GetPhysicalCardResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-result.interface';
+import { GetTokenResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-result.interface';
+import { GetTransactionInformationResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-result.interface';
+import { IssueTokenResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/issue-token-result.interface';
 import { ContactInformation } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/partials/contact-information.interface';
 import { IntersolveVisaApiError } from '@121-service/src/payments/fsp-integration/intersolve-visa/intersolve-visa-api.error';
 import { CustomHttpService } from '@121-service/src/shared/services/custom-http.service';
@@ -83,7 +83,7 @@ export class IntersolveVisaApiService {
     name: string;
     contactInformation: ContactInformation;
     estimatedAnnualPaymentVolumeMajorUnit: number;
-  }): Promise<CreateCustomerReturnType> {
+  }): Promise<CreateCustomerResult> {
     // Create the request body to send
     const createCustomerRequestDto: CreateCustomerRequestIntersolveApiDto = {
       externalReference, // The IntersolveVisa does not "know about this", but we pass in the registration.referenceId here.
@@ -123,7 +123,7 @@ export class IntersolveVisaApiService {
 
     // If the response does not contain errors
     // Put relevant stuff from createCustomerResponseDto into a CreateCustomerResultDto and return
-    const createCustomerResultDto: CreateCustomerReturnType = {
+    const createCustomerResultDto: CreateCustomerResult = {
       holderId: createCustomerResponseDto.data.data.id,
     };
     return createCustomerResultDto;
@@ -137,7 +137,7 @@ export class IntersolveVisaApiService {
     brandCode: string;
     activate: boolean;
     reference?: string;
-  }): Promise<IssueTokenReturnType> {
+  }): Promise<IssueTokenResult> {
     // Create the request body to send
     const issueTokenRequestDto: IssueTokenRequestIntersolveApiDto = {
       reference: reference ?? uuid(), // A UUID reference which can be used for "technical cancellation in case of time-out", which in accordance with Intersolve we do not implement.
@@ -155,7 +155,7 @@ export class IntersolveVisaApiService {
 
     // If the response does not contain errors
     // Put relevant stuff from issueTokenResponseDto into a CreateCustomerResultDto and return
-    const issueTokenResultDto: IssueTokenReturnType = {
+    const issueTokenResultDto: IssueTokenResult = {
       code: issueTokenResponseDto.data.data.token.code,
       blocked: issueTokenResponseDto.data.data.token.blocked || false,
       status: issueTokenResponseDto.data.data.token.status,
@@ -164,7 +164,7 @@ export class IntersolveVisaApiService {
     return issueTokenResultDto;
   }
 
-  public async getToken(tokenCode: string): Promise<GetTokenReturnType> {
+  public async getToken(tokenCode: string): Promise<GetTokenResult> {
     // Send the request
     const getTokenResponseDto =
       await this.intersolveApiRequest<GetTokenResponseIntersolveApiDto>({
@@ -192,7 +192,7 @@ export class IntersolveVisaApiService {
     if (tokenData?.blocked === true || tokenData?.blocked === false) {
       blocked = tokenData.blocked;
     }
-    const getTokenResult: GetTokenReturnType = {
+    const getTokenResult: GetTokenResult = {
       blocked,
       status,
       balance,
@@ -204,7 +204,7 @@ export class IntersolveVisaApiService {
   // Swagger docs https://service-integration.intersolve.nl/payment-instrument-payment/swagger/index.html
   public async getPhysicalCard(
     tokenCode: string,
-  ): Promise<GetPhysicalCardReturnType> {
+  ): Promise<GetPhysicalCardResult> {
     // Send the request
     const getPhysicalCardResponseDto =
       await this.intersolveApiRequest<GetPhysicalCardResponseIntersolveApiDto>({
@@ -215,15 +215,15 @@ export class IntersolveVisaApiService {
       });
 
     // If the response does not contain errors
-    const getPhysicalCardReturnDto: GetPhysicalCardReturnType = {
+    const getPhysicalCardReturnDto: GetPhysicalCardResult = {
       status: getPhysicalCardResponseDto.data.data.status,
     };
     return getPhysicalCardReturnDto;
   }
 
   public async getTransactionInformation(
     tokenCode: string,
-  ): Promise<GetTransactionInformationReturnType> {
+  ): Promise<GetTransactionInformationResult> {
     // get Transactions
     const getTransactionsResponseDto = await this.getTransactions({
       tokenCode,
@@ -255,7 +255,7 @@ export class IntersolveVisaApiService {
     });
 
     // Return relevant information
-    const getTransactionInformationResultDto: GetTransactionInformationReturnType =
+    const getTransactionInformationResultDto: GetTransactionInformationResult =
       {
         spentThisMonth,
         lastTransactionDate,

services/121-service/src/payments/fsp-integration/intersolve-visa/intersolve-visa.service.ts

@@ -11,10 +11,10 @@ import { IntersolveVisaCardStatus } from '@121-service/src/payments/fsp-integrat
 import { IntersolveVisaTokenStatus } from '@121-service/src/payments/fsp-integration/intersolve-visa/enums/intersolve-visa-token-status.enum';
 import { CreatePhysicalCardParams } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/create-physical-card-params.interface';
 import { DoTransferOrIssueCardParams } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/do-transfer-or-issue-card-params.interface';
-import { DoTransferOrIssueCardReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/do-transfer-or-issue-card-return-type.interface';
-import { GetPhysicalCardReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-return-type.interface';
-import { GetTokenReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-return-type.interface';
-import { GetTransactionInformationReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-return-type.interface';
+import { DoTransferOrIssueCardResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/do-transfer-or-issue-card-result.interface';
+import { GetPhysicalCardResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-physical-card-result.interface';
+import { GetTokenResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-result.interface';
+import { GetTransactionInformationResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-transaction-information-result.interface';
 import { ContactInformation } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/partials/contact-information.interface';
 import { ReissueCardParams } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/reissue-card-params.interface';
 import { SendUpdatedContactInformationParams } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/send-updated-contact-information-params.interface';
@@ -60,7 +60,7 @@ export class IntersolveVisaService
    * - Finally, it transfers money from the client's funding token to the parent token.
    *
    * @param {DoTransferOrIssueCardParams} input - The parameters for the transfer or card issuance.
-   * @returns {Promise<DoTransferOrIssueCardReturnType>} The result of the operation, including whether a card was created, whether a transfer was done, and the amount transferred in major units.
+   * @returns {Promise<DoTransferOrIssueCardResult>} The result of the operation, including whether a card was created, whether a transfer was done, and the amount transferred in major units.
    */
   public async doTransferOrIssueCard({
     registrationId,
@@ -72,7 +72,7 @@ export class IntersolveVisaService
     fundingTokenCode,
     transferAmountInMajorUnit,
     transferReference,
-  }: DoTransferOrIssueCardParams): Promise<DoTransferOrIssueCardReturnType> {
+  }: DoTransferOrIssueCardParams): Promise<DoTransferOrIssueCardResult> {
     const intersolveVisaCustomer = await this.getCustomerOrCreate({
       registrationId,
       createCustomerReference,
@@ -445,13 +445,13 @@ export class IntersolveVisaService
     intersolveVisaParentWallet: IntersolveVisaParentWalletEntity,
   ): Promise<IntersolveVisaParentWalletEntity> {
     // Get balance on the parent wallet
-    const getTokenResult: GetTokenReturnType =
+    const getTokenResult: GetTokenResult =
       await this.intersolveVisaApiService.getToken(
         intersolveVisaParentWallet.tokenCode,
       );
 
     // Get parent wallet transaction info from Intersolve
-    const getTransactionInformationResultDto: GetTransactionInformationReturnType =
+    const getTransactionInformationResultDto: GetTransactionInformationResult =
       await this.intersolveVisaApiService.getTransactionInformation(
         intersolveVisaParentWallet.tokenCode,
       );
@@ -474,14 +474,14 @@ export class IntersolveVisaService
     intersolveVisaChildWallet: IntersolveVisaChildWalletEntity,
   ): Promise<IntersolveVisaChildWalletEntity> {
     // Get child wallet information
-    const getTokenResult: GetTokenReturnType =
+    const getTokenResult: GetTokenResult =
       await this.intersolveVisaApiService.getToken(
         intersolveVisaChildWallet.tokenCode,
       );
 
     // Get card status
     if (intersolveVisaChildWallet.isDebitCardCreated) {
-      const GetPhysicalCardReturnDto: GetPhysicalCardReturnType =
+      const GetPhysicalCardReturnDto: GetPhysicalCardResult =
         await this.intersolveVisaApiService.getPhysicalCard(
           intersolveVisaChildWallet.tokenCode,
         );

services/121-service/src/payments/fsp-integration/safaricom/interfaces/transfer-result.interface.ts

@@ -0,0 +1,3 @@
+export interface TransferResult {
+  mpesaConversationId: string;
+}

services/121-service/src/payments/fsp-integration/safaricom/safaricom.service.spec.ts

@@ -1,7 +1,7 @@
 import { TestBed } from '@automock/jest';
 
 import { DoTransferParams } from '@121-service/src/payments/fsp-integration/safaricom/interfaces/do-transfer-params.interface';
-import { TransferReturnType } from '@121-service/src/payments/fsp-integration/safaricom/interfaces/transfer-return-type.interface';
+import { TransferResult } from '@121-service/src/payments/fsp-integration/safaricom/interfaces/transfer-result.interface';
 import { SafaricomTransferScopedRepository } from '@121-service/src/payments/fsp-integration/safaricom/repositories/safaricom-transfer.scoped.repository';
 import { SafaricomService } from '@121-service/src/payments/fsp-integration/safaricom/safaricom.service';
 import { SafaricomApiService } from '@121-service/src/payments/fsp-integration/safaricom/services/safaricom.api.service';
@@ -41,7 +41,7 @@ describe('SafaricomService', () => {
 
   describe('doTransfer', () => {
     it('should do transfer', async () => {
-      const transferResult: TransferReturnType = {
+      const transferResult: TransferResult = {
         mpesaConversationId: 'mocked_conversation_id',
       };
 

services/121-service/src/payments/fsp-integration/safaricom/services/safaricom.api.service.ts

@@ -5,7 +5,7 @@ import { AuthResponseSafaricomApiDto } from '@121-service/src/payments/fsp-integ
 import { TransferRequestSafaricomApiDto } from '@121-service/src/payments/fsp-integration/safaricom/dtos/safaricom-api/transfer-request-safaricom-api.dto';
 import { TransferResponseSafaricomApiDto } from '@121-service/src/payments/fsp-integration/safaricom/dtos/safaricom-api/transfer-response-safaricom-api.dto';
 import { SafaricomApiError } from '@121-service/src/payments/fsp-integration/safaricom/errors/safaricom-api.error';
-import { TransferReturnType } from '@121-service/src/payments/fsp-integration/safaricom/interfaces/transfer-return-type.interface';
+import { TransferResult } from '@121-service/src/payments/fsp-integration/safaricom/interfaces/transfer-result.interface';
 import { SafaricomApiHelperService } from '@121-service/src/payments/fsp-integration/safaricom/services/safaricom.api.helper.service';
 import { CustomHttpService } from '@121-service/src/shared/services/custom-http.service';
 import { TokenValidationService } from '@121-service/src/utils/token/token-validation.service';
@@ -30,7 +30,7 @@ export class SafaricomApiService {
     phoneNumber: string;
     idNumber: string;
     originatorConversationId: string;
-  }): Promise<TransferReturnType> {
+  }): Promise<TransferResult> {
     const payload = this.safaricomApiHelperService.createTransferPayload({
       transferAmount,
       phoneNumber,

services/121-service/src/payments/interfaces/reconciliation-return-type.interface.ts → services/121-service/src/payments/interfaces/reconciliation-result.interface.ts

@@ -1,7 +1,7 @@
 import { PaTransactionResultDto } from '@121-service/src/payments/dto/payment-transaction-result.dto';
 import { ReconciliationFeedbackDto } from '@121-service/src/payments/dto/reconciliation-feedback.dto';
 
-export class ReconciliationReturnType {
+export class ReconciliationResult {
   feedback: ReconciliationFeedbackDto;
 
   programFinancialServiceProviderConfigurationId?: number;

services/121-service/src/payments/reconciliation/excel/excel-reconciliation.service.ts

@@ -10,7 +10,7 @@ import { PaTransactionResultDto } from '@121-service/src/payments/dto/payment-tr
 import { ReconciliationFeedbackDto } from '@121-service/src/payments/dto/reconciliation-feedback.dto';
 import { ExcelFspInstructions } from '@121-service/src/payments/fsp-integration/excel/dto/excel-fsp-instructions.dto';
 import { ExcelService } from '@121-service/src/payments/fsp-integration/excel/excel.service';
-import { ReconciliationReturnType } from '@121-service/src/payments/interfaces/reconciliation-return-type.interface';
+import { ReconciliationResult } from '@121-service/src/payments/interfaces/reconciliation-result.interface';
 import { TransactionReturnDto } from '@121-service/src/payments/transactions/dto/get-transaction.dto';
 import { TransactionStatusEnum } from '@121-service/src/payments/transactions/enums/transaction-status.enum';
 import { TransactionsService } from '@121-service/src/payments/transactions/transactions.service';
@@ -191,17 +191,17 @@ export class ExcelRecociliationService {
     payment: number;
     programId: number;
     fspConfigs: ProgramFinancialServiceProviderConfigurationEntity[];
-  }): Promise<ReconciliationReturnType[]> {
+  }): Promise<ReconciliationResult[]> {
     const maxRecords = 10000;
     const validatedExcelImport = await this.fileImportService.validateCsv(
       file,
       maxRecords,
     );
 
     // First set up unfilled feedback object based on import rows ..
-    const crossFspConfigImportResults: ReconciliationReturnType[] = [];
+    const crossFspConfigImportResults: ReconciliationResult[] = [];
     for (const row of validatedExcelImport) {
-      const resultRow = new ReconciliationReturnType();
+      const resultRow = new ReconciliationResult();
       resultRow.feedback = new ReconciliationFeedbackDto();
       resultRow.feedback = {
         ...row,
@@ -262,7 +262,7 @@ export class ExcelRecociliationService {
     validatedExcelImport: object[];
     fspConfig: ProgramFinancialServiceProviderConfigurationEntity;
     matchColumn: string;
-  }): Promise<ReconciliationReturnType[]> {
+  }): Promise<ReconciliationResult[]> {
     const registrationsForReconciliation =
       await this.getRegistrationsForReconciliation(
         programId,
@@ -324,7 +324,7 @@ export class ExcelRecociliationService {
     matchColumn: string,
     existingTransactions: TransactionReturnDto[],
     fspConfigId: number,
-  ): ReconciliationReturnType[] {
+  ): ReconciliationResult[] {
     // First order registrations by referenceId to join amount from transactions
     const registrationsOrderedByReferenceId = registrations.sort((a, b) =>
       a.referenceId.localeCompare(b.referenceId),
@@ -344,7 +344,7 @@ export class ExcelRecociliationService {
       (a[matchColumn] as string).localeCompare(b[matchColumn] as string),
     );
 
-    const resultFeedback: ReconciliationReturnType[] = [];
+    const resultFeedback: ReconciliationResult[] = [];
     for (const record of importRecordsOrdered) {
       let transaction: PaTransactionResultDto | null = null;
       let importStatus = ImportStatus.notFound;

services/121-service/src/programs/programs.service.ts

@@ -7,7 +7,7 @@ import {
   FinancialServiceProviderConfigurationProperties,
   FinancialServiceProviders,
 } from '@121-service/src/financial-service-providers/enum/financial-service-provider-name.enum';
-import { GetTokenReturnType } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-return-type.interface';
+import { GetTokenResult } from '@121-service/src/payments/fsp-integration/intersolve-visa/interfaces/get-token-result.interface';
 import { IntersolveVisaService } from '@121-service/src/payments/fsp-integration/intersolve-visa/intersolve-visa.service';
 import { ProgramAttributesService } from '@121-service/src/program-attributes/program-attributes.service';
 import { ProgramFinancialServiceProviderConfigurationPropertyEntity } from '@121-service/src/program-financial-service-provider-configurations/entities/program-financial-service-provider-configuration-property.entity';
@@ -540,7 +540,7 @@ export class ProgramService {
     }
 
     // loop over all properties and return all wallets as an array
-    const wallets: GetTokenReturnType[] = [];
+    const wallets: GetTokenResult[] = [];
     for (const property of properties) {
       if (
         property.name ===