@aptly-as/types 3.1.5 → 3.2.1

package/core/webhook-event-data.d.ts

@@ -32,7 +32,7 @@ export declare namespace AptlyWebhookEventData {
         project: Project<ID, DATE>;
         unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name' | 'shipping' | 'users'>;
         order: AptlyOrderSchema<ID, DATE>;
-        offer?: Pick<AptlyOfferSchema<ID, DATE>, '_id' | 'name' | 'number'>;
+        offer?: Pick<AptlyOfferSchema<ID, DATE>, '_id' | 'name' | 'number' | 'description'>;
         receiptUrl?: string;
         signedReceiptUrl?: string;
     }

package/models/algorithm.d.ts

@@ -83,16 +83,26 @@ export interface AptlyExtensionPrice extends AptlyExtensionAmount {
     price?: AptlyPrice;
     currency: AptlyCurrency;
 }
+export interface AptlyLegalMonetaryTotal {
+    lineExtensionAmount: number;
+    taxExclusiveAmount: number;
+    taxInclusiveAmount: number;
+    allowanceTotalAmount: number;
+    chargeTotalAmount: number;
+}
 export interface AptlyAllowance {
     amount?: number;
     multiplier?: number;
     incVAT?: boolean;
 }
 export type AptlyAllowanceCharge<CHARGE extends boolean> = AptlyAllowanceChargeSchema<string, CHARGE>;
+export type AptlyAllowanceChargeItem<CHARGE extends boolean> = AptlyAllowanceChargeItemSchema<string, CHARGE>;
+export type AptlyAllowanceChargeItemSchema<ID, CHARGE extends boolean> = Omit<AptlyAllowanceChargeSchema<ID, CHARGE>, 'vatCategory'>;
 export interface AptlyAllowanceChargeSchema<ID, CHARGE extends boolean> extends AptlyAllowance {
     _id: ID;
     chargeIndicator: CHARGE;
     code: CHARGE extends true ? AptlyChargeReasonCode : AptlyAllowanceReasonCode;
     reason: string;
     baseAmount?: number;
+    vatCategory?: AptlyVatCategory;
 }

package/models/offer.d.ts

@@ -1,6 +1,6 @@
 import { Populated } from '../core/mongoose.js';
 import { AptlyAddress, AptlySearchAddress } from './address.js';
-import { AptlyAllowance, AptlyExtensionAmount } from './algorithm.js';
+import { AptlyAllowance, AptlyAllowanceChargeSchema, AptlyExtensionAmount, AptlyLegalMonetaryTotal } from './algorithm.js';
 import { AptlyCustomer, AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyBaseSchema } from './extends.js';
@@ -78,4 +78,6 @@ export interface AptlyPublicOfferCheckoutSchema<ID, DATE> extends AptlyExtension
             active: boolean;
         };
     };
+    total: AptlyLegalMonetaryTotal;
+    allowanceCharges: AptlyAllowanceChargeSchema<ID, boolean>[];
 }

package/models/option.d.ts

@@ -1,5 +1,5 @@
 import { AptlyQuantityUnitCode } from '../enums/index.js';
-import { AptlyAllowanceChargeSchema, AptlyAllowance, AptlyExtensionAmount, AptlyPrice } from './algorithm.js';
+import { AptlyAllowance, AptlyExtensionAmount, AptlyPrice, AptlyAllowanceChargeItemSchema } from './algorithm.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyItemSchema, AptlyItemType } from './item.js';
 import { AptlyMediaSrcSchema } from './media.js';
@@ -37,7 +37,7 @@ export interface AptlyOptionSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     amountCategory: ID | AptlyCategorySchema<ID, DATE> | null;
     amountCategoryKey?: string;
     allowance?: AptlyAllowance | null;
