resurgence-data 1.1.7 → 1.1.9

package/dist/index.d.ts

@@ -4,4 +4,4 @@ export * from "./exception";
 export * from "./user";
 export * from "./messaging";
 export * from "./biller";
-export * from "./payment/api-key";
+export * from "./payment";

package/dist/index.js

@@ -20,4 +20,4 @@ __exportStar(require("./exception"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./messaging"), exports);
 __exportStar(require("./biller"), exports);
-__exportStar(require("./payment/api-key"), exports);
+__exportStar(require("./payment"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resurgence-data",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "DTOs and shareable resources",
   "module": "dist/index.js",
   "main": "dist/index.js",

package/src/biller/biller.dto.ts

@@ -1329,149 +1329,6 @@ export class UpdateBillerItemDto extends BaseDTO {
   external?: boolean;
 }
 
-export class CreateInvoiceDto extends BaseDTO {
-  @ApiProperty({
-    description: "The ID of the biller",
-    example: "550e8400-e29b-41d4-a716-446655440000",
-  })
-  @IsNotEmpty({ message: "Biller ID must not be empty" })
-  @IsString({ message: "Biller ID must be a valid string" })
-  billerId: string;
-
-  @ApiProperty({
-    description: "The ID of the customer",
-    example: "550e8400-e29b-41d4-a716-446655440001",
-  })
-  @IsNotEmpty({ message: "Customer ID must not be empty" })
-  @IsString({ message: "Customer ID must be a valid string" })
-  customerId: string;
-
-  @ApiProperty({
-    description: "List of items",
-    example: "['550e8400-e29b-41d4-a716-446655440001','550e8400-e29b-41d4-a716-446655440001' ]",
-  })
-  @IsNotEmpty({ message: "Please provide items for this invoice" })
-  @IsArray({ message: "Please provide a list of items for this invoice" })
-  items: string[];
-
-  @ApiProperty({
-    description: "The discount value applied to the invoice",
-    example: 10.5,
-  })
-  @IsNotEmpty({ message: "Discount value must not be empty" })
-  @IsNumber(undefined, { message: "Discount value must be a valid number" })
-  discountValue: number;
-  @ApiProperty({
-    description: "Total for invoice",
-    example: 20030,
-  })
-  @IsInt({ message: "Discount value must be a valid number" })
-  total?: number;
-  @ApiProperty({
-    description: "Total for invoice service charges",
-    example: 1000,
-  })
-  @IsNumber(undefined, { message: "Discount value must be a valid number" })
-  totalService?: number;
-
-  @ApiProperty({
-    description: "The type of discount applied to the invoice",
-    example: "FIXED",
-  })
-  @IsNotEmpty({ message: "Discount type must not be empty" })
-  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
-  discountType: string;
-
-  @ApiProperty({
-    description: "The due date for the invoice",
-    example: "2025-01-31T23:59:59Z",
-  })
-  @IsNotEmpty({ message: "Due date must not be empty" })
-  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
-  dueDate: string;
-
-  @ApiProperty({
-    description: "The status of the invoice",
-    example: "PENDING",
-  })
-  @IsNotEmpty({ message: "Status must not be empty" })
-  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
-  status: string;
-}
-
-export class UpdateInvoiceDto extends BaseDTO {
-  @ApiProperty({
-    description: "The ID of the invoice",
-    example: "550e8400-e29b-41d4-a716-446655440000",
-  })
-  @IsNotEmpty({ message: "ID must not be empty" })
-  @IsString({ message: "ID must be a valid string" })
-  id: string;
-
-  @ApiProperty({
-    description: "The ID of the biller",
-    example: "550e8400-e29b-41d4-a716-446655440000",
-    required: false,
-  })
-  @IsString({ message: "Biller ID must be a valid string" })
-  @IsOptional()
-  billerId?: string;
-
-  @ApiProperty({
-    description: "List of items",
-    example: "['550e8400-e29b-41d4-a716-446655440001','550e8400-e29b-41d4-a716-446655440001' ]",
-    required: false,
-  })
-  @IsNotEmpty({ message: "Please provide items for this invoice" })
-  @IsArray({ message: "Please provide a list of items for this invoice" })
-  items?: string[];
-
-  @ApiProperty({
-    description: "The ID of the customer",
-    example: "550e8400-e29b-41d4-a716-446655440001",
-    required: false,
-  })
-  @IsString({ message: "Customer ID must be a valid string" })
-  @IsOptional()
-  customerId?: string;
-
-  @ApiProperty({
-    description: "The discount value applied to the invoice",
-    example: 10.5,
-    required: false,
-  })
-  @IsInt({ message: "Discount value must be a valid number" })
-  @IsOptional()
-  discountValue?: number;
-
-  @ApiProperty({
-    description: "The type of discount applied to the invoice",
-    example: "FIXED",
-    required: false,
-  })
-  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
-  @IsOptional()
-  discountType?: string;
-
-  @ApiProperty({
-    description: "The due date for the invoice",
-    example: "2025-01-31T23:59:59Z",
-    required: false,
-  })
-  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
-  @IsOptional()
-  dueDate?: string;
-
-  @ApiProperty({
-    description: "The status of the invoice",
-    example: "PENDING",
-    required: false,
-  })
-  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
-  @IsOptional()
-  status?: string;
-}
-
 export class EnrollBillerDto extends CreateBillerDto {
   id: string;
   chargeConfigurations?: CreateBillerChargeConfigurationDto[];

package/src/index.ts

@@ -4,4 +4,5 @@ export * from "./exception";
 export * from "./user";
 export * from "./messaging";
 export * from "./biller";
-export * from "./payment/api-key";
+export * from "./payment";
+export * from "./invoice";

package/src/invoice/index.ts

@@ -0,0 +1,2 @@
+export * from "./payment-page.dto";
+export * from "./invoice.dto";

package/src/invoice/invoice.dto.ts

@@ -0,0 +1,202 @@
+import { ApiProperty } from "@nestjs/swagger";
+import {
+  IsString,
+  IsNotEmpty,
+  IsArray,
+  IsNumber,
+  IsInt,
+  IsEnum,
+  IsDateString,
+  IsOptional,
+  Length,
+} from "class-validator";
+import { BaseDTO } from "../types/dto.type";
+
+export class CreateInvoiceDto extends BaseDTO {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The ID of the customer",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+    required: false,
+  })
+  @IsString({ message: "Customer ID must be a valid string" })
+  @IsOptional()
+  customerId?: string;
+
+  @ApiProperty({
+    description: "List of items",
+    example: "['550e8400-e29b-41d4-a716-446655440001','550e8400-e29b-41d4-a716-446655440001' ]",
+  })
+  @IsNotEmpty({ message: "Please provide items for this invoice" })
+  @IsArray({ message: "Please provide a list of items for this invoice" })
+  items: string[];
+
+  @ApiProperty({
+    description: "The discount value applied to the invoice",
+    example: 10.5,
+  })
+  @IsNotEmpty({ message: "Discount value must not be empty" })
+  @IsNumber(undefined, { message: "Discount value must be a valid number" })
+  discountValue: number;
+  @ApiProperty({
+    description: "Total for invoice",
+    example: 20030,
+  })
+  @IsInt({ message: "Discount value must be a valid number" })
+  total?: number;
+  @ApiProperty({
+    description: "Total for invoice service charges",
+    example: 1000,
+  })
+  @IsNumber(undefined, { message: "Discount value must be a valid number" })
+  totalService?: number;
+
+  @ApiProperty({
+    description: "The type of discount applied to the invoice",
+    example: "FIXED",
+  })
+  @IsNotEmpty({ message: "Discount type must not be empty" })
+  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
+  discountType: string;
+
+  @ApiProperty({
+    description: "The due date for the invoice",
+    example: "2025-01-31T23:59:59Z",
+  })
+  @IsNotEmpty({ message: "Due date must not be empty" })
+  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
+  dueDate: string;
+
+  @ApiProperty({
+    description: "The status of the invoice",
+    example: "PENDING",
+  })
+  @IsNotEmpty({ message: "Status must not be empty" })
+  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
+  status: string;
+
+  @ApiProperty({
+    description: "The customer details",
+  })
+  @IsOptional()
+  customer?: InvoiceCustomerDto;
+}
+
+export class UpdateInvoiceDto extends BaseDTO {
+  @ApiProperty({
+    description: "The ID of the invoice",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "ID must not be empty" })
+  @IsString({ message: "ID must be a valid string" })
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+    required: false,
+  })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "List of items",
+    example: "['550e8400-e29b-41d4-a716-446655440001','550e8400-e29b-41d4-a716-446655440001' ]",
+    required: false,
+  })
+  @IsNotEmpty({ message: "Please provide items for this invoice" })
+  @IsArray({ message: "Please provide a list of items for this invoice" })
+  items?: string[];
+
+  @ApiProperty({
+    description: "The ID of the customer",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+    required: false,
+  })
+  @IsString({ message: "Customer ID must be a valid string" })
+  @IsOptional()
+  customerId?: string;
+
+  @ApiProperty({
+    description: "The discount value applied to the invoice",
+    example: 10.5,
+    required: false,
+  })
+  @IsInt({ message: "Discount value must be a valid number" })
+  @IsOptional()
+  discountValue?: number;
+
+  @ApiProperty({
+    description: "The type of discount applied to the invoice",
+    example: "FIXED",
+    required: false,
+  })
+  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
+  @IsOptional()
+  discountType?: string;
+
+  @ApiProperty({
+    description: "The due date for the invoice",
+    example: "2025-01-31T23:59:59Z",
+    required: false,
+  })
+  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
+  @IsOptional()
+  dueDate?: string;
+
+  @ApiProperty({
+    description: "The status of the invoice",
+    example: "PENDING",
+    required: false,
+  })
+  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
+  @IsOptional()
+  status?: string;
+}
+
+export class InvoiceCustomerDto extends BaseDTO {
+  @ApiProperty({
+    description: "The name of the customer",
+    example: "Jane Smith",
+  })
+  @IsNotEmpty({ message: "Name must not be empty" })
+  @IsString({ message: "Name must be a valid string" })
+  @Length(1, 50, { message: "Name must be between 1 and 50 characters" })
+  name: string;
+
+  @ApiProperty({
+    description: "The email address of the customer",
+    example: "janesmith@example.com",
+    required: false,
+  })
+  @IsString({ message: "Email address must be a valid string" })
+  @Length(1, 50, { message: "Email address must be between 1 and 50 characters" })
+  @IsOptional()
+  emailAddress?: string;
+
+  @ApiProperty({
+    description: "The phone number of the customer",
+    example: "+9876543210",
+    required: false,
+  })
+  @IsString({ message: "Phone number must be a valid string" })
+  @IsOptional()
+  phoneNumber?: string;
+
+  @ApiProperty({
+    description: "Address of the customer",
+    example: "12 Fremont lane, New York",
+    required: false,
+  })
+  @IsString({ message: "Address  must be a valid string" })
+  @IsOptional()
+  address?: string;
+}

