resurgence-data 1.0.25 → 1.0.27

package/src/biller/biller-response.dto.ts

@@ -1,599 +1,599 @@
-// export class BillerCategoryResponseDTO {
-//   id: string;
-//   name: string;
-//   description?: string;
-//   billers?: BillerResponseDTO[];
-// }
-
-// export class ServiceResponseDTO {
-//   id: string;
-//   name: string;
-//   chargeConfigurations?: BillerChargeConfigurationResponseDTO[];
-// }
-
-// export class BankResponseDTO {
-//   id: string;
-//   name: string;
-//   slug: string;
-//   code: string;
-//   longCode: string;
-//   settlementAccounts?: SettlementAccountResponseDTO[];
-// }
-
-// export class BillerResponseDTO {
-//   id: string;
-//   categoryId: string;
-//   name: string;
-//   live: boolean;
-//   active: boolean;
-//   slug?: string;
-//   billerCode?: string;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   category: BillerCategoryResponseDTO;
-//   settlementAccounts: SettlementAccountResponseDTO[];
-//   profile?: BillerProfileResponseDTO;
-//   chargeConfigurations: BillerChargeConfigurationResponseDTO[];
-//   goLiveRequest?: GoLiveRequestResponseDTO;
-//   documents: BillerDocumentResponseDTO[];
-//   contact?: BillerContactResponseDTO;
-//   customers: CustomerResponseDTO[];
-//   items: BillerItemResponseDTO[];
-//   invoices: InvoiceResponseDTO[];
-// }
-
-// export class BillerProfileResponseDTO {
-//   id: string;
-//   name?: string;
-//   billerId: string;
-//   hasTransactionLimit: boolean;
-//   transactionLimit: number;
-//   delimiter: string; // TIME_DELIMITER
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-// }
-
-// export class BillerChargeConfigurationResponseDTO {
-//   id: string;
-//   serviceId: string;
-//   active: boolean;
-//   capped: boolean;
-//   floored: boolean;
-//   chargeCap: number;
-//   chargeFloor: number;
-//   currency: string;
-//   chargeType: string; // CHARGE_TYPE
-//   fixedAmount: number;
-//   percentAmount: number;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller?: BillerResponseDTO[];
-//   service: ServiceResponseDTO;
-// }
-
-// export class SettlementAccountResponseDTO {
-//   id: string;
-//   billerId: string;
-//   bankId: string;
-//   default: boolean;
-//   accountName: string;
-//   accountNumber: string;
-//   currency: string;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-//   bank: BankResponseDTO;
-//   onboardedAccount?: OnboardedAccountResponseDTO;
-// }
-
-// export class OnboardedAccountResponseDTO {
-//   id: string;
-//   settlementAccountId: string;
-//   vendor: string;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   settlementAccount: SettlementAccountResponseDTO;
-// }
-
-// export class BillerDocumentResponseDTO {
-//   id: string;
-//   billerId: string;
-//   url: string;
-//   type: string; // DOCUMENT_TYPE
-//   biller: BillerResponseDTO;
-// }
-
-// export class GoLiveRequestResponseDTO {
-//   id: string;
-//   billerId: string;
-//   status: string; // REQUEST_STATUS
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-// }
-
-// export class BillerContactResponseDTO {
-//   id: string;
-//   billerId: string;
-//   contactName: string;
-//   emailAddress: string;
-//   phoneNumber?: string;
-//   dob: Date;
-//   address: string;
-//   country: string;
-//   city: string;
-//   state: string;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-// }
-
-// export class CustomerResponseDTO {
-//   id: string;
-//   billerId: string;
-//   name: string;
-//   emailAddress?: string;
-//   phoneNumber?: string;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-//   invoices: InvoiceResponseDTO[];
-// }
-
-// export class BillerItemResponseDTO {
-//   id: string;
-//   billerId: string;
-//   amount: number;
-//   source?: string;
-//   customerIdentifierName?: string;
-//   serviceFee: number;
-//   currency: string;
-//   description?: string;
-//   external: boolean;
-//   createdAt: Date;
-//   updatedAt: Date;
-//   biller: BillerResponseDTO;
-//   invoices: InvoiceResponseDTO[];
-// }
-
-// export class InvoiceResponseDTO {
-//   id: string;
-//   billerId: string;
-//   customerId: string;
-//   discountValue: number;
-//   discountType: string; // DISCOUNT_TYPE
-//   dueDate: Date;
-//   status: string; // INVOICE_STATUS
-//   createdAt: Date;
-//   updatedAt: Date;
-//   billerItems: BillerItemResponseDTO[];
-//   biller: BillerResponseDTO;
-//   customer: CustomerResponseDTO;
-// }
-
-import { ApiProperty } from "@nestjs/swagger";
-
 export class BillerCategoryResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   name: string;
