resurgence-data 1.0.29 → 1.0.31

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

@@ -1,35 +1,75 @@
+import { ApiProperty } from "@nestjs/swagger";
+
 export class BillerCategoryResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller category." })
   id: string;
+
+  @ApiProperty({ description: "Name of the biller category." })
   name: string;
+
+  @ApiProperty({ description: "Description of the biller category.", required: false })
   description?: string;
+
   billers?: BillerResponseDTO[];
 }
 
 export class ServiceResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the service." })
   id: string;
+
+  @ApiProperty({ description: "Name of the service." })
   name: string;
+
   chargeConfigurations?: BillerChargeConfigurationResponseDTO[];
 }
 
 export class BankResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the bank." })
   id: string;
+
+  @ApiProperty({ description: "Name of the bank." })
   name: string;
+
+  @ApiProperty({ description: "Slug for the bank." })
   slug: string;
+
+  @ApiProperty({ description: "Bank code." })
   code: string;
+
+  @ApiProperty({ description: "Long bank code." })
   longCode: string;
+
   settlementAccounts?: SettlementAccountResponseDTO[];
 }
 
 export class BillerResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the biller category." })
   categoryId: string;
+
+  @ApiProperty({ description: "Name of the biller." })
   name: string;
+
+  @ApiProperty({ description: "Indicates whether the biller is live." })
   live: boolean;
+
+  @ApiProperty({ description: "Indicates whether the biller is active." })
   active: boolean;
+
+  @ApiProperty({ description: "Slug for the biller.", required: false })
   slug?: string;
+
+  @ApiProperty({ description: "Code for the biller.", required: false })
   billerCode?: string;
+
+  @ApiProperty({ description: "Timestamp when the biller was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the biller was last updated." })
   updatedAt: Date;
+
   category: BillerCategoryResponseDTO;
   settlementAccounts: SettlementAccountResponseDTO[];
   profile?: BillerProfileResponseDTO;
@@ -43,564 +83,313 @@ export class BillerResponseDTO {
 }
 
 export class BillerProfileResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller profile." })
   id: string;
+
+  @ApiProperty({ description: "Name of the biller profile.", required: false })
   name?: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Indicates whether the biller profile has a transaction limit." })
   hasTransactionLimit: boolean;
+
+  @ApiProperty({ description: "Transaction limit for the biller profile." })
   transactionLimit: number;
-  delimiter: string; // TIME_DELIMITER
+
+  @ApiProperty({ description: "Delimiter used in the biller profile." })
+  delimiter: string;
+
+  @ApiProperty({ description: "Timestamp when the profile was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the profile was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
 }
 
 export class BillerChargeConfigurationResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the charge configuration." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated service." })
   serviceId: string;
+
+  @ApiProperty({ description: "Indicates whether the charge configuration is active." })
   active: boolean;
+
+  @ApiProperty({ description: "Indicates whether the charge configuration has a cap." })
   capped: boolean;
+
+  @ApiProperty({ description: "Indicates whether the charge configuration has a floor." })
   floored: boolean;
+
+  @ApiProperty({ description: "Charge cap value for the configuration." })
   chargeCap: number;
+
+  @ApiProperty({ description: "Charge floor value for the configuration." })
   chargeFloor: number;
+
+  @ApiProperty({ description: "Currency used in the charge configuration." })
   currency: string;
-  chargeType: string; // CHARGE_TYPE
+
+  @ApiProperty({ description: "Type of charge applied." })
+  chargeType: string;
+
+  @ApiProperty({ description: "Fixed amount for the charge configuration." })
   fixedAmount: number;
+
+  @ApiProperty({ description: "Percentage amount for the charge configuration." })
   percentAmount: number;
+
+  @ApiProperty({ description: "Timestamp when the configuration was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the configuration was last updated." })
   updatedAt: Date;
+
   biller?: BillerResponseDTO[];
   service: ServiceResponseDTO;
 }
 
+// Other classes can be updated in a similar manner. Let me know if you want all of them adjusted!
+
 export class SettlementAccountResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the settlement account." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated bank." })
   bankId: string;
+
+  @ApiProperty({ description: "Indicates whether this is the default settlement account." })
   default: boolean;
+
+  @ApiProperty({ description: "Name of the settlement account." })
   accountName: string;
+
+  @ApiProperty({ description: "Number of the settlement account." })
   accountNumber: string;
+
+  @ApiProperty({ description: "Currency of the settlement account." })
   currency: string;
