@aptly-as/types 2.4.0 → 2.4.2

package/core/scope.d.ts

@@ -11,7 +11,7 @@ export declare enum AptlyModules {
     ProductsExtended = "productsExtended",
     Recommendations = "recommendations",
     Subcontractor = "subcontractor",
-    Sign = "sign",
+    Signing = "signing",
     Support = "support",
     SupportComplaint = "supportComplaint",
     Testing = "testing",

package/core/scope.js

@@ -12,7 +12,7 @@ export var AptlyModules;
     AptlyModules["ProductsExtended"] = "productsExtended";
     AptlyModules["Recommendations"] = "recommendations";
     AptlyModules["Subcontractor"] = "subcontractor";
-    AptlyModules["Sign"] = "sign";
+    AptlyModules["Signing"] = "signing";
     AptlyModules["Support"] = "support";
     AptlyModules["SupportComplaint"] = "supportComplaint";
     AptlyModules["Testing"] = "testing";

package/enums/document.d.ts

@@ -9,6 +9,7 @@ export declare enum AptlyDocumentType {
     Manual = "manual",
     KitchenDrawing = "kitchenDrawing",
     Receipt = "receipt",
+    PaymentReceipt = "payment-receipt",
     ProductAttachment = "productAttachment",
     SignedReceipt = "signedReceipt",
     OrderAttachment = "orderAttachment",

package/enums/document.js

@@ -10,6 +10,7 @@ export var AptlyDocumentType;
     AptlyDocumentType["Manual"] = "manual";
     AptlyDocumentType["KitchenDrawing"] = "kitchenDrawing";
     AptlyDocumentType["Receipt"] = "receipt";
+    AptlyDocumentType["PaymentReceipt"] = "payment-receipt";
     AptlyDocumentType["ProductAttachment"] = "productAttachment";
     AptlyDocumentType["SignedReceipt"] = "signedReceipt";
     AptlyDocumentType["OrderAttachment"] = "orderAttachment";

package/models/index.d.ts

@@ -15,6 +15,7 @@ export * from './option-label.js';
 export * from './order.js';
 export * from './organization.js';
 export * from './page.js';
+export * from './payment.js';
 export * from './period.js';
 export * from './producer.js';
 export * from './product.js';

package/models/index.js

@@ -15,6 +15,7 @@ export * from './option-label.js';
 export * from './order.js';
 export * from './organization.js';
 export * from './page.js';
+export * from './payment.js';
 export * from './period.js';
 export * from './producer.js';
 export * from './product.js';

package/models/order.d.ts

@@ -3,6 +3,7 @@ import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyEmailSchema } from './email.js';
 import { AptlyOrganizationAppConfigSchema, AptlyOrganizationSchema } from './organization.js';
+import { AptlyPaymentSchema } from './payment.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
@@ -38,23 +39,18 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
         user?: ID | AptlyUserSchema<ID, DATE>;
         at?: DATE;
     };
-    payment?: AptlyOrderPaymentSchema<DATE> | null;
+    paymentSession?: AptlyOrderPaymentSessionSchema<DATE> | null;
+    payment?: ID | AptlyPaymentSchema<ID, DATE>;
     created: DATE;
 }