-
-  @ApiProperty({ required: false })
   description?: string;
-
-  @ApiProperty()
   billers?: BillerResponseDTO[];
 }
 
 export class ServiceResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   name: string;
-
-  @ApiProperty()
   chargeConfigurations?: BillerChargeConfigurationResponseDTO[];
 }
 
 export class BankResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   name: string;
-
-  @ApiProperty()
   slug: string;
-
-  @ApiProperty()
   code: string;
-
-  @ApiProperty()
   longCode: string;
-
-  @ApiProperty()
   settlementAccounts?: SettlementAccountResponseDTO[];
 }
 
 export class BillerResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   categoryId: string;
-
-  @ApiProperty()
   name: string;
-
-  @ApiProperty()
   live: boolean;
-
-  @ApiProperty()
   active: boolean;
-
-  @ApiProperty({ required: false })
   slug?: string;
-
-  @ApiProperty({ required: false })
   billerCode?: string;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   category: BillerCategoryResponseDTO;
-
-  @ApiProperty()
   settlementAccounts: SettlementAccountResponseDTO[];
-
-  @ApiProperty({ required: false })
   profile?: BillerProfileResponseDTO;
-
-  @ApiProperty()
   chargeConfigurations: BillerChargeConfigurationResponseDTO[];
-
-  @ApiProperty({ required: false })
   goLiveRequest?: GoLiveRequestResponseDTO;
-
-  @ApiProperty()
   documents: BillerDocumentResponseDTO[];
-
-  @ApiProperty({ required: false })
   contact?: BillerContactResponseDTO;
-
-  @ApiProperty()
   customers: CustomerResponseDTO[];
-
-  @ApiProperty()
   items: BillerItemResponseDTO[];
-
-  @ApiProperty()
   invoices: InvoiceResponseDTO[];
 }
 
 export class BillerProfileResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty({ required: false })
   name?: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   hasTransactionLimit: boolean;
-
-  @ApiProperty()
   transactionLimit: number;
-
-  @ApiProperty()
-  delimiter: string;
-
-  @ApiProperty()
+  delimiter: string; // TIME_DELIMITER
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
 }
 
 export class BillerChargeConfigurationResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   serviceId: string;
-
-  @ApiProperty()
   active: boolean;
-
-  @ApiProperty()
   capped: boolean;
-
-  @ApiProperty()
   floored: boolean;
-
-  @ApiProperty()
   chargeCap: number;
-
-  @ApiProperty()
   chargeFloor: number;
-
-  @ApiProperty()
   currency: string;
-
-  @ApiProperty()
-  chargeType: string;
-
-  @ApiProperty()
+  chargeType: string; // CHARGE_TYPE
   fixedAmount: number;
-
-  @ApiProperty()
   percentAmount: number;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty({ required: false })
   biller?: BillerResponseDTO[];
-
-  @ApiProperty()
   service: ServiceResponseDTO;
 }
 
 export class SettlementAccountResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   bankId: string;
-
-  @ApiProperty()
   default: boolean;
-
-  @ApiProperty()
   accountName: string;
-
-  @ApiProperty()
   accountNumber: string;
-
-  @ApiProperty()
   currency: string;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
-
-  @ApiProperty()
   bank: BankResponseDTO;
-
-  @ApiProperty({ required: false })
   onboardedAccount?: OnboardedAccountResponseDTO;
 }
 
 export class OnboardedAccountResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   settlementAccountId: string;
-
-  @ApiProperty()
   vendor: string;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   settlementAccount: SettlementAccountResponseDTO;
 }
 
 export class BillerDocumentResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   url: string;
-
-  @ApiProperty()
-  type: string;
-
-  @ApiProperty()
+  type: string; // DOCUMENT_TYPE
   biller: BillerResponseDTO;
 }
 
 export class GoLiveRequestResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
-  status: string;
-
-  @ApiProperty()
+  status: string; // REQUEST_STATUS
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
 }
 
 export class BillerContactResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   contactName: string;
-
-  @ApiProperty()
   emailAddress: string;
