@passly-nl/data 1.3.2 → 1.3.4

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@passly-nl/data",
     "description": "API implementation for Passly.",
-    "version": "1.3.2",
+    "version": "1.3.4",
     "type": "module",
     "license": "MIT",
     "funding": "https://github.com/sponsors/basmilius",

package/src/adapter/OrderAdapter.ts

@@ -17,6 +17,7 @@ export class OrderAdapter {
             optional(data.payment_provider, OrderAdapter.parseOrderPaymentProvider),
             optional(data.platform_cost, PaymentAdapter.parseCost)!,
             optional(data.refunded_total, PaymentAdapter.parseCost)!,
+            data.refund_status,
             optional(data.sub_total, PaymentAdapter.parseCost)!,
             optional(data.total, PaymentAdapter.parseCost)!,
             data.url,

package/src/adapter/RefundAdapter.ts

@@ -1,6 +1,6 @@
 import { adapter, ForeignData } from '@basmilius/http-client';
 import { DateTimeAdapter, PaymentAdapter } from '#data/adapter';
-import { RefundDto, RefundInitiatorDto, RefundTicketRefDto } from '#data/dto';
+import { RefundabilityDto, RefundDto, RefundInitiatorDto, RefundTicketRefDto } from '#data/dto';
 import { optional } from '#data/util';
 
 @adapter
@@ -18,6 +18,13 @@ export class RefundAdapter {
         );
     }
 
+    static parseRefundability(data: ForeignData): RefundabilityDto {
+        return new RefundabilityDto(
+            data.supported,
+            data.reason
+        );
+    }
+
     static parseRefundInitiator(data: ForeignData): RefundInitiatorDto {
         return new RefundInitiatorDto(
             data.id,

package/src/dto/order/OrderDto.ts

@@ -1,7 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { DateTime } from 'luxon';
 import type { BuyerDto, CostDto, EventDto, MarketingAttributionDto, OrderLineDto, OrderPaymentProviderDto, PublicShopDto, TransactionDto } from '#data/dto';
-import type { OrderOrigin, OrderType } from '#data/types';
+import type { OrderOrigin, OrderRefundStatus, OrderType } from '#data/types';
 
 @dto
 export class OrderDto {
@@ -85,6 +85,14 @@ export class OrderDto {
         this.#refundedTotal = value;
     }
 
+    get refundStatus(): OrderRefundStatus {
+        return this.#refundStatus;
+    }
+
+    set refundStatus(value: OrderRefundStatus) {
+        this.#refundStatus = value;
+    }
+
     get subTotal(): CostDto {
         return this.#subTotal;
     }
@@ -167,6 +175,7 @@ export class OrderDto {
     #paymentProvider: OrderPaymentProviderDto | null;
     #platformCost: CostDto;
     #refundedTotal: CostDto;
+    #refundStatus: OrderRefundStatus;
     #subTotal: CostDto;
     #total: CostDto;
     #url: string;
@@ -177,7 +186,7 @@ export class OrderDto {
     #transaction: TransactionDto | null;
     #attribution: MarketingAttributionDto | null;
 
-    constructor(id: string, code: string, origin: OrderOrigin, type: OrderType, createdOn: DateTime, discountAmount: CostDto | null, discountCodeApplied: string | null, paymentProvider: OrderPaymentProviderDto | null, platformCost: CostDto, refundedTotal: CostDto, subTotal: CostDto, total: CostDto, url: string, buyer: BuyerDto | null, event: EventDto | null, lines: OrderLineDto[] | null, shop: PublicShopDto | null, transaction: TransactionDto | null, attribution: MarketingAttributionDto | null) {
+    constructor(id: string, code: string, origin: OrderOrigin, type: OrderType, createdOn: DateTime, discountAmount: CostDto | null, discountCodeApplied: string | null, paymentProvider: OrderPaymentProviderDto | null, platformCost: CostDto, refundedTotal: CostDto, refundStatus: OrderRefundStatus, subTotal: CostDto, total: CostDto, url: string, buyer: BuyerDto | null, event: EventDto | null, lines: OrderLineDto[] | null, shop: PublicShopDto | null, transaction: TransactionDto | null, attribution: MarketingAttributionDto | null) {
         this.#id = id;
         this.#code = code;
         this.#origin = origin;
@@ -188,6 +197,7 @@ export class OrderDto {
         this.#paymentProvider = paymentProvider;
         this.#platformCost = platformCost;
         this.#refundedTotal = refundedTotal;
+        this.#refundStatus = refundStatus;
         this.#subTotal = subTotal;
         this.#total = total;
         this.#url = url;

package/src/dto/refund/RefundabilityDto.ts

@@ -0,0 +1,29 @@
+import { dto } from '@basmilius/http-client';
+import type { RefundabilityReason } from '#data/types';
+
+@dto
+export class RefundabilityDto {
+    get supported(): boolean {
+        return this.#supported;
+    }
+
+    set supported(value: boolean) {
+        this.#supported = value;
+    }
+
+    get reason(): RefundabilityReason | null {
+        return this.#reason;
+    }
+
+    set reason(value: RefundabilityReason | null) {
+        this.#reason = value;
+    }
+
+    #supported: boolean;
+    #reason: RefundabilityReason | null;
+
+    constructor(supported: boolean, reason: RefundabilityReason | null) {
+        this.#supported = supported;
+        this.#reason = reason;
+    }
+}

package/src/dto/refund/index.ts

@@ -1,3 +1,4 @@
+export * from './RefundabilityDto';
 export * from './RefundDto';
 export * from './RefundInitiatorDto';
 export * from './RefundTicketRefDto';

package/src/service/MerchantOrderService.ts

@@ -1,6 +1,6 @@
 import { BaseResponse, BaseService, BlobResponse, QueryString } from '@basmilius/http-client';
 import { CashFlowAdapter, OrderAdapter, RefundAdapter, TicketAdapter } from '#data/adapter';
-import type { CashFlowDto, OrderDto, RefundDto, TicketDto } from '#data/dto';
+import type { CashFlowDto, OrderDto, RefundabilityDto, RefundDto, TicketDto } from '#data/dto';
 import type { RefundReason } from '#data/types';
 
 export class MerchantOrderService extends BaseService {
@@ -24,6 +24,14 @@ export class MerchantOrderService extends BaseService {
             .runAdapter(CashFlowAdapter.parseCashFlow);
     }
 
+    async getRefundability(merchantId: string, orderId: string): Promise<BaseResponse<RefundabilityDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/orders/${orderId}/refundability`)
+            .method('get')
+            .bearerToken()
+            .runAdapter(RefundAdapter.parseRefundability);
+    }
+
     async getPasses(merchantId: string, orderId: string): Promise<BlobResponse> {
         return await this
             .request(`/merchants/${merchantId}/orders/${orderId}/passes`)

package/src/types/order.ts

@@ -2,6 +2,11 @@ export type OrderOrigin =
     | 'local'
     | 'ticketswap';
 
+export type OrderRefundStatus =
+    | 'not_refunded'
+    | 'partially_refunded'
+    | 'fully_refunded';
+
 export type OrderType =
     | 'default'
     | 'guest';

package/src/types/refund.ts

@@ -10,3 +10,9 @@ export type RefundStatus =
     | 'processing'
     | 'completed'
     | 'failed';
+
+export type RefundabilityReason =
+    | 'no_provider'
+    | 'order_not_refundable'
+    | 'provider_not_capable'
+    | 'transaction_not_paid';