feat: void invoice (#18)

Author: StashBank

libs/stripe/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valor/nestjs-stripe",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "type": "commonjs",
   "private": false,
   "author": "opavlovskyi-valor-software",

libs/stripe/src/lib/controllers/invoice.controller.ts

@@ -8,14 +8,17 @@ import {
   Param,
   Get,
   Query,
-  Logger} from '@nestjs/common';
+  Logger,
+  Patch} from '@nestjs/common';
 import { ApiBearerAuth, ApiTags, ApiResponse } from '@nestjs/swagger';
 import {
   BaseDataResponse,
   BaseSearchInvoiceDto,
   InvoiceDto,
+  InvoiceFinalizeInvoiceDto,
   InvoicePreviewDto,
-  InvoicePreviewResponse
+  InvoicePreviewResponse,
+  InvoiceVoidInvoiceDto
 } from '../dto';
 import { StripeAuthGuard } from '../stripe-auth.guard';
 import { StripeService } from '../stripe.service';
@@ -48,4 +51,22 @@ export class InvoiceController {
     return this.stripeService.upcomingInvoicePreview(dto);
   }
 
+  @ApiResponse({ type: BaseDataResponse<InvoiceDto> })
+  @Patch(':invoiceId/void')
+  voidInvoice(
+    @Param('invoiceId') invoiceId: string,
+    @Body() dto: InvoiceVoidInvoiceDto
+  ): Promise<BaseDataResponse<InvoiceDto>> {
+    return this.stripeService.voidInvoice(invoiceId, dto);
+  }
+
+  @ApiResponse({ type: BaseDataResponse<InvoiceDto> })
+  @Patch(':invoiceId/finalize')
+  finalizeInvoice(
+    @Param('invoiceId') invoiceId: string,
+    @Body() dto: InvoiceFinalizeInvoiceDto
+  ): Promise<BaseDataResponse<InvoiceDto>> {
+    return this.stripeService.finalizeInvoice(invoiceId, dto);
+  }
+
 }

libs/stripe/src/lib/dto/index.ts

@@ -21,6 +21,7 @@ export * from './update-product.dto';
 export * from './update-customer.dto';
 export * from './save-webhook-endpoint.dto';
 export * from './save-test-clock.dto';
+export * from './update-invoice.dto';
 
 export * from './stripe/customer.dto';
 export * from './stripe/subscription-item.dto';

libs/stripe/src/lib/dto/update-invoice.dto.ts

@@ -0,0 +1,14 @@
+import { ApiPropertyOptional } from '@nestjs/swagger';
+
+export class InvoiceVoidInvoiceDto {
+  @ApiPropertyOptional({ isArray: true, type: String })
+  expand?: Array<string>;
+}
+
+export class InvoiceFinalizeInvoiceDto {
+  @ApiPropertyOptional()
+  autoAdvance?:boolean;
+
+  @ApiPropertyOptional({ isArray: true, type: String })
+  expand?: Array<string>;
+}

libs/stripe/src/lib/stripe.service.ts

@@ -59,6 +59,8 @@ import {
   ListRequestParamsDto,
   TestClockDto,
   BaseSearchInvoiceDto,
+  InvoiceVoidInvoiceDto,
+  InvoiceFinalizeInvoiceDto,
 } from './dto';
 import { StripeConfig, STRIPE_CONFIG } from './stripe.config';
 import { StripeLogger } from './stripe.logger';
@@ -1018,6 +1020,35 @@ export class StripeService {
       return this.handleError(exception, 'Search Invoices');
     }
   }
+
+  async voidInvoice(id: string, dto: InvoiceVoidInvoiceDto): Promise<BaseDataResponse<InvoiceDto>> {
+    try {
+      const invoice = await this.stripe.invoices.voidInvoice(id, {
+        expand: dto.expand
+      });
+      return {
+        success:  true,
+        data: this.invoiceToDto(invoice)
+      };
+    } catch (exception) {
+      return this.handleError(exception, 'Void Invoice');
+    }
+  }
+
+  async finalizeInvoice(id: string, dto: InvoiceFinalizeInvoiceDto): Promise<BaseDataResponse<InvoiceDto>> {
+    try {
+      const invoice = await this.stripe.invoices.finalizeInvoice(id, {
+        auto_advance: dto.autoAdvance,
+        expand: dto.expand
+      });
+      return {
+        success:  true,
+        data: this.invoiceToDto(invoice)
+      };
+    } catch (exception) {
+      return this.handleError(exception, 'Finalize Invoice');
+    }
+  }
   //#endregion
 
   //#region Quote