package/src/invoice/payment-page.dto.ts

@@ -0,0 +1,126 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsString, IsInt, IsOptional, IsBoolean, IsNotEmpty, IsUUID } from "class-validator";
+
+export class PaymentPageDto {
+  @ApiProperty({ description: "Payment page biller code uuid" })
+  @IsString({ message: "billerId must be a string" })
+  @IsUUID("4", { message: "billerId must be a valid id format" })
+  @IsNotEmpty({ message: "billerId should not be empty" })
+  billerId: string;
+
+  @ApiProperty({ description: "Payment page description", required: false })
+  @IsString({ message: "description must be a string" })
+  @IsOptional()
+  description?: string;
+
+  @ApiProperty({ description: "Payment page's title" })
+  @IsString({ message: "title must be a string" })
+  @IsNotEmpty({ message: "title should not be empty" })
+  title: string;
+
+  @ApiProperty({ description: "Page total amount in lowest denomination" })
+  @IsInt({ message: "totalAmount must be an integer" })
+  @IsNotEmpty({ message: "totalAmount should not be empty" })
+  totalAmount: number;
+
+  @ApiProperty({ description: "Amount's currency code", default: "NGN" })
+  @IsString({ message: "currencyCode must be a string" })
+  @IsNotEmpty({ message: "Please select a currency" })
+  currencyCode: string = "NGN";
+
+  @ApiProperty({ description: "Invoice's active status", required: false })
+  @IsBoolean({ message: "active must be a boolean" })
+  @IsOptional()
+  active?: boolean;
+
+  @ApiProperty({ description: "Url of the page", required: false })
+  @IsString({ message: "URL should be text" })
+  @IsOptional()
+  url?: boolean;
+
+  @ApiProperty({ description: "Whether pages accept user amount", required: false })
+  @IsBoolean({ message: "acceptsUserAmount must be a boolean" })
+  @IsOptional()
+  acceptsUserAmount?: boolean;
+}
+
+export class UpdatePaymentPageDto {
+  @ApiProperty({ description: "Payment page biller code uuid" })
+  @IsString({ message: "Page id  must be a string" })
+  @IsUUID("4", { message: "Id must be a valid id format" })
+  @IsNotEmpty({ message: "Page id  should not be empty" })
+  id: string;
+
+  @ApiProperty({ description: "Payment page biller code uuid", required: false })
+  @IsUUID("4", { message: "billerId must be a valid id format" })
+  @IsString({ message: "billerId must be a string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({ description: "Payment page description", required: false })
+  @IsString({ message: "description must be a string" })
+  @IsOptional()
+  description?: string;
+
+  @ApiProperty({ description: "Payment page's title", required: false })
+  @IsString({ message: "title must be a string" })
+  @IsOptional()
+  title?: string;
+
+  @ApiProperty({ description: "Page total amount in lowest denomination", required: false })
+  @IsInt({ message: "totalAmount must be an integer" })
+  @IsOptional()
+  totalAmount?: number;
+
+  @ApiProperty({ description: "Amount's currency code", default: "NGN", required: false })
+  @IsString({ message: "currencyCode must be a string" })
+  @IsNotEmpty({ message: "Please select a currency" })
+  currencyCode?: string = "NGN";
+
+  @ApiProperty({ description: "Invoice's active status", required: false })
+  @IsBoolean({ message: "active must be a boolean" })
+  @IsOptional()
+  active?: boolean;
+
+  @ApiProperty({ description: "Url of the page", required: false })
+  @IsString({ message: "URL should be text" })
+  @IsOptional()
+  url?: boolean;
+
+  @ApiProperty({ description: "Whether pages accept user amount", required: false })
+  @IsBoolean({ message: "acceptsUserAmount must be a boolean" })
+  @IsOptional()
+  acceptsUserAmount?: boolean;
+}
+
+export class PaymentPageResponseDto {
+  @ApiProperty({ description: "Payment page biller code uuid" })
+  billerId: string;
+
+  @ApiProperty({ description: "Payment page description", required: false })
+  description?: string;
+
+  @ApiProperty({ description: "Payment page's title" })
+  title: string;
+
+  @ApiProperty({ description: "Page total amount in lowest denomination" })
+  totalAmount: number;
+
+  @ApiProperty({ description: "Amount's currency code", default: "NGN" })
+  currencyCode: string;
+
+  @ApiProperty({ description: "Invoice's active status", required: false })
+  active?: boolean;
+
+  @ApiProperty({ description: "Url of the page", required: false })
+  url?: boolean;
+
+  @ApiProperty({ description: "Whether pages accept user amount", required: false })
+  acceptsUserAmount?: boolean;
+
+  @ApiProperty({ description: "Date when the page was created" })
+  createdAt: Date;
+
+  @ApiProperty({ description: "Date when the page was last updated" })
+  updatedAt: Date;
+}