-export type AptlyOrderPayment = AptlyOrderPaymentSchema<string>;
-export interface AptlyOrderPaymentSchema<DATE> {
+export type AptlyOrderPaymentSession = AptlyOrderPaymentSessionSchema<string>;
+export interface AptlyOrderPaymentSessionSchema<DATE> {
     status: AptlyOrderPaymentStatus;
-    sessionId: string;
-    sessionAt: DATE | null;
     url: string;
-    transactionId?: string;
-    transactionAt?: DATE;
-    captures: {
-        amount: number;
-        description?: string;
-    }[];
-    capturedAmount: number;
-    capturedAt?: DATE;
+    id: string;
+    at: DATE | null;
+    paidAt?: DATE | null;
+    capturedAt?: DATE | null;
 }
 export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
 export interface AptlyOrderSigneeSchema<ID, DATE> {
@@ -147,10 +143,10 @@ export interface AptlyOrderActionSignData {
     unit: Pick<AptlyUnit, '_id' | 'name'>;
     order: Pick<AptlyOrder, '_id' | 'orderNumber' | 'receipt' | 'period'>;
     user: AptlyUser;
-    signees: AptlyorderActionSignDataSignee[];
+    signees: AptlyOrderActionSignDataSignee[];
     deadlineInDays?: number;
 }
-export interface AptlyorderActionSignDataSignee {
+export interface AptlyOrderActionSignDataSignee {
     user: AptlyUser;
     signMethod?: string;
     isAdmin?: boolean;

package/models/organization.d.ts

@@ -1,6 +1,6 @@
 import { AptlyModules } from '../core/index.js';
 import { AptlyOrganizationRoles, AptlyAppScope, AptlySignageSchema } from '../core/index.js';
-import { AptlyOrganizationStatus, AptlyOrganizationType } from "../enums/index.js";
+import { AptlyOrganizationStatus, AptlyOrganizationType } from '../enums/index.js';
 import { AptlyModuleItemSchema } from './module.js';
 import { AptlyUserSchema } from './user.js';
 import { AptlyMediaSrc } from './media.js';
@@ -19,6 +19,7 @@ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, D
     negativeLogoMedia?: AptlyMediaSrc | null;
     projectLogoMedia?: AptlyMediaSrc | null;
     address: {
+        billing: AptlyAddress;
         visit: AptlyAddress;
         post: AptlyAddress;
     };

package/models/payment.d.ts

@@ -0,0 +1,96 @@
+import { AptlyAppSchema } from './app.js';
+import { AptlyDocumentSchema } from './document.js';
+import { AptlyAddress, AptlyBaseSchema } from './extends.js';
+import { AptlyOrderPaymentStatus, AptlyOrderSchema } from './order.js';
+import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyProjectSchema } from './project.js';
+import { AptlyUnitCompany, AptlyUnitSchema } from './unit.js';
+import { AptlyUserSchema } from './user.js';
+export type AptlyPayment = AptlyPaymentSchema<string, string>;
+export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
+    organization: ID | AptlyOrganizationSchema<ID, DATE>;
+    project: ID | AptlyProjectSchema<ID, DATE>;
+    unit: ID | AptlyUnitSchema<ID, DATE>;
+    order: ID | AptlyOrderSchema<ID, DATE>;
+    app: ID | AptlyAppSchema<ID, DATE>;
+    document?: ID | AptlyDocumentSchema<ID, DATE>;
+    number: number;
+    totalCost: number;
+    totalVat: number;
+    items: AptlyPaymentItemSchema<ID>[];
+    transaction: {
+        ref: string;
+        at: DATE;
+    };
+    company: AptlyPaymentCompany;
+    customer: AptlyPaymentCustomerSchema<ID, DATE>;
+    shipping: AptlyAddress;
+    shippingDate?: DATE;
+    billing?: AptlyAddress;
+    card?: {
+        brand: string;
+        last4: string;
+    };
+    captures: AptlyPaymentCaptureSchema<ID, DATE>[];
+    captured: {
+        amount: number;
+        at: DATE;
+    };
+}
+export type AptlyPaymentCapture = AptlyPaymentCaptureSchema<string, string>;
+export interface AptlyPaymentCaptureSchema<ID, DATE> {
+    _id: ID;
+    amount: number;
+    description: string;
+    ref: string;
+    user: ID | AptlyUserSchema<ID, DATE>;
+    at: DATE;
+}
+export interface AptlyPaymentCompany {
+    vat: string;
+    name: string;
+    email: string;
+    address: AptlyAddress;
+    phone?: string;
+}
+export type AptlyPaymentCustomer = AptlyPaymentCustomerSchema<string, string>;
+export interface AptlyPaymentCustomerSchema<ID, DATE> {
+    user: ID | AptlyUserSchema<ID, DATE>;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string;
+    company?: AptlyUnitCompany;
+}
+export interface AptlyPaymentItemSchema<ID> {
+    _id: ID;
+    name: string;
+    sku: string;
+    quantity: number;
+    unitCost: number;
+    totalCost: number;
+    totalVat: number;
+}
+export interface AptlyPaymentCaptureBody {
+    id: string;
+    status: AptlyOrderPaymentStatus;
+    capturedAmount: number;
+    totalCost: number;
+    at: string;
+}
+export interface AptlyPaymentTransactionBody {
+    app: string;
+    id: string;
+    at: string;
+    customer: {
+        user: string;
+        firstName: string;
+        lastName: string;
+        email: string;
+        phone?: string;
+        company?: AptlyUnitCompany;
+    };
+    card: AptlyPayment['card'];
+    shipping: AptlyAddress;
+    billing?: AptlyAddress;
+}

package/models/payment.js

@@ -0,0 +1 @@
+export {};

package/models/unit.d.ts

@@ -2,7 +2,7 @@ import { AptlyOrderSchema } from './order.js';
 import { AptlyProducerSchema } from './producer.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProjectSchema } from './project.js';
-import { AptlyHistorySchema } from './extends.js';
+import { AptlyAddress, AptlyHistorySchema } from './extends.js';
 import { AptlyUnitTemplateBaseSchema, AptlyUnitTemplateCategorySchema, AptlyUnitTemplateCategorySectionSchema, AptlyUnitTemplateSchema } from './unit-template';
 import { AptlyIntegration, AptlyUnitItemParamKey, AptlyUnitStatus } from '../enums/index.js';
 import { AptlyUserSchema } from './user.js';
@@ -10,6 +10,10 @@ import { AptlyOrganizationSchema } from './organization.js';
 export type AptlyUnit = AptlyUnitSchema<string, string>;
 export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData<DATE>, AptlyHistorySchema<ID, DATE> {
     status: AptlyUnitStatus;
+    vat?: string;
+    shipping?: AptlyAddress;
+    billing?: AptlyAddress;
+    company?: AptlyUnitCompany;
     rooms: AptlyUnitRoomSchema<ID>[];
     selectedOptions: AptlyUnitSelectedOptionSchema<ID, DATE>[];
     items: AptlyUnitOptionItemSchema<ID, DATE>[];
@@ -232,4 +236,8 @@ export interface AptlyUnitInviteSchema<ID, DATE> {
         claimTime: DATE;
     };
 }
+export interface AptlyUnitCompany {
+    name?: string;
+    vat?: string;
+}
 export {};

package/package.json

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