-
-  @ApiProperty({ required: false })
   phoneNumber?: string;
-
-  @ApiProperty()
   dob: Date;
-
-  @ApiProperty()
   address: string;
-
-  @ApiProperty()
   country: string;
-
-  @ApiProperty()
   city: string;
-
-  @ApiProperty()
   state: string;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
 }
 
 export class CustomerResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   name: string;
-
-  @ApiProperty({ required: false })
   emailAddress?: string;
-
-  @ApiProperty({ required: false })
   phoneNumber?: string;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
-
-  @ApiProperty()
   invoices: InvoiceResponseDTO[];
 }
 
 export class BillerItemResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   amount: number;
-
-  @ApiProperty({ required: false })
   source?: string;
-
-  @ApiProperty({ required: false })
   customerIdentifierName?: string;
-
-  @ApiProperty()
   serviceFee: number;
-
-  @ApiProperty()
   currency: string;
-
-  @ApiProperty({ required: false })
   description?: string;
-
-  @ApiProperty()
   external: boolean;
-
-  @ApiProperty()
   createdAt: Date;
-
-  @ApiProperty()
   updatedAt: Date;
-
-  @ApiProperty()
   biller: BillerResponseDTO;
-
-  @ApiProperty()
   invoices: InvoiceResponseDTO[];
 }
 
 export class InvoiceResponseDTO {
-  @ApiProperty()
   id: string;
-
-  @ApiProperty()
   billerId: string;
-
-  @ApiProperty()
   customerId: string;
-
-  @ApiProperty()
   discountValue: number;
+  discountType: string; // DISCOUNT_TYPE
+  dueDate: Date;
+  status: string; // INVOICE_STATUS
+  createdAt: Date;
+  updatedAt: Date;
+  billerItems: BillerItemResponseDTO[];
+  biller: BillerResponseDTO;
+  customer: CustomerResponseDTO;
+}
 
-  @ApiProperty()
-  discountType: string;
+// import { ApiProperty } from "@nestjs/swagger";
 
-  @ApiProperty()
-  dueDate: Date;
+// export class BillerCategoryResponseDTO {
+//   @ApiProperty()
+//   id: string;
 
-  @ApiProperty()
-  status: string;
+//   @ApiProperty()
+//   name: string;
 
-  @ApiProperty()
-  createdAt: Date;
+//   @ApiProperty({ required: false })
+//   description?: string;
 
-  @ApiProperty()
-  updatedAt: Date;
+//   @ApiProperty()
+//   billers?: BillerResponseDTO[];
+// }
 
-  @ApiProperty()
-  billerItems: BillerItemResponseDTO[];
+// export class ServiceResponseDTO {
+//   @ApiProperty()
+//   id: string;
 
-  @ApiProperty()
-  biller: BillerResponseDTO;
+//   @ApiProperty()
+//   name: string;
 