-    allowanceCharge: AptlyAllowanceChargeSchema<ID, boolean>[];
+    allowanceCharge: AptlyAllowanceChargeItemSchema<ID, boolean>[];
 }
 export type AptlyOptionPopulated = AptlyOptionPopulatedSchema<string, string>;
 export interface AptlyOptionPopulatedSchema<ID, DATE> extends Omit<AptlyOptionSchema<ID, DATE>, 'product'>, AptlyExtensionAmount {

package/models/order.d.ts

@@ -1,5 +1,6 @@
 import { AptlyOrderStatus } from '../enums/index.js';
 import { AptlyAddress } from './address.js';
+import { AptlyAllowanceChargeSchema, AptlyLegalMonetaryTotal } from './algorithm.js';
 import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
 import { AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
@@ -40,6 +41,8 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     vatAmount?: number;
     totalVat?: number;
     totalCost: number;
+    total?: AptlyLegalMonetaryTotal | null;
+    allowanceCharges: AptlyAllowanceChargeSchema<ID, boolean>[];
     customer?: AptlyCustomerSchema<ID, DATE>;
     shipping?: AptlyAddress;
     billing?: AptlyAddress;

package/models/payment.d.ts

@@ -1,4 +1,5 @@
 import { AptlyAddress } from './address.js';
+import { AptlyAllowanceChargeSchema, AptlyLegalMonetaryTotal } from './algorithm.js';
 import { AptlyAppSchema } from './app.js';
 import { AptlyCustomer, AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
@@ -24,6 +25,8 @@ export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, D
     vatAmount: number;
     totalCost: number;
     totalVat: number;
+    total?: AptlyLegalMonetaryTotal | null;
+    allowanceCharges?: AptlyAllowanceChargeSchema<ID, boolean>[];
     items: AptlyPaymentItemSchema<ID>[];
     picks: (ID | AptlyPickConfirmedSchema<ID, DATE>)[];
     transaction: {

package/models/pick.d.ts

@@ -22,6 +22,7 @@ export interface AptlyPickSchema<ID, DATE> extends Pick<AptlyBaseSchema<ID, DATE
     offerItem: ID | null;
     order: ID | AptlyOrderSchema<ID, DATE> | null;
     period: ID | null;
+    index: number;
     quantity?: number;
     note: string;
     invoicedQuantity?: number | null;

package/models/plan-payment.d.ts

@@ -1,6 +1,6 @@
 import { AptlyCurrency, AptlyQuantityUnitCode } from '../enums/index.js';
 import { AptlyAddress } from './address.js';
-import { AptlyPrice } from './algorithm.js';
+import { AptlyAllowanceChargeSchema, AptlyLegalMonetaryTotal, AptlyPrice } from './algorithm.js';
 import { AptlyCustomerSchema } from './customer.js';
 import { AptlyItemSchema } from './item.js';
 import { AptlyOrganizationSchema } from './organization.js';
@@ -12,15 +12,15 @@ export interface AptlyPlanPaymentSchema<ID, DATE> {
     users: ID[];
     from: DATE;
     to: DATE;
-    amount: number;
-    vatAmount: number;
+    total: AptlyLegalMonetaryTotal;
+    allowanceCharges: AptlyAllowanceChargeSchema<ID, boolean>[];
     customer: AptlyCustomerSchema<ID, DATE>;
     billing: AptlyAddress;
-    items: AptlyPlanPaymentItemSchema<ID, DATE>[];
+    lines: AptlyPlanPaymentLineSchema<ID, DATE>[];
     createdAt: DATE;
 }
-export type AptlyPlanPaymentItem = AptlyPlanPaymentItemSchema<string, string>;
-export interface AptlyPlanPaymentItemSchema<ID, DATE> {
+export type AptlyPlanPaymentItem = AptlyPlanPaymentLineSchema<string, string>;
+export interface AptlyPlanPaymentLineSchema<ID, DATE> {
     _id: ID;
     item: AptlyItemSchema<ID, DATE>;
     invoicedQuantity: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptly-as/types",
-  "version": "3.1.5",
+  "version": "3.2.1",
   "description": "Aptly types and enums",
   "type": "module",
   "main": "./index.js",