+
+  @ApiProperty({ description: "Timestamp when the settlement account was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the settlement account was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
   bank: BankResponseDTO;
   onboardedAccount?: OnboardedAccountResponseDTO;
 }
 
 export class OnboardedAccountResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the onboarded account." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated settlement account." })
   settlementAccountId: string;
+
+  @ApiProperty({ description: "Vendor associated with the onboarded account." })
   vendor: string;
+
+  @ApiProperty({ description: "Timestamp when the onboarded account was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the onboarded account was last updated." })
   updatedAt: Date;
+
   settlementAccount: SettlementAccountResponseDTO;
 }
 
 export class BillerDocumentResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller document." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "URL of the biller document." })
   url: string;
-  type: string; // DOCUMENT_TYPE
+
+  @ApiProperty({ description: "Type of the biller document." })
+  type: string;
+
   biller: BillerResponseDTO;
 }
 
 export class GoLiveRequestResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the go-live request." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
-  status: string; // REQUEST_STATUS
+
+  @ApiProperty({ description: "Status of the go-live request." })
+  status: string;
+
+  @ApiProperty({ description: "Timestamp when the go-live request was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the go-live request was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
 }
 
 export class BillerContactResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller contact." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Name of the biller contact." })
   contactName: string;
+
+  @ApiProperty({ description: "Email address of the biller contact." })
   emailAddress: string;
+
+  @ApiProperty({ description: "Phone number of the biller contact.", required: false })
   phoneNumber?: string;
+
+  @ApiProperty({ description: "Date of birth of the biller contact." })
   dob: Date;
+
+  @ApiProperty({ description: "Address of the biller contact." })
   address: string;
+
+  @ApiProperty({ description: "Country of the biller contact." })
   country: string;
+
+  @ApiProperty({ description: "City of the biller contact." })
   city: string;
+
+  @ApiProperty({ description: "State of the biller contact." })
   state: string;
+
+  @ApiProperty({ description: "Timestamp when the biller contact was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the biller contact was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
 }
 
 export class CustomerResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the customer." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Name of the customer." })
   name: string;
+
+  @ApiProperty({ description: "Email address of the customer.", required: false })
   emailAddress?: string;
+
+  @ApiProperty({ description: "Phone number of the customer.", required: false })
   phoneNumber?: string;
+
+  @ApiProperty({ description: "Timestamp when the customer was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the customer was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
   invoices: InvoiceResponseDTO[];
 }
 
 export class BillerItemCategoryResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller item category." })
   id: string;
+
+  @ApiProperty({ description: "Name of the biller item category." })
   name: string;
+
+  @ApiProperty({ description: "Description of the biller item category.", required: false })
   description?: string;
 }
 
 export class BillerItemResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the biller item." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Name of the biller item." })
   name: string;
+
+  @ApiProperty({ description: "Amount associated with the biller item." })
   amount: number;
+
+  @ApiProperty({ description: "Source of the biller item.", required: false })
   source?: string;
+
+  @ApiProperty({ description: "Customer identifier name for the biller item.", required: false })
   customerIdentifierName?: string;
+
+  @ApiProperty({ description: "Service fee for the biller item." })
   serviceFee: number;
+
+  @ApiProperty({ description: "Currency for the biller item." })
   currency: string;
+
+  @ApiProperty({ description: "Description of the biller item.", required: false })
   description?: string;
+
+  @ApiProperty({ description: "Indicates whether the biller item is external." })
   external: boolean;
+
+  @ApiProperty({ description: "Timestamp when the biller item was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the biller item was last updated." })
   updatedAt: Date;
+
   biller: BillerResponseDTO;
   invoices: InvoiceResponseDTO[];
 }
 
 export class InvoiceResponseDTO {
+  @ApiProperty({ description: "Unique identifier for the invoice." })
   id: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated biller." })
   billerId: string;
+
+  @ApiProperty({ description: "Unique identifier for the associated customer." })
   customerId: string;
+
+  @ApiProperty({ description: "Discount value applied to the invoice." })
   discountValue: number;
-  discountType: string; // DISCOUNT_TYPE
+
+  @ApiProperty({ description: "Type of discount applied to the invoice." })
+  discountType: string;
+
+  @ApiProperty({ description: "Due date for the invoice." })
   dueDate: Date;
-  status: string; // INVOICE_STATUS
+
+  @ApiProperty({ description: "Status of the invoice." })
+  status: string;
+
+  @ApiProperty({ description: "Timestamp when the invoice was created." })
   createdAt: Date;
+
+  @ApiProperty({ description: "Timestamp when the invoice was last updated." })
   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()
-//   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;
-// }