Add subType for beneficiary, remove deprecated fields later

Client/Beneficiaries/index.ts

@@ -24,7 +24,7 @@ export class Beneficiaries extends List<model.BeneficiaryResponse> {
 	async getBeneficiary(beneficiaryId: string) {
 		return await this.connection.get<model.BeneficiaryResponse>([this.folder, beneficiaryId].join("/"))
 	}
-	async searchBeneficiary(request: model.SearchBeneficiaryRequest, sort?: string) {
+	async searchBeneficiary(request: model.BeneficiarySearchRequest, sort?: string) {
 		const response = await this.connection.post<model.ErrorResponse | model.BeneficiaryResponse[]>(
 			`${this.folder}/searches`,
 			request,

index.ts

@@ -24,8 +24,12 @@ import {
 	AvailableCardTypesResponse,
 	Batch,
 	BeneficiaryRequest,
+	BeneficiaryRequestStatus,
 	BeneficiaryResponse,
+	BeneficiarySearchRequest,
 	BeneficiaryStatus,
+	BeneficiarySubType,
+	BeneficiarySubTypeSearch,
 	BeneficiaryTransferDestinationResponse,
 	BillingTransactionAmountPair,
 	BookedProductInfo,
@@ -200,7 +204,6 @@ import {
 	Room,
 	ScheduledTaskRequest,
 	ScheduleEntry,
-	SearchBeneficiaryRequest,
 	SearchRolesetsRequest,
 	Segment,
 	SetAvailableCardTypesRequest,
@@ -286,8 +289,11 @@ export {
 	AvailableCardTypesResponse,
 	Batch,
 	BeneficiaryRequest,
+	BeneficiaryRequestStatus,
 	BeneficiaryResponse,
 	BeneficiaryStatus,
+	BeneficiarySubType,
+	BeneficiarySubTypeSearch,
 	BeneficiaryTransferDestinationResponse,
 	BillingTransactionAmountPair,
 	BookedProductInfo,
@@ -469,7 +475,7 @@ export {
 	SftpReportFileDestination,
 	Segment,
 	SsoLoginRequest,
-	SearchBeneficiaryRequest,
+	BeneficiarySearchRequest,
 	StatementReportRequest,
 	StatementReportResponse,
 	StatementReportResponseRow,

model/BeneficiaryRequest.ts

@@ -1,20 +1,24 @@
 import { isly } from "isly"
-import { BeneficiaryStatus } from "./BeneficiaryStatus"
+import { BeneficiaryRequestStatus } from "./BeneficiaryRequestStatus"
+import { BeneficiarySubType } from "./BeneficiarySubType"
 import { TransferDestinationRequest } from "./TransferDestinationRequest"
 
 export interface BeneficiaryRequest {
 	transferDestination: TransferDestinationRequest
 	defaultReference?: string
 	name?: string
-	status?: BeneficiaryStatus
+	//Deprecated, remove when ACTIVE_REBATE gone
+	status?: BeneficiaryRequestStatus
+	subtype?: BeneficiarySubType
 	rebateQualifier?: string
 }
 export namespace BeneficiaryRequest {
 	export const type = isly.object<BeneficiaryRequest>({
 		transferDestination: TransferDestinationRequest.type,
 		defaultReference: isly.string().optional(),
 		name: isly.string().optional(),
-		status: isly.fromIs("BeneficiaryStatus", BeneficiaryStatus.is).optional(),
+		status: isly.fromIs("BeneficiaryRequestStatus", BeneficiaryRequestStatus.is).optional(),
+		subtype: isly.fromIs("BeneficiarySubType", BeneficiarySubType.is).optional(),
 		rebateQualifier: isly.string().optional(),
 	})
 	export const is = type.is

model/BeneficiaryRequestStatus.ts

@@ -0,0 +1,10 @@
+import { isly } from "isly"
+
+export type BeneficiaryRequestStatus = typeof BeneficiaryRequestStatus.values[number]
+
+//ACTIVE_REBATE and ACTIVE_MERCHANT are deprecated, but we keep them here for backward compatibility
+export namespace BeneficiaryRequestStatus {
+	export const values = ["ACTIVE", "ACTIVE_REBATE", "ACTIVE_MERCHANT", "DELETED", "OUTDATED", "INACTIVE"] as const
+	export const type = isly.string<BeneficiaryRequestStatus>(values)
+	export const is = type.is
+}

model/BeneficiaryResponse.ts

@@ -1,16 +1,18 @@
 import { isly } from "isly"
 import { AccountDetailsTransferDestinationResponse } from "./AccountDetailsTransferDestinationResponse"
-import { BeneficiaryStatus } from "./BeneficiaryStatus"
+import { BeneficiaryRequestStatus } from "./BeneficiaryRequestStatus"
+import { BeneficiarySubType } from "./BeneficiarySubType"
 import { TransferDestinationResponse } from "./TransferDestinationResponse"
 
 export interface BeneficiaryResponse<
 	T extends TransferDestinationResponse = AccountDetailsTransferDestinationResponse
 > {
 	transferDestination: T
-	status: BeneficiaryStatus
+	status: BeneficiaryRequestStatus
 	name: string
 	beneficiaryId: string
 	createdOn: string
+	subType?: BeneficiarySubType
 	defaultReference?: string
 	rebateQualifier?: string
 	history?: BeneficiaryResponse<T>[]
@@ -19,10 +21,11 @@ export interface BeneficiaryResponse<
 export namespace BeneficiaryResponse {
 	export const type = isly.object<BeneficiaryResponse<TransferDestinationResponse>>({
 		transferDestination: isly.fromIs("TransferDestinationResponse", TransferDestinationResponse.is),
-		status: isly.fromIs("BeneficiaryStatus", BeneficiaryStatus.is),
+		status: isly.fromIs("BeneficiaryRequestStatus", BeneficiaryRequestStatus.is),
 		name: isly.string(),
 		beneficiaryId: isly.string(),
 		createdOn: isly.string(),
+		subType: isly.fromIs("BeneficiarySubType", BeneficiarySubType.is).optional(),
 		defaultReference: isly.string().optional(),
 		rebateQualifier: isly.string().optional(),
 		history: isly.fromIs("BeneficiaryResponse[]", Array.isArray).optional(), // Not checking same type because of risk of being slow

model/BeneficiarySearchRequest.ts

@@ -0,0 +1,17 @@
+import { Currency } from "isoly"
+import { BeneficiaryRequestStatus } from "./BeneficiaryRequestStatus"
+import { BeneficiarySubTypeSearch } from "./BeneficiarySubTypeSearch"
+import { TransferDestinationAddressType } from "./TransferDestinationAddressType"
+
+export interface BeneficiarySearchRequest {
+	defaultReference?: string
+	currency?: Currency[]
+	type?: TransferDestinationAddressType
+	status?: BeneficiaryRequestStatus[]
+	subtype?: BeneficiarySubTypeSearch[]
+	name?: string
+	fullName?: string
+	fuzzySearch?: string
+	autoPopulateRebate?: boolean
+	rebateQualifier?: string
+}

model/BeneficiaryStatus.ts

@@ -1,4 +1,4 @@
-const beneficiaryStatus = ["ACTIVE", "DELETED", "OUTDATED", "ACTIVE_MERCHANT", "ACTIVE_REBATE"] as const
+const beneficiaryStatus = ["ACTIVE", "DELETED", "OUTDATED", "INACTIVE"] as const
 
 export type BeneficiaryStatus = typeof beneficiaryStatus[number]
 

model/BeneficiarySubType.ts

@@ -0,0 +1,9 @@
+import { isly } from "isly"
+
+export type BeneficiarySubType = typeof BeneficiarySubType.values[number]
+
+export namespace BeneficiarySubType {
+	export const values = ["REBATE", "MERCHANT"] as const
+	export const type = isly.string<BeneficiarySubType>(values)
+	export const is = type.is
+}

model/BeneficiarySubTypeSearch.ts

@@ -0,0 +1,9 @@
+import { isly } from "isly"
+
+export type BeneficiarySubTypeSearch = typeof BeneficiarySubTypeSearch.values[number]
+
+export namespace BeneficiarySubTypeSearch {
+	export const values = ["REBATE", "MERCHANT", "NONE"] as const
+	export const type = isly.string<BeneficiarySubTypeSearch>(values)
+	export const is = type.is
+}

model/UpdateBeneficiaryRequest.ts

@@ -1,10 +1,10 @@
-import { BeneficiaryStatus } from "./BeneficiaryStatus"
+import { BeneficiaryRequestStatus } from "./BeneficiaryRequestStatus"
 import { TransferDestinationRequest } from "./TransferDestinationRequest"
 
 export interface UpdateBeneficiaryRequest {
 	transferDestination?: TransferDestinationRequest
 	defaultReference?: string
-	status?: BeneficiaryStatus
+	status?: BeneficiaryRequestStatus
 	name?: string
 	fullName?: string
 }

model/index.ts

@@ -22,8 +22,12 @@ import { AvailableCardTypesHasResponse } from "./AvailableCardTypesHasResponse"
 import { AvailableCardTypesResponse } from "./AvailableCardTypesResponse"
 import { Batch } from "./Batch"
 import { BeneficiaryRequest } from "./BeneficiaryRequest"
+import { BeneficiaryRequestStatus } from "./BeneficiaryRequestStatus"
 import { BeneficiaryResponse } from "./BeneficiaryResponse"
+import { BeneficiarySearchRequest } from "./BeneficiarySearchRequest"
 import { BeneficiaryStatus } from "./BeneficiaryStatus"
+import { BeneficiarySubType } from "./BeneficiarySubType"
+import { BeneficiarySubTypeSearch } from "./BeneficiarySubTypeSearch"
 import { BeneficiaryTransferDestinationResponse } from "./BeneficiaryTransferDestinationResponse"
 import { BillingTransactionAmountPair } from "./BillingTransactionAmountPair"
 import { BookedProductInfo } from "./BookedProductInfo"
@@ -201,7 +205,6 @@ import { Room } from "./Room"
 import { ScheduledTaskRequest } from "./ScheduledTaskRequest"
 import { ScheduleEntry } from "./ScheduleEntry"
 import { Scheme } from "./Scheme"
-import { SearchBeneficiaryRequest } from "./SearchBeneficiaryRequest"
 import { SearchRolesetsRequest } from "./SearchRolesetsRequest"
 import { Segment } from "./Segment"
 import { SetAvailableCardTypesRequest } from "./SetAvailableCardTypesRequest"
@@ -286,8 +289,11 @@ export {
 	AvailableCardTypesResponse,
 	Batch,
 	BeneficiaryRequest,
+	BeneficiaryRequestStatus,
 	BeneficiaryResponse,
 	BeneficiaryStatus,
+	BeneficiarySubType,
+	BeneficiarySubTypeSearch,
 	BeneficiaryTransferDestinationResponse,
 	BillingTransactionAmountPair,
 	BookedProductInfo,
@@ -470,7 +476,7 @@ export {
 	SftpReportFileDestination,
 	Segment,
 	SsoLoginRequest,
-	SearchBeneficiaryRequest,
+	BeneficiarySearchRequest,
 	StatementReportRequest,
 	StatementReportResponse,
 	StatementReportResponseRow,