-  @ApiProperty()
-  customer: CustomerResponseDTO;
-}
+//   @ApiProperty()
+//   chargeConfigurations?: BillerChargeConfigurationResponseDTO[];
+// }
+
+// export class BankResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   name: string;
+
+//   @ApiProperty()
+//   slug: string;
+
+//   @ApiProperty()
+//   code: string;
+
+//   @ApiProperty()
+//   longCode: string;
+
+//   @ApiProperty()
+//   settlementAccounts?: SettlementAccountResponseDTO[];
+// }
+
+// export class BillerResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   categoryId: string;
+
+//   @ApiProperty()
+//   name: string;
+
+//   @ApiProperty()
+//   live: boolean;
+
+//   @ApiProperty()
+//   active: boolean;
+
+//   @ApiProperty({ required: false })
+//   slug?: string;
+
+//   @ApiProperty({ required: false })
+//   billerCode?: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   category: BillerCategoryResponseDTO;
+
+//   @ApiProperty()
+//   settlementAccounts: SettlementAccountResponseDTO[];
+
+//   @ApiProperty({ required: false })
+//   profile?: BillerProfileResponseDTO;
+
+//   @ApiProperty()
+//   chargeConfigurations: BillerChargeConfigurationResponseDTO[];
+
+//   @ApiProperty({ required: false })
+//   goLiveRequest?: GoLiveRequestResponseDTO;
+
+//   @ApiProperty()
+//   documents: BillerDocumentResponseDTO[];
+
+//   @ApiProperty({ required: false })
+//   contact?: BillerContactResponseDTO;
+
+//   @ApiProperty()
+//   customers: CustomerResponseDTO[];
+
+//   @ApiProperty()
+//   items: BillerItemResponseDTO[];
+
+//   @ApiProperty()
+//   invoices: InvoiceResponseDTO[];
+// }
+
+// export class BillerProfileResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty({ required: false })
+//   name?: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   hasTransactionLimit: boolean;
+
+//   @ApiProperty()
+//   transactionLimit: number;
+
+//   @ApiProperty()
+//   delimiter: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+// }
+
+// export class BillerChargeConfigurationResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   serviceId: string;
+
+//   @ApiProperty()
+//   active: boolean;
+
+//   @ApiProperty()
+//   capped: boolean;
+
+//   @ApiProperty()
+//   floored: boolean;
+
+//   @ApiProperty()
+//   chargeCap: number;
+
+//   @ApiProperty()
+//   chargeFloor: number;
+
+//   @ApiProperty()
+//   currency: string;
+
+//   @ApiProperty()
+//   chargeType: string;
+
+//   @ApiProperty()
+//   fixedAmount: number;
+
+//   @ApiProperty()
+//   percentAmount: number;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty({ required: false })
+//   biller?: BillerResponseDTO[];
+
+//   @ApiProperty()
+//   service: ServiceResponseDTO;
+// }
+
+// export class SettlementAccountResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   bankId: string;
+
+//   @ApiProperty()
+//   default: boolean;
+
+//   @ApiProperty()
+//   accountName: string;
+
+//   @ApiProperty()
+//   accountNumber: string;
+
+//   @ApiProperty()
+//   currency: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+
+//   @ApiProperty()
+//   bank: BankResponseDTO;
+
+//   @ApiProperty({ required: false })
+//   onboardedAccount?: OnboardedAccountResponseDTO;
+// }
+
+// export class OnboardedAccountResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   settlementAccountId: string;
+
+//   @ApiProperty()
+//   vendor: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   settlementAccount: SettlementAccountResponseDTO;
+// }
+
+// export class BillerDocumentResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   url: string;
+
+//   @ApiProperty()
+//   type: string;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+// }
+
+// export class GoLiveRequestResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   status: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+// }
+
+// export class BillerContactResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   contactName: string;
+
+//   @ApiProperty()
+//   emailAddress: string;
+
+//   @ApiProperty({ required: false })
+//   phoneNumber?: string;
+
+//   @ApiProperty()
+//   dob: Date;
+
+//   @ApiProperty()
+//   address: string;
+
+//   @ApiProperty()
+//   country: string;
+
+//   @ApiProperty()
+//   city: string;
+
+//   @ApiProperty()
+//   state: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+// }
+
+// export class CustomerResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   name: string;
+
+//   @ApiProperty({ required: false })
+//   emailAddress?: string;
+
+//   @ApiProperty({ required: false })
+//   phoneNumber?: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+
+//   @ApiProperty()
+//   invoices: InvoiceResponseDTO[];
+// }
+
+// export class BillerItemResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   amount: number;
+
+//   @ApiProperty({ required: false })
+//   source?: string;
+
+//   @ApiProperty({ required: false })
+//   customerIdentifierName?: string;
+
+//   @ApiProperty()
+//   serviceFee: number;
+
+//   @ApiProperty()
+//   currency: string;
+
+//   @ApiProperty({ required: false })
+//   description?: string;
+
+//   @ApiProperty()
+//   external: boolean;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+
+//   @ApiProperty()
+//   invoices: InvoiceResponseDTO[];
+// }
+
+// export class InvoiceResponseDTO {
+//   @ApiProperty()
+//   id: string;
+
+//   @ApiProperty()
+//   billerId: string;
+
+//   @ApiProperty()
+//   customerId: string;
+
+//   @ApiProperty()
+//   discountValue: number;
+
+//   @ApiProperty()
+//   discountType: string;
+
+//   @ApiProperty()
+//   dueDate: Date;
+
+//   @ApiProperty()
+//   status: string;
+
+//   @ApiProperty()
+//   createdAt: Date;
+
+//   @ApiProperty()
+//   updatedAt: Date;
+
+//   @ApiProperty()
+//   billerItems: BillerItemResponseDTO[];
+
+//   @ApiProperty()
+//   biller: BillerResponseDTO;
+
+//   @ApiProperty()
+//   customer: CustomerResponseDTO;
+// }