@aptly-as/types 3.4.5 → 3.5.0

package/core/mongoose.d.ts

@@ -1,5 +1,5 @@
 export type Populated<T extends {
     _id: unknown;
-}, ID extends T['_id'] = T['_id']> = Omit<Partial<T>, '_id'> & {
+}, ID extends T['_id'] = T['_id']> = ID | (Omit<Partial<T>, '_id'> & {
     _id: ID;
-};
+});

package/core/scope.d.ts

@@ -4,6 +4,7 @@ export declare enum AptlyModules {
     Core = "core",
     Default = "default",
     Departments = "departments",
+    Documents = "documents",
     Emails = "emails",
     Members = "members",
     Offers = "offers",

package/core/scope.js

@@ -5,6 +5,7 @@ export var AptlyModules;
     AptlyModules["Core"] = "core";
     AptlyModules["Default"] = "default";
     AptlyModules["Departments"] = "departments";
+    AptlyModules["Documents"] = "documents";
     AptlyModules["Emails"] = "emails";
     AptlyModules["Members"] = "members";
     AptlyModules["Offers"] = "offers";

package/enums/index.d.ts

@@ -11,6 +11,7 @@ export declare enum AptlyOrderStatus {
     SignedByOrganization = "signedByOrganization",
     Signed = "signed",
     Payment = "payment",
+    Delivery = "delivery",
     FileReceived = "fileReceived",
     Completed = "completed",
     AllPeriodsSigned = "allPeriodsSigned",
@@ -141,6 +142,8 @@ export declare enum AptlyEmailType {
     Offer = "offer",
     OfferAccepted = "offer-accepted",
     OrderCreated = "order-created",
+    OrderDelivery = "order-delivery",
+    OrderDeliver = "order-deliver",
     OrderSign = "order-sign",
     OrderSignNotify = "order-sign-notify",
     OrderSignExpired = "order-sign-expired",

package/enums/index.js

@@ -12,6 +12,7 @@ export var AptlyOrderStatus;
     AptlyOrderStatus["SignedByOrganization"] = "signedByOrganization";
     AptlyOrderStatus["Signed"] = "signed";
     AptlyOrderStatus["Payment"] = "payment";
+    AptlyOrderStatus["Delivery"] = "delivery";
     AptlyOrderStatus["FileReceived"] = "fileReceived";
     AptlyOrderStatus["Completed"] = "completed";
     AptlyOrderStatus["AllPeriodsSigned"] = "allPeriodsSigned";
@@ -160,6 +161,8 @@ export var AptlyEmailType;
     AptlyEmailType["Offer"] = "offer";
     AptlyEmailType["OfferAccepted"] = "offer-accepted";
     AptlyEmailType["OrderCreated"] = "order-created";
+    AptlyEmailType["OrderDelivery"] = "order-delivery";
+    AptlyEmailType["OrderDeliver"] = "order-deliver";
     AptlyEmailType["OrderSign"] = "order-sign";
     AptlyEmailType["OrderSignNotify"] = "order-sign-notify";
     AptlyEmailType["OrderSignExpired"] = "order-sign-expired";

package/models/document.d.ts

@@ -11,6 +11,8 @@ export interface AptlyDocumentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID,
     organization?: ID;
     project?: ID;
     unit?: ID;
+    note?: ID;
+    offer?: ID;
     product?: ID | AptlyProductSchema<ID, DATE>;
     text?: string;
     size: number;

package/models/note.d.ts

@@ -4,12 +4,15 @@ import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyProjectSchema } from './project.js';
 import { AptlyUnitSchema } from './unit.js';
 import { AptlyUserSchema } from './user.js';
+import { AptlyDocumentSchema } from './document';
+import { AptlyOfferSchema } from './offer';
 export type AptlyNote = AptlyNoteSchema<string, string>;
 export interface AptlyNoteSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     content: string;
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE>;
+    offer: ID | AptlyOfferSchema<ID, DATE>;
     category: ID | AptlyCategorySchema<ID, DATE> | null;
     users: (ID | AptlyUserSchema<ID, DATE>)[];
     addToReceipt: boolean;
@@ -18,4 +21,5 @@ export interface AptlyNoteSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     reminderDate?: DATE | null;
     hasReminder?: boolean;
     author?: ID | AptlyUserSchema<ID, DATE>;
+    documents?: (ID | AptlyDocumentSchema<ID, DATE>)[];
 }

package/models/offer.d.ts

@@ -18,7 +18,7 @@ export interface AptlyOfferSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, O
     unit: ID | AptlyUnitSchema<ID, DATE> | null;
     order: ID | AptlyOrderSchema<ID, DATE> | null;
     document: ID | AptlyDocumentSchema<ID, DATE> | null;
-    createdBy: ID | Populated<AptlyUserSchema<ID, DATE>> | null;
+    createdBy: Populated<AptlyUserSchema<ID, DATE>> | null;
     expiresAt: DATE | null;
     sentAt: DATE | null;
     number?: number;

package/models/order.d.ts

@@ -14,6 +14,7 @@ import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './pr
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyUser, AptlyUserSchema } from './user.js';
+import { Populated } from '../core';
 export declare enum AptlyOrderPaymentStatus {
     Pending = "PENDING",
     Authorized = "AUTHORIZED",
@@ -57,7 +58,10 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     };
     paymentSession?: AptlyOrderPaymentSessionSchema<ID, DATE> | null;
     payment?: ID | AptlyPaymentSchema<ID, DATE>;
-    createdBy?: ID | AptlyUserSchema<ID, DATE>;
+    shippingDate?: DATE;
+    shippingDescription?: string;
+    completedAt?: DATE | null;
+    createdBy?: Populated<AptlyUserSchema<ID, DATE>> | null;
     createdByAdmin?: boolean;
     created: DATE;
 }
@@ -134,6 +138,7 @@ export interface AptlyOrderItemPricePipelineSchema<ID> {
 }
 export declare enum AptlyOrderAction {
     Complete = "complete",
+    Delivery = "delivery",
     Payment = "payment",
     SignManually = "sign-manually",
     Sign = "sign"
@@ -147,6 +152,8 @@ export interface AptlyOrderActionPostBody {
     emailMarkdown: string;
     users: AptlyOrderActionPostBodyUser[];
     deadlineInDays?: number;
+    shippingDate?: string | null;
+    shippingDescription?: string | null;
 }
 export interface AptlyOrderActionPostBodyUser {
     user: string;

package/models/order.js

@@ -15,6 +15,7 @@ export var AptlyOrderSigneeType;
 export var AptlyOrderAction;
 (function (AptlyOrderAction) {
     AptlyOrderAction["Complete"] = "complete";
+    AptlyOrderAction["Delivery"] = "delivery";
     AptlyOrderAction["Payment"] = "payment";
     AptlyOrderAction["SignManually"] = "sign-manually";
     AptlyOrderAction["Sign"] = "sign";

package/models/payment.d.ts

@@ -11,6 +11,7 @@ import { AptlyProjectContent, AptlyProjectSchema } from './project.js';
 import { AptlyUnitContent, AptlyUnitSchema } from './unit.js';
 import { AptlyUserSchema } from './user.js';
 import { AptlyOfferSchema } from './offer';
+import { Populated } from '../core';
 export type AptlyPayment = AptlyPaymentSchema<string, string>;
 export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
@@ -51,6 +52,7 @@ export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, D
         amount: number;
         at: DATE;
     };
+    createdBy: Populated<AptlyUserSchema<ID, DATE>> | null;
 }
 export declare enum AptlyPaymentStatus {
     Authorized = "AUTHORIZED",

package/package.json

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