@aptly-as/types 2.1.10 → 2.2.0

package/core/scope.d.ts

@@ -10,6 +10,7 @@ export declare enum AptlyModules {
     Recommendations = "recommendations",
     Subcontractor = "subcontractor",
     ThirdParty = "thirdParty",
+    Sign = "sign",
     Support = "support",
     SupportComplaint = "supportComplaint",
     Testing = "testing",
@@ -70,6 +71,7 @@ export declare enum AptlyScopes {
     ProjectUnitInvites = "projectUnitInvites",
     ProjectUnitExtraFields = "projectUnitExtraFields",
     ProjectUnitExtraOptions = "projectUnitExtraOptions",
+    ProjectUnitDocuments = "projectUnitDocuments",
     ProjectUnitTemplates = "projectUnitTemplates",
     ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
     ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",

package/core/scope.js

@@ -11,6 +11,7 @@ export var AptlyModules;
     AptlyModules["Recommendations"] = "recommendations";
     AptlyModules["Subcontractor"] = "subcontractor";
     AptlyModules["ThirdParty"] = "thirdParty";
+    AptlyModules["Sign"] = "sign";
     AptlyModules["Support"] = "support";
     AptlyModules["SupportComplaint"] = "supportComplaint";
     AptlyModules["Testing"] = "testing";
@@ -72,6 +73,7 @@ export var AptlyScopes;
     AptlyScopes["ProjectUnitInvites"] = "projectUnitInvites";
     AptlyScopes["ProjectUnitExtraFields"] = "projectUnitExtraFields";
     AptlyScopes["ProjectUnitExtraOptions"] = "projectUnitExtraOptions";
+    AptlyScopes["ProjectUnitDocuments"] = "projectUnitDocuments";
     AptlyScopes["ProjectUnitTemplates"] = "projectUnitTemplates";
     AptlyScopes["ProjectUnitTemplatesAlgorithms"] = "projectUnitTemplatesAlgorithms";
     AptlyScopes["ProjectUnitTemplatesPrices"] = "projectUnitTemplatesPrices";

package/enums/index.d.ts

@@ -3,12 +3,14 @@ export * from './fields.js';
 export * from './unit-template.js';
 export * from './webhook.js';
 export declare enum AptlyOrderStatus {
+    New = "new",
     NotSigned = "notSigned",
     ReadyToSign = "readyToSign",
     SignedByCustomer = "signedByCustomer",
     SignedByOrganization = "signedByOrganization",
     Signed = "signed",
     FileReceived = "fileReceived",
+    Completed = "completed",
     AllPeriodsSigned = "allPeriodsSigned",
     Invalid = "invalid"
 }

package/enums/index.js

@@ -4,12 +4,14 @@ export * from './unit-template.js';
 export * from './webhook.js';
 export var AptlyOrderStatus;
 (function (AptlyOrderStatus) {
+    AptlyOrderStatus["New"] = "new";
     AptlyOrderStatus["NotSigned"] = "notSigned";
     AptlyOrderStatus["ReadyToSign"] = "readyToSign";
     AptlyOrderStatus["SignedByCustomer"] = "signedByCustomer";
     AptlyOrderStatus["SignedByOrganization"] = "signedByOrganization";
     AptlyOrderStatus["Signed"] = "signed";
     AptlyOrderStatus["FileReceived"] = "fileReceived";
+    AptlyOrderStatus["Completed"] = "completed";
     AptlyOrderStatus["AllPeriodsSigned"] = "allPeriodsSigned";
     AptlyOrderStatus["Invalid"] = "invalid";
 })(AptlyOrderStatus || (AptlyOrderStatus = {}));

package/models/app.d.ts

@@ -14,8 +14,18 @@ export interface AptlyAppSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>
     banner?: AptlyMediaSrcSchema<ID, DATE> | null;
     settings: AptlyAppSettingSchema<ID>[];
     webhooks: AptlyAppWebhookSchema<ID>[];
-    proxies: AptlyAppProxySchema<ID>[];
     menus: AptlyAppMenuSchema<ID, DATE>[];
+    implements: AptlyAppImplementation[];
+    sign?: {
+        costPer?: number;
+        order: string;
+    };
+}
+export declare enum AptlyAppImplementation {
+    Sign = "sign"
+}
+export declare enum AptlyAppImplementationSetting {
+    SignCostPer = "costPerSign"
 }
 export type AptlyAppSetting = AptlyAppSettingSchema<string>;
 export interface AptlyAppSettingSchema<ID> extends AptlyField {
@@ -67,8 +77,3 @@ export interface AptlyAppMenuSchema<ID, DATE> {
     src: string;
     sandbox: AptlyAppSandbox[];
 }
-export interface AptlyAppProxySchema<ID> {
-    _id: ID;
-    path: string;
-    url: string;
-}

package/models/app.js

@@ -1,3 +1,11 @@
+export var AptlyAppImplementation;
+(function (AptlyAppImplementation) {
+    AptlyAppImplementation["Sign"] = "sign";
+})(AptlyAppImplementation || (AptlyAppImplementation = {}));
+export var AptlyAppImplementationSetting;
+(function (AptlyAppImplementationSetting) {
+    AptlyAppImplementationSetting["SignCostPer"] = "costPerSign";
+})(AptlyAppImplementationSetting || (AptlyAppImplementationSetting = {}));
 export var AptlyOrganizationInjection;
 (function (AptlyOrganizationInjection) {
     AptlyOrganizationInjection["Base"] = "";

package/models/order.d.ts

@@ -1,9 +1,11 @@
 import { AptlyOrderStatus } from '../enums/index.js';
+import { AptlyAppSchema } from './app.js';
+import { AptlyDocumentSchema } from './document.js';
 import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
-import { AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
+import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
-import { AptlyUserSchema } from './user.js';
+import { AptlyUser, AptlyUserSchema } from './user.js';
 export type AptlyOrder = AptlyOrderSchema<string, string>;
 export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
     orderNumber: string;
@@ -13,14 +15,28 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     unit: ID | AptlyUnitSchema<ID, DATE>;
     signers: (ID | AptlyUserSchema<ID, DATE>)[];
     status: AptlyOrderStatus;
-    receipt: ID;
+    receipt: ID | AptlyDocumentSchema<ID, DATE>;
+    signedReceipt?: ID;
     attachments: ID[];
     signage: AptlyOrderSignageSchema<ID, DATE>;
     items: AptlyOrderItemSchema<ID, DATE>[];
     totalCost: number;
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
+    signees: AptlyOrderSigneeSchema<ID, DATE>[];
     created: DATE;
 }
+export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
+export interface AptlyOrderSigneeSchema<ID, DATE> {
+    _id: ID;
+    user: ID;
+    type: AptlyOrderSigneeType;
+    url: string;
+    signedAt?: DATE;
+}
+export declare enum AptlyOrderSigneeType {
+    Unit = 0,
+    Admin = 1
+}
 export type AptlyOrderPricePipelineItem = AptlyOrderPricePipelineItemSchema<string>;
 export interface AptlyOrderPricePipelineItemSchema<ID> {
     _id: ID;
@@ -32,7 +48,7 @@ export interface AptlyOrderSignageSchema<ID, DATE> {
     hasReceivedFile: boolean;
     signed: boolean;
     documentId?: ID;
-    signedFile?: ID;
+    signedFile?: ID | AptlyDocumentSchema<ID, DATE>;
     documentCreationDate?: DATE;
     expireDate?: DATE;
     customerSignerId?: string;
@@ -58,3 +74,22 @@ export interface AptlyOrderItemPricePipelineSchema<ID> {
     label: string;
     value: number;
 }
+export declare enum AptlyOrderAction {
+    Complete = "complete",
+    SignManually = "sign-manually",
+    Sign = "sign"
+}
+export type AptlyOrderActionItem = AptlyOrderActionItemSchema<string, string>;
+export interface AptlyOrderActionItemSchema<ID, DATE> {
+    action: AptlyOrderAction;
+    path: string;
+    app?: Pick<AptlyAppSchema<ID, DATE>, '_id' | 'name' | 'sign'>;
+    costPerSign?: number;
+}
+export interface AptlyOrderActionSignData {
+    project: string;
+    unit: Pick<AptlyUnit, '_id' | 'name'>;
+    order: Pick<AptlyOrder, '_id' | 'orderNumber' | 'receipt'>;
+    users: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone'>[];
+    admins: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone'>[];
+}

package/models/order.js

@@ -1 +1,11 @@
-export {};
+export var AptlyOrderSigneeType;
+(function (AptlyOrderSigneeType) {
+    AptlyOrderSigneeType[AptlyOrderSigneeType["Unit"] = 0] = "Unit";
+    AptlyOrderSigneeType[AptlyOrderSigneeType["Admin"] = 1] = "Admin";
+})(AptlyOrderSigneeType || (AptlyOrderSigneeType = {}));
+export var AptlyOrderAction;
+(function (AptlyOrderAction) {
+    AptlyOrderAction["Complete"] = "complete";
+    AptlyOrderAction["SignManually"] = "sign-manually";
+    AptlyOrderAction["Sign"] = "sign";
+})(AptlyOrderAction || (AptlyOrderAction = {}));

package/models/organization.d.ts

@@ -11,6 +11,7 @@ import { AptlyAlgorithmSchema } from './algorithm.js';
 export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
     slug: string;
+    number?: string;
     logo?: string | null;
     logoMedia?: AptlyMediaSrc | null;
     negativeLogoMedia?: AptlyMediaSrc | null;

package/models/unit.d.ts

@@ -1,3 +1,4 @@
+import { AptlyOrderSchema } from './order.js';
 import { AptlyProducerSchema } from './producer.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProjectSchema } from './project.js';
@@ -30,7 +31,7 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
     project: AptlyProjectSchema<ID, DATE> | ID;
     users: (AptlyUserSchema<ID, DATE> | ID)[];
     unitTemplate: ID | AptlyUnitTemplateSchema<ID, DATE>;
-    confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID>[];
+    confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID, DATE>[];
     queueInvites: string[];
     invites: AptlyUnitInviteSchema<ID, DATE>[];
     overridePeriod?: ID;
@@ -169,11 +170,11 @@ export interface AptlyUnitSpec {
         }[];
     }[];
 }
-export type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string>;
-export interface AptlyUnitConfirmedPeriodSchema<ID> {
+export type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string, string>;
+export interface AptlyUnitConfirmedPeriodSchema<ID, DATE> {
     _id: ID;
     period: ID;
-    order: ID;
+    order?: ID | AptlyOrderSchema<ID, DATE>;
 }
 export type AptlyUnitIntegration = AptlyUnitIntegrationSchema<string>;
 export interface AptlyUnitIntegrationSchema<ID> {

package/package.json

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