Class IShippingService`Abstract`

Interface for the ShippingService.

File

apps/api/src/interfaces/IShippingService.ts

Hierarchy (View Summary)

IShippingService
- ShippingService

Index

Constructors

Methods

calculateShippingCost createDelivery getDeliveriesForUser sendTrackAndTraceEmail

Constructors

constructor

new IShippingService(): IShippingService
Returns IShippingService

Methods

`Abstract`calculateShippingCost

calculateShippingCost(orderTotal: number): IShippingCostResult
Calculates the shipping cost based on the order total.
Parameters
- orderTotal: number
  The total price of the order.
Returns IShippingCostResult
The shipping cost and total including shipping.
- Defined in apps/api/src/interfaces/IShippingService.ts:17

`Abstract`createDelivery

createDelivery(userId: number, orderTotal: number): Promise<IDeliveryResult>
Creates a fake delivery for the given user and sends a track & trace email.
Parameters
- userId: number
  The ID of the user.
- orderTotal: number
  The total price of the order.
Returns Promise<IDeliveryResult>
A DeliveryResult with track & trace code and cost details.
- Defined in apps/api/src/interfaces/IShippingService.ts:25

`Abstract`getDeliveriesForUser

getDeliveriesForUser(userId: number): Promise<IUserDelivery[]>
Retrieves all deliveries for a given user, ordered by creation date descending.
Parameters
- userId: number
  The ID of the user.
Returns Promise<IUserDelivery[]>
An array of UserDelivery objects.
- Defined in apps/api/src/interfaces/IShippingService.ts:44

`Abstract`sendTrackAndTraceEmail

sendTrackAndTraceEmail(
    email: string,
    trackAndTrace: string,
    estimatedDelivery: string,
): void
Sends a fake track & trace email to the given email address.
Parameters
- email: string
  The email address of the customer.
- trackAndTrace: string
  The track & trace code.
- estimatedDelivery: string
  The estimated delivery date.
Returns void
- Defined in apps/api/src/interfaces/IShippingService.ts:33